@kvaser/canking-api 7.3.0 → 7.4.0

package/doc_md/hooks/functions/useLanguage.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/useLocalizedStrings.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/useLogMessages.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/useMaxDataBytes.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/useMeasurementSetup.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/useMeasurementStatus.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/useMessageData.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,20 +6,37 @@
 
 # Function: useMessageData()
 
-> **useMessageData**(`identifiers`): [`Frame`](../../models/interfaces/Frame.md)[]
+> **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 identifier to get data for. To avoid unnecessary re-renders, make sure to memoize this object.
+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 identifier.
+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

@@ -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,7 +6,7 @@
 
 # Function: useMessageLogFileFormats()
 
-> **useMessageLogFileFormats**(`read_support`): [`ILogFileFormat`](../../models/interfaces/ILogFileFormat.md)[]
+> **useMessageLogFileFormats**(`read_support`): `LogFileFormatInfo`[]
 
 Hook keeping track of message log file formats.
 
@@ -20,4 +20,6 @@ Optional flag to indicate if read support is required.
 
 ## Returns
 
-[`ILogFileFormat`](../../models/interfaces/ILogFileFormat.md)[]
+`LogFileFormatInfo`[]
+
+The message log file formats.

package/doc_md/hooks/functions/useNewMeasurementData.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/useNodeStatus.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/useNumericRadix.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/useOnlineStatus.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/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

@@ -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/useProjectData.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,9 +6,10 @@
 
 # Function: useProjectData()
 
-> **useProjectData**\<`T`\>(`id`, `defaultValue?`): `object`
+> **useProjectData**\<`T`\>(`id`, `defaultValue`): `object`
 
 A hook for data that should be saved to the current project.
+The state is automatically saved to and restored from the main process.
 
 ## Type Parameters
 
@@ -22,13 +23,13 @@ A hook for data that should be saved to the current project.
 
 `number`
 
-The unique id of the view.
+The unique id of the view. This is passed to the view component as the `id` prop.
 
-### defaultValue?
+### defaultValue
 
-`T`
+The default value or a function that returns the default value.
 
-The default value or a callback to set default value.
+`T` | () => `T`
 
 ## Returns
 
@@ -47,3 +48,12 @@ An object with a flag indicating if the project data has been initialized, the c
 ### setProjectData
 
 > **setProjectData**: `Dispatch`\<`SetStateAction`\<`T`\>\>
+
+## Remarks
+
+It's only possible to use this hook once per workspace view component tree.
+Use this hook if your view component only needs to store a small amount of project data.
+For larger amounts of data, consider using `useProjectDataSlice` instead, which allows
+splitting the project data into multiple named slices.
+Using multiple slices can improve performance and reduce memory usage and it also allows
+different parts of the component tree to independently load and save their project data.

package/doc_md/hooks/functions/useProjectDataSlice.md

@@ -0,0 +1,58 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useProjectDataSlice
+
+# Function: useProjectDataSlice()
+
+> **useProjectDataSlice**\<`T`\>(`id`, `slice`, `defaultValue`, `loadedCallback?`): \[`T`, `Dispatch`\<`SetStateAction`\<`T`\>\>, `boolean`\]
+
+A hook for data that should be saved to the current project.
+The state is automatically saved to and restored from the main process.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### id
+
+`number`
+
+The unique id of the view. This is passed to the view component as the `id` prop.
+
+### slice
+
+`string`
+
+The slice name for the project data.
+
+### defaultValue
+
+The default value or a function that returns the default value.
+
+`T` | () => `T`
+
+### loadedCallback?
+
+(`value`) => `void`
+
+Optional callback invoked once after data is loaded.
+
+## Returns
+
+\[`T`, `Dispatch`\<`SetStateAction`\<`T`\>\>, `boolean`\]
+
+An object with a flag indicating if the project data has been initialized, the current project data and a setter callback.
+
+## Remarks
+
+Use this hook to split your workspace view's project data into multiple named slices.
+This can improve performance and reduce memory usage and it also allows
+different parts of the component tree to independently load and save their project data.
+Make sure to use the workspace view component's `id` prop and to use unique slice names
+for each slice within the component tree.

package/doc_md/hooks/functions/useRecentProjectFiles.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/useRunningPeriodicTransmissions.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/useScrollModeMeasurementData.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: useScrollModeMeasurementData()
 
