@kvaser/canking-api 7.1.0-beta.231

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (554) hide show
  1. package/EULA.pdf +0 -0
  2. package/README.md +87 -0
  3. package/REDISTRIBUTABLES.txt +5 -0
  4. package/dist/ElectronAPIFake.js +1 -0
  5. package/dist/ElectronAPIFake.mjs +266 -0
  6. package/dist/controls/CanChannelSelectControl.d.ts +35 -0
  7. package/dist/controls/CanIdentifierControl.d.ts +176 -0
  8. package/dist/controls/CanKingDataProvider.d.ts +116 -0
  9. package/dist/controls/CheckboxControl.d.ts +30 -0
  10. package/dist/controls/ContextMenu.d.ts +44 -0
  11. package/dist/controls/DropdownButton.d.ts +73 -0
  12. package/dist/controls/DropdownPanel.d.ts +41 -0
  13. package/dist/controls/FillBox.d.ts +8 -0
  14. package/dist/controls/FormControlRow.d.ts +30 -0
  15. package/dist/controls/InlineEditor.d.ts +26 -0
  16. package/dist/controls/LocalizedStrings.d.ts +21 -0
  17. package/dist/controls/NumberRangeControl.d.ts +80 -0
  18. package/dist/controls/OneLineButton.d.ts +9 -0
  19. package/dist/controls/RadioControl.d.ts +25 -0
  20. package/dist/controls/RadioGroupControl.d.ts +31 -0
  21. package/dist/controls/SectionControl.d.ts +40 -0
  22. package/dist/controls/SelectControl.d.ts +55 -0
  23. package/dist/controls/SizedBox.d.ts +11 -0
  24. package/dist/controls/TableControl.d.ts +61 -0
  25. package/dist/controls/TabsPanel.d.ts +5 -0
  26. package/dist/controls/TextControl.d.ts +56 -0
  27. package/dist/controls/ToolbarControl.d.ts +143 -0
  28. package/dist/controls/ValidateableTextControl.d.ts +82 -0
  29. package/dist/controls/index.d.ts +103 -0
  30. package/dist/controls.js +1 -0
  31. package/dist/controls.mjs +1714 -0
  32. package/dist/grpc/index.d.ts +7 -0
  33. package/dist/grpc.js +1 -0
  34. package/dist/grpc.mjs +917 -0
  35. package/dist/hooks/index.d.ts +112 -0
  36. package/dist/hooks.js +1 -0
  37. package/dist/hooks.mjs +28 -0
  38. package/dist/icons/index.d.ts +121 -0
  39. package/dist/icons.js +1 -0
  40. package/dist/icons.mjs +1237 -0
  41. package/dist/index.d.ts +6 -0
  42. package/dist/index.js +1 -0
  43. package/dist/index.mjs +596 -0
  44. package/dist/ipc/index.d.ts +160 -0
  45. package/dist/ipc.js +1 -0
  46. package/dist/ipc.mjs +123 -0
  47. package/dist/measurement_settings.js +1 -0
  48. package/dist/measurement_settings.mjs +4132 -0
  49. package/dist/models/DataBuffer.d.ts +100 -0
  50. package/dist/models/ElectronAPIFake.d.ts +13 -0
  51. package/dist/models/Point.d.ts +30 -0
  52. package/dist/models/index.d.ts +95 -0
  53. package/dist/models.js +1 -0
  54. package/dist/models.mjs +448 -0
  55. package/dist/protos/app_params.d.ts +208 -0
  56. package/dist/protos/app_service.d.ts +354 -0
  57. package/dist/protos/common_params.d.ts +33 -0
  58. package/dist/protos/device_params.d.ts +271 -0
  59. package/dist/protos/device_service.d.ts +154 -0
  60. package/dist/protos/frame_params.d.ts +189 -0
  61. package/dist/protos/google/protobuf/empty.d.ts +35 -0
  62. package/dist/protos/measurement_params.d.ts +308 -0
  63. package/dist/protos/measurement_service.d.ts +1333 -0
  64. package/dist/protos/measurement_settings.d.ts +453 -0
  65. package/dist/protos/signal_params.d.ts +72 -0
  66. package/dist/protos/status_params.d.ts +118 -0
  67. package/dist/status_params.js +1 -0
  68. package/dist/status_params.mjs +5045 -0
  69. package/doc/.nojekyll +1 -0
  70. package/doc/assets/highlight.css +120 -0
  71. package/doc/assets/icons.js +18 -0
  72. package/doc/assets/icons.svg +1 -0
  73. package/doc/assets/main.js +60 -0
  74. package/doc/assets/material-style.css +247 -0
  75. package/doc/assets/navigation.js +1 -0
  76. package/doc/assets/search.js +1 -0
  77. package/doc/assets/style.css +1493 -0
  78. package/doc/classes/controls.LocalizedStrings.html +177 -0
  79. package/doc/classes/models.DataBuffer.html +205 -0
  80. package/doc/classes/models.DataBufferView.html +193 -0
  81. package/doc/classes/models.Point.html +187 -0
  82. package/doc/enums/models.AccessMode.html +188 -0
  83. package/doc/enums/models.AppEvent.html +179 -0
  84. package/doc/enums/models.CanChannelCap.html +217 -0
  85. package/doc/enums/models.CanFrameFlag.html +200 -0
  86. package/doc/enums/models.CanMode.html +180 -0
  87. package/doc/enums/models.DecimalChar.html +178 -0
  88. package/doc/enums/models.DeviceEvent.html +179 -0
  89. package/doc/enums/models.FileConflictAction.html +180 -0
  90. package/doc/enums/models.LinFrameFlag.html +185 -0
  91. package/doc/enums/models.LogFileFormat.html +221 -0
  92. package/doc/enums/models.LogLevel.html +195 -0
  93. package/doc/enums/models.LogReplayState.html +179 -0
  94. package/doc/enums/models.MeasurementEvent.html +185 -0
  95. package/doc/enums/models.MessageLoggerState.html +180 -0
  96. package/doc/enums/models.Protocols.html +182 -0
  97. package/doc/enums/models.Separator.html +178 -0
  98. package/doc/enums/models.SignalEncoding.html +178 -0
  99. package/doc/enums/models.SignalType.html +185 -0
  100. package/doc/enums/models.SignalValueTriggerOperator.html +186 -0
  101. package/doc/enums/models.StatusLevel.html +180 -0
  102. package/doc/enums/models.TimeReference.html +178 -0
  103. package/doc/enums/models.TriggerOperator.html +179 -0
  104. package/doc/functions/controls.CanChannelSelectControl.html +177 -0
  105. package/doc/functions/controls.CanIdentifierControl.html +177 -0
  106. package/doc/functions/controls.CanIdentifierFrameControl.html +177 -0
  107. package/doc/functions/controls.CanIdentifierGeneratorControl.html +177 -0
  108. package/doc/functions/controls.CanIdentifierGeneratorSettingsControl.html +178 -0
  109. package/doc/functions/controls.CanKingDataProvider.html +182 -0
  110. package/doc/functions/controls.CheckboxControl.html +177 -0
  111. package/doc/functions/controls.ContextMenu.html +177 -0
  112. package/doc/functions/controls.DropdownButton.html +177 -0
  113. package/doc/functions/controls.DropdownButtonTextItems.html +177 -0
  114. package/doc/functions/controls.DropdownPanel.html +177 -0
  115. package/doc/functions/controls.FillBox.html +206 -0
  116. package/doc/functions/controls.FormControlRow.html +177 -0
  117. package/doc/functions/controls.InlineEditor.html +177 -0
  118. package/doc/functions/controls.NumberRangeControl.html +177 -0
  119. package/doc/functions/controls.OneLineButton.html +205 -0
  120. package/doc/functions/controls.RadioControl.html +177 -0
  121. package/doc/functions/controls.RadioGroupControl.html +177 -0
  122. package/doc/functions/controls.SectionControl.html +177 -0
  123. package/doc/functions/controls.SelectControl.html +177 -0
  124. package/doc/functions/controls.SizedBox.html +206 -0
  125. package/doc/functions/controls.TableControl.html +177 -0
  126. package/doc/functions/controls.TabsPanel.html +205 -0
  127. package/doc/functions/controls.TextControl.html +177 -0
  128. package/doc/functions/controls.ToolbarControl.html +177 -0
  129. package/doc/functions/controls.ValidateableTextControl.html +177 -0
  130. package/doc/functions/hooks.useDevices.html +176 -0
  131. package/doc/functions/hooks.useIsOnline.html +176 -0
  132. package/doc/functions/hooks.useLanguage.html +176 -0
  133. package/doc/functions/hooks.useLocalizedStrings.html +176 -0
  134. package/doc/functions/hooks.useLogMessages.html +176 -0
  135. package/doc/functions/hooks.useMaxDataBytes.html +175 -0
  136. package/doc/functions/hooks.useMeasurementSetup.html +176 -0
  137. package/doc/functions/hooks.useMeasurementStatus.html +176 -0
  138. package/doc/functions/hooks.useMessageLogFileFormats.html +175 -0
  139. package/doc/functions/hooks.useNewMeasurementData.html +178 -0
  140. package/doc/functions/hooks.useNodeStatus.html +176 -0
  141. package/doc/functions/hooks.useNumericRadix.html +176 -0
  142. package/doc/functions/hooks.useOnlineStatus.html +176 -0
  143. package/doc/functions/hooks.useOverallStatusLevel.html +176 -0
  144. package/doc/functions/hooks.useProjectData.html +178 -0
  145. package/doc/functions/hooks.useRecentProjectFiles.html +175 -0
  146. package/doc/functions/hooks.useRunningPeriodicTransmissions.html +176 -0
  147. package/doc/functions/hooks.useSessionData.html +178 -0
  148. package/doc/functions/hooks.useUserSettings.html +176 -0
  149. package/doc/functions/hooks.useWorkspacePaneWithId.html +175 -0
  150. package/doc/functions/icons.AddIcon.html +175 -0
  151. package/doc/functions/icons.ArrowDownIcon.html +175 -0
  152. package/doc/functions/icons.ArrowLeftIcon.html +175 -0
  153. package/doc/functions/icons.ArrowRightIcon.html +175 -0
  154. package/doc/functions/icons.ArrowUpIcon.html +175 -0
  155. package/doc/functions/icons.BusIsOffIcon.html +175 -0
  156. package/doc/functions/icons.BusIsOnIcon.html +175 -0
  157. package/doc/functions/icons.CloseIcon.html +175 -0
  158. package/doc/functions/icons.CopyIcon.html +175 -0
  159. package/doc/functions/icons.DarkModeIcon.html +175 -0
  160. package/doc/functions/icons.DeleteIcon.html +175 -0
  161. package/doc/functions/icons.DisableIcon.html +175 -0
  162. package/doc/functions/icons.EditIcon.html +175 -0
  163. package/doc/functions/icons.FilterIcon.html +175 -0
  164. package/doc/functions/icons.FixedPositionIcon.html +175 -0
  165. package/doc/functions/icons.LeaveFullScreenIcon.html +175 -0
  166. package/doc/functions/icons.LightModeIcon.html +175 -0
  167. package/doc/functions/icons.LineArrowDownIcon.html +175 -0
  168. package/doc/functions/icons.LineArrowUpIcon.html +175 -0
  169. package/doc/functions/icons.MaximizeWindowIcon.html +175 -0
  170. package/doc/functions/icons.MeasurementSetupIcon.html +175 -0
  171. package/doc/functions/icons.MoreHorizIcon.html +175 -0
  172. package/doc/functions/icons.MoreVertIcon.html +175 -0
  173. package/doc/functions/icons.NewIcon.html +175 -0
  174. package/doc/functions/icons.OpenExternallyIcon.html +175 -0
  175. package/doc/functions/icons.OpenIcon.html +175 -0
  176. package/doc/functions/icons.PauseIcon.html +175 -0
  177. package/doc/functions/icons.PlayIcon.html +175 -0
  178. package/doc/functions/icons.PlaySolidIcon.html +175 -0
  179. package/doc/functions/icons.SaveIcon.html +175 -0
  180. package/doc/functions/icons.SelectAllIcon.html +175 -0
  181. package/doc/functions/icons.ServiceIconActive.html +175 -0
  182. package/doc/functions/icons.ServiceIconInactive.html +175 -0
  183. package/doc/functions/icons.SettingsIcon.html +175 -0
  184. package/doc/functions/icons.StopIcon.html +175 -0
  185. package/doc/functions/icons.StopSolidIcon.html +175 -0
  186. package/doc/functions/icons.ToolsPanelHiddenIcon.html +175 -0
  187. package/doc/functions/icons.ToolsPanelVisibleIcon.html +175 -0
  188. package/doc/functions/icons.UnmaximizeWindowIcon.html +175 -0
  189. package/doc/functions/icons.WorkspacesIcon.html +175 -0
  190. package/doc/functions/ipc.addDataProcessor.html +178 -0
  191. package/doc/functions/ipc.addSource.html +176 -0
  192. package/doc/functions/ipc.addTarget.html +176 -0
  193. package/doc/functions/ipc.connectNodes.html +177 -0
  194. package/doc/functions/ipc.deleteDataProcessor.html +176 -0
  195. package/doc/functions/ipc.deleteSource.html +176 -0
  196. package/doc/functions/ipc.deleteTarget.html +176 -0
  197. package/doc/functions/ipc.disableNode.html +176 -0
  198. package/doc/functions/ipc.disconnectNodes.html +177 -0
  199. package/doc/functions/ipc.enableNode.html +176 -0
  200. package/doc/functions/ipc.getFrameDefinitions.html +178 -0
  201. package/doc/functions/ipc.getLogger.html +177 -0
  202. package/doc/functions/ipc.getMessageLogFileFormats.html +176 -0
  203. package/doc/functions/ipc.sendCanMessage.html +179 -0
  204. package/doc/functions/ipc.sendMessage.html +177 -0
  205. package/doc/functions/ipc.showMessageBox.html +177 -0
  206. package/doc/functions/ipc.showQuestionBox.html +183 -0
  207. package/doc/functions/ipc.startLogReplay.html +176 -0
  208. package/doc/functions/ipc.startMeasurement.html +175 -0
  209. package/doc/functions/ipc.startPeriodicTransmission.html +177 -0
  210. package/doc/functions/ipc.stopLogReplay.html +176 -0
  211. package/doc/functions/ipc.stopMeasurement.html +175 -0
  212. package/doc/functions/ipc.stopPeriodicTransmission.html +176 -0
  213. package/doc/functions/ipc.updateDataProcessor.html +176 -0
  214. package/doc/functions/ipc.updateSource.html +176 -0
  215. package/doc/functions/ipc.updateTarget.html +176 -0
  216. package/doc/functions/models.accessModeFromJSON.html +174 -0
  217. package/doc/functions/models.accessModeToJSON.html +174 -0
  218. package/doc/functions/models.appEventFromJSON.html +174 -0
  219. package/doc/functions/models.appEventToJSON.html +174 -0
  220. package/doc/functions/models.canChannelCapFromJSON.html +174 -0
  221. package/doc/functions/models.canChannelCapToJSON.html +174 -0
  222. package/doc/functions/models.canFrameFlagFromJSON.html +174 -0
  223. package/doc/functions/models.canFrameFlagToJSON.html +174 -0
  224. package/doc/functions/models.canModeFromJSON.html +174 -0
  225. package/doc/functions/models.canModeToJSON.html +174 -0
  226. package/doc/functions/models.createElectronApiFake.html +177 -0
  227. package/doc/functions/models.decimalCharFromJSON.html +174 -0
  228. package/doc/functions/models.decimalCharToJSON.html +174 -0
  229. package/doc/functions/models.decimalToFixed.html +174 -0
  230. package/doc/functions/models.decimalToHex.html +174 -0
  231. package/doc/functions/models.deviceEventFromJSON.html +174 -0
  232. package/doc/functions/models.deviceEventToJSON.html +174 -0
  233. package/doc/functions/models.fileConflictActionFromJSON.html +174 -0
  234. package/doc/functions/models.fileConflictActionToJSON.html +174 -0
  235. package/doc/functions/models.linFrameFlagFromJSON.html +174 -0
  236. package/doc/functions/models.linFrameFlagToJSON.html +174 -0
  237. package/doc/functions/models.logFileFormatFromJSON.html +174 -0
  238. package/doc/functions/models.logFileFormatToJSON.html +174 -0
  239. package/doc/functions/models.logLevelFromJSON.html +174 -0
  240. package/doc/functions/models.logLevelToJSON.html +174 -0
  241. package/doc/functions/models.logReplayStateFromJSON.html +174 -0
  242. package/doc/functions/models.logReplayStateToJSON.html +174 -0
  243. package/doc/functions/models.longToNumber.html +174 -0
  244. package/doc/functions/models.measurementEventFromJSON.html +174 -0
  245. package/doc/functions/models.measurementEventToJSON.html +174 -0
  246. package/doc/functions/models.messageLoggerStateFromJSON.html +174 -0
  247. package/doc/functions/models.messageLoggerStateToJSON.html +174 -0
  248. package/doc/functions/models.protocolsFromJSON.html +174 -0
  249. package/doc/functions/models.protocolsToJSON.html +174 -0
  250. package/doc/functions/models.separatorFromJSON.html +174 -0
  251. package/doc/functions/models.separatorToJSON.html +174 -0
  252. package/doc/functions/models.signalEncodingFromJSON.html +174 -0
  253. package/doc/functions/models.signalEncodingToJSON.html +174 -0
  254. package/doc/functions/models.signalTypeFromJSON.html +174 -0
  255. package/doc/functions/models.signalTypeToJSON.html +174 -0
  256. package/doc/functions/models.signalValueTriggerOperatorFromJSON.html +174 -0
  257. package/doc/functions/models.signalValueTriggerOperatorToJSON.html +174 -0
  258. package/doc/functions/models.statusLevelFromJSON.html +174 -0
  259. package/doc/functions/models.statusLevelToJSON.html +174 -0
  260. package/doc/functions/models.timeReferenceFromJSON.html +174 -0
  261. package/doc/functions/models.timeReferenceToJSON.html +174 -0
  262. package/doc/functions/models.triggerOperatorFromJSON.html +174 -0
  263. package/doc/functions/models.triggerOperatorToJSON.html +174 -0
  264. package/doc/hierarchy.html +174 -0
  265. package/doc/index.html +244 -0
  266. package/doc/interfaces/controls.ButtonGroupProps.html +183 -0
  267. package/doc/interfaces/controls.ButtonProps.html +195 -0
  268. package/doc/interfaces/controls.CanChannelSelectControlProps.html +194 -0
  269. package/doc/interfaces/controls.CanIdentifierControlProps.html +195 -0
  270. package/doc/interfaces/controls.CanIdentifierFrameControlProps.html +190 -0
  271. package/doc/interfaces/controls.CanIdentifierGeneratorControlProps.html +208 -0
  272. package/doc/interfaces/controls.CanIdentifierGeneratorSettingsControlProps.html +194 -0
  273. package/doc/interfaces/controls.CheckboxControlProps.html +190 -0
  274. package/doc/interfaces/controls.ContextMenuProps.html +182 -0
  275. package/doc/interfaces/controls.DropdownButtonChildrenProps.html +177 -0
  276. package/doc/interfaces/controls.DropdownButtonProps.html +193 -0
  277. package/doc/interfaces/controls.DropdownButtonTextItemsProps.html +183 -0
  278. package/doc/interfaces/controls.DropdownPanelProps.html +193 -0
  279. package/doc/interfaces/controls.FormControlRowProps.html +181 -0
  280. package/doc/interfaces/controls.ILocalizedStrings.html +176 -0
  281. package/doc/interfaces/controls.InlineEditorProps.html +186 -0
  282. package/doc/interfaces/controls.LabelProps.html +179 -0
  283. package/doc/interfaces/controls.NumberRangeControlProps.html +225 -0
  284. package/doc/interfaces/controls.RadioControlProps.html +187 -0
  285. package/doc/interfaces/controls.RadioGroupControlProps.html +182 -0
  286. package/doc/interfaces/controls.SectionControlProps.html +190 -0
  287. package/doc/interfaces/controls.SelectControlProps.html +205 -0
  288. package/doc/interfaces/controls.TableColumn.html +185 -0
  289. package/doc/interfaces/controls.TableControlProps.html +197 -0
  290. package/doc/interfaces/controls.TextControlProps.html +214 -0
  291. package/doc/interfaces/controls.ToggleButtonGroupProps.html +190 -0
  292. package/doc/interfaces/controls.ToggleButtonProps.html +187 -0
  293. package/doc/interfaces/controls.ToolbarControlProps.html +191 -0
  294. package/doc/interfaces/controls.ValidateableTextControlProps.html +233 -0
  295. package/doc/interfaces/controls.toolbarItem.html +185 -0
  296. package/doc/interfaces/ipc.ILogger.html +181 -0
  297. package/doc/interfaces/models.AboutInformation.html +181 -0
  298. package/doc/interfaces/models.ActivateLicenseRequest.html +181 -0
  299. package/doc/interfaces/models.AddAllConnectedCanChannelsRequest.html +177 -0
  300. package/doc/interfaces/models.AddAllConnectedLinChannelsRequest.html +177 -0
  301. package/doc/interfaces/models.AddOrUpdateDataProcessorRequest.html +185 -0
  302. package/doc/interfaces/models.AddOrUpdateSourceRequest.html +181 -0
  303. package/doc/interfaces/models.AddOrUpdateTargetRequest.html +181 -0
  304. package/doc/interfaces/models.ApiPreferences.html +183 -0
  305. package/doc/interfaces/models.AppEventArgs.html +179 -0
  306. package/doc/interfaces/models.BaseNodeProperties.html +181 -0
  307. package/doc/interfaces/models.BusStatus.html +190 -0
  308. package/doc/interfaces/models.CanBusParamLimits.html +180 -0
  309. package/doc/interfaces/models.CanBusParams.html +197 -0
  310. package/doc/interfaces/models.CanBusSpeed.html +187 -0
  311. package/doc/interfaces/models.CanBusSpeedInfo.html +193 -0
  312. package/doc/interfaces/models.CanChannelCapacity.html +180 -0
  313. package/doc/interfaces/models.CanChannelConfiguration.html +185 -0
  314. package/doc/interfaces/models.CanFDBusSpeedCombination.html +177 -0
  315. package/doc/interfaces/models.CanFDBusSpeedInfo.html +191 -0
  316. package/doc/interfaces/models.CanFrameFlags.html +177 -0
  317. package/doc/interfaces/models.CanMessageFilterSettings.html +178 -0
  318. package/doc/interfaces/models.Channel.html +180 -0
  319. package/doc/interfaces/models.ChannelSettings.html +193 -0
  320. package/doc/interfaces/models.ClearLinMessageRequest.html +180 -0
  321. package/doc/interfaces/models.ConnectNodesRequest.html +178 -0
  322. package/doc/interfaces/models.DataProcessingStatus.html +179 -0
  323. package/doc/interfaces/models.DataProcessorNodeProperties.html +181 -0
  324. package/doc/interfaces/models.DatabasesSettings.html +176 -0
  325. package/doc/interfaces/models.Device.html +182 -0
  326. package/doc/interfaces/models.DeviceEventArgs.html +177 -0
  327. package/doc/interfaces/models.Devices.html +175 -0
  328. package/doc/interfaces/models.DisconnectNodesRequest.html +178 -0
  329. package/doc/interfaces/models.Empty.html +182 -0
  330. package/doc/interfaces/models.ErrorStatus.html +177 -0
  331. package/doc/interfaces/models.Frame.html +203 -0
  332. package/doc/interfaces/models.FrameDefinition.html +185 -0
  333. package/doc/interfaces/models.FrameDefinitions.html +175 -0
  334. package/doc/interfaces/models.FramePropertyValue.html +177 -0
  335. package/doc/interfaces/models.FrameReceivedTrigger.html +179 -0
  336. package/doc/interfaces/models.Frame_PropertiesEntry.html +176 -0
  337. package/doc/interfaces/models.Frames.html +175 -0
  338. package/doc/interfaces/models.GetCanChannelBusSpeedsRequest.html +177 -0
  339. package/doc/interfaces/models.GetCanChannelBusSpeedsResponse.html +179 -0
  340. package/doc/interfaces/models.GetCanFdBusSpeedsRequest.html +179 -0
  341. package/doc/interfaces/models.GetCanFdBusSpeedsResponse.html +177 -0
  342. package/doc/interfaces/models.GetChannelsFromLogFileRequest.html +178 -0
  343. package/doc/interfaces/models.GetChannelsFromLogFileResponse.html +177 -0
  344. package/doc/interfaces/models.GetClassicCanBusSpeedsRequest.html +178 -0
  345. package/doc/interfaces/models.GetClassicCanBusSpeedsResponse.html +177 -0
  346. package/doc/interfaces/models.GetDataProcessorResponse.html +176 -0
  347. package/doc/interfaces/models.GetDevicesRequest.html +177 -0
  348. package/doc/interfaces/models.GetDevicesResponse.html +176 -0
  349. package/doc/interfaces/models.GetFrameDefinitionsFromDatabaseFilesRequest.html +178 -0
  350. package/doc/interfaces/models.GetLicensesResponse.html +177 -0
  351. package/doc/interfaces/models.GetLogFileFormatsRequest.html +180 -0
  352. package/doc/interfaces/models.GetLogFileFormatsResponse.html +183 -0
  353. package/doc/interfaces/models.GetLogLevelResponse.html +177 -0
  354. package/doc/interfaces/models.GetScheduleTablesFromDatabaseFilesRequest.html +178 -0
  355. package/doc/interfaces/models.GetScheduleTablesFromDatabaseFilesResponse.html +177 -0
  356. package/doc/interfaces/models.GetServiceExtensionInfoRequest.html +181 -0
  357. package/doc/interfaces/models.GetServiceExtensionInfoResponse.html +187 -0
  358. package/doc/interfaces/models.GetSignalDataFromMessageDataRequest.html +180 -0
  359. package/doc/interfaces/models.GetSignalDataFromMessageDataResponse.html +177 -0
  360. package/doc/interfaces/models.GetSourceResponse.html +176 -0
  361. package/doc/interfaces/models.GetTargetResponse.html +176 -0
  362. package/doc/interfaces/models.ILogFileFormat.html +179 -0
  363. package/doc/interfaces/models.IProject.html +179 -0
  364. package/doc/interfaces/models.IUserSettings.html +187 -0
  365. package/doc/interfaces/models.IWorkspaceComponentPaneData.html +177 -0
  366. package/doc/interfaces/models.IWorkspaceContainerPaneData.html +178 -0
  367. package/doc/interfaces/models.IWorkspaceData.html +178 -0
  368. package/doc/interfaces/models.IWorkspacePaneData.html +178 -0
  369. package/doc/interfaces/models.IdentifierRequest.html +178 -0
  370. package/doc/interfaces/models.IdentifiersRequest.html +178 -0
  371. package/doc/interfaces/models.InstallServiceExtensionRequest.html +181 -0
  372. package/doc/interfaces/models.InterpreterSettings.html +177 -0
  373. package/doc/interfaces/models.J1939InterpreterSettings.html +175 -0
  374. package/doc/interfaces/models.LicenseInformation.html +191 -0
  375. package/doc/interfaces/models.Licenses.html +177 -0
  376. package/doc/interfaces/models.LinChannelConfiguration.html +185 -0
  377. package/doc/interfaces/models.LinFrameFlags.html +177 -0
  378. package/doc/interfaces/models.LogMessage.html +185 -0
  379. package/doc/interfaces/models.LogMessages.html +177 -0
  380. package/doc/interfaces/models.LogReplaySettings.html +199 -0
  381. package/doc/interfaces/models.LogReplaySettings_ChannelIdentifiersEntry.html +176 -0
  382. package/doc/interfaces/models.LogReplayStatus.html +176 -0
  383. package/doc/interfaces/models.MeasurementEventArgs.html +179 -0
  384. package/doc/interfaces/models.MeasurementSetup.html +179 -0
  385. package/doc/interfaces/models.MessageLoggerSettings.html +213 -0
  386. package/doc/interfaces/models.MessageLoggerStatus.html +176 -0
  387. package/doc/interfaces/models.NodeStatus.html +191 -0
  388. package/doc/interfaces/models.NodeStatuses.html +176 -0
  389. package/doc/interfaces/models.OnlineStatus.html +176 -0
  390. package/doc/interfaces/models.PeriodicTransmissionSettings.html +209 -0
  391. package/doc/interfaces/models.RequestLinMessageRequest.html +180 -0
  392. package/doc/interfaces/models.ScheduleTable.html +181 -0
  393. package/doc/interfaces/models.ScheduleTableEntry.html +179 -0
  394. package/doc/interfaces/models.SendLinWakeupFrameRequest.html +182 -0
  395. package/doc/interfaces/models.SendMessageRequest.html +178 -0
  396. package/doc/interfaces/models.ServiceExtensionSettings.html +177 -0
  397. package/doc/interfaces/models.SetLogLevelRequest.html +179 -0
  398. package/doc/interfaces/models.SetMeasurementSetupRequest.html +177 -0
  399. package/doc/interfaces/models.SetSignalDataToMessageDataRequest.html +182 -0
  400. package/doc/interfaces/models.SetSignalDataToMessageDataResponse.html +180 -0
  401. package/doc/interfaces/models.SignalDefinition.html +188 -0
  402. package/doc/interfaces/models.SignalDefinition_EnumValuesEntry.html +176 -0
  403. package/doc/interfaces/models.SignalDefinitions.html +175 -0
  404. package/doc/interfaces/models.SignalValue.html +180 -0
  405. package/doc/interfaces/models.SignalValueTrigger.html +189 -0
  406. package/doc/interfaces/models.SourceNodeProperties.html +180 -0
  407. package/doc/interfaces/models.StartPeriodicTransmissionRequest.html +178 -0
  408. package/doc/interfaces/models.StartPeriodicTransmissionResponse.html +176 -0
  409. package/doc/interfaces/models.TargetNodeProperties.html +178 -0
  410. package/doc/interfaces/models.TriggerSettings.html +181 -0
  411. package/doc/interfaces/models.UninstallServiceExtensionRequest.html +179 -0
  412. package/doc/interfaces/models.UpdateLinMessageRequest.html +181 -0
  413. package/doc/interfaces/models.WriteFrame.html +183 -0
  414. package/doc/modules/controls.html +242 -0
  415. package/doc/modules/hooks.html +201 -0
  416. package/doc/modules/icons.html +216 -0
  417. package/doc/modules/ipc.html +202 -0
  418. package/doc/modules/models.html +478 -0
  419. package/doc/modules.html +179 -0
  420. package/doc/types/controls.ContextMenuOption.html +179 -0
  421. package/doc/types/controls.SelectOption.html +177 -0
  422. package/doc/types/controls.StringsMap.html +175 -0
  423. package/doc/types/controls.canIdentifierType.html +175 -0
  424. package/doc/types/models.IReadOnlyDataBuffer.html +174 -0
  425. package/doc/types/models.themes.html +174 -0
  426. package/doc/variables/models.AboutInformation-1.html +174 -0
  427. package/doc/variables/models.ActivateLicenseRequest-1.html +174 -0
  428. package/doc/variables/models.AddAllConnectedCanChannelsRequest-1.html +174 -0
  429. package/doc/variables/models.AddAllConnectedLinChannelsRequest-1.html +174 -0
  430. package/doc/variables/models.AddOrUpdateDataProcessorRequest-1.html +174 -0
  431. package/doc/variables/models.AddOrUpdateSourceRequest-1.html +174 -0
  432. package/doc/variables/models.AddOrUpdateTargetRequest-1.html +174 -0
  433. package/doc/variables/models.ApiPreferences-1.html +174 -0
  434. package/doc/variables/models.AppEventArgs-1.html +174 -0
  435. package/doc/variables/models.BaseNodeProperties-1.html +174 -0
  436. package/doc/variables/models.BusStatus-1.html +174 -0
  437. package/doc/variables/models.CanBusParamLimits-1.html +174 -0
  438. package/doc/variables/models.CanBusParams-1.html +174 -0
  439. package/doc/variables/models.CanBusSpeed-1.html +174 -0
  440. package/doc/variables/models.CanBusSpeedInfo-1.html +174 -0
  441. package/doc/variables/models.CanChannelCapacity-1.html +174 -0
  442. package/doc/variables/models.CanChannelConfiguration-1.html +174 -0
  443. package/doc/variables/models.CanFDBusSpeedCombination-1.html +174 -0
  444. package/doc/variables/models.CanFDBusSpeedInfo-1.html +174 -0
  445. package/doc/variables/models.CanFrameFlags-1.html +174 -0
  446. package/doc/variables/models.CanMessageFilterSettings-1.html +174 -0
  447. package/doc/variables/models.Channel-1.html +174 -0
  448. package/doc/variables/models.ChannelSettings-1.html +174 -0
  449. package/doc/variables/models.ClearLinMessageRequest-1.html +174 -0
  450. package/doc/variables/models.ConnectNodesRequest-1.html +174 -0
  451. package/doc/variables/models.DataProcessingStatus-1.html +174 -0
  452. package/doc/variables/models.DataProcessorNodeProperties-1.html +174 -0
  453. package/doc/variables/models.DatabasesSettings-1.html +174 -0
  454. package/doc/variables/models.Device-1.html +174 -0
  455. package/doc/variables/models.DeviceEventArgs-1.html +174 -0
  456. package/doc/variables/models.Devices-1.html +174 -0
  457. package/doc/variables/models.DisconnectNodesRequest-1.html +174 -0
  458. package/doc/variables/models.Empty-1.html +174 -0
  459. package/doc/variables/models.ErrorStatus-1.html +174 -0
  460. package/doc/variables/models.Frame-1.html +174 -0
  461. package/doc/variables/models.FrameDefinition-1.html +174 -0
  462. package/doc/variables/models.FrameDefinitions-1.html +174 -0
  463. package/doc/variables/models.FramePropertyValue-1.html +174 -0
  464. package/doc/variables/models.FrameReceivedTrigger-1.html +174 -0
  465. package/doc/variables/models.Frame_PropertiesEntry-1.html +174 -0
  466. package/doc/variables/models.Frames-1.html +174 -0
  467. package/doc/variables/models.GetCanChannelBusSpeedsRequest-1.html +174 -0
  468. package/doc/variables/models.GetCanChannelBusSpeedsResponse-1.html +174 -0
  469. package/doc/variables/models.GetCanFdBusSpeedsRequest-1.html +174 -0
  470. package/doc/variables/models.GetCanFdBusSpeedsResponse-1.html +174 -0
  471. package/doc/variables/models.GetChannelsFromLogFileRequest-1.html +174 -0
  472. package/doc/variables/models.GetChannelsFromLogFileResponse-1.html +174 -0
  473. package/doc/variables/models.GetClassicCanBusSpeedsRequest-1.html +174 -0
  474. package/doc/variables/models.GetClassicCanBusSpeedsResponse-1.html +174 -0
  475. package/doc/variables/models.GetDataProcessorResponse-1.html +174 -0
  476. package/doc/variables/models.GetDevicesRequest-1.html +174 -0
  477. package/doc/variables/models.GetDevicesResponse-1.html +174 -0
  478. package/doc/variables/models.GetFrameDefinitionsFromDatabaseFilesRequest-1.html +174 -0
  479. package/doc/variables/models.GetLicensesResponse-1.html +174 -0
  480. package/doc/variables/models.GetLogFileFormatsRequest-1.html +174 -0
  481. package/doc/variables/models.GetLogFileFormatsResponse-1.html +174 -0
  482. package/doc/variables/models.GetLogLevelResponse-1.html +174 -0
  483. package/doc/variables/models.GetScheduleTablesFromDatabaseFilesRequest-1.html +174 -0
  484. package/doc/variables/models.GetScheduleTablesFromDatabaseFilesResponse-1.html +174 -0
  485. package/doc/variables/models.GetServiceExtensionInfoRequest-1.html +174 -0
  486. package/doc/variables/models.GetServiceExtensionInfoResponse-1.html +174 -0
  487. package/doc/variables/models.GetSignalDataFromMessageDataRequest-1.html +174 -0
  488. package/doc/variables/models.GetSignalDataFromMessageDataResponse-1.html +174 -0
  489. package/doc/variables/models.GetSourceResponse-1.html +174 -0
  490. package/doc/variables/models.GetTargetResponse-1.html +174 -0
  491. package/doc/variables/models.IdentifierRequest-1.html +174 -0
  492. package/doc/variables/models.IdentifiersRequest-1.html +174 -0
  493. package/doc/variables/models.InstallServiceExtensionRequest-1.html +174 -0
  494. package/doc/variables/models.InterpreterSettings-1.html +174 -0
  495. package/doc/variables/models.J1939InterpreterSettings-1.html +174 -0
  496. package/doc/variables/models.LicenseInformation-1.html +174 -0
  497. package/doc/variables/models.Licenses-1.html +174 -0
  498. package/doc/variables/models.LinChannelConfiguration-1.html +174 -0
  499. package/doc/variables/models.LinFrameFlags-1.html +174 -0
  500. package/doc/variables/models.LogMessage-1.html +174 -0
  501. package/doc/variables/models.LogMessages-1.html +174 -0
  502. package/doc/variables/models.LogReplaySettings-1.html +174 -0
  503. package/doc/variables/models.LogReplaySettings_ChannelIdentifiersEntry-1.html +174 -0
  504. package/doc/variables/models.LogReplayStatus-1.html +174 -0
  505. package/doc/variables/models.MeasurementEventArgs-1.html +174 -0
  506. package/doc/variables/models.MeasurementSetup-1.html +174 -0
  507. package/doc/variables/models.MessageLoggerSettings-1.html +174 -0
  508. package/doc/variables/models.MessageLoggerStatus-1.html +174 -0
  509. package/doc/variables/models.NodeStatus-1.html +174 -0
  510. package/doc/variables/models.NodeStatuses-1.html +174 -0
  511. package/doc/variables/models.OnlineStatus-1.html +174 -0
  512. package/doc/variables/models.PeriodicTransmissionSettings-1.html +174 -0
  513. package/doc/variables/models.RequestLinMessageRequest-1.html +174 -0
  514. package/doc/variables/models.ScheduleTable-1.html +174 -0
  515. package/doc/variables/models.ScheduleTableEntry-1.html +174 -0
  516. package/doc/variables/models.SendLinWakeupFrameRequest-1.html +174 -0
  517. package/doc/variables/models.SendMessageRequest-1.html +174 -0
  518. package/doc/variables/models.ServiceExtensionSettings-1.html +174 -0
  519. package/doc/variables/models.SetLogLevelRequest-1.html +174 -0
  520. package/doc/variables/models.SetMeasurementSetupRequest-1.html +174 -0
  521. package/doc/variables/models.SetSignalDataToMessageDataRequest-1.html +174 -0
  522. package/doc/variables/models.SetSignalDataToMessageDataResponse-1.html +174 -0
  523. package/doc/variables/models.SignalDefinition-1.html +174 -0
  524. package/doc/variables/models.SignalDefinition_EnumValuesEntry-1.html +174 -0
  525. package/doc/variables/models.SignalDefinitions-1.html +174 -0
  526. package/doc/variables/models.SignalValue-1.html +174 -0
  527. package/doc/variables/models.SignalValueTrigger-1.html +174 -0
  528. package/doc/variables/models.SourceNodeProperties-1.html +174 -0
  529. package/doc/variables/models.StartPeriodicTransmissionRequest-1.html +174 -0
  530. package/doc/variables/models.StartPeriodicTransmissionResponse-1.html +174 -0
  531. package/doc/variables/models.TargetNodeProperties-1.html +174 -0
  532. package/doc/variables/models.TriggerSettings-1.html +174 -0
  533. package/doc/variables/models.UninstallServiceExtensionRequest-1.html +174 -0
  534. package/doc/variables/models.UpdateLinMessageRequest-1.html +174 -0
  535. package/doc/variables/models.WriteFrame-1.html +174 -0
  536. package/doc/variables/models.defaultUserSettings.html +175 -0
  537. package/package.json +129 -0
  538. package/scripts/createCanKingExtension.js +403 -0
  539. package/scripts/index.js +39 -0
  540. package/scripts/template/_.eslintrc.cjs +38 -0
  541. package/scripts/template/_.gitignore +24 -0
  542. package/scripts/template/_.npmrc +2 -0
  543. package/scripts/template/_.prettierrc +8 -0
  544. package/scripts/template/_.vscode/_launch.json +28 -0
  545. package/scripts/template/_index.html +15 -0
  546. package/scripts/template/_tsconfig.app.json +27 -0
  547. package/scripts/template/_tsconfig.json +11 -0
  548. package/scripts/template/_tsconfig.node.json +13 -0
  549. package/scripts/template/_vite.config.ts +7 -0
  550. package/scripts/template/src/App.tsx +12 -0
  551. package/scripts/template/src/WorkspaceView/index.tsx +47 -0
  552. package/scripts/template/src/main.css +9 -0
  553. package/scripts/template/src/main.tsx +19 -0
  554. package/scripts/template/src/vite-env.d.ts +1 -0
