@kvaser/canking-api 7.2.1 → 7.4.0

package/doc_md/hooks/functions/useProjectData.md

@@ -0,0 +1,59 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useProjectData
+
+# Function: useProjectData()
+
+> **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
+
+### T
+
+`T`
+
+## Parameters
+
+### id
+
+`number`
+
+The unique id of the view. This is passed to the view component as the `id` prop.
+
+### defaultValue
+
+The default value or a function that returns the default value.
+
+`T` | () => `T`
+
+## Returns
+
+`object`
+
+An object with a flag indicating if the project data has been initialized, the current project data and a setter callback.
+
+### projectData
+
+> **projectData**: `T`
+
+### projectDataIsInitialized
+
+> **projectDataIsInitialized**: `boolean`
+
+### 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

@@ -0,0 +1,15 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useRecentProjectFiles
+
+# Function: useRecentProjectFiles()
+
+> **useRecentProjectFiles**(): `string`[]
+
+Hook keeping track of recent project files.
+
+## Returns
+
+`string`[]

package/doc_md/hooks/functions/useRunningPeriodicTransmissions.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) / useRunningPeriodicTransmissions
+
+# Function: useRunningPeriodicTransmissions()
+
+> **useRunningPeriodicTransmissions**(): `string`[]
+
+A hook for running periodic transmissions.
+
+## Returns
+
+`string`[]
+
+The running periodic transmissions.

package/doc_md/hooks/functions/useScrollModeMeasurementData.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) / useScrollModeMeasurementData
+
+# Function: useScrollModeMeasurementData()
+
+> **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
+
+### startUs?
+
+`number`
+
+Optional start time (in microseconds) to read from the scroll 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/useSessionData.md

@@ -0,0 +1,67 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useSessionData
+
+# Function: useSessionData()
+
+> **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
+
+### 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.
+
+### 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
+
+`object`
+
+An object with a flag indicating if the session data has been initialized, the current session data and a setter callback.
+
+### sessionData
+
+> **sessionData**: `T`
+
+### sessionDataIsInitialized
+
+> **sessionDataIsInitialized**: `boolean`
+
+### 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

@@ -0,0 +1,42 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useSignalData
+
+# Function: useSignalData()
+
+> **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
+
+### 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 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. 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

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useSignalLogFileFormats
+
+# Function: useSignalLogFileFormats()
+
+> **useSignalLogFileFormats**(): `LogFileFormatInfo`[]
+
+Hook keeping track of signal log file formats.
+
+## Returns
+
+`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.

package/doc_md/hooks/functions/useUndoSessionDataSlice.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) / useUndoSessionDataSlice
+
+# Function: useUndoSessionDataSlice()
+
+> **useUndoSessionDataSlice**\<`T`\>(`id`, `slice`, `initialState?`): \[[`IUndoObject`](../interfaces/IUndoObject.md)\<`T`\>, `boolean`\]
+
+Custom hook to manage undo/redo state using session data storage.
+
+## Type Parameters
+
+### T
+
+`T`
+
+The type of the state being managed, must be serializable to JSON.
+
+## 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.
+
+### initialState?
+
+[`IUndoState`](../interfaces/IUndoState.md)\<`T`\>
+
+The initial undo state. Will be used if there is no existing session data.
+
+## Returns
+
+\[[`IUndoObject`](../interfaces/IUndoObject.md)\<`T`\>, `boolean`\]
+
+[undoObject, loaded] - An undo object for managing state history and loaded flag.
+
+## Remarks
+
+This hook triggers component re-renders whenever the state changes.
+This is useful for persisting undo/redo state across sessions.

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

package/doc_md/hooks/functions/useWorkspacePaneWithId.md

@@ -0,0 +1,21 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / useWorkspacePaneWithId
+
+# Function: useWorkspacePaneWithId()
+
+> **useWorkspacePaneWithId**(`id`): [`IWorkspacePaneData`](../../models/interfaces/IWorkspacePaneData.md)
+
+Hook to get/set a workspace pane by id.
+
+## Parameters
+
+### id
+
+`number`
+
+## Returns
+
+[`IWorkspacePaneData`](../../models/interfaces/IWorkspacePaneData.md)

package/doc_md/hooks/interfaces/IEnvelopeView.md

@@ -0,0 +1,49 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / IEnvelopeView
+
+# Interface: IEnvelopeView
+
+Interface for envelope view parameters.
+
+## Properties
+
+### endTimeUs?
+
+> `optional` **endTimeUs**: `number`
+
+The end time of the view in microseconds.
+
+***
+
+### forceUpdateCounter?
+
+> `optional` **forceUpdateCounter**: `number`
+
+Optional counter to force update the envelopes. Change it to trigger a refresh even if other parameters have not changed.
+
+***
+
+### startTimeUs?
+
+> `optional` **startTimeUs**: `number`
+
+The start time of the view in microseconds.
+
+***
+
+### width?
+
+> `optional` **width**: `number`
+
+The width of the view in pixels.
+
+***
+
+### windowUs?
+
+> `optional` **windowUs**: `number`
+
+The time window of the view in microseconds. If start and end is not set then this defines the window.