@kvaser/canking-api 7.2.1 → 7.4.0

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

@@ -0,0 +1,43 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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"` \| `"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

@@ -0,0 +1,12 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.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.4.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,70 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.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
+
+- [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)
+- [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)
+- [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

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.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.

package/doc_md/hooks/functions/useFixedPositionModeMeasurementData.md

@@ -0,0 +1,25 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useFixedPositionModeMeasurementData
+
+# Function: useFixedPositionModeMeasurementData()
+
+> **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
+
+### startUs?
+
+`number`
+
+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
+
+[`Frame`](../../models/interfaces/Frame.md)[]
+
+The measurement data.

package/doc_md/hooks/functions/useIsOnline.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) / useIsOnline
+
+# Function: useIsOnline()
+
+> **useIsOnline**(): `boolean`
+
+Hook keeping track of if the measurement is online.
+
+## Returns
+
+`boolean`
+
+A flag that indicates if a measurement is started.

package/doc_md/hooks/functions/useLanguage.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) / useLanguage
+
+# Function: useLanguage()
+
+> **useLanguage**(): `string`
+
+Hook keeping track of the selected language.
+
+## Returns
+
+`string`
+
+The selected language.

package/doc_md/hooks/functions/useLocalizedStrings.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) / useLocalizedStrings
+
+# Function: useLocalizedStrings()
+
+> **useLocalizedStrings**(): [`ILocalizedStrings`](../../controls/interfaces/ILocalizedStrings.md)
+
+Hook keeping track of localized strings.
+
+## Returns
+
+[`ILocalizedStrings`](../../controls/interfaces/ILocalizedStrings.md)
+
+The localized strings object.

package/doc_md/hooks/functions/useLogMessages.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) / useLogMessages
+
+# Function: useLogMessages()
+
+> **useLogMessages**(): [`LogMessage`](../../models/interfaces/LogMessage.md)[]
+
+A hook for log messages.
+
+## Returns
+
+[`LogMessage`](../../models/interfaces/LogMessage.md)[]
+
+The log messages.

package/doc_md/hooks/functions/useMaxDataBytes.md

@@ -0,0 +1,15 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useMaxDataBytes
+
+# Function: useMaxDataBytes()
+
+> **useMaxDataBytes**(): `number`
+
+Hook keeping track of the selected radix for converting numeric values to strings.
+
+## Returns
+
+`number`

package/doc_md/hooks/functions/useMeasurementSetup.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) / useMeasurementSetup
+
+# Function: useMeasurementSetup()
+
+> **useMeasurementSetup**(): [`MeasurementSetup`](../../models/interfaces/MeasurementSetup.md)
+
+A hook for measurement setup.
+
+## Returns
+
+[`MeasurementSetup`](../../models/interfaces/MeasurementSetup.md)
+
+The measurement setup.

package/doc_md/hooks/functions/useMeasurementStatus.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) / useMeasurementStatus
+
+# Function: useMeasurementStatus()
+
+> **useMeasurementStatus**(): [`NodeStatus`](../../models/interfaces/NodeStatus.md)[]
+
+A hook for measurement status.
+
+## Returns
+
+[`NodeStatus`](../../models/interfaces/NodeStatus.md)[]
+
+The measurement status.

package/doc_md/hooks/functions/useMessageData.md

@@ -0,0 +1,42 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useMessageData
+
+# Function: useMessageData()
+
+> **useMessageData**(`id`, `subscriptionName`, `identifiers`): [`Frame`](../../models/interfaces/Frame.md)[]
+
+A hook for extracting message data from the measurement context. Will return the latest measurement data for the specified identifier.
+
+## Parameters
+
+### id
+
+`number`
+
+The unique id of the view. This is passed to the view component as the `id` prop.
+
+### subscriptionName
+
+`string`
+
+The subscription name for the data. Must be unique per view. To avoid conflicts, use a descriptive name.
+
+### identifiers
+
+[`FixedPosFrameIdentifier`](../../models/interfaces/FixedPosFrameIdentifier.md)[]
+
+The fixed position frame identifiers to get data for. To avoid unnecessary re-renders, make sure to memoize this object.
+
+## Returns
+
+[`Frame`](../../models/interfaces/Frame.md)[]
+
+The measurement data for the specified identifiers. If an empty array is returned, then all previously received data is invalid and should be discarded.
+
+## Remarks
+
+This hook buffers incoming frame data during initialization (before historical data is ready)
+and merges it with historical data once available. This ensures no data is lost during the startup phase.