@@ -0,0 +1,116 @@
1
+ /**
2
+ * This module includes CanKing data provider React components.
3
+ * The CanKingDataProvider component is needed to be at the root of the component tree to
4
+ * make it possible to use the CanKing UI Controls.
5
+ *
6
+ * @example
7
+ * ```tsx
8
+ * const container = document.getElementById('root') as HTMLElement;
9
+ * const root = createRoot(container);
10
+ * root.render(
11
+ * <React.StrictMode>
12
+ * <CanKingDataProvider>
13
+ * <App />
14
+ * </CanKingDataProvider>
15
+ * </React.StrictMode>,
16
+ * );
17
+ * ```
18
+ *
19
+ * @packageDocumentation
20
+ */
21
+ import React from 'react';
22
+ import { Device, NodeStatus, LogMessage, MeasurementSetup, OnlineStatus, IUserSettings, IWorkspacePaneData } from '../models';
23
+ /**
24
+ * Possible CanKing event channels for an extension to listen to.
25
+ */
26
+ type extensionEventChannels = 'devices-changed' | 'new-log-messages' | 'online-status-changed' | 'periodic-trans-started' | 'periodic-trans-stopped' | 'new-measurement-data' | 'new-measurement-status' | 'user-settings-changed' | 'meas-setup-changed' | 'workspace-panes-changed';
27
+ /**
28
+ * Starts a subscription to an event raised by CanKing.
29
+ *
30
+ * @typeParam T - Type of the data that will be sent by the event.
31
+ * @param key - A unique key for this subscription, this key should be used when calling removeEventListener to unsubcribe
32
+ * from the event. The uuid package can be used for generating unique keys.
33
+ * @param event - The event channel to subscibe to.
34
+ * @param callback - A callback that will be called when new data arrives on the channel.
35
+ * @param options - Optional options including following options:
36
+ * numberOfHistoryFrames - used when adding a 'new-measurement-data' event listener to control number of frames to read from history at initialization.
37
+ * @returns A promise that will resolve with start values for the event.
38
+ * @internal
39
+ */
40
+ export declare function addEventListener<T>(key: string, event: extensionEventChannels, callback: (data: T) => void, options?: {
41
+ numberOfHistoryFrames?: number;
42
+ }): Promise<T>;
43
+ /**
44
+ * Unsubscribes from an event.
45
+ *
46
+ * @param key - The key that was used when addEventListener was called.
47
+ * @param event - The event channel to unsubscribe from.
48
+ * @internal
49
+ */
50
+ export declare const removeEventListener: (key: string, event: extensionEventChannels) => Promise<void>;
51
+ /**
52
+ * The UserSettings context
53
+ * @internal
54
+ */
55
+ export declare const UserSettingsContext: React.Context<IUserSettings>;
56
+ /**
57
+ * The Devices context
58
+ * @internal
59
+ */
60
+ export declare const DevicesContext: React.Context<Device[]>;
61
+ /**
62
+ * The MeasurementStatus context
63
+ * @internal
64
+ */
65
+ export declare const MeasurementStatusContext: React.Context<NodeStatus[]>;
66
+ /**
67
+ * The MeasurementSetup context
68
+ * @internal
69
+ */
70
+ export declare const MeasurementSetupContext: React.Context<MeasurementSetup>;
71
+ /**
72
+ * The OnlineStatus context
73
+ * @internal
74
+ */
75
+ export declare const OnlineStatusContext: React.Context<OnlineStatus>;
76
+ /**
77
+ * The RunningPeriodicTransmissions context
78
+ * @internal
79
+ */
80
+ export declare const RunningPeriodicTransmissionsContext: React.Context<string[]>;
81
+ /**
82
+ * The LogMessages context
83
+ * @internal
84
+ */
85
+ export declare const LogMessagesContext: React.Context<LogMessage[]>;
86
+ /**
87
+ * The WorkspacePanes context
88
+ * @internal
89
+ */
90
+ export declare const WorkspacePanesContext: React.Context<[IWorkspacePaneData[], React.Dispatch<React.SetStateAction<IWorkspacePaneData[]>>]>;
91
+ /**
92
+ * Creates a data provider to access CanKing data.
93
+ * The CanKingDataProvider component is needed to be at the root of the component tree to
94
+ * make it possible to use the CanKing UI Controls.
95
+ *
96
+ * @example
97
+ * ```tsx
98
+ * const container = document.getElementById('root') as HTMLElement;
99
+ * const root = createRoot(container);
100
+ * root.render(
101
+ * <React.StrictMode>
102
+ * <CanKingDataProvider>
103
+ * <App />
104
+ * </CanKingDataProvider>
105
+ * </React.StrictMode>,
106
+ * );
107
+ * ```
108
+ *
109
+ * @param props Component properties.
110
+ * @returns The CanKingDataProvider React component.
111
+ */
112
+ declare const CanKingDataProvider: ({ initialUserSettings, children, }: {
113
+ initialUserSettings?: IUserSettings;
114
+ children?: React.ReactNode;
115
+ }) => import("react/jsx-runtime").JSX.Element;
116
+ export default CanKingDataProvider;
@@ -0,0 +1,30 @@
1
+ import { SxProps, Theme } from '@mui/material';
2
+ /**
3
+ * Properties of the CheckboxControl React component.
4
+ */
5
+ export interface CheckboxControlProps {
6
+ /** The component id. */
7
+ id?: string;
8
+ /** A text label to be displayed. */
9
+ label: string;
10
+ /** The current check state. */
11
+ checked: boolean;
12
+ /**
13
+ * Callback that is called when the checked state has changed.
14
+ * @param checked The new checked state.
15
+ */
16
+ onChange: (checked: boolean) => void;
17
+ /** Set to true to disable this control. */
18
+ disabled?: boolean;
19
+ /** The optional size, defaults to 'small'. */
20
+ size?: 'small' | 'medium';
21
+ /** Optional sx props. */
22
+ sx?: SxProps<Theme>;
23
+ }
24
+ /**
25
+ * Creates a checkbox UI control.
26
+ * @param props Component properties.
27
+ * @returns The CheckboxControl React component.
28
+ */
29
+ declare function CheckboxControl({ id, label, checked, onChange, disabled, size, sx, }: CheckboxControlProps): import("react/jsx-runtime").JSX.Element;
30
+ export default CheckboxControl;
@@ -0,0 +1,44 @@
1
+ /**
2
+ * This module includes a context menu UI control.
3
+ *
4
+ * To be able to use these controls the CanKingDataProvider component must be present in the
5
+ * component tree above your component. Normally the CanKingDataProvider is added
6
+ * at the root of the component tree.
7
+ *
8
+ * @packageDocumentation
9
+ */
10
+ import React from 'react';
11
+ /**
12
+ * Menu option that describes one menu item.
13
+ */
14
+ export type ContextMenuOption = {
15
+ /** A unique value that identifies this menu item. */
16
+ value: number;
17
+ /** The text to be displayed in the context menu. */
18
+ displayText: string;
19
+ /** An optional icon to be displayed together with the displayText. */
20
+ icon?: React.ReactNode;
21
+ /** An optional shortcut string to be displayed together with the displayText. */
22
+ shortcut?: string;
23
+ };
24
+ /**
25
+ * Properties of the ContextMenu React component.
26
+ */
27
+ export interface ContextMenuProps {
28
+ /** The menu item options. */
29
+ options: ContextMenuOption[];
30
+ /**
31
+ * A callback that will be called when the user selects one of the menu items in this context menu.
32
+ * @param value Value of the selected menu option.
33
+ */
34
+ onSelect: (value: number) => void;
35
+ /** Children nodes that will be using this context menu. */
36
+ children?: React.ReactNode;
37
+ }
38
+ /**
39
+ * Creates a context menu UI control.
40
+ * @param props Component properties.
41
+ * @returns The ContextMenu React component.
42
+ */
43
+ declare function ContextMenu({ options, onSelect, children }: ContextMenuProps): import("react/jsx-runtime").JSX.Element;
44
+ export default ContextMenu;
@@ -0,0 +1,73 @@
1
+ /**
2
+ * This module includes a drop down button UI control, a button with a drop down menu.
3
+ *
4
+ * To be able to use these controls the CanKingDataProvider component must be present in the
5
+ * component tree above your component. Normally the CanKingDataProvider is added
6
+ * at the root of the component tree.
7
+ *
8
+ * @packageDocumentation
9
+ */
10
+ import React from 'react';
11
+ /**
12
+ * Base properties of any child component of the DropdownButton component.
13
+ */
14
+ export interface DropdownButtonChildrenProps {
15
+ /**
16
+ * Callback that is called when the drop down menu is closed.
17
+ */
18
+ onClose?: () => void;
19
+ }
20
+ /**
21
+ * Properties of the DropdownButtonTextItems React component.
22
+ */
23
+ export interface DropdownButtonTextItemsProps extends DropdownButtonChildrenProps {
24
+ /**
25
+ * The items that will be displayed in the drop down control.
26
+ * Each item has a unique key and a display text.
27
+ */
28
+ items: {
29
+ key: string;
30
+ text: string;
31
+ }[];
32
+ /**
33
+ * Callback that is called when the user selects one of the drop down items.
34
+ * @param itemKey The key of the selected item.
35
+ */
36
+ onSelect: (itemKey: string) => void;
37
+ }
38
+ /**
39
+ * Creates a drop down control that displays a menu with text strings.
40
+ * @param props Component properties.
41
+ * @returns The DropdownButtonTextItems React component.
42
+ */
43
+ export declare function DropdownButtonTextItems({ items, onSelect, onClose }: DropdownButtonTextItemsProps): import("react/jsx-runtime").JSX.Element;
44
+ /**
45
+ * Properties of the DropdownButton React component.
46
+ */
47
+ export interface DropdownButtonProps {
48
+ /** The component id. */
49
+ id?: string;
50
+ /** A start icon displayed inside the button. */
51
+ startIcon?: React.ReactNode;
52
+ /** An end icon displayed inside the button. */
53
+ endIcon?: React.ReactNode;
54
+ /** The text to be displayed inside the button. */
55
+ text?: string;
56
+ /** Button variant. */
57
+ variant?: 'text' | 'outlined' | 'contained';
58
+ /** Button color. */
59
+ color?: 'inherit' | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning';
60
+ /** Button size. */
61
+ size?: 'small' | 'medium' | 'large';
62
+ /** Set to true to disable this button. */
63
+ disabled?: boolean;
64
+ /** The drop down items that will be displayed when the user clicks on this button. */
65
+ children: React.ReactElement<DropdownButtonChildrenProps>;
66
+ }
67
+ /**
68
+ * Creates a drop down button control.
69
+ * @param props Component properties.
70
+ * @returns The DropdownButton React component.
71
+ */
72
+ declare function DropdownButton({ id, startIcon, endIcon, text, variant, color, size, disabled, children, }: DropdownButtonProps): import("react/jsx-runtime").JSX.Element;
73
+ export default DropdownButton;
@@ -0,0 +1,41 @@
1
+ /**
2
+ * This module includes a drop down panel UI control, a panel that will be displayed when
3
+ * the mouse is hovering over a specific area.
4
+ *
5
+ * To be able to use these controls the CanKingDataProvider component must be present in the
6
+ * component tree above your component. Normally the CanKingDataProvider is added
7
+ * at the root of the component tree.
8
+ *
9
+ * @packageDocumentation
10
+ */
11
+ import React from 'react';
12
+ /**
13
+ * Properties of the DropdownPanel React component.
14
+ */
15
+ export interface DropdownPanelProps {
16
+ /** The component id. */
17
+ id?: string;
18
+ /** The position of the panel in relation to the parent. */
19
+ position: 'left' | 'top' | 'right' | 'bottom';
20
+ /** The parent's width in pixels. */
21
+ parentWidth: number;
22
+ /** The parent's height in pixels. */
23
+ parentHeight: number;
24
+ /** The maximum length of the panel, either height or width depending on position. */
25
+ maxLength: number;
26
+ /** The size of the panel, either height or width depending on position. */
27
+ dropDownSize: number;
28
+ /** Force the panel to be visible even if not hovered. */
29
+ forceShow?: boolean;
30
+ /** The time in milliseconds until the panel will auto-hide */
31
+ autoHideTimeout?: number;
32
+ /** The children that will be displayed in the panel. */
33
+ children?: React.ReactNode;
34
+ }
35
+ /**
36
+ * Creates a drop down panel control.
37
+ * @param props Component properties.
38
+ * @returns The DropdownPanel React component.
39
+ */
40
+ declare function DropdownPanel({ id, position, parentWidth, parentHeight, maxLength, dropDownSize, autoHideTimeout, forceShow, children, }: DropdownPanelProps): import("react/jsx-runtime").JSX.Element;
41
+ export default DropdownPanel;
@@ -0,0 +1,8 @@
1
+ /**
2
+ * A Box UI control that will fill up it's parent's view completely.
3
+ * A padding of 4px will be used.
4
+ */
5
+ declare const FillBox: import("@emotion/styled").StyledComponent<import("@mui/system").BoxOwnProps<import("@mui/material").Theme> & Omit<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
6
+ ref?: import("react").Ref<HTMLDivElement>;
7
+ }, keyof import("@mui/system").BoxOwnProps<import("@mui/material").Theme>> & import("@mui/system").MUIStyledCommonProps<import("@mui/material").Theme>, {}, {}>;
8
+ export default FillBox;
@@ -0,0 +1,30 @@
1
+ /**
2
+ * This module includes a form row UI control, a container component that can be used to
3
+ * display form controls on one row.
4
+ *
5
+ * To be able to use these controls the CanKingDataProvider component must be present in the
6
+ * component tree above your component. Normally the CanKingDataProvider is added
7
+ * at the root of the component tree.
8
+ *
9
+ * @packageDocumentation
10
+ */
11
+ import React from 'react';
12
+ import { ResponsiveStyleValue } from '@mui/system';
13
+ /**
14
+ * Properties of the FormControlRow React component.
15
+ */
16
+ export interface FormControlRowProps {
17
+ /** Expand this control to use the full width. */
18
+ fullWidth?: boolean;
19
+ /** The spacing between the child controls. */
20
+ spacing?: ResponsiveStyleValue<number | string>;
21
+ /** Alignment of the child controls. */
22
+ alignItems?: 'center' | 'end' | 'flex-end' | 'flex-start' | 'self-end' | 'self-start' | 'start' | 'baseline' | 'normal' | 'stretch' | undefined;
23
+ }
24
+ /**
25
+ * Creates a form control row.
26
+ * @param props Component properties.
27
+ * @returns The FormControlRow React component.
28
+ */
29
+ declare function FormControlRow({ children, fullWidth, spacing, alignItems, }: React.PropsWithChildren<FormControlRowProps>): import("react/jsx-runtime").JSX.Element;
30
+ export default FormControlRow;
@@ -0,0 +1,26 @@
1
+ import { Variant } from '@mui/material/styles/createTypography';
2
+ /**
3
+ * Properties of the InlineEditor React component.
4
+ */
5
+ export interface InlineEditorProps {
6
+ /** Flag indicating if in edit mode or not. */
7
+ editMode: boolean;
8
+ /** The current value. */
9
+ value: string;
10
+ /**
11
+ * Callback that will be called when the value has been changed.
12
+ * @param value The new value.
13
+ */
14
+ onValueChange: (value: string) => void;
15
+ /** An aria label. */
16
+ ariaLabel?: string;
17
+ /** The variant of the text control. */
18
+ variant?: Variant;
19
+ }
20
+ /**
21
+ * Creates an inline editor.
22
+ * @param props Component properties.
23
+ * @returns The InlineEditor React component.
24
+ */
25
+ declare function InlineEditor({ editMode, value, onValueChange, ariaLabel, variant }: InlineEditorProps): import("react/jsx-runtime").JSX.Element;
26
+ export default InlineEditor;
@@ -0,0 +1,21 @@
1
+ /**
2
+ * Localized strings interface
3
+ */
4
+ export interface ILocalizedStrings {
5
+ getString(key: string, ...args: Array<number | string>): string;
6
+ }
7
+ /**
8
+ * A string map type.
9
+ */
10
+ export type StringsMap = {
11
+ [key: string]: string;
12
+ };
13
+ /**
14
+ * Default ILocalizedStrings implementation.
15
+ */
16
+ export declare class LocalizedStrings implements ILocalizedStrings {
17
+ private language;
18
+ private strings;
19
+ constructor(language: string, strings: StringsMap);
20
+ getString(key: string, ...args: Array<number | string>): string;
21
+ }
@@ -0,0 +1,80 @@
1
+ /**
2
+ * Properties of the NumberRangeControl React component.
3
+ */
4
+ export interface NumberRangeControlProps {
5
+ /** The min value. */
6
+ minValue: string;
7
+ /** The max value. */
8
+ maxValue: string;
9
+ /**
10
+ * Callback that is called on a change event.
11
+ * @param newMinValue The new min value.
12
+ * @param newMaxValue The new max value.
13
+ */
14
+ onChange?: (newMinValue: string, newMaxValue: string) => void;
15
+ /**
16
+ * Callback that is called on a blur event.
17
+ * @param newMinValue The new min value.
18
+ * @param newMaxValue The new max value.
19
+ */
20
+ onBlur?: (newMinValue: string, newMaxValue: string) => void;
21
+ /** The current min error state. */
22
+ minError?: boolean;
23
+ /**
24
+ * Callback that is called when the min errors state has changed.
25
+ * @param errors The new min errors state.
26
+ */
27
+ onMinErrorChange?: (errors: boolean) => void;
28
+ /** The current max error state. */
29
+ maxError?: boolean;
30
+ /**
31
+ * Callback that is called when the max errors state has changed.
32
+ * @param errors The new max errors state.
33
+ */
34
+ onMaxErrorChange?: (errors: boolean) => void;
35
+ /**
36
+ * Callback that will be called when the value has been changed or the control has lost focus.
37
+ * This callback is called before onChange and if the returned err value is true then onChange
38
+ * won't be called.
39
+ * The implemtation of this callback is allowed to modify the specified value and return
40
+ * the modified value in the val property of the returned object.
41
+ * @param value The new text value.
42
+ * @param trigger The trigger of this callback, either on 'change' or on 'blur'.
43
+ * @returns An object with the validated text value (val) and an error state (err).
44
+ */
45
+ onMinValidate?: (value: string, trigger: 'change' | 'blur') => {
46
+ val: string;
47
+ err: boolean;
48
+ };
49
+ /**
50
+ * Callback that will be called when the value has been changed or the control has lost focus.
51
+ * This callback is called before onChange and if the returned err value is true then onChange
52
+ * won't be called.
53
+ * The implemtation of this callback is allowed to modify the specified value and return
54
+ * the modified value in the val property of the returned object.
55
+ * @param value The new text value.
56
+ * @param trigger The trigger of this callback, either on 'change' or on 'blur'.
57
+ * @returns An object with the validated text value (val) and an error state (err).
58
+ */
59
+ onMaxValidate?: (value: string, trigger: 'change' | 'blur') => {
60
+ val: string;
61
+ err: boolean;
62
+ };
63
+ /** Set to true to disable the min value field. */
64
+ minDisabled?: boolean;
65
+ /** Set to true to disable the max value field. */
66
+ maxDisabled?: boolean;
67
+ /** A unit text that will be displayed next to the values. */
68
+ unit?: string;
69
+ /** Lower value limit. */
70
+ lowerLimit?: number;
71
+ /** Upper value limit. */
72
+ upperLimit?: number;
73
+ }
74
+ /**
75
+ * Creates a number range control.
76
+ * @param props Component properties.
77
+ * @returns The NumberRangeControl React component.
78
+ */
79
+ declare function NumberRangeControl({ minValue, maxValue, onChange, onBlur, minError, onMinErrorChange, maxError, onMaxErrorChange, onMinValidate, onMaxValidate, minDisabled, maxDisabled, unit, lowerLimit, upperLimit, }: NumberRangeControlProps): import("react/jsx-runtime").JSX.Element;
80
+ export default NumberRangeControl;
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Creates a one line button.
3
+ */
4
+ declare const OneLineButton: import("@emotion/styled").StyledComponent<import("@mui/material").ButtonOwnProps & Omit<import("@mui/material").ButtonBaseOwnProps, "classes"> & import("@mui/material/OverridableComponent").CommonProps & Omit<Omit<import("react").DetailedHTMLProps<import("react").ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref"> & {
5
+ ref?: import("react").Ref<HTMLButtonElement>;
6
+ }, "variant" | "color" | "style" | "action" | "className" | "children" | "tabIndex" | "disabled" | "size" | "href" | "sx" | "classes" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "TouchRippleProps" | "touchRippleRef" | "disableFocusRipple" | "fullWidth" | "disableElevation" | "endIcon" | "startIcon"> & import("@mui/system").MUIStyledCommonProps<import("@mui/material").Theme> & {
7
+ component?: React.ElementType;
8
+ }, {}, {}>;
9
+ export default OneLineButton;
@@ -0,0 +1,25 @@
1
+ import { SxProps, Theme } from '@mui/material';
2
+ /**
3
+ * Properties of the RadioControl React component.
4
+ */
5
+ export interface RadioControlProps {
6
+ /** The component id. */
7
+ id?: string;
8
+ /** The label to be displayed next to the radio button. */
9
+ label: string;
10
+ /** The value that this radio button represents. */
11
+ value: string;
12
+ /** Set to true to disable this control. */
13
+ disabled?: boolean;
14
+ /** The component size. */
15
+ size?: 'small' | 'medium';
16
+ /** Optional sx properties. */
17
+ sx?: SxProps<Theme>;
18
+ }
19
+ /**
20
+ * Creates a radio button control.
21
+ * @param props Component properties.
22
+ * @returns The RadioControl React component.
23
+ */
24
+ declare function RadioControl({ id, label, value, disabled, size, sx, }: RadioControlProps): import("react/jsx-runtime").JSX.Element;
25
+ export default RadioControl;
@@ -0,0 +1,31 @@
1
+ /**
2
+ * This module includes a radio button group UI control.
3
+ *
4
+ * To be able to use these controls the CanKingDataProvider component must be present in the
5
+ * component tree above your component. Normally the CanKingDataProvider is added
6
+ * at the root of the component tree.
7
+ *
8
+ * @packageDocumentation
9
+ */
10
+ import React from 'react';
11
+ /**
12
+ * Properties of the RadioGroupControl React component.
13
+ */
14
+ export interface RadioGroupControlProps {
15
+ /** The component id. */
16
+ id?: string;
17
+ /** Value of the currently selected radio button in this group. */
18
+ value: string;
19
+ /**
20
+ * Callback that is called when a new radio button has been selected.
21
+ * @param value The new value.
22
+ */
23
+ onChange: (value: string) => void;
24
+ }
25
+ /**
26
+ * Creates a radio button group control.
27
+ * @param props Component properties.
28
+ * @returns The RadioGroupControl React component.
29
+ */
30
+ declare function RadioGroupControl({ children, id, value, onChange, }: React.PropsWithChildren<RadioGroupControlProps>): import("react/jsx-runtime").JSX.Element;
31
+ export default RadioGroupControl;
@@ -0,0 +1,40 @@
1
+ /**
2
+ * This module includes a section UI control, to be used for organizing UI controls into
3
+ * collapsible sections.
4
+ *
5
+ * To be able to use these controls the CanKingDataProvider component must be present in the
6
+ * component tree above your component. Normally the CanKingDataProvider is added
7
+ * at the root of the component tree.
8
+ *
9
+ * @packageDocumentation
10
+ */
11
+ import React from 'react';
12
+ /**
13
+ * Properties of the SectionControl React component.
14
+ */
15
+ export interface SectionControlProps {
16
+ /** Text alignment to used in the divider. */
17
+ textAlign?: 'center' | 'right' | 'left';
18
+ /** Text to be displayed in the divider. */
19
+ text?: string;
20
+ /** A summary that will be added to text when the section is collapsed. */
21
+ summary?: string;
22
+ /** Children that will be included in this section. */
23
+ children?: React.ReactNode;
24
+ /** Sets to true if this section should be collapsible. */
25
+ collapsible?: boolean;
26
+ /** The current collapsed state. */
27
+ collapsed?: boolean;
28
+ /**
29
+ * Callback that will be called when this section has been collpsed or expanded.
30
+ * @param value The new collapsed state.
31
+ */
32
+ collapsedChange?: (value: boolean) => void;
33
+ }
34
+ /**
35
+ * Creates a section control.
36
+ * @param props Component properties.
37
+ * @returns The SectionControl React component.
38
+ */
39
+ declare function SectionControl({ textAlign, text, summary, children, collapsible, collapsed, collapsedChange, }: SectionControlProps): import("react/jsx-runtime").JSX.Element;
40
+ export default SectionControl;
@@ -0,0 +1,55 @@
1
+ /**
2
+ * A select option.
3
+ */
4
+ export type SelectOption = {
5
+ /** The unique value. */
6
+ value: number;
7
+ /** The display text. */
8
+ displayText: string;
9
+ };
10
+ /**
11
+ * Properties of the SelectControl React component.
12
+ */
13
+ export interface SelectControlProps {
14
+ /** The component id. */
15
+ id: string;
16
+ /** A label text that will be displayed in front of the select control. */
17
+ label: string;
18
+ /** Set to true to display the label. */
19
+ showLabel?: boolean;
20
+ /** A helper text that will be displayed underneath the select control. */
21
+ helperText?: string;
22
+ /** The options to be available inside the select control. */
23
+ options: SelectOption[] | Map<string, SelectOption[]>;
24
+ /** Value of the selected option or '' if no option has been selected. */
25
+ value: number | '';
26
+ /**
27
+ * Callback that will be called when a new option has been selected.
28
+ * @param value The new selected value.
29
+ */
30
+ onChange: (value: number | '') => void;
31
+ /** Set to true to disable this control. */
32
+ disabled?: boolean;
33
+ /** Set to true if the value of this control is required. */
34
+ required?: boolean;
35
+ /** Margins between controls inside this control. */
36
+ margin?: 'dense' | 'normal' | 'none';
37
+ /** The component size. */
38
+ size?: 'small' | 'medium';
39
+ /** Set to true to expand this control to use the full width of its parent. */
40
+ fullWidth?: boolean;
41
+ /** The min width of this control. */
42
+ minWidth?: number | string;
43
+ /**
44
+ * Set to true to display each option as '<value> - <displayText>', otherwise each option will
45
+ * be displayed with its displayText only.
46
+ */
47
+ prefixTextWithValue?: boolean;
48
+ }
49
+ /**
50
+ * Creates a select control.
51
+ * @param props Component properties.
52
+ * @returns The SelectControl React component.
53
+ */
54
+ declare function SelectControl({ id, label, showLabel, helperText, options, value, onChange, disabled, required, margin, size, fullWidth, minWidth, prefixTextWithValue, }: SelectControlProps): import("react/jsx-runtime").JSX.Element;
55
+ export default SelectControl;
@@ -0,0 +1,11 @@
1
+ /**
2
+ * A Box UI control that will be sized to the specified height and width.
3
+ * A padding of 4px will be used.
4
+ */
5
+ declare const SizedBox: import("@emotion/styled").StyledComponent<import("@mui/system").BoxOwnProps<import("@mui/material").Theme> & Omit<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
6
+ ref?: import("react").Ref<HTMLDivElement>;
7
+ }, keyof import("@mui/system").BoxOwnProps<import("@mui/material").Theme>> & import("@mui/system").MUIStyledCommonProps<import("@mui/material").Theme> & {
8
+ height?: number;
9
+ width?: number;
10
+ }, {}, {}>;
11
+ export default SizedBox;