@kvaser/canking-api 7.2.1 → 7.3.0

package/doc_md/controls/interfaces/ToggleButtonProps.md

@@ -0,0 +1,57 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / ToggleButtonProps
+
+# Interface: ToggleButtonProps
+
+Properties of a ToggleButton component displayed by the toolbar.
+
+## Properties
+
+### ariaLabel?
+
+> `optional` **ariaLabel**: `string`
+
+Aria label.
+
+***
+
+### disabled?
+
+> `optional` **disabled**: `boolean`
+
+Set to true to disable this button.
+
+***
+
+### icon
+
+> **icon**: `ReactNode`
+
+An icon that will be displayed in this button.
+
+***
+
+### size?
+
+> `optional` **size**: `number` \| `"small"` \| `"medium"` \| `"large"`
+
+The button size.
+
+***
+
+### tooltip?
+
+> `optional` **tooltip**: `string`
+
+A tooltip of this button.
+
+***
+
+### value
+
+> **value**: `string`
+
+The value represented by this toggle button.

package/doc_md/controls/interfaces/ToolbarControlProps.md

@@ -0,0 +1,73 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / ToolbarControlProps
+
+# Interface: ToolbarControlProps
+
+Properties of a ToolbarControl component.
+
+## Properties
+
+### backgroundColor?
+
+> `optional` **backgroundColor**: `string`
+
+The background color.
+
+***
+
+### borderSize?
+
+> `optional` **borderSize**: `number`
+
+The border size.
+
+***
+
+### height?
+
+> `optional` **height**: `number`
+
+The toolbar height.
+
+***
+
+### items
+
+> **items**: [`toolbarItem`](toolbarItem.md)[]
+
+The toolbar items.
+
+***
+
+### justifyContent?
+
+> `optional` **justifyContent**: `"left"` \| `"right"` \| `"center"` \| `"space-between"`
+
+How to justify the items.
+
+***
+
+### orientation?
+
+> `optional` **orientation**: `"horizontal"` \| `"vertical"`
+
+The orientation.
+
+***
+
+### padding?
+
+> `optional` **padding**: `number`
+
+The padding.
+
+***
+
+### width?
+
+> `optional` **width**: `number`
+
+The toolbar width.

package/doc_md/controls/interfaces/ValidateableTextControlProps.md