package/doc_md/hooks/functions/useMessageLogFileFormats.md

@@ -0,0 +1,25 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useMessageLogFileFormats
+
+# Function: useMessageLogFileFormats()
+
+> **useMessageLogFileFormats**(`read_support`): `LogFileFormatInfo`[]
+
+Hook keeping track of message log file formats.
+
+## Parameters
+
+### read\_support
+
+`boolean` = `false`
+
+Optional flag to indicate if read support is required.
+
+## Returns
+
+`LogFileFormatInfo`[]
+
+The message log file formats.

package/doc_md/hooks/functions/useNewMeasurementData.md

@@ -0,0 +1,35 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useNewMeasurementData
+
+# ~~Function: useNewMeasurementData()~~
+
+> **useNewMeasurementData**(`numberOfHistoryFrames?`, `predicate?`): [`Frame`](../../models/interfaces/Frame.md)[]
+
+A hook for new measurement data.
+
+## Parameters
+
+### numberOfHistoryFrames?
+
+`number`
+
+Optional number of history frames to read from data buffer when this hook initializes.
+
+### predicate?
+
+(`frame`) => `boolean`
+
+An optional predicate to filter out which data to return.
+
+## Returns
+
+[`Frame`](../../models/interfaces/Frame.md)[]
+
+The new measurement data.
+
+## Deprecated
+
+Use `useScrollModeMeasurementData`, `useFixedPositionModeMeasurementData`, `useMessageData` or `useSignalData` instead.

package/doc_md/hooks/functions/useNodeStatus.md

@@ -0,0 +1,23 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useNodeStatus
+
+# Function: useNodeStatus()
+
+> **useNodeStatus**(`id`): [`NodeStatus`](../../models/interfaces/NodeStatus.md)
+
+Hook to get status for one node.
+
+## Parameters
+
+### id
+
+`string`
+
+## Returns
+
+[`NodeStatus`](../../models/interfaces/NodeStatus.md)
+
+The node status.

package/doc_md/hooks/functions/useNumericRadix.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) / useNumericRadix
+
+# Function: useNumericRadix()
+
+> **useNumericRadix**(): `number`
+
+Hook keeping track of the selected radix for converting numeric values to strings.
+
+## Returns
+
+`number`
+
+The selected numeric radix.

package/doc_md/hooks/functions/useOnlineStatus.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) / useOnlineStatus
+
+# Function: useOnlineStatus()
+
+> **useOnlineStatus**(): [`OnlineStatus`](../../models/interfaces/OnlineStatus.md)
+
+A hook for online status.
+
+## Returns
+
+[`OnlineStatus`](../../models/interfaces/OnlineStatus.md)
+
+The online status.

package/doc_md/hooks/functions/useOnlineStatusSync.md

@@ -0,0 +1,43 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useOnlineStatusSync
+
+# Function: useOnlineStatusSync()
+
+> **useOnlineStatusSync**(`parentIsInitialized`, `id`, `onGoingOnline`, `onGoingOffline`): `boolean`
+
+Custom hook to synchronize session state with online/offline status changes.
+
+## Parameters
+
+### parentIsInitialized
+
+`boolean`
+
+Whether the parent component is initialized and has loaded all project and session data needed before receiving online updates.
+
+### id
+
+`number`
+
+The unique id of the view. This is passed to the view component as the `id` prop.
+
+### onGoingOnline
+
+[`OnGoingOnlineCallback`](../type-aliases/OnGoingOnlineCallback.md)
+
+Callback function to handle going online. Called when the CanKing starts a measurement or when the view is mounted while online.
+
+### onGoingOffline
+
+[`OnGoingOfflineCallback`](../type-aliases/OnGoingOfflineCallback.md)
+
+Callback function to handle going offline. Called when the CanKing stops a measurement or when the view is mounted while offline.
+
+## Returns
+
+`boolean`
+
+The current online status.

package/doc_md/hooks/functions/useOverallStatusLevel.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) / useOverallStatusLevel
+
+# Function: useOverallStatusLevel()
+
+> **useOverallStatusLevel**(): [`StatusLevel`](../../models/enumerations/StatusLevel.md)
+
+Hook to get the measurement's highest overall status level.
+
+## Returns
+
+[`StatusLevel`](../../models/enumerations/StatusLevel.md)
+
+The measurement's highest overall status.