npm - @kvaser/canking-api - Versions diffs - 7.3.0 → 7.4.0 - Mend

@kvaser/canking-api 7.3.0 → 7.4.0

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 (713) hide show

package/doc_md/controls/interfaces/ButtonProps.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***

package/doc_md/controls/interfaces/CanChannelSelectControlProps.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***

package/doc_md/controls/interfaces/CanIdentifierControlProps.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***
@@ -121,7 +121,7 @@ Leave undefined if no filtering should be done.
 ### onCanIdentifierChange()
-> **onCanIdentifierChange**: (`identifier`, `idType`) => `void`
+> **onCanIdentifierChange**: (`identifier`, `idType`, `sourceId`) => `void`
 Callback that will be called when the CAN identifier has changed.
@@ -139,6 +139,12 @@ The new CAN identifier.
 The new CAN identifier type.
+##### sourceId
+`string`
+The source identifier of the selected message. Could be undefined if no (any) source is selected.
 #### Returns
 `void`
@@ -167,7 +173,7 @@ The new errors state.
 ### onSignalChange()?
-> `optional` **onSignalChange**: (`identifier`, `idType`, `signal`) => `void`
+> `optional` **onSignalChange**: (`identifier`, `idType`, `signal`, `sourceId`) => `void`
 Callback that will be called when the settings have changed after selecting a signal.
 If this property is set, then the onCanIdentifierChange callback will not be called.
@@ -192,6 +198,12 @@ The new CAN identifier type.
 The new signal or undefined if no signal is selected.
+##### sourceId
+`string`
+The source identifier of the selected signal. Could be undefined if no (any) source is selected.
 #### Returns
 `void`
@@ -207,8 +219,33 @@ Leave undefined if there is no parent dialog.
 ***
+### selectedSourceId?
+> `optional` **selectedSourceId**: `string`
+The source identifier of the selected message or signal.
+***
 ### showSelectSignalButton?
 > `optional` **showSelectSignalButton**: `boolean`
 Set to true if the select signal button should be visible. If set to true, then the select message button will be hidden.
+***
+### showSource?
+> `optional` **showSource**: `boolean`
+Set to true if the source field should be shown. Default is false.
+***
+### sourceIdFilter?
+> `optional` **sourceIdFilter**: `string`
+The source identifier that will be used to filter messages in the select dialog.
+Leave undefined if no filtering should be done.

package/doc_md/controls/interfaces/CanIdentifierFrameControlProps.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***
@@ -141,3 +141,12 @@ The new frame object.
 Name of a parent dialog, if any, that is used as the parent for the select message and select signal dialogs.
 Leave undefined if there is no parent dialog.
+***
+### sourceIdFilter?
+> `optional` **sourceIdFilter**: `string`
+The source identifier that will be used to filter messages in the select dialog.
+Leave undefined if no filtering should be done.

package/doc_md/controls/interfaces/CanIdentifierGeneratorControlProps.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***
@@ -208,3 +208,12 @@ Callback for specifying if the signal values table should be visible.
 #### Returns
 `void`
+***
+### sourceIdFilter?
+> `optional` **sourceIdFilter**: `string`
+The source identifier that will be used to filter messages in the select dialog.
+Leave undefined if no filtering should be done.

package/doc_md/controls/interfaces/CanIdentifierGeneratorSettingsControlProps.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***
@@ -151,3 +151,12 @@ Callback for specifying if the signal values table should be visible.
 #### Returns
 `void`
+***
+### sourceIdFilter?
+> `optional` **sourceIdFilter**: `string`
+The source identifier that will be used to filter messages in the select dialog.
+Leave undefined if no filtering should be done.

package/doc_md/controls/interfaces/CheckboxControlProps.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***
@@ -26,6 +26,14 @@ Set to true to disable this control.
 ***
+### disableTypography?
+> `optional` **disableTypography**: `boolean`
+If `true`, the label is rendered as it is passed without an additional typography node.
+***
 ### id?
 > `optional` **id**: `string`
@@ -75,3 +83,12 @@ The optional size, defaults to 'small'.
 > `optional` **sx**: `SxProps`\<`Theme`\>
 Optional sx props.
+***
+### typography?
+> `optional` **typography**: `TypographyProps`
+Props applied to the Typography wrapper of the passed label.
+This is unused if disableTypography is true.

package/doc_md/controls/interfaces/ContextMenuProps.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***

package/doc_md/controls/interfaces/DropdownButtonChildrenProps.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***