@@ -0,0 +1,269 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / ValidateableTextControlProps
+
+# Interface: ValidateableTextControlProps
+
+Properties of the ValidateableTextControl React component.
+
+## Properties
+
+### disabled?
+
+> `optional` **disabled**: `boolean`
+
+Set to true to disable this control.
+
+***
+
+### endAdornment?
+
+> `optional` **endAdornment**: `string`
+
+A text to be displayed after the value.
+
+***
+
+### error?
+
+> `optional` **error**: `boolean`
+
+The current error state.
+
+***
+
+### fullWidth?
+
+> `optional` **fullWidth**: `boolean`
+
+Set to true to expand this control to use the full widht of its parent.
+
+***
+
+### helperText?
+
+> `optional` **helperText**: `string`
+
+Any helper text that should be displayed.
+
+***
+
+### id?
+
+> `optional` **id**: `string`
+
+The component id.
+
+***
+
+### inputMode?
+
+> `optional` **inputMode**: `"search"` \| `"text"` \| `"none"` \| `"tel"` \| `"url"` \| `"email"` \| `"numeric"` \| `"decimal"`
+
+Input mode.
+
+***
+
+### label?
+
+> `optional` **label**: `string`
+
+The label of this input control.
+
+***
+
+### margin?
+
+> `optional` **margin**: `"none"` \| `"normal"` \| `"dense"`
+
+Margins between controls inside this control.
+
+***
+
+### maxValue?
+
+> `optional` **maxValue**: `number`
+
+The max value if numberType is set.
+
+***
+
+### minValue?
+
+> `optional` **minValue**: `number`
+
+The min value if numberType is set.
+
+***
+
+### numberType?
+
+> `optional` **numberType**: `"float"` \| `"int"`
+
+Number type if the expected value is a number, if left undefined then the value is expected to be a string.
+
+***
+
+### onBlur()?
+
+> `optional` **onBlur**: (`value`) => `void`
+
+Callback that will be called when the control has lost focus.
+
+#### Parameters
+
+##### value
+
+`string`
+
+The new value.
+
+#### Returns
+
+`void`
+
+***
+
+### onChange()?
+
+> `optional` **onChange**: (`value`) => `void`
+
+Callback that will be called when the value has been changed.
+
+#### Parameters
+
+##### value
+
+`string`
+
+The new value.
+
+#### Returns
+
+`void`
+
+***
+
+### onErrorChange()?
+
+> `optional` **onErrorChange**: (`error`) => `void`
+
+Callback that is called when the error state has changed.
+
+#### Parameters
+
+##### error
+
+`boolean`
+
+The new error state.
+
+#### Returns
+
+`void`
+
+***
+
+### onValidate()?
+
+> `optional` **onValidate**: (`text`, `trigger`) => `object`
+
+Callback that will be called when the value has been changed or the control has lost focus.
+This callback is called before onChange and if the returned err value is true then onChange
+won't be called.
+The implemtation of this callback is allowed to modify the specified text value and return
+the modified value in the val property of the returned object.
+
+#### Parameters
+
+##### text
+
+`string`
+
+The new text value.
+
+##### trigger
+
+The trigger of this callback, either on 'change' or on 'blur'.
+
+`"change"` | `"blur"`
+
+#### Returns
+
+`object`
+
+An object with the validated value (val) and an error state (err).
+
+##### err
+
+> **err**: `boolean`
+
+##### val
+
+> **val**: `string`
+
+***
+
+### pattern?
+
+> `optional` **pattern**: `string`
+
+Regex pattern of the value in this control.
+
+***
+
+### required?
+
+> `optional` **required**: `boolean`
+
+Set to true if this control's value is required.
+
+***
+
+### size?
+
+> `optional` **size**: `"small"` \| `"medium"`
+
+The component size.
+
+***
+
+### startAdornment?
+
+> `optional` **startAdornment**: `string`
+
+A text to be displayed in front of the value.
+
+***
+
+### sx?
+
+> `optional` **sx**: `SxProps`\<`Theme`\>
+
+Optional sx properties.
+
+***
+
+### sxEndAdornment?
+
+> `optional` **sxEndAdornment**: `SxProps`\<`Theme`\>
+
+Optional sx properties for the end adornment.
+
+***
+
+### sxStartAdornment?
+
+> `optional` **sxStartAdornment**: `SxProps`\<`Theme`\>
+
+Optional sx properties for the start adornment.
+
+***
+
+### value
+
+> **value**: `string`
+
+The current value.

package/doc_md/controls/interfaces/toolbarItem.md

@@ -0,0 +1,49 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / toolbarItem
+
+# Interface: toolbarItem
+
+A toolbar item. Could be one of its properties.
+
+## Properties
+
+### button?
+
+> `optional` **button**: [`ButtonProps`](ButtonProps.md)
+
+A button.
+
+***
+
+### buttonGroup?
+
+> `optional` **buttonGroup**: [`ButtonGroupProps`](ButtonGroupProps.md)
+
+A button group.
+
+***
+
+### label?
+
+> `optional` **label**: [`LabelProps`](LabelProps.md)
+
+A label.
+
+***
+
+### other?
+
+> `optional` **other**: `ReactNode`
+
+A custom node.
+
+***
+
+### toggleButtonGroup?
+
+> `optional` **toggleButtonGroup**: [`ToggleButtonGroupProps`](ToggleButtonGroupProps.md)
+
+A toggle button group.

package/doc_md/controls/type-aliases/ContextMenuOption.md

