@kvaser/canking-api 7.2.1 → 7.3.0

package/doc_md/controls/interfaces/LinIdentifierGeneratorControlProps.md

@@ -0,0 +1,198 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / LinIdentifierGeneratorControlProps
+
+# Interface: LinIdentifierGeneratorControlProps
+
+Properties of the LinIdentifierGeneratorControl React component.
+
+## Properties
+
+### collapsed?
+
+> `optional` **collapsed**: `boolean`
+
+Current collapse state of the SectionControl.
+
+***
+
+### collapsedChange()?
+
+> `optional` **collapsedChange**: (`value`) => `void`
+
+Callback that will be called when collapse state has changed.
+
+#### Parameters
+
+##### value
+
+`boolean`
+
+The new collapse state.
+
+#### Returns
+
+`void`
+
+***
+
+### collapsible?
+
+> `optional` **collapsible**: `boolean`
+
+Set to true if the SectionControl should be collapsible.
+
+***
+
+### disabled?
+
+> `optional` **disabled**: `boolean`
+
+Set to true to disable this control.
+
+***
+
+### fullScreen?
+
+> `optional` **fullScreen**: `boolean`
+
+Set to true if the select message dialog should be a full screen dialog.
+
+***
+
+### identifierGeneratorType
+
+> **identifierGeneratorType**: [`linIdentifierGeneratorType`](../type-aliases/linIdentifierGeneratorType.md)
+
+The generator type: 'constant' | 'random' | 'scan'
+'constant': The LIN identifier set to linIdentifier will be used for all generated messages.
+'random': A random LIN identifier between minLinIdentifier and maxLinIdentifier will be used.
+'scan': A LIN identifier will be picked from minLinIdentifier to maxLinIdentifier.
+
+***
+
+### linIdentifier
+
+> **linIdentifier**: `string`
+
+The LIN identifier.
+
+***
+
+### linIdentifierGeneratorSettingsError?
+
+> `optional` **linIdentifierGeneratorSettingsError**: `MutableRefObject`\<`boolean`\>
+
+The current error state.
+
+***
+
+### maxLinIdentifier
+
+> **maxLinIdentifier**: `string`
+
+The max LIN identifier that will be used if identifierGeneratorType is 'random' or 'scan'.
+
+***
+
+### minLinIdentifier
+
+> **minLinIdentifier**: `string`
+
+The min LIN identifier that will be used if identifierGeneratorType is 'random' or 'scan'.
+
+***
+
+### nodeIdentifier?
+
+> `optional` **nodeIdentifier**: `string`
+
+Identifier of the node that will be used to filter messages in the select dialog.
+Leave undefined if no filtering should be done.
+
+***
+
+### onChange()
+
+> **onChange**: (`newLinIdentifier`, `newIdentifierGeneratorType`, `newMinLinIdentifier`, `newMaxLinIdentifier`) => `void`
+
+Callback that will be called when the LIN identifier(s) has changed.
+
+#### Parameters
+
+##### newLinIdentifier
+
+`string`
+
+The new constant LIN identifier.
+
+##### newIdentifierGeneratorType
+
+[`linIdentifierGeneratorType`](../type-aliases/linIdentifierGeneratorType.md)
+
+The new generator type.
+
+##### newMinLinIdentifier
+
+`string`
+
+The new min LIN identifier.
+
+##### newMaxLinIdentifier
+
+`string`
+
+The new max LIN identifier.
+
+#### Returns
+
+`void`
+
+***
+
+### onErrorsChange()?
+
+> `optional` **onErrorsChange**: (`errors`) => `void`
+
+Callback that will be called when the errors state has changed.
+
+#### Parameters
+
+##### errors
+
+`boolean`
+
+The new errors state.
+
+#### Returns
+
+`void`
+
+***
+
+### parentDialogTitle?
+
+> `optional` **parentDialogTitle**: `string`
+
+Name of a parent dialog, if any, that is used as the parent for the select message dialog.
+Leave undefined if there is no parent dialog.
+
+***
+
+### showSignalValuesTable()
+
+> **showSignalValuesTable**: (`value`) => `void`
+
+Callback for specifying if the signal values table should be visible.
+
+#### Parameters
+
+##### value
+
+`boolean`
+
+#### Returns
+
+`void`

