@kvaser/canking-api 7.3.0 → 7.4.0

package/doc_md/controls/interfaces/SelectSignalDialogProps.md

@@ -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,226 @@
 # Interface: SelectSignalDialogProps
 
 Properties of the SelectSignalDialog React component.
+
+## Properties
+
+### checkboxSelection?
+
+> `optional` **checkboxSelection**: `boolean`
+
+If true, checkboxes are shown for multi selection.
+Only used if multiSelect is true.
+Default is false.
+
+***
+
+### modal?
+
+> `optional` **modal**: `boolean`
+
+If true, the dialog is shown as a modal dialog.
+If false, the dialog is shown as a full screen dialog.
+Default is false.
+
+***
+
+### multiSelect?
+
+> `optional` **multiSelect**: `boolean`
+
+If true, multiple signals can be selected.
+If false, only a single signal can be selected.
+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 function that is called when the dialog should be closed.
+Set the open property to false to close the dialog.
+
+#### Returns
+
+`void`
+
+***
+
+### ~~onMultiSelect()?~~
+
+> `optional` **onMultiSelect**: (`messages`, `signals`) => `void`
+
+Callback function that is called when signals are selected and the Save button is clicked.
+Only used if multiSelect is true.
+The function receives the selected messages and signals as parameters.
+If not specified, nothing happens when the Save button is clicked.
+After calling the onMultiSelect callback, the onClose callback is called.
+
+#### Parameters
+
+##### messages
+
+[`FrameDefinition`](../../models/interfaces/FrameDefinition.md)[]
+
+##### signals
+
+[`SignalDefinition`](../../models/interfaces/SignalDefinition.md)[]
+
+#### Returns
+
+`void`
+
+#### Deprecated
+
+Use onMultiSelectSignalInfos instead.
+
+***
+
+### onMultiSelectSignalInfos()?
+
+> `optional` **onMultiSelectSignalInfos**: (`args`) => `void`
+
+Callback function that is called when multiple signals are selected and the Save button is clicked.
+Only used if multiSelect is true.
+The function receives an array of selected signal informations as parameter.
+If not specified, nothing happens when the Save button is clicked.
+After calling the onMultiSelectSignalInfos callback, the onClose callback is called.
+
+#### Parameters
+
+##### args
+
+[`SelectedSignalInfoChangeArgs`](SelectedSignalInfoChangeArgs.md)[]
+
+#### Returns
+
+`void`
+
+***
+
+### ~~onSelect()?~~
+
+> `optional` **onSelect**: (`message`, `signal`) => `void`
+
+Callback function that is called when a signal is selected.
+Only used if multiSelect is false.
+The function receives the selected message and signal as parameters.
+If not specified, nothing happens when a signal is selected.
+After calling the onSelect callback, the onClose callback is called.
+
+#### Parameters
+
+##### message
+
+[`FrameDefinition`](../../models/interfaces/FrameDefinition.md)
+
+##### signal
+
+[`SignalDefinition`](../../models/interfaces/SignalDefinition.md)
+
+#### Returns
+
+`void`
+
+#### Deprecated
+
+Use onSelectSignalInfo instead.
+
+***
+
+### onSelectSignalInfo()?
+
+> `optional` **onSelectSignalInfo**: (`args`) => `void`
+
+Callback function that is called when a signal is selected.
+The function receives the selected signal information as parameter.
+Only used if multiSelect is false.
+If not specified, nothing happens when a signal is selected.
+After calling the onSelectSignalInfo callback, the onClose callback is called.
+
+#### Parameters
+
+##### args
+
+[`SelectedSignalInfoChangeArgs`](SelectedSignalInfoChangeArgs.md)
+
+#### Returns
+
+`void`
+
+***
+
+### open
+
+> **open**: `boolean`
+
+Whether the dialog is open.
+
+***
+
+### parentDialogTitle?
+
+> `optional` **parentDialogTitle**: `string`
+
+Optional title of the parent dialog to be shown in the title bar as a breadcrumb.
+
+***
+
+### ~~selectedMessages?~~
+
+> `optional` **selectedMessages**: `string`[]
+
+Optional array of initially selected message qualified names.
+Only used if multiSelect is true.
+If not specified, no messages are initially selected.
+If specified, the messages with the specified qualified names will be initially selected.
+Signals of the selected messages will also be selected.
+
+#### Deprecated
+
+Use selectedSignalInfos instead.
+
+***
+
+### selectedSignalInfos?
+
+> `optional` **selectedSignalInfos**: [`SelectedSignalInfo`](SelectedSignalInfo.md)[]
+
+Optional array of initially selected signal informations.
+Only used if multiSelect is true.
+If not specified, no signals are initially selected.
+If specified, the signals with the specified informations will be initially selected.
+
+***
+
+### ~~selectedSignals?~~
+
+> `optional` **selectedSignals**: `string`[]
+
+Optional array of initially selected signal qualified names.
+Only used if multiSelect is true.
+If not specified, no signals are initially selected.
+If specified, the signals with the specified qualified names will be initially selected.
+
+#### Deprecated
+
+Use selectedSignalInfos instead.
+
+***
+
+### 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/SelectSignalsControlProps.md