-> **useScrollModeMeasurementData**(`start?`): [`Frame`](../../models/interfaces/Frame.md)[]
+> **useScrollModeMeasurementData**(`startUs?`): [`Frame`](../../models/interfaces/Frame.md)[]
 
 A hook for scroll mode measurement data. Will return the latest measurement data. Will include at most 500 frames.
 
 ## Parameters
 
-### start?
+### startUs?
 
 `number`
 
-Optional start time to read from the scroll data buffer. Any frame with a timestamp less than this will be excluded.
+Optional start time (in microseconds) to read from the scroll data buffer. Any frame with a timestamp less than this will be excluded.
 
 ## Returns
 

package/doc_md/hooks/functions/useSessionData.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,9 +6,10 @@
 
 # Function: useSessionData()
 
-> **useSessionData**\<`T`\>(`id`, `defaultValue?`): `object`
+> **useSessionData**\<`T`\>(`id`, `defaultValue`, `loadedCallback?`): `object`
 
 A hook for data that should be saved to the session data.
+The state is automatically saved to and restored from the main process.
 
 ## Type Parameters
 
@@ -16,19 +17,27 @@ A hook for data that should be saved to the session data.
 
 `T`
 
+The type of the session data. Must be JSON serializable.
+
 ## Parameters
 
 ### id
 
 `number`
 
-The unique id of the view.
+The unique id of the view. This is passed to the view component as the `id` prop.
 
-### defaultValue?
+### defaultValue
 
-`T`
+The default value or a function that returns the default value.
+
+`T` | () => `T`
+
+### loadedCallback?
 
-The default value or a callback to set default value.
+(`value`) => `void`
+
+Optional callback invoked once after data is loaded.
 
 ## Returns
 
@@ -47,3 +56,12 @@ An object with a flag indicating if the session data has been initialized, the c
 ### setSessionData
 
 > **setSessionData**: `Dispatch`\<`SetStateAction`\<`T`\>\>
+
+## Remarks
+
+It's only possible to use this hook once per workspace view component tree.
+Use this hook if your view component only needs to store a small amount of session data.
+For larger amounts of data, consider using `useSessionDataSlice` instead, which allows
+splitting the session data into multiple named slices.
+Using multiple slices can improve performance and reduce memory usage and it also allows
+different parts of the component tree to independently load and save their session data.

package/doc_md/hooks/functions/useSessionDataSlice.md

@@ -0,0 +1,60 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useSessionDataSlice
+
+# Function: useSessionDataSlice()
+
+> **useSessionDataSlice**\<`T`\>(`id`, `slice`, `defaultValue`, `loadedCallback?`): \[`T`, `Dispatch`\<`SetStateAction`\<`T`\>\>, `boolean`\]
+
+A hook for persistent (session) data tied to a specific view slice.
+The state is automatically saved to and restored from the main process.
+
+## Type Parameters
+
+### T
+
+`T`
+
+The type of the session data. Must be JSON serializable.
+
+## Parameters
+
+### id
+
+`number`
+
+The unique id of the view. This is passed to the view component as the `id` prop.
+
+### slice
+
+`string`
+
+The slice name for the session data.
+
+### defaultValue
+
+The default value or a function that returns the default value.
+
+`T` | () => `T`
+
+### loadedCallback?
+
+(`value`) => `void`
+
+Optional callback invoked once after data is loaded.
+
+## Returns
+
+\[`T`, `Dispatch`\<`SetStateAction`\<`T`\>\>, `boolean`\]
+
+[state, setState, loaded] — the current data, setter, and loaded flag.
+
+## Remarks
+
+Use this hook to split your workspace view's session data into multiple named slices.
+This can improve performance and reduce memory usage and it also allows
+different parts of the component tree to independently load and save their session data.
+Make sure to use the workspace view component's `id` prop and to use unique slice names
+for each slice within the component tree.

package/doc_md/hooks/functions/useSignalData.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,20 +6,37 @@
 
 # Function: useSignalData()
 
-> **useSignalData**(`qualifiedSignalNames`): [`ISignalData`](../interfaces/ISignalData.md)[]
+> **useSignalData**(`id`, `subscriptionName`, `subscribedSignals`): [`ISignalData`](../interfaces/ISignalData.md)[]
 
 A hook for extracting signal data from the measurement context. Will return the latest measurement data for the specified signal names.
 
 ## Parameters
 
-### qualifiedSignalNames
+### id
 
-`string`[]
+`number`
 