@@ -0,0 +1,43 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / ContextMenuOption
+
+# Type Alias: ContextMenuOption
+
+> **ContextMenuOption** = `object`
+
+Menu option that describes one menu item.
+
+## Properties
+
+### displayText
+
+> **displayText**: `string`
+
+The text to be displayed in the context menu.
+
+***
+
+### icon?
+
+> `optional` **icon**: `React.ReactNode`
+
+An optional icon to be displayed together with the displayText.
+
+***
+
+### shortcut?
+
+> `optional` **shortcut**: `string`
+
+An optional shortcut string to be displayed together with the displayText.
+
+***
+
+### value
+
+> **value**: `number`
+
+A unique value that identifies this menu item.

package/doc_md/controls/type-aliases/SelectOption.md

@@ -0,0 +1,27 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / SelectOption
+
+# Type Alias: SelectOption
+
+> **SelectOption** = `object`
+
+A select option.
+
+## Properties
+
+### displayText
+
+> **displayText**: `string`
+
+The display text.
+
+***
+
+### value
+
+> **value**: `number`
+
+The unique value.

package/doc_md/controls/type-aliases/StringsMap.md

@@ -0,0 +1,15 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / StringsMap
+
+# Type Alias: StringsMap
+
+> **StringsMap** = `object`
+
+A string map type.
+
+## Index Signature
+
+\[`key`: `string`\]: `string`

package/doc_md/controls/type-aliases/canIdentifierGeneratorType.md

@@ -0,0 +1,11 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / canIdentifierGeneratorType
+
+# Type Alias: canIdentifierGeneratorType
+
+> **canIdentifierGeneratorType** = `"constant"` \| `"random"` \| `"scan"`
+
+Possible CAN identifier generator types.

package/doc_md/controls/type-aliases/canIdentifierType.md

@@ -0,0 +1,11 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / canIdentifierType
+
+# Type Alias: canIdentifierType
+
+> **canIdentifierType** = `"standard"` \| `"extended"`
+
+Possible CAN identifier types, standard (11-bits) or extended (29-bits).

package/doc_md/controls/type-aliases/linIdentifierGeneratorType.md

@@ -0,0 +1,11 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / linIdentifierGeneratorType
+
+# Type Alias: linIdentifierGeneratorType
+
+> **linIdentifierGeneratorType** = `"constant"` \| `"random"` \| `"scan"`
+
+Possible LIN identifier generator types.

package/doc_md/controls/variables/FillBox.md

@@ -0,0 +1,12 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / FillBox
+
+# Variable: FillBox
+
+> `const` **FillBox**: `StyledComponent`\<`BoxOwnProps`\<`Theme`\> & `Omit`\<`Omit`\<`DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>, `HTMLDivElement`\>, `"ref"`\> & `object`, keyof `BoxOwnProps`\<`Theme`\>\> & `MUIStyledCommonProps`\<`Theme`\>, \{ \}, \{ \}\>
+
+A Box UI control that will fill up it's parent's view completely.
+A padding of 4px will be used.

package/doc_md/controls/variables/OneLineButton.md

@@ -0,0 +1,11 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / OneLineButton
+
+# Variable: OneLineButton
+
+> `const` **OneLineButton**: `StyledComponent`\<`ButtonOwnProps` & `Omit`\<`ButtonBaseOwnProps`, `"classes"`\> & `CommonProps` & `Omit`\<`Omit`\<`DetailedHTMLProps`\<`ButtonHTMLAttributes`\<`HTMLButtonElement`\>, `HTMLButtonElement`\>, `"ref"`\> & `object`, `"color"` \| `"disabled"` \| `"size"` \| `"sx"` \| `"classes"` \| `"children"` \| `"className"` \| `"style"` \| `"tabIndex"` \| `"variant"` \| `"action"` \| `"centerRipple"` \| `"disableRipple"` \| `"disableTouchRipple"` \| `"focusRipple"` \| `"focusVisibleClassName"` \| `"LinkComponent"` \| `"onFocusVisible"` \| `"TouchRippleProps"` \| `"touchRippleRef"` \| `"disableFocusRipple"` \| `"href"` \| `"loading"` \| `"disableElevation"` \| `"endIcon"` \| `"fullWidth"` \| `"loadingIndicator"` \| `"loadingPosition"` \| `"startIcon"`\> & `MUIStyledCommonProps`\<`Theme`\> & `object`, \{ \}, \{ \}\>
+
+Creates a one line button.

package/doc_md/controls/variables/SizedBox.md

@@ -0,0 +1,12 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / SizedBox
+
+# Variable: SizedBox
+
+> `const` **SizedBox**: `StyledComponent`\<`BoxOwnProps`\<`Theme`\> & `Omit`\<`Omit`\<`DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>, `HTMLDivElement`\>, `"ref"`\> & `object`, keyof `BoxOwnProps`\<`Theme`\>\> & `MUIStyledCommonProps`\<`Theme`\> & `object`, \{ \}, \{ \}\>
+
+A Box UI control that will be sized to the specified height and width.
+A padding of 4px will be used.