package/doc_md/controls/interfaces/LinIdentifierGeneratorSettingsControlProps.md

@@ -0,0 +1,153 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / LinIdentifierGeneratorSettingsControlProps
+
+# Interface: LinIdentifierGeneratorSettingsControlProps
+
+Properties of the LinIdentifierGeneratorSettingsControl React component.
+
+## Properties
+
+### collapsed?
+
+> `optional` **collapsed**: `boolean`
+
+Current collapse state of the SectionControl.
+
+***
+
+### collapsedChange()?
+
+> `optional` **collapsedChange**: (`value`) => `void`
+
+Callback that will be called when collapse state has changed.
+
+#### Parameters
+
+##### value
+
+`boolean`
+
+The new collapse state.
+
+#### Returns
+
+`void`
+
+***
+
+### collapsible?
+
+> `optional` **collapsible**: `boolean`
+
+Set to true if the SectionControl should be collapsible.
+
+***
+
+### disabled?
+
+> `optional` **disabled**: `boolean`
+
+Set to true to disable this control.
+
+***
+
+### fullScreen?
+
+> `optional` **fullScreen**: `boolean`
+
+Set to true if the select message dialog should be a full screen dialog.
+
+***
+
+### linIdentifierGeneratorSettingsError?
+
+> `optional` **linIdentifierGeneratorSettingsError**: `MutableRefObject`\<`boolean`\>
+
+The current error state.
+
+***
+
+### nodeIdentifier?
+
+> `optional` **nodeIdentifier**: `string`
+
+Identifier of the node that will be used to filter messages in the select dialog.
+Leave undefined if no filtering should be done.
+
+***
+
+### onErrorsChange()?
+
+> `optional` **onErrorsChange**: (`errors`) => `void`
+
+Callback that will be called when the errors state has changed.
+
+#### Parameters
+
+##### errors
+
+`boolean`
+
+The new errors state.
+
+#### Returns
+
+`void`
+
+***
+
+### onSettingsChange()
+
+> **onSettingsChange**: (`value`) => `void`
+
+Callback that will be called when the settings are updated after the LIN identifiers have changed.
+
+#### Parameters
+
+##### value
+
+[`PeriodicTransmissionSettings`](../../models/interfaces/PeriodicTransmissionSettings.md)
+
+The new settings object.
+
+#### Returns
+
+`void`
+
+***
+
+### parentDialogTitle?
+
+> `optional` **parentDialogTitle**: `string`
+
+Name of a parent dialog, if any, that is used as the parent for the select message dialog.
+Leave undefined if there is no parent dialog.
+
+***
+
+### settings
+
+> **settings**: [`PeriodicTransmissionSettings`](../../models/interfaces/PeriodicTransmissionSettings.md)
+
+The settings object that holds the LIN identifier(s) generator settings.
+
+***
+
+### showSignalValuesTable()
+
+> **showSignalValuesTable**: (`value`) => `void`
+
+Callback for specifying if the signal values table should be visible.
+
+#### Parameters
+
+##### value
+
+`boolean`
+
+#### Returns
+
+`void`

package/doc_md/controls/interfaces/NumberRangeControlProps.md