@@ -0,0 +1,119 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / SelectSignalsControlProps
+
+# Interface: SelectSignalsControlProps
+
+Properties of the SelectSignalsControl component.
+
+## Properties
+
+### disabled?
+
+> `optional` **disabled**: `boolean`
+
+Whether the control is disabled.
+
+***
+
+### nodeIdentifier?
+
+> `optional` **nodeIdentifier**: `string`
+
+Node identifier to use when retrieving messages and signals.
+
+***
+
+### onErrorsChange()?
+
+> `optional` **onErrorsChange**: (`errors`) => `void`
+
+Event fired when there are errors in the selection.
+
+#### Parameters
+
+##### errors
+
+`boolean`
+
+#### Returns
+
+`void`
+
+***
+
+### onSelectedSignalInfosChange()?
+
+> `optional` **onSelectedSignalInfosChange**: (`infos`) => `void`
+
+Event fired when selected signal infos change.
+
+#### Parameters
+
+##### infos
+
+[`SelectedSignalInfoChangeArgs`](SelectedSignalInfoChangeArgs.md)[]
+
+#### Returns
+
+`void`
+
+***
+
+### ~~onSelectedSignalsChange()?~~
+
+> `optional` **onSelectedSignalsChange**: (`selectedSignals`) => `void`
+
+Event fired when selected signals change.
+
+#### Parameters
+
+##### selectedSignals
+
+`string`[]
+
+#### Returns
+
+`void`
+
+#### Deprecated
+
+Use onSelectedSignalInfosChange instead.
+
+***
+
+### parentDialogTitle?
+
+> `optional` **parentDialogTitle**: `string`
+
+Title of the parent dialog, if any.
+
+***
+
+### selectedSignalInfos?
+
+> `optional` **selectedSignalInfos**: [`SelectedSignalInfo`](SelectedSignalInfo.md)[]
+
+Currently selected signal infos.
+
+***
+
+### ~~selectedSignals?~~
+
+> `optional` **selectedSignals**: `string`[]
+
+Currently selected signals.
+
+#### Deprecated
+
+Use selectedSignalInfos instead.
+
+***
+
+### signalFilterError?
+
+> `optional` **signalFilterError**: `MutableRefObject`\<`boolean`\>
+
+Ref object that will be updated to indicate if there is an error in the signal filter.

package/doc_md/controls/interfaces/SelectedSignalInfo.md

@@ -0,0 +1,29 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / SelectedSignalInfo
+
+# Interface: SelectedSignalInfo
+
+Information about a selected signal.
+
+## Extended by
+
+- [`SelectedSignalInfoChangeArgs`](SelectedSignalInfoChangeArgs.md)
+
+## Properties
+
+### qualifiedName
+
+> **qualifiedName**: `string`
+
+The qualified name of the selected signal.
+
+***
+
+### sourceId
+
+> **sourceId**: `string`
+
+The source identifier of the selected signal.

package/doc_md/controls/interfaces/SelectedSignalInfoChangeArgs.md