package/doc_md/controls/variables/TabsPanel.md

@@ -0,0 +1,11 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / TabsPanel
+
+# Variable: TabsPanel
+
+> `const` **TabsPanel**: `StyledComponent`\<`MUIStyledCommonProps`\<`Theme`\>, `DetailedHTMLProps`\<`HTMLAttributes`\<`HTMLDivElement`\>, `HTMLDivElement`\>, \{ \}\>
+
+A TabsPanel UI control.

package/doc_md/hooks/README.md

@@ -0,0 +1,53 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../modules.md) / hooks
+
+# hooks
+
+This module includes React hooks for getting/setting data from/to CanKing.
+
+To be able to use these hooks the CanKingDataProvider component must be present in the
+component tree above your component. Normally the CanKingDataProvider is added
+at the root of the component tree.
+
+## Example
+
+```
+import { useUserSettings } from '@kvaser/canking-api/hooks';
+...
+const userSettings = useUserSettings();
+```
+
+## Interfaces
+
+- [ISignalData](interfaces/ISignalData.md)
+
+## Functions
+
+- [useDevices](functions/useDevices.md)
+- [useFixedPositionModeMeasurementData](functions/useFixedPositionModeMeasurementData.md)
+- [useIsOnline](functions/useIsOnline.md)
+- [useLanguage](functions/useLanguage.md)
+- [useLocalizedStrings](functions/useLocalizedStrings.md)
+- [useLogMessages](functions/useLogMessages.md)
+- [useMaxDataBytes](functions/useMaxDataBytes.md)
+- [useMeasurementSetup](functions/useMeasurementSetup.md)
+- [useMeasurementStatus](functions/useMeasurementStatus.md)
+- [useMessageData](functions/useMessageData.md)
+- [useMessageLogFileFormats](functions/useMessageLogFileFormats.md)
+- [~~useNewMeasurementData~~](functions/useNewMeasurementData.md)
+- [useNodeStatus](functions/useNodeStatus.md)
+- [useNumericRadix](functions/useNumericRadix.md)
+- [useOnlineStatus](functions/useOnlineStatus.md)
+- [useOverallStatusLevel](functions/useOverallStatusLevel.md)
+- [useProjectData](functions/useProjectData.md)
+- [useRecentProjectFiles](functions/useRecentProjectFiles.md)
+- [useRunningPeriodicTransmissions](functions/useRunningPeriodicTransmissions.md)
+- [useScrollModeMeasurementData](functions/useScrollModeMeasurementData.md)
+- [useSessionData](functions/useSessionData.md)
+- [useSignalData](functions/useSignalData.md)
+- [useSignalLogFileFormats](functions/useSignalLogFileFormats.md)
+- [useUserSettings](functions/useUserSettings.md)
+- [useWorkspacePaneWithId](functions/useWorkspacePaneWithId.md)

package/doc_md/hooks/functions/useDevices.md

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useDevices
+
+# Function: useDevices()
+
+> **useDevices**(): [`Device`](../../models/interfaces/Device.md)[]
+
+A hook for hardware devices.
+
+## Returns
+
+[`Device`](../../models/interfaces/Device.md)[]
+
+The hardware devices.