@@ -0,0 +1,253 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / NumberRangeControlProps
+
+# Interface: NumberRangeControlProps
+
+Properties of the NumberRangeControl React component.
+
+## Properties
+
+### lowerLimit?
+
+> `optional` **lowerLimit**: `number`
+
+Lower value limit.
+
+***
+
+### maxDisabled?
+
+> `optional` **maxDisabled**: `boolean`
+
+Set to true to disable the max value field.
+
+***
+
+### maxError?
+
+> `optional` **maxError**: `boolean`
+
+The current max error state.
+
+***
+
+### maxValue
+
+> **maxValue**: `string`
+
+The max value.
+
+***
+
+### minDisabled?
+
+> `optional` **minDisabled**: `boolean`
+
+Set to true to disable the min value field.
+
+***
+
+### minError?
+
+> `optional` **minError**: `boolean`
+
+The current min error state.
+
+***
+
+### minValue
+
+> **minValue**: `string`
+
+The min value.
+
+***
+
+### onBlur()?
+
+> `optional` **onBlur**: (`newMinValue`, `newMaxValue`) => `void`
+
+Callback that is called on a blur event.
+
+#### Parameters
+
+##### newMinValue
+
+`string`
+
+The new min value.
+
+##### newMaxValue
+
+`string`
+
+The new max value.
+
+#### Returns
+
+`void`
+
+***
+
+### onChange()?
+
+> `optional` **onChange**: (`newMinValue`, `newMaxValue`) => `void`
+
+Callback that is called on a change event.
+
+#### Parameters
+
+##### newMinValue
+
+`string`
+
+The new min value.
+
+##### newMaxValue
+
+`string`
+
+The new max value.
+
+#### Returns
+
+`void`
+
+***
+
+### onMaxErrorChange()?
+
+> `optional` **onMaxErrorChange**: (`errors`) => `void`
+
+Callback that is called when the max errors state has changed.
+
+#### Parameters
+
+##### errors
+
+`boolean`
+
+The new max errors state.
+
+#### Returns
+
+`void`
+
+***
+
+### onMaxValidate()?
+
+> `optional` **onMaxValidate**: (`value`, `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 value and return
+the modified value in the val property of the returned object.
+
+#### Parameters
+
+##### value
+
+`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 text value (val) and an error state (err).
+
+##### err
+
+> **err**: `boolean`
+
+##### val
+
+> **val**: `string`
+
+***
+
+### onMinErrorChange()?
+
+> `optional` **onMinErrorChange**: (`errors`) => `void`
+
+Callback that is called when the min errors state has changed.
+
+#### Parameters
+
+##### errors
+
+`boolean`
+
+The new min errors state.
+
+#### Returns
+
+`void`
+
+***
+
+### onMinValidate()?
+
+> `optional` **onMinValidate**: (`value`, `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 value and return
+the modified value in the val property of the returned object.
+
+#### Parameters
+
+##### value
+
+`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 text value (val) and an error state (err).
+
+##### err
+
+> **err**: `boolean`
+
+##### val
+
+> **val**: `string`
+
+***
+
+### unit?
+
+> `optional` **unit**: `string`
+
+A unit text that will be displayed next to the values.
+
+***
+
+### upperLimit?
+
+> `optional` **upperLimit**: `number`
+
+Upper value limit.

package/doc_md/controls/interfaces/RadioControlProps.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) / RadioControlProps
+
+# Interface: RadioControlProps
+
+Properties of the RadioControl React component.
+
+## Properties
+
+### disabled?
+
+> `optional` **disabled**: `boolean`
+
+Set to true to disable this control.
+
+***
+
+### id?
+
+> `optional` **id**: `string`
+
+The component id.
+
+***
+
+### label
+
+> **label**: `string`
+
+The label to be displayed next to the radio button.
+
+***
+
+### size?
+
+> `optional` **size**: `"small"` \| `"medium"`
+
+The component size.
+
+***
+
+### sx?
+
+> `optional` **sx**: `SxProps`\<`Theme`\>
+
+Optional sx properties.
+
+***
+
+### value
+
+> **value**: `string`
+
+The value that this radio button represents.

package/doc_md/controls/interfaces/RadioGroupControlProps.md

@@ -0,0 +1,45 @@
+[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / RadioGroupControlProps
+
+# Interface: RadioGroupControlProps
+
+Properties of the RadioGroupControl React component.
+
+## Properties
+
+### id?
+
+> `optional` **id**: `string`
+
+The component id.
+
+***
+
+### onChange()
+
+> **onChange**: (`value`) => `void`
+
+Callback that is called when a new radio button has been selected.
+
+#### Parameters
+
+##### value
+
+`string`
+
+The new value.
+
+#### Returns
+
+`void`
+
+***
+
+### value
+
+> **value**: `string`
+
+Value of the currently selected radio button in this group.