@kvaser/canking-api 7.3.0 → 7.4.0

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

@@ -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/useWorkspacePaneWithId.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/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.

package/doc_md/hooks/interfaces/ISignalData.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,71 @@
 # Interface: ISignalData
 
 Interface for signal data.
+
+## Properties
+
+### doubleValue
+
+> **doubleValue**: `number`
+
+The double value of the signal.
+
+***
+
+### name
+
+> **name**: `string`
+
+The name of the signal.
+
+***
+
+### qualifiedName
+
+> **qualifiedName**: `string`
+
+The qualified name of the signal.
+
+***
+
+### sourceId?
+
+> `optional` **sourceId**: `string`
+
+The source identifier of the signal.
+
+***
+
+### stringValue?
+
+> `optional` **stringValue**: `string`
+
+Optional string value of the signal.
+
+***
+
+### ~~time~~
+
+> **time**: `number`
+
+The timestamp of the signal data.
+
+#### Deprecated
+
+Use `timeUs` for higher precision timestamps in microseconds. This field is kept for backward compatibility but may be removed in the future.
+
+***
+
+### timeUs
+
+> **timeUs**: `Long`
+
+The timestamp of the signal data in microseconds.
+
+***
+
+### unit
+
+> **unit**: `string`
+
+The unit of the signal.

package/doc_md/hooks/interfaces/ISignalDataEnvelope.md

@@ -0,0 +1,51 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / ISignalDataEnvelope
+
+# Interface: ISignalDataEnvelope
+
+Interface for signal data envelope.
+Each envelope contains arrays of time, min, and max values for a signal.
+All arrays are aligned by index.
+
+## Properties
+
+### max
+
+> **max**: `number`[]
+
+The maximum values of the signal data.
+
+***
+
+### min
+
+> **min**: `number`[]
+
+The minimum values of the signal data.
+
+***
+
+### qualifiedName
+
+> **qualifiedName**: `string`
+
+The qualified name of the signal.
+
+***
+
+### sourceId?
+
+> `optional` **sourceId**: `string`
+
+The source identifier of the signal.
+
+***
+
+### timeUs
+
+> **timeUs**: `number`[]
+
+The timestamps of the signal data in microseconds.

package/doc_md/hooks/interfaces/IUndoObject.md

@@ -0,0 +1,155 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / IUndoObject
+
+# Interface: IUndoObject\<T\>
+
+The undo/redo object. Includes the current state and methods to manipulate it.
+
+## Type Parameters
+
+### T
+
+`T`
+
+The type of the undo/redo data.
+
+## Properties
+
+### canRedo()
+
+> **canRedo**: () => `boolean`
+
+Check if redo is possible
+
+#### Returns
+
+`boolean`
+
+true if there are states to redo to
+
+***
+
+### canUndo()
+
+> **canUndo**: () => `boolean`
+
+Check if undo is possible
+
+#### Returns
+
+`boolean`
+
+true if there are states to undo to
+
+***
+
+### redo()
+
+> **redo**: () => `void`
+
+Redo to the next state
+
+#### Returns
+
+`void`
+
+***
+
+### reset()
+
+> **reset**: (`current?`, `previous?`, `next?`) => `void`
+
+Reset the undo/redo history with a new initial value
+
+#### Parameters
+
+##### current?
+
+`T`
+
+The new initial value. If undefined, current will be unset.
+
+##### previous?
+
+`T`[]
+
+The previous values (optional)
+
+##### next?
+
+`T`[]
+
+The next values (optional)
+
+#### Returns
+
+`void`
+
+***
+
+### set()
+
+> **set**: (`updater`) => `void`
+
+Set a new current state
+
+#### Parameters
+
+##### updater
+
+The new value or a function that receives the current value and returns the new value
+
+`T` | (`curr?`) => `T`
+
+#### Returns
+
+`void`
+
+***
+
+### state
+
+> **state**: [`IUndoState`](IUndoState.md)\<`T`\>
+
+The current undo/redo state
+
+***
+
+### subscribe()?
+
+> `optional` **subscribe**: (`listener`) => () => `void`
+
+Subscribe to state changes (optional, for triggering re-renders)
+
+#### Parameters
+
+##### listener
+
+() => `void`
+
+Callback function that will be called whenever state changes
+
+#### Returns
+
+Unsubscribe function
+
+> (): `void`
+
+##### Returns
+
+`void`
+
+***
+
+### undo()
+
+> **undo**: () => `void`
+
+Undo to the previous state
+
+#### Returns
+
+`void`

package/doc_md/hooks/interfaces/IUndoState.md

@@ -0,0 +1,41 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / IUndoState
+
+# Interface: IUndoState\<T\>
+
+The undo/redo state.
+
+## Type Parameters
+
+### T
+
+`T`
+
+The type of the undo/redo data.
+
+## Properties
+
+### current?
+
+> `optional` **current**: `T`
+
+The current value
+
+***
+
+### next
+
+> **next**: `T`[]
+
+The next values
+
+***
+
+### previous
+
+> **previous**: `T`[]
+
+The previous values

