@kvaser/canking-api 7.3.0 → 7.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/controls/CanIdentifierControl.d.ts +32 -6
- package/dist/controls/CanKingDataProvider.d.ts +14 -19
- package/dist/controls/CheckboxControl.d.ts +11 -2
- package/dist/controls/ColorControl.d.ts +26 -0
- package/dist/controls/ExtensionWorkspaceViewProps.d.ts +8 -0
- package/dist/controls/InlineEditor.d.ts +2 -2
- package/dist/controls/LinIdentifierControl.d.ts +24 -4
- package/dist/controls/SelectMessageDialog.d.ts +32 -3
- package/dist/controls/SelectSignalDialog.d.ts +102 -1
- package/dist/controls/SelectSignalsControl.d.ts +37 -4
- package/dist/controls/SizedBox.d.ts +1 -0
- package/dist/controls/TableControl.d.ts +2 -3
- package/dist/controls/ToolbarControl.d.ts +4 -2
- package/dist/controls/index.d.ts +3 -0
- package/dist/controls.js +1 -1
- package/dist/controls.mjs +2257 -1769
- package/dist/grpc.js +1 -1
- package/dist/grpc.mjs +196 -168
- package/dist/hooks/index.d.ts +388 -27
- package/dist/hooks.js +1 -1
- package/dist/hooks.mjs +48 -30
- package/dist/icons/index.d.ts +36 -0
- package/dist/icons.js +1 -1
- package/dist/icons.mjs +927 -755
- package/dist/index.d.ts +0 -2
- package/dist/index.js +1 -1
- package/dist/index.mjs +1160 -600
- package/dist/ipc/index.d.ts +31 -3
- package/dist/ipc.js +1 -1
- package/dist/ipc.mjs +132 -104
- package/dist/models/Point.d.ts +4 -0
- package/dist/models/deep_equal.d.ts +7 -0
- package/dist/models/index.d.ts +85 -12
- package/dist/models/json_utilities.d.ts +16 -0
- package/dist/models.js +1 -1
- package/dist/models.mjs +762 -289
- package/dist/protos/app_params.d.ts +109 -62
- package/dist/protos/app_service.d.ts +81 -50
- package/dist/protos/common_params.d.ts +4 -1
- package/dist/protos/device_params.d.ts +82 -27
- package/dist/protos/frame_params.d.ts +92 -9
- package/dist/protos/measurement_params.d.ts +229 -47
- package/dist/protos/measurement_service.d.ts +84 -58
- package/dist/protos/measurement_settings.d.ts +156 -6
- package/dist/protos/signal_params.d.ts +20 -0
- package/dist/protos/status_params.d.ts +30 -0
- package/dist/status_params.js +1 -1
- package/dist/status_params.mjs +8709 -1825
- package/doc/assets/hierarchy.js +1 -1
- package/doc/assets/navigation.js +1 -1
- package/doc/assets/search.js +1 -1
- package/doc/enums/models.AccessMode.html +5 -3
- package/doc/enums/models.CanChannelCap.html +2 -2
- package/doc/enums/models.CanConfigMode.html +16 -0
- package/doc/enums/models.CanFrameFlag.html +33 -2
- package/doc/enums/models.CanMessageFilterType.html +4 -2
- package/doc/enums/models.CanMode.html +7 -2
- package/doc/enums/{models.DeviceEvent.html → models.DecimalChar.html} +7 -5
- package/doc/enums/models.FileConflictAction.html +5 -2
- package/doc/enums/models.LinFrameFlag.html +11 -2
- package/doc/enums/models.LogFileFormat.html +4 -2
- package/doc/enums/models.LogLevel.html +2 -2
- package/doc/enums/models.LogReplayState.html +4 -2
- package/doc/enums/models.LoggerState.html +5 -2
- package/doc/enums/models.Separator.html +8 -0
- package/doc/enums/models.SignalEncoding.html +4 -2
- package/doc/enums/models.SignalType.html +2 -2
- package/doc/enums/models.SignalValueTriggerOperator.html +11 -2
- package/doc/enums/models.StatusLevel.html +5 -2
- package/doc/enums/models.TimeReference.html +8 -0
- package/doc/enums/models.TriggerOperator.html +4 -2
- package/doc/functions/controls.CanChannelSelectControl.html +2 -2
- package/doc/functions/controls.CanIdentifierControl.html +2 -2
- package/doc/functions/controls.CanIdentifierFrameControl.html +2 -2
- package/doc/functions/controls.CanIdentifierGeneratorControl.html +2 -2
- package/doc/functions/controls.CanIdentifierGeneratorSettingsControl.html +2 -2
- package/doc/functions/controls.CanKingDataProvider.html +2 -2
- package/doc/functions/controls.CheckboxControl.html +2 -2
- package/doc/functions/controls.ColorControl.html +4 -0
- package/doc/functions/controls.ColumnItemControl.html +2 -2
- package/doc/functions/controls.ContextMenu.html +2 -2
- package/doc/functions/controls.DropdownButton.html +2 -2
- package/doc/functions/controls.DropdownButtonTextItems.html +2 -2
- package/doc/functions/controls.DropdownPanel.html +2 -2
- package/doc/functions/controls.FormControlRow.html +2 -2
- package/doc/functions/controls.InlineEditor.html +2 -2
- package/doc/functions/controls.LinChannelSelectControl.html +2 -2
- package/doc/functions/controls.LinIdentifierControl.html +2 -2
- package/doc/functions/controls.LinIdentifierFrameControl.html +2 -2
- package/doc/functions/controls.LinIdentifierGeneratorControl.html +2 -2
- package/doc/functions/controls.LinIdentifierGeneratorSettingsControl.html +2 -2
- package/doc/functions/controls.NumberRangeControl.html +2 -2
- package/doc/functions/controls.RadioControl.html +2 -2
- package/doc/functions/controls.RadioGroupControl.html +2 -2
- package/doc/functions/controls.SectionControl.html +2 -2
- package/doc/functions/controls.SelectControl.html +2 -2
- package/doc/functions/controls.SelectMessageDialog.html +2 -2
- package/doc/functions/controls.SelectSignalDialog.html +2 -2
- package/doc/functions/controls.SelectSignalsControl.html +2 -0
- package/doc/functions/controls.TableControl.html +2 -2
- package/doc/functions/controls.TextControl.html +2 -2
- package/doc/functions/controls.ToolbarControl.html +2 -2
- package/doc/functions/controls.ValidateableTextControl.html +2 -2
- package/doc/functions/controls.useColumnItem.html +2 -2
- package/doc/functions/controls.useColumnItems.html +2 -2
- package/doc/functions/controls.useMessageDatabases.html +2 -2
- package/doc/functions/hooks.useAvailableProtocols.html +3 -0
- package/doc/functions/hooks.useDevices.html +2 -2
- package/doc/functions/hooks.useFixedPositionModeMeasurementData.html +3 -3
- package/doc/functions/hooks.useIsOnline.html +2 -2
- package/doc/functions/hooks.useLanguage.html +2 -2
- package/doc/functions/hooks.useLocalizedStrings.html +2 -2
- package/doc/functions/hooks.useLogMessages.html +2 -2
- package/doc/functions/hooks.useMaxDataBytes.html +2 -2
- package/doc/functions/hooks.useMeasurementSetup.html +2 -2
- package/doc/functions/hooks.useMeasurementStatus.html +2 -2
- package/doc/functions/hooks.useMessageData.html +8 -4
- package/doc/functions/hooks.useMessageLogFileFormats.html +3 -2
- package/doc/functions/hooks.useNewMeasurementData.html +2 -2
- package/doc/functions/hooks.useNodeStatus.html +2 -2
- package/doc/functions/hooks.useNumericRadix.html +2 -2
- package/doc/functions/hooks.useOnlineStatus.html +2 -2
- package/doc/functions/hooks.useOnlineStatusSync.html +7 -0
- package/doc/functions/hooks.useOverallStatusLevel.html +2 -2
- package/doc/functions/hooks.useProjectData.html +11 -4
- package/doc/functions/hooks.useProjectDataSlice.html +13 -0
- package/doc/functions/hooks.useRecentProjectFiles.html +2 -2
- package/doc/functions/hooks.useRunningPeriodicTransmissions.html +2 -2
- package/doc/functions/hooks.useScrollModeMeasurementData.html +3 -3
- package/doc/functions/hooks.useSessionData.html +13 -4
- package/doc/functions/hooks.useSessionDataSlice.html +14 -0
- package/doc/functions/hooks.useSignalData.html +8 -4
- package/doc/functions/hooks.useSignalDataEnvelopes.html +11 -0
- package/doc/functions/hooks.useSignalLogFileFormats.html +3 -2
- package/doc/functions/hooks.useUndo.html +7 -0
- package/doc/functions/hooks.useUndoRef.html +7 -0
- package/doc/functions/hooks.useUndoSessionDataSlice.html +9 -0
- package/doc/functions/hooks.useUserSettings.html +2 -2
- package/doc/functions/hooks.useWorkspacePaneWithId.html +2 -2
- package/doc/functions/ipc.addDataProcessor.html +2 -2
- package/doc/functions/ipc.addSource.html +2 -2
- package/doc/functions/ipc.addTarget.html +2 -2
- package/doc/functions/ipc.clearLinMessage.html +2 -2
- package/doc/functions/ipc.connectNodes.html +2 -2
- package/doc/functions/ipc.deleteDataProcessor.html +2 -2
- package/doc/functions/ipc.deleteSource.html +2 -2
- package/doc/functions/ipc.deleteTarget.html +2 -2
- package/doc/functions/ipc.disableNode.html +2 -2
- package/doc/functions/ipc.disconnectNodes.html +2 -2
- package/doc/functions/ipc.enableNode.html +2 -2
- package/doc/functions/ipc.getFirstAndLatestTimestamp.html +4 -0
- package/doc/functions/ipc.getFirstTimestamp.html +3 -0
- package/doc/functions/ipc.getFrameDefinitions.html +2 -2
- package/doc/functions/ipc.getLatestTimestamp.html +3 -0
- package/doc/functions/ipc.getLogger.html +2 -2
- package/doc/functions/ipc.getMessageDataBeforeTimestamp.html +7 -0
- package/doc/functions/ipc.getMessageLogFileFormats.html +3 -3
- package/doc/functions/ipc.getSignalLogFileFormats.html +3 -3
- package/doc/functions/ipc.requestLinMessage.html +2 -2
- package/doc/functions/ipc.sendCanMessage.html +2 -2
- package/doc/functions/ipc.sendMessage.html +2 -2
- package/doc/functions/ipc.showMessageBox.html +2 -2
- package/doc/functions/ipc.showQuestionBox.html +2 -2
- package/doc/functions/ipc.startLogReplay.html +2 -2
- package/doc/functions/ipc.startMeasurement.html +2 -2
- package/doc/functions/ipc.startPeriodicTransmission.html +2 -2
- package/doc/functions/ipc.stopLogReplay.html +2 -2
- package/doc/functions/ipc.stopMeasurement.html +2 -2
- package/doc/functions/ipc.stopPeriodicTransmission.html +2 -2
- package/doc/functions/ipc.updateDataProcessor.html +2 -2
- package/doc/functions/ipc.updateLinMessage.html +2 -2
- package/doc/functions/ipc.updatePeriodicTransmission.html +2 -2
- package/doc/functions/ipc.updateSource.html +2 -2
- package/doc/functions/ipc.updateTarget.html +2 -2
- package/doc/functions/models.decimalToFixed.html +5 -0
- package/doc/functions/models.decimalToHex.html +6 -0
- package/doc/functions/models.deep_equal.html +5 -0
- package/doc/functions/models.deserializeFrame.html +4 -0
- package/doc/functions/models.jsonReplacer.html +6 -0
- package/doc/functions/models.jsonReviver.html +6 -0
- package/doc/functions/models.longToNumber.html +4 -0
- package/doc/functions/models.serializeFrame.html +4 -0
- package/doc/hierarchy.html +1 -1
- package/doc/index.html +2 -2
- package/doc/interfaces/controls.ButtonGroupProps.html +2 -2
- package/doc/interfaces/controls.ButtonProps.html +2 -2
- package/doc/interfaces/controls.CanChannelSelectControlProps.html +2 -2
- package/doc/interfaces/controls.CanIdentifierControlProps.html +16 -7
- package/doc/interfaces/controls.CanIdentifierFrameControlProps.html +6 -3
- package/doc/interfaces/controls.CanIdentifierGeneratorControlProps.html +6 -3
- package/doc/interfaces/controls.CanIdentifierGeneratorSettingsControlProps.html +6 -3
- package/doc/interfaces/controls.CheckboxControlProps.html +8 -3
- package/doc/interfaces/controls.ContextMenuProps.html +2 -2
- package/doc/interfaces/controls.DropdownButtonChildrenProps.html +3 -3
- package/doc/interfaces/controls.DropdownButtonProps.html +2 -2
- package/doc/interfaces/controls.DropdownButtonTextItemsProps.html +3 -3
- package/doc/interfaces/controls.DropdownPanelProps.html +2 -2
- package/doc/interfaces/controls.FormControlRowProps.html +2 -2
- package/doc/interfaces/{models.IProject.html → controls.IExtensionWorkspaceViewProps.html} +2 -2
- package/doc/interfaces/controls.ILocalizedStrings.html +2 -2
- package/doc/interfaces/controls.IMessageDatabase.html +2 -2
- package/doc/interfaces/controls.InlineEditorProps.html +2 -2
- package/doc/interfaces/controls.LabelProps.html +2 -2
- package/doc/interfaces/controls.LinChannelSelectControlProps.html +2 -2
- package/doc/interfaces/controls.LinIdentifierControlProps.html +6 -3
- package/doc/interfaces/controls.LinIdentifierFrameControlProps.html +6 -3
- package/doc/interfaces/controls.LinIdentifierGeneratorControlProps.html +6 -3
- package/doc/interfaces/controls.LinIdentifierGeneratorSettingsControlProps.html +6 -3
- package/doc/interfaces/controls.NumberRangeControlProps.html +2 -2
- package/doc/interfaces/controls.RadioControlProps.html +2 -2
- package/doc/interfaces/controls.RadioGroupControlProps.html +2 -2
- package/doc/interfaces/controls.SectionControlProps.html +2 -2
- package/doc/interfaces/controls.SelectControlProps.html +2 -2
- package/doc/interfaces/controls.SelectMessageDialogProps.html +19 -2
- package/doc/interfaces/controls.SelectSignalDialogProps.html +71 -2
- package/doc/interfaces/controls.SelectSignalsControlProps.html +22 -0
- package/doc/interfaces/{models.SetLogLevelRequest.html → controls.SelectedSignalInfo.html} +6 -6
- package/doc/interfaces/controls.SelectedSignalInfoChangeArgs.html +9 -0
- package/doc/interfaces/controls.TableColumn.html +2 -2
- package/doc/interfaces/controls.TableControlProps.html +2 -2
- package/doc/interfaces/controls.TextControlProps.html +2 -2
- package/doc/interfaces/controls.ToggleButtonGroupProps.html +2 -2
- package/doc/interfaces/controls.ToggleButtonProps.html +2 -2
- package/doc/interfaces/controls.ToolbarControlProps.html +2 -2
- package/doc/interfaces/controls.ValidateableTextControlProps.html +2 -2
- package/doc/interfaces/controls.toolbarItem.html +5 -3
- package/doc/interfaces/hooks.IEnvelopeView.html +12 -0
- package/doc/interfaces/hooks.ISignalData.html +19 -2
- package/doc/interfaces/hooks.ISignalDataEnvelope.html +14 -0
- package/doc/interfaces/hooks.IUndoObject.html +27 -0
- package/doc/interfaces/hooks.IUndoState.html +9 -0
- package/doc/interfaces/ipc.ILogger.html +2 -2
- package/doc/interfaces/models.BaseNodeProperties.html +14 -2
- package/doc/interfaces/models.BusStatus.html +32 -2
- package/doc/interfaces/models.CanBusParamLimits.html +12 -2
- package/doc/interfaces/models.CanBusParams.html +14 -2
- package/doc/interfaces/models.CanChannelCapacity.html +10 -4
- package/doc/interfaces/models.CanChannelConfiguration.html +39 -9
- package/doc/interfaces/models.CanFrameFlags.html +4 -2
- package/doc/interfaces/models.CanMessageFilterSettings.html +8 -2
- package/doc/interfaces/models.Channel.html +12 -2
- package/doc/interfaces/models.ChannelSettings.html +5 -3
- package/doc/interfaces/models.DataProcessingStatus.html +10 -2
- package/doc/interfaces/models.DataProcessorNodeProperties.html +14 -2
- package/doc/interfaces/models.DatabasesSettings.html +4 -2
- package/doc/interfaces/models.Device.html +16 -2
- package/doc/interfaces/{models.Licenses.html → models.Devices.html} +4 -4
- package/doc/interfaces/models.Empty.html +2 -2
- package/doc/interfaces/models.ErrorStatus.html +2 -2
- package/doc/interfaces/models.FixedPosFrameIdentifier.html +8 -8
- package/doc/interfaces/models.Frame.html +16 -5
- package/doc/interfaces/models.FrameDefinition.html +5 -3
- package/doc/interfaces/{models.AboutInformation.html → models.FrameDefinitions.html} +4 -8
- package/doc/interfaces/models.FramePropertyValue.html +6 -2
- package/doc/interfaces/models.FrameReceivedTrigger.html +5 -3
- package/doc/interfaces/{models.GetFrameDefinitionsFromDatabaseFilesRequest.html → models.Frames.html} +4 -4
- package/doc/interfaces/models.IUserSettings.html +2 -2
- package/doc/interfaces/models.IWorkspaceComponentPaneData.html +2 -2
- package/doc/interfaces/models.IWorkspaceContainerPaneData.html +2 -2
- package/doc/interfaces/models.IWorkspacePaneData.html +2 -2
- package/doc/interfaces/models.InterpreterSettings.html +2 -2
- package/doc/interfaces/models.J1939InterpreterSettings.html +2 -2
- package/doc/interfaces/models.LinChannelConfiguration.html +2 -2
- package/doc/interfaces/models.LinFrameFlags.html +4 -2
- package/doc/interfaces/models.LogMessage.html +2 -2
- package/doc/interfaces/models.LogMessages.html +2 -2
- package/doc/interfaces/models.LogReplaySettings.html +2 -2
- package/doc/interfaces/models.LogReplayStatus.html +4 -2
- package/doc/interfaces/models.LoggerStatus.html +4 -2
- package/doc/interfaces/models.MeasurementSetup.html +10 -2
- package/doc/interfaces/models.MessageLoggerSettings.html +6 -6
- package/doc/interfaces/models.NodeStatus.html +2 -2
- package/doc/interfaces/models.NodeStatuses.html +4 -2
- package/doc/interfaces/models.OnlineStatus.html +6 -2
- package/doc/interfaces/models.PeriodicTransmissionSettings.html +2 -2
- package/doc/interfaces/models.ServiceExtensionSettings.html +6 -2
- package/doc/interfaces/models.SignalDefinition.html +34 -2
- package/doc/interfaces/models.SignalDefinitions.html +4 -0
- package/doc/interfaces/models.SignalFilterSettings.html +6 -4
- package/doc/interfaces/models.SignalLoggerSettings.html +6 -6
- package/doc/interfaces/models.SignalValue.html +12 -2
- package/doc/interfaces/models.SignalValueTrigger.html +5 -3
- package/doc/interfaces/models.SourceNodeProperties.html +12 -2
- package/doc/interfaces/models.TargetNodeProperties.html +12 -2
- package/doc/interfaces/models.TdcConfiguration.html +17 -0
- package/doc/interfaces/models.TriggerSettings.html +2 -2
- package/doc/interfaces/models.WriteFrame.html +2 -2
- package/doc/modules/controls.html +2 -2
- package/doc/modules/hooks.html +2 -2
- package/doc/modules/ipc.html +2 -2
- package/doc/modules/models.html +2 -2
- package/doc/modules.html +1 -1
- package/doc/types/controls.ContextMenuOption.html +2 -2
- package/doc/types/controls.SelectOption.html +2 -2
- package/doc/types/controls.StringsMap.html +2 -2
- package/doc/types/controls.canIdentifierGeneratorType.html +2 -2
- package/doc/types/controls.canIdentifierType.html +2 -2
- package/doc/types/controls.linIdentifierGeneratorType.html +2 -2
- package/doc/types/hooks.OnGoingOfflineCallback.html +6 -0
- package/doc/types/hooks.OnGoingOnlineCallback.html +6 -0
- package/doc/types/models.SerializableFrame.html +2 -0
- package/doc/variables/controls.FillBox.html +2 -2
- package/doc/variables/controls.OneLineButton.html +2 -2
- package/doc/variables/controls.SizedBox.html +2 -2
- package/doc/variables/controls.TabsPanel.html +2 -2
- package/doc/variables/models.defaultUserSettings.html +2 -2
- package/doc_md/README.md +1 -1
- package/doc_md/controls/README.md +7 -1
- package/doc_md/controls/functions/CanChannelSelectControl.md +1 -1
- package/doc_md/controls/functions/CanIdentifierControl.md +1 -1
- package/doc_md/controls/functions/CanIdentifierFrameControl.md +1 -1
- package/doc_md/controls/functions/CanIdentifierGeneratorControl.md +1 -1
- package/doc_md/controls/functions/CanIdentifierGeneratorSettingsControl.md +1 -1
- package/doc_md/controls/functions/CanKingDataProvider.md +1 -1
- package/doc_md/controls/functions/CheckboxControl.md +1 -1
- package/doc_md/controls/functions/ColorControl.md +25 -0
- package/doc_md/controls/functions/ColumnItemControl.md +1 -1
- package/doc_md/controls/functions/ContextMenu.md +1 -1
- package/doc_md/controls/functions/DropdownButton.md +1 -1
- package/doc_md/controls/functions/DropdownButtonTextItems.md +1 -1
- package/doc_md/controls/functions/DropdownPanel.md +1 -1
- package/doc_md/controls/functions/FormControlRow.md +1 -1
- package/doc_md/controls/functions/InlineEditor.md +1 -1
- package/doc_md/controls/functions/LinChannelSelectControl.md +1 -1
- package/doc_md/controls/functions/LinIdentifierControl.md +1 -1
- package/doc_md/controls/functions/LinIdentifierFrameControl.md +1 -1
- package/doc_md/controls/functions/LinIdentifierGeneratorControl.md +1 -1
- package/doc_md/controls/functions/LinIdentifierGeneratorSettingsControl.md +1 -1
- package/doc_md/controls/functions/NumberRangeControl.md +1 -1
- package/doc_md/controls/functions/RadioControl.md +1 -1
- package/doc_md/controls/functions/RadioGroupControl.md +1 -1
- package/doc_md/controls/functions/SectionControl.md +1 -1
- package/doc_md/controls/functions/SelectControl.md +1 -1
- package/doc_md/controls/functions/SelectMessageDialog.md +1 -1
- package/doc_md/controls/functions/SelectSignalDialog.md +1 -1
- package/doc_md/controls/functions/SelectSignalsControl.md +21 -0
- package/doc_md/controls/functions/TableControl.md +1 -1
- package/doc_md/controls/functions/TextControl.md +1 -1
- package/doc_md/controls/functions/ToolbarControl.md +1 -1
- package/doc_md/controls/functions/ValidateableTextControl.md +1 -1
- package/doc_md/controls/functions/useColumnItem.md +1 -1
- package/doc_md/controls/functions/useColumnItems.md +1 -1
- package/doc_md/controls/functions/useMessageDatabases.md +1 -1
- package/doc_md/controls/interfaces/ButtonGroupProps.md +1 -1
- package/doc_md/controls/interfaces/ButtonProps.md +1 -1
- package/doc_md/controls/interfaces/CanChannelSelectControlProps.md +1 -1
- package/doc_md/controls/interfaces/CanIdentifierControlProps.md +40 -3
- package/doc_md/controls/interfaces/CanIdentifierFrameControlProps.md +10 -1
- package/doc_md/controls/interfaces/CanIdentifierGeneratorControlProps.md +10 -1
- package/doc_md/controls/interfaces/CanIdentifierGeneratorSettingsControlProps.md +10 -1
- package/doc_md/controls/interfaces/CheckboxControlProps.md +18 -1
- package/doc_md/controls/interfaces/ContextMenuProps.md +1 -1
- package/doc_md/controls/interfaces/DropdownButtonChildrenProps.md +1 -1
- package/doc_md/controls/interfaces/DropdownButtonProps.md +1 -1
- package/doc_md/controls/interfaces/DropdownButtonTextItemsProps.md +1 -1
- package/doc_md/controls/interfaces/DropdownPanelProps.md +1 -1
- package/doc_md/controls/interfaces/FormControlRowProps.md +1 -1
- package/doc_md/controls/interfaces/IExtensionWorkspaceViewProps.md +9 -0
- package/doc_md/controls/interfaces/ILocalizedStrings.md +1 -1
- package/doc_md/controls/interfaces/IMessageDatabase.md +1 -1
- package/doc_md/controls/interfaces/InlineEditorProps.md +1 -1
- package/doc_md/controls/interfaces/LabelProps.md +1 -1
- package/doc_md/controls/interfaces/LinChannelSelectControlProps.md +1 -1
- package/doc_md/controls/interfaces/LinIdentifierControlProps.md +10 -1
- package/doc_md/controls/interfaces/LinIdentifierFrameControlProps.md +10 -1
- package/doc_md/controls/interfaces/LinIdentifierGeneratorControlProps.md +10 -1
- package/doc_md/controls/interfaces/LinIdentifierGeneratorSettingsControlProps.md +10 -1
- package/doc_md/controls/interfaces/NumberRangeControlProps.md +1 -1
- package/doc_md/controls/interfaces/RadioControlProps.md +1 -1
- package/doc_md/controls/interfaces/RadioGroupControlProps.md +1 -1
- package/doc_md/controls/interfaces/SectionControlProps.md +1 -1
- package/doc_md/controls/interfaces/SelectControlProps.md +1 -1
- package/doc_md/controls/interfaces/SelectMessageDialogProps.md +78 -1
- package/doc_md/controls/interfaces/SelectSignalDialogProps.md +224 -1
- package/doc_md/controls/interfaces/SelectSignalsControlProps.md +119 -0
- package/doc_md/controls/interfaces/SelectedSignalInfo.md +29 -0
- package/doc_md/controls/interfaces/SelectedSignalInfoChangeArgs.md +46 -0
- package/doc_md/controls/interfaces/TableColumn.md +1 -1
- package/doc_md/controls/interfaces/TableControlProps.md +1 -1
- package/doc_md/controls/interfaces/TextControlProps.md +1 -1
- package/doc_md/controls/interfaces/ToggleButtonGroupProps.md +1 -1
- package/doc_md/controls/interfaces/ToggleButtonProps.md +1 -1
- package/doc_md/controls/interfaces/ToolbarControlProps.md +1 -1
- package/doc_md/controls/interfaces/ValidateableTextControlProps.md +1 -1
- package/doc_md/controls/interfaces/toolbarItem.md +9 -1
- package/doc_md/controls/type-aliases/ContextMenuOption.md +1 -1
- package/doc_md/controls/type-aliases/SelectOption.md +1 -1
- package/doc_md/controls/type-aliases/StringsMap.md +1 -1
- package/doc_md/controls/type-aliases/canIdentifierGeneratorType.md +1 -1
- package/doc_md/controls/type-aliases/canIdentifierType.md +1 -1
- package/doc_md/controls/type-aliases/linIdentifierGeneratorType.md +1 -1
- package/doc_md/controls/variables/FillBox.md +1 -1
- package/doc_md/controls/variables/OneLineButton.md +2 -2
- package/doc_md/controls/variables/SizedBox.md +1 -1
- package/doc_md/controls/variables/TabsPanel.md +1 -1
- package/doc_md/hooks/README.md +18 -1
- package/doc_md/hooks/functions/useAvailableProtocols.md +17 -0
- package/doc_md/hooks/functions/useDevices.md +1 -1
- package/doc_md/hooks/functions/useFixedPositionModeMeasurementData.md +4 -4
- package/doc_md/hooks/functions/useIsOnline.md +1 -1
- package/doc_md/hooks/functions/useLanguage.md +1 -1
- package/doc_md/hooks/functions/useLocalizedStrings.md +1 -1
- package/doc_md/hooks/functions/useLogMessages.md +1 -1
- package/doc_md/hooks/functions/useMaxDataBytes.md +1 -1
- package/doc_md/hooks/functions/useMeasurementSetup.md +1 -1
- package/doc_md/hooks/functions/useMeasurementStatus.md +1 -1
- package/doc_md/hooks/functions/useMessageData.md +21 -4
- package/doc_md/hooks/functions/useMessageLogFileFormats.md +5 -3
- package/doc_md/hooks/functions/useNewMeasurementData.md +1 -1
- package/doc_md/hooks/functions/useNodeStatus.md +1 -1
- package/doc_md/hooks/functions/useNumericRadix.md +1 -1
- package/doc_md/hooks/functions/useOnlineStatus.md +1 -1
- package/doc_md/hooks/functions/useOnlineStatusSync.md +43 -0
- package/doc_md/hooks/functions/useOverallStatusLevel.md +1 -1
- package/doc_md/hooks/functions/useProjectData.md +16 -6
- package/doc_md/hooks/functions/useProjectDataSlice.md +58 -0
- package/doc_md/hooks/functions/useRecentProjectFiles.md +1 -1
- package/doc_md/hooks/functions/useRunningPeriodicTransmissions.md +1 -1
- package/doc_md/hooks/functions/useScrollModeMeasurementData.md +4 -4
- package/doc_md/hooks/functions/useSessionData.md +24 -6
- package/doc_md/hooks/functions/useSessionDataSlice.md +60 -0
- package/doc_md/hooks/functions/useSignalData.md +23 -6
- package/doc_md/hooks/functions/useSignalDataEnvelopes.md +50 -0
- package/doc_md/hooks/functions/useSignalLogFileFormats.md +5 -3
- package/doc_md/hooks/functions/useUndo.md +38 -0
- package/doc_md/hooks/functions/useUndoRef.md +38 -0
- package/doc_md/hooks/functions/useUndoSessionDataSlice.md +50 -0
- package/doc_md/hooks/functions/useUserSettings.md +1 -1
- package/doc_md/hooks/functions/useWorkspacePaneWithId.md +1 -1
- package/doc_md/hooks/interfaces/IEnvelopeView.md +49 -0
- package/doc_md/hooks/interfaces/ISignalData.md +69 -1
- package/doc_md/hooks/interfaces/ISignalDataEnvelope.md +51 -0
- package/doc_md/hooks/interfaces/IUndoObject.md +155 -0
- package/doc_md/hooks/interfaces/IUndoState.md +41 -0
- package/doc_md/hooks/type-aliases/OnGoingOfflineCallback.md +36 -0
- package/doc_md/hooks/type-aliases/OnGoingOnlineCallback.md +36 -0
- package/doc_md/ipc/README.md +5 -1
- package/doc_md/ipc/functions/addDataProcessor.md +1 -1
- package/doc_md/ipc/functions/addSource.md +1 -1
- package/doc_md/ipc/functions/addTarget.md +1 -1
- package/doc_md/ipc/functions/clearLinMessage.md +1 -1
- package/doc_md/ipc/functions/connectNodes.md +1 -1
- package/doc_md/ipc/functions/deleteDataProcessor.md +1 -1
- package/doc_md/ipc/functions/deleteSource.md +1 -1
- package/doc_md/ipc/functions/deleteTarget.md +1 -1
- package/doc_md/ipc/functions/disableNode.md +1 -1
- package/doc_md/ipc/functions/disconnectNodes.md +1 -1
- package/doc_md/ipc/functions/enableNode.md +1 -1
- package/doc_md/ipc/functions/getFirstAndLatestTimestamp.md +18 -0
- package/doc_md/ipc/functions/getFirstTimestamp.md +17 -0
- package/doc_md/ipc/functions/getFrameDefinitions.md +1 -1
- package/doc_md/ipc/functions/getLatestTimestamp.md +17 -0
- package/doc_md/ipc/functions/getLogger.md +1 -1
- package/doc_md/ipc/functions/getMessageDataBeforeTimestamp.md +38 -0
- package/doc_md/ipc/functions/getMessageLogFileFormats.md +3 -3
- package/doc_md/ipc/functions/getSignalLogFileFormats.md +3 -3
- package/doc_md/ipc/functions/requestLinMessage.md +1 -1
- package/doc_md/ipc/functions/sendCanMessage.md +1 -1
- package/doc_md/ipc/functions/sendMessage.md +1 -1
- package/doc_md/ipc/functions/showMessageBox.md +1 -1
- package/doc_md/ipc/functions/showQuestionBox.md +1 -1
- package/doc_md/ipc/functions/startLogReplay.md +1 -1
- package/doc_md/ipc/functions/startMeasurement.md +1 -1
- package/doc_md/ipc/functions/startPeriodicTransmission.md +1 -1
- package/doc_md/ipc/functions/stopLogReplay.md +1 -1
- package/doc_md/ipc/functions/stopMeasurement.md +1 -1
- package/doc_md/ipc/functions/stopPeriodicTransmission.md +1 -1
- package/doc_md/ipc/functions/updateDataProcessor.md +1 -1
- package/doc_md/ipc/functions/updateLinMessage.md +1 -1
- package/doc_md/ipc/functions/updatePeriodicTransmission.md +1 -1
- package/doc_md/ipc/functions/updateSource.md +1 -1
- package/doc_md/ipc/functions/updateTarget.md +1 -1
- package/doc_md/ipc/interfaces/ILogger.md +1 -1
- package/doc_md/models/README.md +25 -73
- package/doc_md/models/enumerations/AccessMode.md +4 -1
- package/doc_md/models/enumerations/CanChannelCap.md +1 -1
- package/doc_md/models/enumerations/CanConfigMode.md +69 -0
- package/doc_md/models/enumerations/CanFrameFlag.md +68 -1
- package/doc_md/models/enumerations/CanMessageFilterType.md +5 -1
- package/doc_md/models/enumerations/CanMode.md +15 -1
- package/doc_md/models/enumerations/DecimalChar.md +37 -0
- package/doc_md/models/enumerations/FileConflictAction.md +7 -1
- package/doc_md/models/enumerations/LinFrameFlag.md +19 -1
- package/doc_md/models/enumerations/LogFileFormat.md +9 -1
- package/doc_md/models/enumerations/LogLevel.md +1 -1
- package/doc_md/models/enumerations/LogReplayState.md +5 -1
- package/doc_md/models/enumerations/LoggerState.md +7 -1
- package/doc_md/models/enumerations/Separator.md +37 -0
- package/doc_md/models/enumerations/SignalEncoding.md +5 -1
- package/doc_md/models/enumerations/SignalType.md +1 -1
- package/doc_md/models/enumerations/SignalValueTriggerOperator.md +19 -1
- package/doc_md/models/enumerations/StatusLevel.md +7 -1
- package/doc_md/models/enumerations/TimeReference.md +37 -0
- package/doc_md/models/enumerations/TriggerOperator.md +5 -1
- package/doc_md/models/functions/decimalToFixed.md +31 -0
- package/doc_md/models/functions/decimalToHex.md +37 -0
- package/doc_md/models/functions/deep_equal.md +37 -0
- package/doc_md/models/functions/deserializeFrame.md +25 -0
- package/doc_md/models/functions/jsonReplacer.md +32 -0
- package/doc_md/models/functions/jsonReviver.md +32 -0
- package/doc_md/models/functions/longToNumber.md +25 -0
- package/doc_md/models/functions/serializeFrame.md +25 -0
- package/doc_md/models/interfaces/BaseNodeProperties.md +49 -1
- package/doc_md/models/interfaces/BusStatus.md +121 -1
- package/doc_md/models/interfaces/CanBusParamLimits.md +41 -1
- package/doc_md/models/interfaces/CanBusParams.md +49 -1
- package/doc_md/models/interfaces/CanChannelCapacity.md +25 -1
- package/doc_md/models/interfaces/CanChannelConfiguration.md +107 -8
- package/doc_md/models/interfaces/CanFrameFlags.md +9 -1
- package/doc_md/models/interfaces/CanMessageFilterSettings.md +25 -1
- package/doc_md/models/interfaces/Channel.md +41 -1
- package/doc_md/models/interfaces/ChannelSettings.md +9 -1
- package/doc_md/models/interfaces/DataProcessingStatus.md +33 -1
- package/doc_md/models/interfaces/DataProcessorNodeProperties.md +49 -1
- package/doc_md/models/interfaces/DatabasesSettings.md +9 -1
- package/doc_md/models/interfaces/Device.md +57 -1
- package/doc_md/models/interfaces/Devices.md +17 -0
- package/doc_md/models/interfaces/Empty.md +1 -1
- package/doc_md/models/interfaces/ErrorStatus.md +1 -1
- package/doc_md/models/interfaces/FixedPosFrameIdentifier.md +8 -8
- package/doc_md/models/interfaces/Frame.md +46 -2
- package/doc_md/models/interfaces/FrameDefinition.md +9 -1
- package/doc_md/models/interfaces/FrameDefinitions.md +17 -0
- package/doc_md/models/interfaces/FramePropertyValue.md +17 -1
- package/doc_md/models/interfaces/FrameReceivedTrigger.md +9 -1
- package/doc_md/models/interfaces/Frames.md +17 -0
- package/doc_md/models/interfaces/IUserSettings.md +1 -1
- package/doc_md/models/interfaces/IWorkspaceComponentPaneData.md +1 -1
- package/doc_md/models/interfaces/IWorkspaceContainerPaneData.md +1 -1
- package/doc_md/models/interfaces/IWorkspacePaneData.md +1 -1
- package/doc_md/models/interfaces/InterpreterSettings.md +1 -1
- package/doc_md/models/interfaces/J1939InterpreterSettings.md +1 -1
- package/doc_md/models/interfaces/LinChannelConfiguration.md +1 -1
- package/doc_md/models/interfaces/LinFrameFlags.md +9 -1
- package/doc_md/models/interfaces/LogMessage.md +1 -1
- package/doc_md/models/interfaces/LogMessages.md +1 -1
- package/doc_md/models/interfaces/LogReplaySettings.md +1 -1
- package/doc_md/models/interfaces/LogReplayStatus.md +9 -1
- package/doc_md/models/interfaces/LoggerStatus.md +9 -1
- package/doc_md/models/interfaces/MeasurementSetup.md +33 -1
- package/doc_md/models/interfaces/MessageLoggerSettings.md +4 -4
- package/doc_md/models/interfaces/NodeStatus.md +1 -1
- package/doc_md/models/interfaces/NodeStatuses.md +9 -1
- package/doc_md/models/interfaces/OnlineStatus.md +17 -1
- package/doc_md/models/interfaces/PeriodicTransmissionSettings.md +1 -1
- package/doc_md/models/interfaces/ServiceExtensionSettings.md +17 -1
- package/doc_md/models/interfaces/SignalDefinition.md +133 -1
- package/doc_md/models/interfaces/SignalDefinitions.md +17 -0
- package/doc_md/models/interfaces/SignalFilterSettings.md +10 -2
- package/doc_md/models/interfaces/SignalLoggerSettings.md +4 -4
- package/doc_md/models/interfaces/SignalValue.md +41 -1
- package/doc_md/models/interfaces/SignalValueTrigger.md +9 -1
- package/doc_md/models/interfaces/SourceNodeProperties.md +41 -1
- package/doc_md/models/interfaces/TargetNodeProperties.md +41 -1
- package/doc_md/models/interfaces/TdcConfiguration.md +33 -0
- package/doc_md/models/interfaces/TriggerSettings.md +1 -1
- package/doc_md/models/interfaces/WriteFrame.md +1 -1
- package/doc_md/models/type-aliases/SerializableFrame.md +33 -0
- package/doc_md/models/variables/defaultUserSettings.md +1 -1
- package/doc_md/modules.md +2 -3
- package/package.json +16 -4
- package/dist/ElectronAPIFake.js +0 -1
- package/dist/ElectronAPIFake.mjs +0 -273
- package/dist/measurement_settings.js +0 -1
- package/dist/measurement_settings.mjs +0 -6121
- package/doc/enums/models.AppEvent.html +0 -6
- package/doc/enums/models.FileType.html +0 -7
- package/doc/enums/models.MeasurementEvent.html +0 -12
- package/doc/enums/models.Protocols.html +0 -9
- package/doc/enums/models.ServiceExtensionType.html +0 -8
- package/doc/interfaces/models.ActivateLicenseRequest.html +0 -8
- package/doc/interfaces/models.AddAllConnectedCanChannelsRequest.html +0 -2
- package/doc/interfaces/models.AddAllConnectedLinChannelsRequest.html +0 -2
- package/doc/interfaces/models.AddOrUpdateDataProcessorRequest.html +0 -10
- package/doc/interfaces/models.AddOrUpdateSourceRequest.html +0 -6
- package/doc/interfaces/models.AddOrUpdateTargetRequest.html +0 -6
- package/doc/interfaces/models.ApiPreferences.html +0 -10
- package/doc/interfaces/models.AppEventArgs.html +0 -6
- package/doc/interfaces/models.CanBusSpeedInfo.html +0 -14
- package/doc/interfaces/models.CanFDBusSpeedCombination.html +0 -2
- package/doc/interfaces/models.CanFDBusSpeedInfo.html +0 -10
- package/doc/interfaces/models.ClearLinMessageRequest.html +0 -6
- package/doc/interfaces/models.ConnectNodesRequest.html +0 -2
- package/doc/interfaces/models.DatabaseFiles.html +0 -6
- package/doc/interfaces/models.DeviceEventArgs.html +0 -2
- package/doc/interfaces/models.DisconnectNodesRequest.html +0 -2
- package/doc/interfaces/models.GetCanChannelBusSpeedsRequest.html +0 -2
- package/doc/interfaces/models.GetCanChannelBusSpeedsResponse.html +0 -6
- package/doc/interfaces/models.GetCanFdBusSpeedsRequest.html +0 -2
- package/doc/interfaces/models.GetCanFdBusSpeedsResponse.html +0 -4
- package/doc/interfaces/models.GetChannelsFromLogFileRequest.html +0 -4
- package/doc/interfaces/models.GetChannelsFromLogFileResponse.html +0 -4
- package/doc/interfaces/models.GetClassicCanBusSpeedsRequest.html +0 -2
- package/doc/interfaces/models.GetClassicCanBusSpeedsResponse.html +0 -4
- package/doc/interfaces/models.GetDataFramesBeforeTimestampRequest.html +0 -6
- package/doc/interfaces/models.GetDataProcessorResponse.html +0 -2
- package/doc/interfaces/models.GetDevicesRequest.html +0 -2
- package/doc/interfaces/models.GetDevicesResponse.html +0 -2
- package/doc/interfaces/models.GetLicensesResponse.html +0 -4
- package/doc/interfaces/models.GetLogFileFormatsRequest.html +0 -8
- package/doc/interfaces/models.GetLogFileFormatsResponse.html +0 -10
- package/doc/interfaces/models.GetLogLevelResponse.html +0 -4
- package/doc/interfaces/models.GetScheduleTablesFromDatabaseFilesRequest.html +0 -4
- package/doc/interfaces/models.GetScheduleTablesFromDatabaseFilesResponse.html +0 -4
- package/doc/interfaces/models.GetServiceExtensionInfoRequest.html +0 -8
- package/doc/interfaces/models.GetServiceExtensionInfoResponse.html +0 -16
- package/doc/interfaces/models.GetSignalDataFromMessageDataRequest.html +0 -6
- package/doc/interfaces/models.GetSignalDataFromMessageDataResponse.html +0 -4
- package/doc/interfaces/models.GetSourceResponse.html +0 -2
- package/doc/interfaces/models.GetTargetResponse.html +0 -2
- package/doc/interfaces/models.ILogFileFormat.html +0 -2
- package/doc/interfaces/models.IWorkspaceData.html +0 -2
- package/doc/interfaces/models.IdentifierRequest.html +0 -3
- package/doc/interfaces/models.IdentifiersRequest.html +0 -3
- package/doc/interfaces/models.InstallServiceExtensionRequest.html +0 -8
- package/doc/interfaces/models.LicenseInformation.html +0 -18
- package/doc/interfaces/models.MeasurementEventArgs.html +0 -2
- package/doc/interfaces/models.RequestLinMessageRequest.html +0 -6
- package/doc/interfaces/models.ScheduleTable.html +0 -8
- package/doc/interfaces/models.ScheduleTableEntry.html +0 -6
- package/doc/interfaces/models.SendLinWakeupFrameRequest.html +0 -8
- package/doc/interfaces/models.SendMessageRequest.html +0 -2
- package/doc/interfaces/models.SetMeasurementSetupRequest.html +0 -2
- package/doc/interfaces/models.SetSignalDataToMessageDataRequest.html +0 -8
- package/doc/interfaces/models.SetSignalDataToMessageDataResponse.html +0 -7
- package/doc/interfaces/models.StartPeriodicTransmissionRequest.html +0 -4
- package/doc/interfaces/models.StartPeriodicTransmissionResponse.html +0 -2
- package/doc/interfaces/models.SubscribeForDataRequest.html +0 -4
- package/doc/interfaces/models.UninstallServiceExtensionRequest.html +0 -6
- package/doc/interfaces/models.UpdateLinMessageRequest.html +0 -7
- package/doc/interfaces/models.UpdatePeriodicTransmissionRequest.html +0 -6
- package/doc/modules/icons.html +0 -2
- package/doc_md/icons/README.md +0 -9
- package/doc_md/models/enumerations/AppEvent.md +0 -29
- package/doc_md/models/enumerations/DeviceEvent.md +0 -29
- package/doc_md/models/enumerations/FileType.md +0 -39
- package/doc_md/models/enumerations/MeasurementEvent.md +0 -53
- package/doc_md/models/enumerations/Protocols.md +0 -39
- package/doc_md/models/enumerations/ServiceExtensionType.md +0 -37
- package/doc_md/models/interfaces/AboutInformation.md +0 -33
- package/doc_md/models/interfaces/ActivateLicenseRequest.md +0 -33
- package/doc_md/models/interfaces/AddAllConnectedCanChannelsRequest.md +0 -9
- package/doc_md/models/interfaces/AddAllConnectedLinChannelsRequest.md +0 -9
- package/doc_md/models/interfaces/AddOrUpdateDataProcessorRequest.md +0 -35
- package/doc_md/models/interfaces/AddOrUpdateSourceRequest.md +0 -19
- package/doc_md/models/interfaces/AddOrUpdateTargetRequest.md +0 -19
- package/doc_md/models/interfaces/ApiPreferences.md +0 -41
- package/doc_md/models/interfaces/AppEventArgs.md +0 -25
- package/doc_md/models/interfaces/CanBusSpeedInfo.md +0 -57
- package/doc_md/models/interfaces/CanFDBusSpeedCombination.md +0 -9
- package/doc_md/models/interfaces/CanFDBusSpeedInfo.md +0 -41
- package/doc_md/models/interfaces/ClearLinMessageRequest.md +0 -25
- package/doc_md/models/interfaces/ConnectNodesRequest.md +0 -9
- package/doc_md/models/interfaces/DatabaseFiles.md +0 -25
- package/doc_md/models/interfaces/DeviceEventArgs.md +0 -9
- package/doc_md/models/interfaces/DisconnectNodesRequest.md +0 -9
- package/doc_md/models/interfaces/GetCanChannelBusSpeedsRequest.md +0 -9
- package/doc_md/models/interfaces/GetCanChannelBusSpeedsResponse.md +0 -25
- package/doc_md/models/interfaces/GetCanFdBusSpeedsRequest.md +0 -9
- package/doc_md/models/interfaces/GetCanFdBusSpeedsResponse.md +0 -17
- package/doc_md/models/interfaces/GetChannelsFromLogFileRequest.md +0 -17
- package/doc_md/models/interfaces/GetChannelsFromLogFileResponse.md +0 -17
- package/doc_md/models/interfaces/GetClassicCanBusSpeedsRequest.md +0 -9
- package/doc_md/models/interfaces/GetClassicCanBusSpeedsResponse.md +0 -17
- package/doc_md/models/interfaces/GetDataFramesBeforeTimestampRequest.md +0 -25
- package/doc_md/models/interfaces/GetDataProcessorResponse.md +0 -9
- package/doc_md/models/interfaces/GetDevicesRequest.md +0 -9
- package/doc_md/models/interfaces/GetDevicesResponse.md +0 -9
- package/doc_md/models/interfaces/GetFrameDefinitionsFromDatabaseFilesRequest.md +0 -17
- package/doc_md/models/interfaces/GetLicensesResponse.md +0 -17
- package/doc_md/models/interfaces/GetLogFileFormatsRequest.md +0 -33
- package/doc_md/models/interfaces/GetLogFileFormatsResponse.md +0 -41
- package/doc_md/models/interfaces/GetLogLevelResponse.md +0 -17
- package/doc_md/models/interfaces/GetScheduleTablesFromDatabaseFilesRequest.md +0 -17
- package/doc_md/models/interfaces/GetScheduleTablesFromDatabaseFilesResponse.md +0 -17
- package/doc_md/models/interfaces/GetServiceExtensionInfoRequest.md +0 -27
- package/doc_md/models/interfaces/GetServiceExtensionInfoResponse.md +0 -65
- package/doc_md/models/interfaces/GetSignalDataFromMessageDataRequest.md +0 -25
- package/doc_md/models/interfaces/GetSignalDataFromMessageDataResponse.md +0 -17
- package/doc_md/models/interfaces/GetSourceResponse.md +0 -9
- package/doc_md/models/interfaces/GetTargetResponse.md +0 -9
- package/doc_md/models/interfaces/ILogFileFormat.md +0 -9
- package/doc_md/models/interfaces/IProject.md +0 -9
- package/doc_md/models/interfaces/IWorkspaceData.md +0 -9
- package/doc_md/models/interfaces/IdentifierRequest.md +0 -10
- package/doc_md/models/interfaces/IdentifiersRequest.md +0 -10
- package/doc_md/models/interfaces/InstallServiceExtensionRequest.md +0 -33
- package/doc_md/models/interfaces/LicenseInformation.md +0 -73
- package/doc_md/models/interfaces/Licenses.md +0 -17
- package/doc_md/models/interfaces/MeasurementEventArgs.md +0 -9
- package/doc_md/models/interfaces/RequestLinMessageRequest.md +0 -25
- package/doc_md/models/interfaces/ScheduleTable.md +0 -33
- package/doc_md/models/interfaces/ScheduleTableEntry.md +0 -25
- package/doc_md/models/interfaces/SendLinWakeupFrameRequest.md +0 -33
- package/doc_md/models/interfaces/SendMessageRequest.md +0 -9
- package/doc_md/models/interfaces/SetLogLevelRequest.md +0 -25
- package/doc_md/models/interfaces/SetMeasurementSetupRequest.md +0 -9
- package/doc_md/models/interfaces/SetSignalDataToMessageDataRequest.md +0 -33
- package/doc_md/models/interfaces/SetSignalDataToMessageDataResponse.md +0 -26
- package/doc_md/models/interfaces/StartPeriodicTransmissionRequest.md +0 -17
- package/doc_md/models/interfaces/StartPeriodicTransmissionResponse.md +0 -9
- package/doc_md/models/interfaces/SubscribeForDataRequest.md +0 -17
- package/doc_md/models/interfaces/UninstallServiceExtensionRequest.md +0 -25
- package/doc_md/models/interfaces/UpdateLinMessageRequest.md +0 -26
- package/doc_md/models/interfaces/UpdatePeriodicTransmissionRequest.md +0 -25
- package/licenses/ELECTRON-TOOLKIT-PRELOAD_MIT.TXT +0 -21
- package/licenses/FAST-DEEP-EQUAL_MIT.TXT +0 -21
- package/licenses/GOOGLE-PROTOBUF_(BSD-3-CLAUSE AND APACHE-2.0).TXT +0 -29
- package/licenses/REACT-DOM_MIT.TXT +0 -21
- package/licenses/REACT_MIT.TXT +0 -21
- package/licenses/UUID_MIT.TXT +0 -9
- package/licenses/licenses.css +0 -22
- package/licenses/licenses.html +0 -67
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useOnlineStatus | Kvaser CanKing GUI Extensions SDK - v7.
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useOnlineStatus | Kvaser CanKing GUI Extensions SDK - v7.4.0</title><link rel="icon" href="../assets/favicon.png" type="image/png"/><meta name="description" content="Documentation for Kvaser CanKing GUI Extensions SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Kvaser CanKing GUI Extensions SDK - v7.4.0</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/hooks.html">hooks</a></li><li><a href="" aria-current="page">useOnlineStatus</a></li></ul><h1>Function useOnlineStatus</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="useonlinestatus"><span class="tsd-kind-call-signature">useOnlineStatus</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/models.OnlineStatus.html" class="tsd-signature-type tsd-kind-interface">OnlineStatus</a><a href="#useonlinestatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>A hook for online status.</p>
|
|
2
2
|
</div><h4 class="tsd-returns-title">Returns <a href="../interfaces/models.OnlineStatus.html" class="tsd-signature-type tsd-kind-interface">OnlineStatus</a></h4><p>The online status.</p>
|
|
3
|
-
<div class="tsd-comment tsd-typography"></div></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Kvaser CanKing GUI Extensions SDK - v7.
|
|
3
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Kvaser CanKing GUI Extensions SDK - v7.4.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p>Copyright KVASER AB 2026</p></footer><div class="overlay"></div></body></html>
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useOnlineStatusSync | Kvaser CanKing GUI Extensions SDK - v7.4.0</title><link rel="icon" href="../assets/favicon.png" type="image/png"/><meta name="description" content="Documentation for Kvaser CanKing GUI Extensions SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Kvaser CanKing GUI Extensions SDK - v7.4.0</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/hooks.html">hooks</a></li><li><a href="" aria-current="page">useOnlineStatusSync</a></li></ul><h1>Function useOnlineStatusSync</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="useonlinestatussync"><span class="tsd-kind-call-signature">useOnlineStatusSync</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">parentIsInitialized</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">onGoingOnline</span><span class="tsd-signature-symbol">:</span> <a href="../types/hooks.OnGoingOnlineCallback.html" class="tsd-signature-type tsd-kind-type-alias">OnGoingOnlineCallback</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">onGoingOffline</span><span class="tsd-signature-symbol">:</span> <a href="../types/hooks.OnGoingOfflineCallback.html" class="tsd-signature-type tsd-kind-type-alias">OnGoingOfflineCallback</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#useonlinestatussync" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Custom hook to synchronize session state with online/offline status changes.</p>
|
|
2
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">parentIsInitialized</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Whether the parent component is initialized and has loaded all project and session data needed before receiving online updates.</p>
|
|
3
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The unique id of the view. This is passed to the view component as the <code>id</code> prop.</p>
|
|
4
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">onGoingOnline</span>: <a href="../types/hooks.OnGoingOnlineCallback.html" class="tsd-signature-type tsd-kind-type-alias">OnGoingOnlineCallback</a></span><div class="tsd-comment tsd-typography"><p>Callback function to handle going online. Called when the CanKing starts a measurement or when the view is mounted while online.</p>
|
|
5
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">onGoingOffline</span>: <a href="../types/hooks.OnGoingOfflineCallback.html" class="tsd-signature-type tsd-kind-type-alias">OnGoingOfflineCallback</a></span><div class="tsd-comment tsd-typography"><p>Callback function to handle going offline. Called when the CanKing stops a measurement or when the view is mounted while offline.</p>
|
|
6
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>The current online status.</p>
|
|
7
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Kvaser CanKing GUI Extensions SDK - v7.4.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p>Copyright KVASER AB 2026</p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useOverallStatusLevel | Kvaser CanKing GUI Extensions SDK - v7.
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useOverallStatusLevel | Kvaser CanKing GUI Extensions SDK - v7.4.0</title><link rel="icon" href="../assets/favicon.png" type="image/png"/><meta name="description" content="Documentation for Kvaser CanKing GUI Extensions SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Kvaser CanKing GUI Extensions SDK - v7.4.0</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/hooks.html">hooks</a></li><li><a href="" aria-current="page">useOverallStatusLevel</a></li></ul><h1>Function useOverallStatusLevel</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="useoverallstatuslevel"><span class="tsd-kind-call-signature">useOverallStatusLevel</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../enums/models.StatusLevel.html" class="tsd-signature-type tsd-kind-enum">StatusLevel</a><a href="#useoverallstatuslevel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Hook to get the measurement's highest overall status level.</p>
|
|
2
2
|
</div><h4 class="tsd-returns-title">Returns <a href="../enums/models.StatusLevel.html" class="tsd-signature-type tsd-kind-enum">StatusLevel</a></h4><p>The measurement's highest overall status.</p>
|
|
3
|
-
<div class="tsd-comment tsd-typography"></div></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Kvaser CanKing GUI Extensions SDK - v7.
|
|
3
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Kvaser CanKing GUI Extensions SDK - v7.4.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p>Copyright KVASER AB 2026</p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,5 +1,12 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useProjectData | Kvaser CanKing GUI Extensions SDK - v7.
|
|
2
|
-
|
|
3
|
-
</div><
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useProjectData | Kvaser CanKing GUI Extensions SDK - v7.4.0</title><link rel="icon" href="../assets/favicon.png" type="image/png"/><meta name="description" content="Documentation for Kvaser CanKing GUI Extensions SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Kvaser CanKing GUI Extensions SDK - v7.4.0</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/hooks.html">hooks</a></li><li><a href="" aria-current="page">useProjectData</a></li></ul><h1>Function useProjectData</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="useprojectdata"><span class="tsd-kind-call-signature">useProjectData</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#useprojectdatat">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">defaultValue</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#useprojectdatat">T</a> <span class="tsd-signature-symbol">|</span> (<span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#useprojectdatat">T</a>)<span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">projectData</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#useprojectdatat">T</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">projectDataIsInitialized</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">setProjectData</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Dispatch</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">SetStateAction</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#useprojectdatat">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span><a href="#useprojectdata" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>A hook for data that should be saved to the current project.
|
|
2
|
+
The state is automatically saved to and restored from the main process.</p>
|
|
3
|
+
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="useprojectdatat"><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The unique id of the view. This is passed to the view component as the <code>id</code> prop.</p>
|
|
4
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">defaultValue</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#useprojectdatat">T</a> <span class="tsd-signature-symbol">|</span> (<span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#useprojectdatat">T</a>)</span><div class="tsd-comment tsd-typography"><p>The default value or a function that returns the default value.</p>
|
|
4
5
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">projectData</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#useprojectdatat">T</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">projectDataIsInitialized</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">setProjectData</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Dispatch</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">SetStateAction</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#useprojectdatat">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></h4><p>An object with a flag indicating if the project data has been initialized, the current project data and a setter callback.</p>
|
|
5
|
-
<div class="tsd-comment tsd-typography"
|
|
6
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks">Remarks<a href="#remarks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>It's only possible to use this hook once per workspace view component tree.
|
|
7
|
+
Use this hook if your view component only needs to store a small amount of project data.
|
|
8
|
+
For larger amounts of data, consider using <code>useProjectDataSlice</code> instead, which allows
|
|
9
|
+
splitting the project data into multiple named slices.
|
|
10
|
+
Using multiple slices can improve performance and reduce memory usage and it also allows
|
|
11
|
+
different parts of the component tree to independently load and save their project data.</p>
|
|
12
|
+
</div></div></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Kvaser CanKing GUI Extensions SDK - v7.4.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p>Copyright KVASER AB 2026</p></footer><div class="overlay"></div></body></html>
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useProjectDataSlice | Kvaser CanKing GUI Extensions SDK - v7.4.0</title><link rel="icon" href="../assets/favicon.png" type="image/png"/><meta name="description" content="Documentation for Kvaser CanKing GUI Extensions SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Kvaser CanKing GUI Extensions SDK - v7.4.0</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/hooks.html">hooks</a></li><li><a href="" aria-current="page">useProjectDataSlice</a></li></ul><h1>Function useProjectDataSlice</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="useprojectdataslice"><span class="tsd-kind-call-signature">useProjectDataSlice</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#useprojectdataslicet">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">slice</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">defaultValue</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#useprojectdataslicet">T</a> <span class="tsd-signature-symbol">|</span> (<span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#useprojectdataslicet">T</a>)<span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">loadedCallback</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#useprojectdataslicet">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#useprojectdataslicet">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">Dispatch</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">SetStateAction</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#useprojectdataslicet">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">]</span><a href="#useprojectdataslice" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>A hook for data that should be saved to the current project.
|
|
2
|
+
The state is automatically saved to and restored from the main process.</p>
|
|
3
|
+
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="useprojectdataslicet"><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The unique id of the view. This is passed to the view component as the <code>id</code> prop.</p>
|
|
4
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">slice</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The slice name for the project data.</p>
|
|
5
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">defaultValue</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#useprojectdataslicet">T</a> <span class="tsd-signature-symbol">|</span> (<span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#useprojectdataslicet">T</a>)</span><div class="tsd-comment tsd-typography"><p>The default value or a function that returns the default value.</p>
|
|
6
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">loadedCallback</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#useprojectdataslicet">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></span><div class="tsd-comment tsd-typography"><p>Optional callback invoked once after data is loaded.</p>
|
|
7
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#useprojectdataslicet">T</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">Dispatch</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">SetStateAction</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#useprojectdataslicet">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">]</span></h4><p>An object with a flag indicating if the project data has been initialized, the current project data and a setter callback.</p>
|
|
8
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks">Remarks<a href="#remarks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Use this hook to split your workspace view's project data into multiple named slices.
|
|
9
|
+
This can improve performance and reduce memory usage and it also allows
|
|
10
|
+
different parts of the component tree to independently load and save their project data.
|
|
11
|
+
Make sure to use the workspace view component's <code>id</code> prop and to use unique slice names
|
|
12
|
+
for each slice within the component tree.</p>
|
|
13
|
+
</div></div></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Kvaser CanKing GUI Extensions SDK - v7.4.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p>Copyright KVASER AB 2026</p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useRecentProjectFiles | Kvaser CanKing GUI Extensions SDK - v7.
|
|
2
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><div class="tsd-comment tsd-typography"></div></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Kvaser CanKing GUI Extensions SDK - v7.
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useRecentProjectFiles | Kvaser CanKing GUI Extensions SDK - v7.4.0</title><link rel="icon" href="../assets/favicon.png" type="image/png"/><meta name="description" content="Documentation for Kvaser CanKing GUI Extensions SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Kvaser CanKing GUI Extensions SDK - v7.4.0</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/hooks.html">hooks</a></li><li><a href="" aria-current="page">useRecentProjectFiles</a></li></ul><h1>Function useRecentProjectFiles</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="userecentprojectfiles"><span class="tsd-kind-call-signature">useRecentProjectFiles</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#userecentprojectfiles" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Hook keeping track of recent project files.</p>
|
|
2
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><div class="tsd-comment tsd-typography"></div></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Kvaser CanKing GUI Extensions SDK - v7.4.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p>Copyright KVASER AB 2026</p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useRunningPeriodicTransmissions | Kvaser CanKing GUI Extensions SDK - v7.
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useRunningPeriodicTransmissions | Kvaser CanKing GUI Extensions SDK - v7.4.0</title><link rel="icon" href="../assets/favicon.png" type="image/png"/><meta name="description" content="Documentation for Kvaser CanKing GUI Extensions SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Kvaser CanKing GUI Extensions SDK - v7.4.0</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/hooks.html">hooks</a></li><li><a href="" aria-current="page">useRunningPeriodicTransmissions</a></li></ul><h1>Function useRunningPeriodicTransmissions</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="userunningperiodictransmissions"><span class="tsd-kind-call-signature">useRunningPeriodicTransmissions</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#userunningperiodictransmissions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>A hook for running periodic transmissions.</p>
|
|
2
2
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><p>The running periodic transmissions.</p>
|
|
3
|
-
<div class="tsd-comment tsd-typography"></div></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Kvaser CanKing GUI Extensions SDK - v7.
|
|
3
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Kvaser CanKing GUI Extensions SDK - v7.4.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p>Copyright KVASER AB 2026</p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useScrollModeMeasurementData | Kvaser CanKing GUI Extensions SDK - v7.
|
|
2
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useScrollModeMeasurementData | Kvaser CanKing GUI Extensions SDK - v7.4.0</title><link rel="icon" href="../assets/favicon.png" type="image/png"/><meta name="description" content="Documentation for Kvaser CanKing GUI Extensions SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Kvaser CanKing GUI Extensions SDK - v7.4.0</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/hooks.html">hooks</a></li><li><a href="" aria-current="page">useScrollModeMeasurementData</a></li></ul><h1>Function useScrollModeMeasurementData</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="usescrollmodemeasurementdata"><span class="tsd-kind-call-signature">useScrollModeMeasurementData</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">startUs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/models.Frame.html" class="tsd-signature-type tsd-kind-interface">Frame</a><span class="tsd-signature-symbol">[]</span><a href="#usescrollmodemeasurementdata" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>A hook for scroll mode measurement data. Will return the latest measurement data. Will include at most 500 frames.</p>
|
|
2
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">startUs</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Optional start time (in microseconds) to read from the scroll data buffer. Any frame with a timestamp less than this will be excluded.</p>
|
|
3
3
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/models.Frame.html" class="tsd-signature-type tsd-kind-interface">Frame</a><span class="tsd-signature-symbol">[]</span></h4><p>The measurement data.</p>
|
|
4
|
-
<div class="tsd-comment tsd-typography"></div></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Kvaser CanKing GUI Extensions SDK - v7.
|
|
4
|
+
<div class="tsd-comment tsd-typography"></div></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Kvaser CanKing GUI Extensions SDK - v7.4.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p>Copyright KVASER AB 2026</p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,5 +1,14 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useSessionData | Kvaser CanKing GUI Extensions SDK - v7.
|
|
2
|
-
|
|
3
|
-
</div><
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useSessionData | Kvaser CanKing GUI Extensions SDK - v7.4.0</title><link rel="icon" href="../assets/favicon.png" type="image/png"/><meta name="description" content="Documentation for Kvaser CanKing GUI Extensions SDK"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Kvaser CanKing GUI Extensions SDK - v7.4.0</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/hooks.html">hooks</a></li><li><a href="" aria-current="page">useSessionData</a></li></ul><h1>Function useSessionData</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="usesessiondata"><span class="tsd-kind-call-signature">useSessionData</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#usesessiondatat">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">defaultValue</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#usesessiondatat">T</a> <span class="tsd-signature-symbol">|</span> (<span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#usesessiondatat">T</a>)<span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">loadedCallback</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#usesessiondatat">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">sessionData</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#usesessiondatat">T</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sessionDataIsInitialized</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">setSessionData</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Dispatch</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">SetStateAction</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#usesessiondatat">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span><a href="#usesessiondata" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>A hook for data that should be saved to the session data.
|
|
2
|
+
The state is automatically saved to and restored from the main process.</p>
|
|
3
|
+
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="usesessiondatat"><span class="tsd-kind-type-parameter">T</span></span><div class="tsd-comment tsd-typography"><p>The type of the session data. Must be JSON serializable.</p>
|
|
4
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The unique id of the view. This is passed to the view component as the <code>id</code> prop.</p>
|
|
5
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">defaultValue</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#usesessiondatat">T</a> <span class="tsd-signature-symbol">|</span> (<span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#usesessiondatat">T</a>)</span><div class="tsd-comment tsd-typography"><p>The default value or a function that returns the default value.</p>
|
|
6
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">loadedCallback</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#usesessiondatat">T</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></span><div class="tsd-comment tsd-typography"><p>Optional callback invoked once after data is loaded.</p>
|
|
4
7
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">sessionData</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#usesessiondatat">T</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sessionDataIsInitialized</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">setSessionData</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Dispatch</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">SetStateAction</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#usesessiondatat">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></h4><p>An object with a flag indicating if the session data has been initialized, the current session data and a setter callback.</p>
|
|
5
|
-
<div class="tsd-comment tsd-typography"
|
|
8
|
+
<div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link" id="remarks">Remarks<a href="#remarks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>It's only possible to use this hook once per workspace view component tree.
|
|
9
|
+
Use this hook if your view component only needs to store a small amount of session data.
|
|
10
|
+
For larger amounts of data, consider using <code>useSessionDataSlice</code> instead, which allows
|
|
11
|
+
splitting the session data into multiple named slices.
|
|
12
|
+
Using multiple slices can improve performance and reduce memory usage and it also allows
|
|
13
|
+
different parts of the component tree to independently load and save their session data.</p>
|
|
14
|
+
</div></div></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Kvaser CanKing GUI Extensions SDK - v7.4.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p>Copyright KVASER AB 2026</p></footer><div class="overlay"></div></body></html>
|