-The qualified names of the signals to extract data for. To avoid unnecessary re-renders, make sure to memoize this object.
+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.
+
+### subscribedSignals
+
+`object`[]
+
+The signals to extract data for, including optional source identifiers. To avoid unnecessary re-renders, make sure to memoize this object.
 
 ## Returns
 
 [`ISignalData`](../interfaces/ISignalData.md)[]
 
-The extracted signal data.
+The extracted signal data. 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 frame keys and historical data are ready)
+and merges it with historical data once available. This ensures no data is lost during the startup phase.

package/doc_md/hooks/functions/useSignalDataEnvelopes.md

@@ -0,0 +1,50 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useSignalDataEnvelopes
+
+# Function: useSignalDataEnvelopes()
+
+> **useSignalDataEnvelopes**(`id`, `subscriptionName`, `subscribedSignals`, `view`): [`ISignalDataEnvelope`](../interfaces/ISignalDataEnvelope.md)[]
+
+A hook for extracting signal data envelopes to be used for graphical visualization.
+The envelopes contain min/max values for signals over time ranges, suitable for plotting.
+
+## 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.
+
+### subscribedSignals
+
+`object`[]
+
+The subscribed signals with their qualified names and optional source identifiers. To avoid unnecessary re-renders, make sure to memoize this object.
+
+### view
+
+[`IEnvelopeView`](../interfaces/IEnvelopeView.md)
+
+Optional view parameters to define the time range and width for the envelopes. If startTime and endTime are set then the envelopes
+will be fetched from history/cached data, otherwise only new/live envelope data will be provided.
+
+## Returns
+
+[`ISignalDataEnvelope`](../interfaces/ISignalDataEnvelope.md)[]
+
+The extracted signal data. If an empty array is returned, then all previously received data is invalid and should be discarded.
+
+## Remarks
+
+This hook subscribes to live envelope data when no view time range is provided.
+If a view with startTime and endTime is given, it fetches envelopes from historical/cached data instead.

package/doc_md/hooks/functions/useSignalLogFileFormats.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,10 +6,12 @@
 
 # Function: useSignalLogFileFormats()
 
-> **useSignalLogFileFormats**(): [`ILogFileFormat`](../../models/interfaces/ILogFileFormat.md)[]
+> **useSignalLogFileFormats**(): `LogFileFormatInfo`[]
 
 Hook keeping track of signal log file formats.
 
 ## Returns
 
-[`ILogFileFormat`](../../models/interfaces/ILogFileFormat.md)[]
+`LogFileFormatInfo`[]
+
+The signal log file formats.

package/doc_md/hooks/functions/useUndo.md

@@ -0,0 +1,38 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useUndo
+
+# Function: useUndo()
+
+> **useUndo**\<`T`\>(`initialState?`): [`IUndoObject`](../interfaces/IUndoObject.md)\<`T`\>
+
+Custom hook to manage undo/redo state with automatic re-renders.
+
+## Type Parameters
+
+### T
+
+`T`
+
+The type of the state being managed.
+
+## Parameters
+
+### initialState?
+
+[`IUndoState`](../interfaces/IUndoState.md)\<`T`\>
+
+The initial undo state.
+
+## Returns
+
+[`IUndoObject`](../interfaces/IUndoObject.md)\<`T`\>
+
+An undo object for managing state history with automatic re-renders.
+
+## Remarks
+
+This hook triggers component re-renders whenever the state changes.
+If you don't need re-renders, use useUndoRef instead for better performance.

package/doc_md/hooks/functions/useUndoRef.md

@@ -0,0 +1,38 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useUndoRef
+
+# Function: useUndoRef()
+
+> **useUndoRef**\<`T`\>(`initialState?`): [`IUndoObject`](../interfaces/IUndoObject.md)\<`T`\>
+
+Custom hook to manage undo/redo state using a ref (does not trigger re-renders by default).
+
+## Type Parameters
+
+### T
+
+`T`
+
+The type of the undo/redo data.
+
+## Parameters
+
+### initialState?
+
+[`IUndoState`](../interfaces/IUndoState.md)\<`T`\>
+
+The initial undo state.
+
+## Returns
+
+[`IUndoObject`](../interfaces/IUndoObject.md)\<`T`\>
+
+An undo object for managing state history.
+
+## Remarks
+
+This hook uses useRef and does not automatically trigger component re-renders.
+Use the subscribe method if you need to trigger re-renders on state changes, or use useUndo instead.