package/doc_md/controls/interfaces/DropdownButtonProps.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***

package/doc_md/controls/interfaces/DropdownButtonTextItemsProps.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***

package/doc_md/controls/interfaces/DropdownPanelProps.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***

package/doc_md/controls/interfaces/FormControlRowProps.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***

package/doc_md/controls/interfaces/IExtensionWorkspaceViewProps.md ADDED Viewed

@@ -0,0 +1,9 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+***
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / IExtensionWorkspaceViewProps
+# Interface: IExtensionWorkspaceViewProps
+Properties for an extension WorkspaceView component.

package/doc_md/controls/interfaces/ILocalizedStrings.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***

package/doc_md/controls/interfaces/IMessageDatabase.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***

package/doc_md/controls/interfaces/InlineEditorProps.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***

package/doc_md/controls/interfaces/LabelProps.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***

package/doc_md/controls/interfaces/LinChannelSelectControlProps.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***

package/doc_md/controls/interfaces/LinIdentifierControlProps.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***
@@ -192,3 +192,12 @@ Leave undefined if there is no parent dialog.
 > `optional` **showSelectSignalButton**: `boolean`
 Set to true if the select signal button should be visible. If set to true, then the select message button will be hidden.
+***
+### sourceIdFilter?
+> `optional` **sourceIdFilter**: `string`
+The source identifier that will be used to filter messages in the select dialog.
+Leave undefined if no filtering should be done.

package/doc_md/controls/interfaces/LinIdentifierFrameControlProps.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***
@@ -141,3 +141,12 @@ The new frame object.
 Name of a parent dialog, if any, that is used as the parent for the select message and select signal dialogs.
 Leave undefined if there is no parent dialog.
+***
+### sourceIdFilter?
+> `optional` **sourceIdFilter**: `string`
+The source identifier that will be used to filter messages in the select dialog.
+Leave undefined if no filtering should be done.

package/doc_md/controls/interfaces/LinIdentifierGeneratorControlProps.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***
@@ -196,3 +196,12 @@ Callback for specifying if the signal values table should be visible.
 #### Returns
 `void`
+***
+### sourceIdFilter?
+> `optional` **sourceIdFilter**: `string`
+The source identifier that will be used to filter messages in the select dialog.
+Leave undefined if no filtering should be done.

package/doc_md/controls/interfaces/LinIdentifierGeneratorSettingsControlProps.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***
@@ -151,3 +151,12 @@ Callback for specifying if the signal values table should be visible.
 #### Returns
 `void`
+***
+### sourceIdFilter?
+> `optional` **sourceIdFilter**: `string`
+The source identifier that will be used to filter messages in the select dialog.
+Leave undefined if no filtering should be done.

package/doc_md/controls/interfaces/NumberRangeControlProps.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***

package/doc_md/controls/interfaces/RadioControlProps.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***

package/doc_md/controls/interfaces/RadioGroupControlProps.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***

package/doc_md/controls/interfaces/SectionControlProps.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***

package/doc_md/controls/interfaces/SelectControlProps.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***

package/doc_md/controls/interfaces/SelectMessageDialogProps.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 ***
@@ -7,3 +7,80 @@
 # Interface: SelectMessageDialogProps
 Properties of the SelectMessageDialog React component.
+## Properties
+### modal?
+> `optional` **modal**: `boolean`
+Whether the dialog should be modal or not. Default is false.
+***
+### nodeIdentifier?
+> `optional` **nodeIdentifier**: `string`
+Optional node identifier to limit the databases to those available on the specified node.
+If not specified, all databases available in the system will be shown.
+***
+### onClose()
+> **onClose**: () => `void`
+Callback that is called when the dialog is closed.
+#### Returns
+`void`
+***
+### onSelect()
+> **onSelect**: (`message`, `sourceId`) => `void`
+Callback that is called when a message is selected.
+The selected message and source identifier are passed as parameters.
+#### Parameters
+##### message
+[`FrameDefinition`](../../models/interfaces/FrameDefinition.md)
+##### sourceId
+`string`
+#### Returns
+`void`
+***
+### open
+> **open**: `boolean`
+If true, the dialog is open.
+***
+### parentDialogTitle?
+> `optional` **parentDialogTitle**: `string`
+Optional title of the parent dialog to be shown in the title bar as a breadcrumb.
+***
+### sourceIdFilter?
+> `optional` **sourceIdFilter**: `string`
+The source identifier that will be used to filter messages in the select dialog.
+Leave undefined if no filtering should be done.