package/doc_md/hooks/type-aliases/OnGoingOfflineCallback.md

@@ -0,0 +1,36 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / OnGoingOfflineCallback
+
+# Type Alias: OnGoingOfflineCallback()
+
+> **OnGoingOfflineCallback** = (`isNewView`, `isMounting`, `onlineCounter`) => `void`
+
+Callback type for when the view goes offline.
+The online counter can be used to determine if CanKing has been online and come back offline while the view was unmounted.
+
+## Parameters
+
+### isNewView
+
+`boolean`
+
+Whether the view is newly created.
+
+### isMounting
+
+`boolean`
+
+Whether the view is mounting.
+
+### onlineCounter
+
+`number`
+
+The number of times CanKing has gone online (including the current one).
+
+## Returns
+
+`void`

package/doc_md/hooks/type-aliases/OnGoingOnlineCallback.md

@@ -0,0 +1,36 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [hooks](../README.md) / OnGoingOnlineCallback
+
+# Type Alias: OnGoingOnlineCallback()
+
+> **OnGoingOnlineCallback** = (`isNewView`, `isMounting`, `onlineCounter`) => `void`
+
+Callback type for when the view goes online.
+The online counter can be used to determine if CanKing has been offline and come back online while the view was unmounted.
+
+## Parameters
+
+### isNewView
+
+`boolean`
+
+Whether the view is newly created.
+
+### isMounting
+
+`boolean`
+
+Whether the view is mounting.
+
+### onlineCounter
+
+`number`
+
+The number of times CanKing has gone online (including the current one).
+
+## Returns
+
+`void`

package/doc_md/ipc/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)
 
 ***
 
@@ -25,8 +25,12 @@ This module includes Inter-Process Communication calls for getting/setting data
 - [disableNode](functions/disableNode.md)
 - [disconnectNodes](functions/disconnectNodes.md)
 - [enableNode](functions/enableNode.md)
+- [getFirstAndLatestTimestamp](functions/getFirstAndLatestTimestamp.md)
+- [getFirstTimestamp](functions/getFirstTimestamp.md)
 - [getFrameDefinitions](functions/getFrameDefinitions.md)
+- [getLatestTimestamp](functions/getLatestTimestamp.md)
 - [getLogger](functions/getLogger.md)
+- [getMessageDataBeforeTimestamp](functions/getMessageDataBeforeTimestamp.md)
 - [getMessageLogFileFormats](functions/getMessageLogFileFormats.md)
 - [getSignalLogFileFormats](functions/getSignalLogFileFormats.md)
 - [requestLinMessage](functions/requestLinMessage.md)

package/doc_md/ipc/functions/addDataProcessor.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/ipc/functions/addSource.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/ipc/functions/addTarget.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/ipc/functions/clearLinMessage.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/ipc/functions/connectNodes.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/ipc/functions/deleteDataProcessor.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/ipc/functions/deleteSource.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/ipc/functions/deleteTarget.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/ipc/functions/disableNode.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/ipc/functions/disconnectNodes.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/ipc/functions/enableNode.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/ipc/functions/getFirstAndLatestTimestamp.md

@@ -0,0 +1,18 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [ipc](../README.md) / getFirstAndLatestTimestamp
+
+# Function: getFirstAndLatestTimestamp()
+
+> **getFirstAndLatestTimestamp**(): `Promise`\<\{ `firstTimestamp`: `number`; `latestTimestamp`: `number`; \}\>
+
+Gets timestamps of the first and latest frames in the current measurement.
+
+## Returns
+
+`Promise`\<\{ `firstTimestamp`: `number`; `latestTimestamp`: `number`; \}\>
+
+A promise that resolves with an object containing the first and latest timestamps
+         (in microseconds since start of measurement).

package/doc_md/ipc/functions/getFirstTimestamp.md

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [ipc](../README.md) / getFirstTimestamp
+
+# Function: getFirstTimestamp()
+
+> **getFirstTimestamp**(): `Promise`\<`number`\>
+
+Gets timestamp of the first frame in the current measurement.
+
+## Returns
+
+`Promise`\<`number`\>
+
+A promise that resolves with the first timestamp (in microseconds since start of measurement).

package/doc_md/ipc/functions/getFrameDefinitions.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/ipc/functions/getLatestTimestamp.md

@@ -0,0 +1,17 @@
+[**Kvaser CanKing GUI Extensions SDK v7.4.0**](../../README.md)
+
+***
+
+[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [ipc](../README.md) / getLatestTimestamp
+
+# Function: getLatestTimestamp()
+
+> **getLatestTimestamp**(): `Promise`\<`number`\>
+
+Gets timestamp of the latest frame in the current measurement.
+
+## Returns
+
+`Promise`\<`number`\>
+
+A promise that resolves with the latest timestamp (in microseconds since start of measurement).

package/doc_md/ipc/functions/getLogger.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)
 
 ***