@@ -0,0 +1,46 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [controls](../README.md) / SelectedSignalInfoChangeArgs
+
+# Interface: SelectedSignalInfoChangeArgs
+
+Arguments for the SelectedSignalInfo change event.
+Includes the message definition containing the signal.
+
+## Extends
+
+- [`SelectedSignalInfo`](SelectedSignalInfo.md)
+
+## Properties
+
+### message
+
+> **message**: [`FrameDefinition`](../../models/interfaces/FrameDefinition.md)
+
+The message definition containing the signal.
+
+***
+
+### qualifiedName
+
+> **qualifiedName**: `string`
+
+The qualified name of the selected signal.
+
+#### Inherited from
+
+[`SelectedSignalInfo`](SelectedSignalInfo.md).[`qualifiedName`](SelectedSignalInfo.md#qualifiedname)
+
+***
+
+### sourceId
+
+> **sourceId**: `string`
+
+The source identifier of the selected signal.
+
+#### Inherited from
+
+[`SelectedSignalInfo`](SelectedSignalInfo.md).[`sourceId`](SelectedSignalInfo.md#sourceid)

package/doc_md/controls/interfaces/TableColumn.md

@@ -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/TableControlProps.md

@@ -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/TextControlProps.md

@@ -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/ToggleButtonGroupProps.md

@@ -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/ToggleButtonProps.md

@@ -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/ToolbarControlProps.md

@@ -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/ValidateableTextControlProps.md

@@ -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/toolbarItem.md

@@ -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 @@ A button group.
 
 ***
 
+### items?
+
+> `optional` **items**: `toolbarItem`[]
+
+A nested collection of toolbar items.
+
+***
+
 ### label?
 
 > `optional` **label**: [`LabelProps`](LabelProps.md)

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

@@ -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/type-aliases/SelectOption.md

@@ -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/type-aliases/StringsMap.md

@@ -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/type-aliases/canIdentifierGeneratorType.md

@@ -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/type-aliases/canIdentifierType.md

@@ -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/type-aliases/linIdentifierGeneratorType.md

@@ -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/variables/FillBox.md

@@ -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/variables/OneLineButton.md

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 
 ***
 
@@ -6,6 +6,6 @@
 
 # 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`, \{ \}, \{ \}\>
+> `const` **OneLineButton**: `StyledComponent`\<`ButtonOwnProps` & `Omit`\<`ButtonBaseOwnProps`, `"classes"`\> & `CommonProps` & `Omit`\<`Omit`\<`DetailedHTMLProps`\<`ButtonHTMLAttributes`\<`HTMLButtonElement`\>, `HTMLButtonElement`\>, `"ref"`\> & `object`, `"color"` \| `"className"` \| `"style"` \| `"classes"` \| `"children"` \| `"sx"` \| `"variant"` \| `"tabIndex"` \| `"disabled"` \| `"size"` \| `"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

@@ -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/variables/TabsPanel.md

@@ -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/hooks/README.md

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../README.md)
 
 ***
 
@@ -22,10 +22,20 @@ const userSettings = useUserSettings();
 
 ## Interfaces
 
+- [IEnvelopeView](interfaces/IEnvelopeView.md)
 - [ISignalData](interfaces/ISignalData.md)
+- [ISignalDataEnvelope](interfaces/ISignalDataEnvelope.md)
+- [IUndoObject](interfaces/IUndoObject.md)
+- [IUndoState](interfaces/IUndoState.md)
+
+## Type Aliases
+
+- [OnGoingOfflineCallback](type-aliases/OnGoingOfflineCallback.md)
+- [OnGoingOnlineCallback](type-aliases/OnGoingOnlineCallback.md)
 
 ## Functions
 
+- [useAvailableProtocols](functions/useAvailableProtocols.md)
 - [useDevices](functions/useDevices.md)
 - [useFixedPositionModeMeasurementData](functions/useFixedPositionModeMeasurementData.md)
 - [useIsOnline](functions/useIsOnline.md)
@@ -41,13 +51,20 @@ const userSettings = useUserSettings();
 - [useNodeStatus](functions/useNodeStatus.md)
 - [useNumericRadix](functions/useNumericRadix.md)
 - [useOnlineStatus](functions/useOnlineStatus.md)
+- [useOnlineStatusSync](functions/useOnlineStatusSync.md)
 - [useOverallStatusLevel](functions/useOverallStatusLevel.md)
 - [useProjectData](functions/useProjectData.md)
+- [useProjectDataSlice](functions/useProjectDataSlice.md)
 - [useRecentProjectFiles](functions/useRecentProjectFiles.md)
 - [useRunningPeriodicTransmissions](functions/useRunningPeriodicTransmissions.md)
 - [useScrollModeMeasurementData](functions/useScrollModeMeasurementData.md)
 - [useSessionData](functions/useSessionData.md)
+- [useSessionDataSlice](functions/useSessionDataSlice.md)
 - [useSignalData](functions/useSignalData.md)
+- [useSignalDataEnvelopes](functions/useSignalDataEnvelopes.md)
 - [useSignalLogFileFormats](functions/useSignalLogFileFormats.md)
+- [useUndo](functions/useUndo.md)
+- [useUndoRef](functions/useUndoRef.md)
+- [useUndoSessionDataSlice](functions/useUndoSessionDataSlice.md)
 - [useUserSettings](functions/useUserSettings.md)
 - [useWorkspacePaneWithId](functions/useWorkspacePaneWithId.md)

package/doc_md/hooks/functions/useAvailableProtocols.md

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useAvailableProtocols
+
+# Function: useAvailableProtocols()
+
+> **useAvailableProtocols**(): `string`[]
+
+Hook to get all available protocols from the measurement setup.
+
+## Returns
+
+`string`[]
+
+The available protocols.

package/doc_md/hooks/functions/useDevices.md

@@ -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/hooks/functions/useFixedPositionModeMeasurementData.md

@@ -1,4 +1,4 @@
-[**Kvaser CanKing GUI Extensions SDK v7.3.0**](../../README.md)
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
 
 ***
 
@@ -6,17 +6,17 @@
 
 # Function: useFixedPositionModeMeasurementData()
 
-> **useFixedPositionModeMeasurementData**(`start?`): [`Frame`](../../models/interfaces/Frame.md)[]
+> **useFixedPositionModeMeasurementData**(`startUs?`): [`Frame`](../../models/interfaces/Frame.md)[]
 
 A hook for fixed position mode measurement data. Will return the latest measurement data for each unique frame id and type.
 
 ## Parameters
 
-### start?
+### startUs?
 
 `number`
 
-Optional start time to read from the fixed position data buffer. Any frame with a timestamp less than this will be excluded.
+Optional start time (in microseconds) to read from the fixed position data buffer. Any frame with a timestamp less than this will be excluded.
 
 ## Returns
 

package/doc_md/hooks/functions/useIsOnline.md

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