@kvaser/canking-api 7.1.0-beta.231
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/EULA.pdf +0 -0
- package/README.md +87 -0
- package/REDISTRIBUTABLES.txt +5 -0
- package/dist/ElectronAPIFake.js +1 -0
- package/dist/ElectronAPIFake.mjs +266 -0
- package/dist/controls/CanChannelSelectControl.d.ts +35 -0
- package/dist/controls/CanIdentifierControl.d.ts +176 -0
- package/dist/controls/CanKingDataProvider.d.ts +116 -0
- package/dist/controls/CheckboxControl.d.ts +30 -0
- package/dist/controls/ContextMenu.d.ts +44 -0
- package/dist/controls/DropdownButton.d.ts +73 -0
- package/dist/controls/DropdownPanel.d.ts +41 -0
- package/dist/controls/FillBox.d.ts +8 -0
- package/dist/controls/FormControlRow.d.ts +30 -0
- package/dist/controls/InlineEditor.d.ts +26 -0
- package/dist/controls/LocalizedStrings.d.ts +21 -0
- package/dist/controls/NumberRangeControl.d.ts +80 -0
- package/dist/controls/OneLineButton.d.ts +9 -0
- package/dist/controls/RadioControl.d.ts +25 -0
- package/dist/controls/RadioGroupControl.d.ts +31 -0
- package/dist/controls/SectionControl.d.ts +40 -0
- package/dist/controls/SelectControl.d.ts +55 -0
- package/dist/controls/SizedBox.d.ts +11 -0
- package/dist/controls/TableControl.d.ts +61 -0
- package/dist/controls/TabsPanel.d.ts +5 -0
- package/dist/controls/TextControl.d.ts +56 -0
- package/dist/controls/ToolbarControl.d.ts +143 -0
- package/dist/controls/ValidateableTextControl.d.ts +82 -0
- package/dist/controls/index.d.ts +103 -0
- package/dist/controls.js +1 -0
- package/dist/controls.mjs +1714 -0
- package/dist/grpc/index.d.ts +7 -0
- package/dist/grpc.js +1 -0
- package/dist/grpc.mjs +917 -0
- package/dist/hooks/index.d.ts +112 -0
- package/dist/hooks.js +1 -0
- package/dist/hooks.mjs +28 -0
- package/dist/icons/index.d.ts +121 -0
- package/dist/icons.js +1 -0
- package/dist/icons.mjs +1237 -0
- package/dist/index.d.ts +6 -0
- package/dist/index.js +1 -0
- package/dist/index.mjs +596 -0
- package/dist/ipc/index.d.ts +160 -0
- package/dist/ipc.js +1 -0
- package/dist/ipc.mjs +123 -0
- package/dist/measurement_settings.js +1 -0
- package/dist/measurement_settings.mjs +4132 -0
- package/dist/models/DataBuffer.d.ts +100 -0
- package/dist/models/ElectronAPIFake.d.ts +13 -0
- package/dist/models/Point.d.ts +30 -0
- package/dist/models/index.d.ts +95 -0
- package/dist/models.js +1 -0
- package/dist/models.mjs +448 -0
- package/dist/protos/app_params.d.ts +208 -0
- package/dist/protos/app_service.d.ts +354 -0
- package/dist/protos/common_params.d.ts +33 -0
- package/dist/protos/device_params.d.ts +271 -0
- package/dist/protos/device_service.d.ts +154 -0
- package/dist/protos/frame_params.d.ts +189 -0
- package/dist/protos/google/protobuf/empty.d.ts +35 -0
- package/dist/protos/measurement_params.d.ts +308 -0
- package/dist/protos/measurement_service.d.ts +1333 -0
- package/dist/protos/measurement_settings.d.ts +453 -0
- package/dist/protos/signal_params.d.ts +72 -0
- package/dist/protos/status_params.d.ts +118 -0
- package/dist/status_params.js +1 -0
- package/dist/status_params.mjs +5045 -0
- package/doc/.nojekyll +1 -0
- package/doc/assets/highlight.css +120 -0
- package/doc/assets/icons.js +18 -0
- package/doc/assets/icons.svg +1 -0
- package/doc/assets/main.js +60 -0
- package/doc/assets/material-style.css +247 -0
- package/doc/assets/navigation.js +1 -0
- package/doc/assets/search.js +1 -0
- package/doc/assets/style.css +1493 -0
- package/doc/classes/controls.LocalizedStrings.html +177 -0
- package/doc/classes/models.DataBuffer.html +205 -0
- package/doc/classes/models.DataBufferView.html +193 -0
- package/doc/classes/models.Point.html +187 -0
- package/doc/enums/models.AccessMode.html +188 -0
- package/doc/enums/models.AppEvent.html +179 -0
- package/doc/enums/models.CanChannelCap.html +217 -0
- package/doc/enums/models.CanFrameFlag.html +200 -0
- package/doc/enums/models.CanMode.html +180 -0
- package/doc/enums/models.DecimalChar.html +178 -0
- package/doc/enums/models.DeviceEvent.html +179 -0
- package/doc/enums/models.FileConflictAction.html +180 -0
- package/doc/enums/models.LinFrameFlag.html +185 -0
- package/doc/enums/models.LogFileFormat.html +221 -0
- package/doc/enums/models.LogLevel.html +195 -0
- package/doc/enums/models.LogReplayState.html +179 -0
- package/doc/enums/models.MeasurementEvent.html +185 -0
- package/doc/enums/models.MessageLoggerState.html +180 -0
- package/doc/enums/models.Protocols.html +182 -0
- package/doc/enums/models.Separator.html +178 -0
- package/doc/enums/models.SignalEncoding.html +178 -0
- package/doc/enums/models.SignalType.html +185 -0
- package/doc/enums/models.SignalValueTriggerOperator.html +186 -0
- package/doc/enums/models.StatusLevel.html +180 -0
- package/doc/enums/models.TimeReference.html +178 -0
- package/doc/enums/models.TriggerOperator.html +179 -0
- package/doc/functions/controls.CanChannelSelectControl.html +177 -0
- package/doc/functions/controls.CanIdentifierControl.html +177 -0
- package/doc/functions/controls.CanIdentifierFrameControl.html +177 -0
- package/doc/functions/controls.CanIdentifierGeneratorControl.html +177 -0
- package/doc/functions/controls.CanIdentifierGeneratorSettingsControl.html +178 -0
- package/doc/functions/controls.CanKingDataProvider.html +182 -0
- package/doc/functions/controls.CheckboxControl.html +177 -0
- package/doc/functions/controls.ContextMenu.html +177 -0
- package/doc/functions/controls.DropdownButton.html +177 -0
- package/doc/functions/controls.DropdownButtonTextItems.html +177 -0
- package/doc/functions/controls.DropdownPanel.html +177 -0
- package/doc/functions/controls.FillBox.html +206 -0
- package/doc/functions/controls.FormControlRow.html +177 -0
- package/doc/functions/controls.InlineEditor.html +177 -0
- package/doc/functions/controls.NumberRangeControl.html +177 -0
- package/doc/functions/controls.OneLineButton.html +205 -0
- package/doc/functions/controls.RadioControl.html +177 -0
- package/doc/functions/controls.RadioGroupControl.html +177 -0
- package/doc/functions/controls.SectionControl.html +177 -0
- package/doc/functions/controls.SelectControl.html +177 -0
- package/doc/functions/controls.SizedBox.html +206 -0
- package/doc/functions/controls.TableControl.html +177 -0
- package/doc/functions/controls.TabsPanel.html +205 -0
- package/doc/functions/controls.TextControl.html +177 -0
- package/doc/functions/controls.ToolbarControl.html +177 -0
- package/doc/functions/controls.ValidateableTextControl.html +177 -0
- package/doc/functions/hooks.useDevices.html +176 -0
- package/doc/functions/hooks.useIsOnline.html +176 -0
- package/doc/functions/hooks.useLanguage.html +176 -0
- package/doc/functions/hooks.useLocalizedStrings.html +176 -0
- package/doc/functions/hooks.useLogMessages.html +176 -0
- package/doc/functions/hooks.useMaxDataBytes.html +175 -0
- package/doc/functions/hooks.useMeasurementSetup.html +176 -0
- package/doc/functions/hooks.useMeasurementStatus.html +176 -0
- package/doc/functions/hooks.useMessageLogFileFormats.html +175 -0
- package/doc/functions/hooks.useNewMeasurementData.html +178 -0
- package/doc/functions/hooks.useNodeStatus.html +176 -0
- package/doc/functions/hooks.useNumericRadix.html +176 -0
- package/doc/functions/hooks.useOnlineStatus.html +176 -0
- package/doc/functions/hooks.useOverallStatusLevel.html +176 -0
- package/doc/functions/hooks.useProjectData.html +178 -0
- package/doc/functions/hooks.useRecentProjectFiles.html +175 -0
- package/doc/functions/hooks.useRunningPeriodicTransmissions.html +176 -0
- package/doc/functions/hooks.useSessionData.html +178 -0
- package/doc/functions/hooks.useUserSettings.html +176 -0
- package/doc/functions/hooks.useWorkspacePaneWithId.html +175 -0
- package/doc/functions/icons.AddIcon.html +175 -0
- package/doc/functions/icons.ArrowDownIcon.html +175 -0
- package/doc/functions/icons.ArrowLeftIcon.html +175 -0
- package/doc/functions/icons.ArrowRightIcon.html +175 -0
- package/doc/functions/icons.ArrowUpIcon.html +175 -0
- package/doc/functions/icons.BusIsOffIcon.html +175 -0
- package/doc/functions/icons.BusIsOnIcon.html +175 -0
- package/doc/functions/icons.CloseIcon.html +175 -0
- package/doc/functions/icons.CopyIcon.html +175 -0
- package/doc/functions/icons.DarkModeIcon.html +175 -0
- package/doc/functions/icons.DeleteIcon.html +175 -0
- package/doc/functions/icons.DisableIcon.html +175 -0
- package/doc/functions/icons.EditIcon.html +175 -0
- package/doc/functions/icons.FilterIcon.html +175 -0
- package/doc/functions/icons.FixedPositionIcon.html +175 -0
- package/doc/functions/icons.LeaveFullScreenIcon.html +175 -0
- package/doc/functions/icons.LightModeIcon.html +175 -0
- package/doc/functions/icons.LineArrowDownIcon.html +175 -0
- package/doc/functions/icons.LineArrowUpIcon.html +175 -0
- package/doc/functions/icons.MaximizeWindowIcon.html +175 -0
- package/doc/functions/icons.MeasurementSetupIcon.html +175 -0
- package/doc/functions/icons.MoreHorizIcon.html +175 -0
- package/doc/functions/icons.MoreVertIcon.html +175 -0
- package/doc/functions/icons.NewIcon.html +175 -0
- package/doc/functions/icons.OpenExternallyIcon.html +175 -0
- package/doc/functions/icons.OpenIcon.html +175 -0
- package/doc/functions/icons.PauseIcon.html +175 -0
- package/doc/functions/icons.PlayIcon.html +175 -0
- package/doc/functions/icons.PlaySolidIcon.html +175 -0
- package/doc/functions/icons.SaveIcon.html +175 -0
- package/doc/functions/icons.SelectAllIcon.html +175 -0
- package/doc/functions/icons.ServiceIconActive.html +175 -0
- package/doc/functions/icons.ServiceIconInactive.html +175 -0
- package/doc/functions/icons.SettingsIcon.html +175 -0
- package/doc/functions/icons.StopIcon.html +175 -0
- package/doc/functions/icons.StopSolidIcon.html +175 -0
- package/doc/functions/icons.ToolsPanelHiddenIcon.html +175 -0
- package/doc/functions/icons.ToolsPanelVisibleIcon.html +175 -0
- package/doc/functions/icons.UnmaximizeWindowIcon.html +175 -0
- package/doc/functions/icons.WorkspacesIcon.html +175 -0
- package/doc/functions/ipc.addDataProcessor.html +178 -0
- package/doc/functions/ipc.addSource.html +176 -0
- package/doc/functions/ipc.addTarget.html +176 -0
- package/doc/functions/ipc.connectNodes.html +177 -0
- package/doc/functions/ipc.deleteDataProcessor.html +176 -0
- package/doc/functions/ipc.deleteSource.html +176 -0
- package/doc/functions/ipc.deleteTarget.html +176 -0
- package/doc/functions/ipc.disableNode.html +176 -0
- package/doc/functions/ipc.disconnectNodes.html +177 -0
- package/doc/functions/ipc.enableNode.html +176 -0
- package/doc/functions/ipc.getFrameDefinitions.html +178 -0
- package/doc/functions/ipc.getLogger.html +177 -0
- package/doc/functions/ipc.getMessageLogFileFormats.html +176 -0
- package/doc/functions/ipc.sendCanMessage.html +179 -0
- package/doc/functions/ipc.sendMessage.html +177 -0
- package/doc/functions/ipc.showMessageBox.html +177 -0
- package/doc/functions/ipc.showQuestionBox.html +183 -0
- package/doc/functions/ipc.startLogReplay.html +176 -0
- package/doc/functions/ipc.startMeasurement.html +175 -0
- package/doc/functions/ipc.startPeriodicTransmission.html +177 -0
- package/doc/functions/ipc.stopLogReplay.html +176 -0
- package/doc/functions/ipc.stopMeasurement.html +175 -0
- package/doc/functions/ipc.stopPeriodicTransmission.html +176 -0
- package/doc/functions/ipc.updateDataProcessor.html +176 -0
- package/doc/functions/ipc.updateSource.html +176 -0
- package/doc/functions/ipc.updateTarget.html +176 -0
- package/doc/functions/models.accessModeFromJSON.html +174 -0
- package/doc/functions/models.accessModeToJSON.html +174 -0
- package/doc/functions/models.appEventFromJSON.html +174 -0
- package/doc/functions/models.appEventToJSON.html +174 -0
- package/doc/functions/models.canChannelCapFromJSON.html +174 -0
- package/doc/functions/models.canChannelCapToJSON.html +174 -0
- package/doc/functions/models.canFrameFlagFromJSON.html +174 -0
- package/doc/functions/models.canFrameFlagToJSON.html +174 -0
- package/doc/functions/models.canModeFromJSON.html +174 -0
- package/doc/functions/models.canModeToJSON.html +174 -0
- package/doc/functions/models.createElectronApiFake.html +177 -0
- package/doc/functions/models.decimalCharFromJSON.html +174 -0
- package/doc/functions/models.decimalCharToJSON.html +174 -0
- package/doc/functions/models.decimalToFixed.html +174 -0
- package/doc/functions/models.decimalToHex.html +174 -0
- package/doc/functions/models.deviceEventFromJSON.html +174 -0
- package/doc/functions/models.deviceEventToJSON.html +174 -0
- package/doc/functions/models.fileConflictActionFromJSON.html +174 -0
- package/doc/functions/models.fileConflictActionToJSON.html +174 -0
- package/doc/functions/models.linFrameFlagFromJSON.html +174 -0
- package/doc/functions/models.linFrameFlagToJSON.html +174 -0
- package/doc/functions/models.logFileFormatFromJSON.html +174 -0
- package/doc/functions/models.logFileFormatToJSON.html +174 -0
- package/doc/functions/models.logLevelFromJSON.html +174 -0
- package/doc/functions/models.logLevelToJSON.html +174 -0
- package/doc/functions/models.logReplayStateFromJSON.html +174 -0
- package/doc/functions/models.logReplayStateToJSON.html +174 -0
- package/doc/functions/models.longToNumber.html +174 -0
- package/doc/functions/models.measurementEventFromJSON.html +174 -0
- package/doc/functions/models.measurementEventToJSON.html +174 -0
- package/doc/functions/models.messageLoggerStateFromJSON.html +174 -0
- package/doc/functions/models.messageLoggerStateToJSON.html +174 -0
- package/doc/functions/models.protocolsFromJSON.html +174 -0
- package/doc/functions/models.protocolsToJSON.html +174 -0
- package/doc/functions/models.separatorFromJSON.html +174 -0
- package/doc/functions/models.separatorToJSON.html +174 -0
- package/doc/functions/models.signalEncodingFromJSON.html +174 -0
- package/doc/functions/models.signalEncodingToJSON.html +174 -0
- package/doc/functions/models.signalTypeFromJSON.html +174 -0
- package/doc/functions/models.signalTypeToJSON.html +174 -0
- package/doc/functions/models.signalValueTriggerOperatorFromJSON.html +174 -0
- package/doc/functions/models.signalValueTriggerOperatorToJSON.html +174 -0
- package/doc/functions/models.statusLevelFromJSON.html +174 -0
- package/doc/functions/models.statusLevelToJSON.html +174 -0
- package/doc/functions/models.timeReferenceFromJSON.html +174 -0
- package/doc/functions/models.timeReferenceToJSON.html +174 -0
- package/doc/functions/models.triggerOperatorFromJSON.html +174 -0
- package/doc/functions/models.triggerOperatorToJSON.html +174 -0
- package/doc/hierarchy.html +174 -0
- package/doc/index.html +244 -0
- package/doc/interfaces/controls.ButtonGroupProps.html +183 -0
- package/doc/interfaces/controls.ButtonProps.html +195 -0
- package/doc/interfaces/controls.CanChannelSelectControlProps.html +194 -0
- package/doc/interfaces/controls.CanIdentifierControlProps.html +195 -0
- package/doc/interfaces/controls.CanIdentifierFrameControlProps.html +190 -0
- package/doc/interfaces/controls.CanIdentifierGeneratorControlProps.html +208 -0
- package/doc/interfaces/controls.CanIdentifierGeneratorSettingsControlProps.html +194 -0
- package/doc/interfaces/controls.CheckboxControlProps.html +190 -0
- package/doc/interfaces/controls.ContextMenuProps.html +182 -0
- package/doc/interfaces/controls.DropdownButtonChildrenProps.html +177 -0
- package/doc/interfaces/controls.DropdownButtonProps.html +193 -0
- package/doc/interfaces/controls.DropdownButtonTextItemsProps.html +183 -0
- package/doc/interfaces/controls.DropdownPanelProps.html +193 -0
- package/doc/interfaces/controls.FormControlRowProps.html +181 -0
- package/doc/interfaces/controls.ILocalizedStrings.html +176 -0
- package/doc/interfaces/controls.InlineEditorProps.html +186 -0
- package/doc/interfaces/controls.LabelProps.html +179 -0
- package/doc/interfaces/controls.NumberRangeControlProps.html +225 -0
- package/doc/interfaces/controls.RadioControlProps.html +187 -0
- package/doc/interfaces/controls.RadioGroupControlProps.html +182 -0
- package/doc/interfaces/controls.SectionControlProps.html +190 -0
- package/doc/interfaces/controls.SelectControlProps.html +205 -0
- package/doc/interfaces/controls.TableColumn.html +185 -0
- package/doc/interfaces/controls.TableControlProps.html +197 -0
- package/doc/interfaces/controls.TextControlProps.html +214 -0
- package/doc/interfaces/controls.ToggleButtonGroupProps.html +190 -0
- package/doc/interfaces/controls.ToggleButtonProps.html +187 -0
- package/doc/interfaces/controls.ToolbarControlProps.html +191 -0
- package/doc/interfaces/controls.ValidateableTextControlProps.html +233 -0
- package/doc/interfaces/controls.toolbarItem.html +185 -0
- package/doc/interfaces/ipc.ILogger.html +181 -0
- package/doc/interfaces/models.AboutInformation.html +181 -0
- package/doc/interfaces/models.ActivateLicenseRequest.html +181 -0
- package/doc/interfaces/models.AddAllConnectedCanChannelsRequest.html +177 -0
- package/doc/interfaces/models.AddAllConnectedLinChannelsRequest.html +177 -0
- package/doc/interfaces/models.AddOrUpdateDataProcessorRequest.html +185 -0
- package/doc/interfaces/models.AddOrUpdateSourceRequest.html +181 -0
- package/doc/interfaces/models.AddOrUpdateTargetRequest.html +181 -0
- package/doc/interfaces/models.ApiPreferences.html +183 -0
- package/doc/interfaces/models.AppEventArgs.html +179 -0
- package/doc/interfaces/models.BaseNodeProperties.html +181 -0
- package/doc/interfaces/models.BusStatus.html +190 -0
- package/doc/interfaces/models.CanBusParamLimits.html +180 -0
- package/doc/interfaces/models.CanBusParams.html +197 -0
- package/doc/interfaces/models.CanBusSpeed.html +187 -0
- package/doc/interfaces/models.CanBusSpeedInfo.html +193 -0
- package/doc/interfaces/models.CanChannelCapacity.html +180 -0
- package/doc/interfaces/models.CanChannelConfiguration.html +185 -0
- package/doc/interfaces/models.CanFDBusSpeedCombination.html +177 -0
- package/doc/interfaces/models.CanFDBusSpeedInfo.html +191 -0
- package/doc/interfaces/models.CanFrameFlags.html +177 -0
- package/doc/interfaces/models.CanMessageFilterSettings.html +178 -0
- package/doc/interfaces/models.Channel.html +180 -0
- package/doc/interfaces/models.ChannelSettings.html +193 -0
- package/doc/interfaces/models.ClearLinMessageRequest.html +180 -0
- package/doc/interfaces/models.ConnectNodesRequest.html +178 -0
- package/doc/interfaces/models.DataProcessingStatus.html +179 -0
- package/doc/interfaces/models.DataProcessorNodeProperties.html +181 -0
- package/doc/interfaces/models.DatabasesSettings.html +176 -0
- package/doc/interfaces/models.Device.html +182 -0
- package/doc/interfaces/models.DeviceEventArgs.html +177 -0
- package/doc/interfaces/models.Devices.html +175 -0
- package/doc/interfaces/models.DisconnectNodesRequest.html +178 -0
- package/doc/interfaces/models.Empty.html +182 -0
- package/doc/interfaces/models.ErrorStatus.html +177 -0
- package/doc/interfaces/models.Frame.html +203 -0
- package/doc/interfaces/models.FrameDefinition.html +185 -0
- package/doc/interfaces/models.FrameDefinitions.html +175 -0
- package/doc/interfaces/models.FramePropertyValue.html +177 -0
- package/doc/interfaces/models.FrameReceivedTrigger.html +179 -0
- package/doc/interfaces/models.Frame_PropertiesEntry.html +176 -0
- package/doc/interfaces/models.Frames.html +175 -0
- package/doc/interfaces/models.GetCanChannelBusSpeedsRequest.html +177 -0
- package/doc/interfaces/models.GetCanChannelBusSpeedsResponse.html +179 -0
- package/doc/interfaces/models.GetCanFdBusSpeedsRequest.html +179 -0
- package/doc/interfaces/models.GetCanFdBusSpeedsResponse.html +177 -0
- package/doc/interfaces/models.GetChannelsFromLogFileRequest.html +178 -0
- package/doc/interfaces/models.GetChannelsFromLogFileResponse.html +177 -0
- package/doc/interfaces/models.GetClassicCanBusSpeedsRequest.html +178 -0
- package/doc/interfaces/models.GetClassicCanBusSpeedsResponse.html +177 -0
- package/doc/interfaces/models.GetDataProcessorResponse.html +176 -0
- package/doc/interfaces/models.GetDevicesRequest.html +177 -0
- package/doc/interfaces/models.GetDevicesResponse.html +176 -0
- package/doc/interfaces/models.GetFrameDefinitionsFromDatabaseFilesRequest.html +178 -0
- package/doc/interfaces/models.GetLicensesResponse.html +177 -0
- package/doc/interfaces/models.GetLogFileFormatsRequest.html +180 -0
- package/doc/interfaces/models.GetLogFileFormatsResponse.html +183 -0
- package/doc/interfaces/models.GetLogLevelResponse.html +177 -0
- package/doc/interfaces/models.GetScheduleTablesFromDatabaseFilesRequest.html +178 -0
- package/doc/interfaces/models.GetScheduleTablesFromDatabaseFilesResponse.html +177 -0
- package/doc/interfaces/models.GetServiceExtensionInfoRequest.html +181 -0
- package/doc/interfaces/models.GetServiceExtensionInfoResponse.html +187 -0
- package/doc/interfaces/models.GetSignalDataFromMessageDataRequest.html +180 -0
- package/doc/interfaces/models.GetSignalDataFromMessageDataResponse.html +177 -0
- package/doc/interfaces/models.GetSourceResponse.html +176 -0
- package/doc/interfaces/models.GetTargetResponse.html +176 -0
- package/doc/interfaces/models.ILogFileFormat.html +179 -0
- package/doc/interfaces/models.IProject.html +179 -0
- package/doc/interfaces/models.IUserSettings.html +187 -0
- package/doc/interfaces/models.IWorkspaceComponentPaneData.html +177 -0
- package/doc/interfaces/models.IWorkspaceContainerPaneData.html +178 -0
- package/doc/interfaces/models.IWorkspaceData.html +178 -0
- package/doc/interfaces/models.IWorkspacePaneData.html +178 -0
- package/doc/interfaces/models.IdentifierRequest.html +178 -0
- package/doc/interfaces/models.IdentifiersRequest.html +178 -0
- package/doc/interfaces/models.InstallServiceExtensionRequest.html +181 -0
- package/doc/interfaces/models.InterpreterSettings.html +177 -0
- package/doc/interfaces/models.J1939InterpreterSettings.html +175 -0
- package/doc/interfaces/models.LicenseInformation.html +191 -0
- package/doc/interfaces/models.Licenses.html +177 -0
- package/doc/interfaces/models.LinChannelConfiguration.html +185 -0
- package/doc/interfaces/models.LinFrameFlags.html +177 -0
- package/doc/interfaces/models.LogMessage.html +185 -0
- package/doc/interfaces/models.LogMessages.html +177 -0
- package/doc/interfaces/models.LogReplaySettings.html +199 -0
- package/doc/interfaces/models.LogReplaySettings_ChannelIdentifiersEntry.html +176 -0
- package/doc/interfaces/models.LogReplayStatus.html +176 -0
- package/doc/interfaces/models.MeasurementEventArgs.html +179 -0
- package/doc/interfaces/models.MeasurementSetup.html +179 -0
- package/doc/interfaces/models.MessageLoggerSettings.html +213 -0
- package/doc/interfaces/models.MessageLoggerStatus.html +176 -0
- package/doc/interfaces/models.NodeStatus.html +191 -0
- package/doc/interfaces/models.NodeStatuses.html +176 -0
- package/doc/interfaces/models.OnlineStatus.html +176 -0
- package/doc/interfaces/models.PeriodicTransmissionSettings.html +209 -0
- package/doc/interfaces/models.RequestLinMessageRequest.html +180 -0
- package/doc/interfaces/models.ScheduleTable.html +181 -0
- package/doc/interfaces/models.ScheduleTableEntry.html +179 -0
- package/doc/interfaces/models.SendLinWakeupFrameRequest.html +182 -0
- package/doc/interfaces/models.SendMessageRequest.html +178 -0
- package/doc/interfaces/models.ServiceExtensionSettings.html +177 -0
- package/doc/interfaces/models.SetLogLevelRequest.html +179 -0
- package/doc/interfaces/models.SetMeasurementSetupRequest.html +177 -0
- package/doc/interfaces/models.SetSignalDataToMessageDataRequest.html +182 -0
- package/doc/interfaces/models.SetSignalDataToMessageDataResponse.html +180 -0
- package/doc/interfaces/models.SignalDefinition.html +188 -0
- package/doc/interfaces/models.SignalDefinition_EnumValuesEntry.html +176 -0
- package/doc/interfaces/models.SignalDefinitions.html +175 -0
- package/doc/interfaces/models.SignalValue.html +180 -0
- package/doc/interfaces/models.SignalValueTrigger.html +189 -0
- package/doc/interfaces/models.SourceNodeProperties.html +180 -0
- package/doc/interfaces/models.StartPeriodicTransmissionRequest.html +178 -0
- package/doc/interfaces/models.StartPeriodicTransmissionResponse.html +176 -0
- package/doc/interfaces/models.TargetNodeProperties.html +178 -0
- package/doc/interfaces/models.TriggerSettings.html +181 -0
- package/doc/interfaces/models.UninstallServiceExtensionRequest.html +179 -0
- package/doc/interfaces/models.UpdateLinMessageRequest.html +181 -0
- package/doc/interfaces/models.WriteFrame.html +183 -0
- package/doc/modules/controls.html +242 -0
- package/doc/modules/hooks.html +201 -0
- package/doc/modules/icons.html +216 -0
- package/doc/modules/ipc.html +202 -0
- package/doc/modules/models.html +478 -0
- package/doc/modules.html +179 -0
- package/doc/types/controls.ContextMenuOption.html +179 -0
- package/doc/types/controls.SelectOption.html +177 -0
- package/doc/types/controls.StringsMap.html +175 -0
- package/doc/types/controls.canIdentifierType.html +175 -0
- package/doc/types/models.IReadOnlyDataBuffer.html +174 -0
- package/doc/types/models.themes.html +174 -0
- package/doc/variables/models.AboutInformation-1.html +174 -0
- package/doc/variables/models.ActivateLicenseRequest-1.html +174 -0
- package/doc/variables/models.AddAllConnectedCanChannelsRequest-1.html +174 -0
- package/doc/variables/models.AddAllConnectedLinChannelsRequest-1.html +174 -0
- package/doc/variables/models.AddOrUpdateDataProcessorRequest-1.html +174 -0
- package/doc/variables/models.AddOrUpdateSourceRequest-1.html +174 -0
- package/doc/variables/models.AddOrUpdateTargetRequest-1.html +174 -0
- package/doc/variables/models.ApiPreferences-1.html +174 -0
- package/doc/variables/models.AppEventArgs-1.html +174 -0
- package/doc/variables/models.BaseNodeProperties-1.html +174 -0
- package/doc/variables/models.BusStatus-1.html +174 -0
- package/doc/variables/models.CanBusParamLimits-1.html +174 -0
- package/doc/variables/models.CanBusParams-1.html +174 -0
- package/doc/variables/models.CanBusSpeed-1.html +174 -0
- package/doc/variables/models.CanBusSpeedInfo-1.html +174 -0
- package/doc/variables/models.CanChannelCapacity-1.html +174 -0
- package/doc/variables/models.CanChannelConfiguration-1.html +174 -0
- package/doc/variables/models.CanFDBusSpeedCombination-1.html +174 -0
- package/doc/variables/models.CanFDBusSpeedInfo-1.html +174 -0
- package/doc/variables/models.CanFrameFlags-1.html +174 -0
- package/doc/variables/models.CanMessageFilterSettings-1.html +174 -0
- package/doc/variables/models.Channel-1.html +174 -0
- package/doc/variables/models.ChannelSettings-1.html +174 -0
- package/doc/variables/models.ClearLinMessageRequest-1.html +174 -0
- package/doc/variables/models.ConnectNodesRequest-1.html +174 -0
- package/doc/variables/models.DataProcessingStatus-1.html +174 -0
- package/doc/variables/models.DataProcessorNodeProperties-1.html +174 -0
- package/doc/variables/models.DatabasesSettings-1.html +174 -0
- package/doc/variables/models.Device-1.html +174 -0
- package/doc/variables/models.DeviceEventArgs-1.html +174 -0
- package/doc/variables/models.Devices-1.html +174 -0
- package/doc/variables/models.DisconnectNodesRequest-1.html +174 -0
- package/doc/variables/models.Empty-1.html +174 -0
- package/doc/variables/models.ErrorStatus-1.html +174 -0
- package/doc/variables/models.Frame-1.html +174 -0
- package/doc/variables/models.FrameDefinition-1.html +174 -0
- package/doc/variables/models.FrameDefinitions-1.html +174 -0
- package/doc/variables/models.FramePropertyValue-1.html +174 -0
- package/doc/variables/models.FrameReceivedTrigger-1.html +174 -0
- package/doc/variables/models.Frame_PropertiesEntry-1.html +174 -0
- package/doc/variables/models.Frames-1.html +174 -0
- package/doc/variables/models.GetCanChannelBusSpeedsRequest-1.html +174 -0
- package/doc/variables/models.GetCanChannelBusSpeedsResponse-1.html +174 -0
- package/doc/variables/models.GetCanFdBusSpeedsRequest-1.html +174 -0
- package/doc/variables/models.GetCanFdBusSpeedsResponse-1.html +174 -0
- package/doc/variables/models.GetChannelsFromLogFileRequest-1.html +174 -0
- package/doc/variables/models.GetChannelsFromLogFileResponse-1.html +174 -0
- package/doc/variables/models.GetClassicCanBusSpeedsRequest-1.html +174 -0
- package/doc/variables/models.GetClassicCanBusSpeedsResponse-1.html +174 -0
- package/doc/variables/models.GetDataProcessorResponse-1.html +174 -0
- package/doc/variables/models.GetDevicesRequest-1.html +174 -0
- package/doc/variables/models.GetDevicesResponse-1.html +174 -0
- package/doc/variables/models.GetFrameDefinitionsFromDatabaseFilesRequest-1.html +174 -0
- package/doc/variables/models.GetLicensesResponse-1.html +174 -0
- package/doc/variables/models.GetLogFileFormatsRequest-1.html +174 -0
- package/doc/variables/models.GetLogFileFormatsResponse-1.html +174 -0
- package/doc/variables/models.GetLogLevelResponse-1.html +174 -0
- package/doc/variables/models.GetScheduleTablesFromDatabaseFilesRequest-1.html +174 -0
- package/doc/variables/models.GetScheduleTablesFromDatabaseFilesResponse-1.html +174 -0
- package/doc/variables/models.GetServiceExtensionInfoRequest-1.html +174 -0
- package/doc/variables/models.GetServiceExtensionInfoResponse-1.html +174 -0
- package/doc/variables/models.GetSignalDataFromMessageDataRequest-1.html +174 -0
- package/doc/variables/models.GetSignalDataFromMessageDataResponse-1.html +174 -0
- package/doc/variables/models.GetSourceResponse-1.html +174 -0
- package/doc/variables/models.GetTargetResponse-1.html +174 -0
- package/doc/variables/models.IdentifierRequest-1.html +174 -0
- package/doc/variables/models.IdentifiersRequest-1.html +174 -0
- package/doc/variables/models.InstallServiceExtensionRequest-1.html +174 -0
- package/doc/variables/models.InterpreterSettings-1.html +174 -0
- package/doc/variables/models.J1939InterpreterSettings-1.html +174 -0
- package/doc/variables/models.LicenseInformation-1.html +174 -0
- package/doc/variables/models.Licenses-1.html +174 -0
- package/doc/variables/models.LinChannelConfiguration-1.html +174 -0
- package/doc/variables/models.LinFrameFlags-1.html +174 -0
- package/doc/variables/models.LogMessage-1.html +174 -0
- package/doc/variables/models.LogMessages-1.html +174 -0
- package/doc/variables/models.LogReplaySettings-1.html +174 -0
- package/doc/variables/models.LogReplaySettings_ChannelIdentifiersEntry-1.html +174 -0
- package/doc/variables/models.LogReplayStatus-1.html +174 -0
- package/doc/variables/models.MeasurementEventArgs-1.html +174 -0
- package/doc/variables/models.MeasurementSetup-1.html +174 -0
- package/doc/variables/models.MessageLoggerSettings-1.html +174 -0
- package/doc/variables/models.MessageLoggerStatus-1.html +174 -0
- package/doc/variables/models.NodeStatus-1.html +174 -0
- package/doc/variables/models.NodeStatuses-1.html +174 -0
- package/doc/variables/models.OnlineStatus-1.html +174 -0
- package/doc/variables/models.PeriodicTransmissionSettings-1.html +174 -0
- package/doc/variables/models.RequestLinMessageRequest-1.html +174 -0
- package/doc/variables/models.ScheduleTable-1.html +174 -0
- package/doc/variables/models.ScheduleTableEntry-1.html +174 -0
- package/doc/variables/models.SendLinWakeupFrameRequest-1.html +174 -0
- package/doc/variables/models.SendMessageRequest-1.html +174 -0
- package/doc/variables/models.ServiceExtensionSettings-1.html +174 -0
- package/doc/variables/models.SetLogLevelRequest-1.html +174 -0
- package/doc/variables/models.SetMeasurementSetupRequest-1.html +174 -0
- package/doc/variables/models.SetSignalDataToMessageDataRequest-1.html +174 -0
- package/doc/variables/models.SetSignalDataToMessageDataResponse-1.html +174 -0
- package/doc/variables/models.SignalDefinition-1.html +174 -0
- package/doc/variables/models.SignalDefinition_EnumValuesEntry-1.html +174 -0
- package/doc/variables/models.SignalDefinitions-1.html +174 -0
- package/doc/variables/models.SignalValue-1.html +174 -0
- package/doc/variables/models.SignalValueTrigger-1.html +174 -0
- package/doc/variables/models.SourceNodeProperties-1.html +174 -0
- package/doc/variables/models.StartPeriodicTransmissionRequest-1.html +174 -0
- package/doc/variables/models.StartPeriodicTransmissionResponse-1.html +174 -0
- package/doc/variables/models.TargetNodeProperties-1.html +174 -0
- package/doc/variables/models.TriggerSettings-1.html +174 -0
- package/doc/variables/models.UninstallServiceExtensionRequest-1.html +174 -0
- package/doc/variables/models.UpdateLinMessageRequest-1.html +174 -0
- package/doc/variables/models.WriteFrame-1.html +174 -0
- package/doc/variables/models.defaultUserSettings.html +175 -0
- package/package.json +129 -0
- package/scripts/createCanKingExtension.js +403 -0
- package/scripts/index.js +39 -0
- package/scripts/template/_.eslintrc.cjs +38 -0
- package/scripts/template/_.gitignore +24 -0
- package/scripts/template/_.npmrc +2 -0
- package/scripts/template/_.prettierrc +8 -0
- package/scripts/template/_.vscode/_launch.json +28 -0
- package/scripts/template/_index.html +15 -0
- package/scripts/template/_tsconfig.app.json +27 -0
- package/scripts/template/_tsconfig.json +11 -0
- package/scripts/template/_tsconfig.node.json +13 -0
- package/scripts/template/_vite.config.ts +7 -0
- package/scripts/template/src/App.tsx +12 -0
- package/scripts/template/src/WorkspaceView/index.tsx +47 -0
- package/scripts/template/src/main.css +9 -0
- package/scripts/template/src/main.tsx +19 -0
- package/scripts/template/src/vite-env.d.ts +1 -0
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useOnlineStatus | Kvaser CanKing GUI Extensions SDK</title><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><style>
|
|
2
|
+
@media (prefers-color-scheme: dark) {
|
|
3
|
+
:root {
|
|
4
|
+
--md-sys-color-primary: #60d4fe;
|
|
5
|
+
--md-sys-color-on-primary: #003545;
|
|
6
|
+
--md-sys-color-primary-container: #004d62;
|
|
7
|
+
--md-sys-color-on-primary-container: #baeaff;
|
|
8
|
+
--md-sys-color-secondary: #b4cad5;
|
|
9
|
+
--md-sys-color-on-secondary: #1e333c;
|
|
10
|
+
--md-sys-color-secondary-container: #354a53;
|
|
11
|
+
--md-sys-color-on-secondary-container: #cfe6f1;
|
|
12
|
+
--md-sys-color-tertiary: #c4c3ea;
|
|
13
|
+
--md-sys-color-on-tertiary: #2d2d4d;
|
|
14
|
+
--md-sys-color-tertiary-container: #444465;
|
|
15
|
+
--md-sys-color-on-tertiary-container: #e2dfff;
|
|
16
|
+
--md-sys-color-error: #ffb4ab;
|
|
17
|
+
--md-sys-color-on-error: #690005;
|
|
18
|
+
--md-sys-color-error-container: #93000a;
|
|
19
|
+
--md-sys-color-on-error-container: #ffb4ab;
|
|
20
|
+
--md-sys-color-background: #191c1e;
|
|
21
|
+
--md-sys-color-on-background: #e1e3e4;
|
|
22
|
+
--md-sys-color-surface: #191c1e;
|
|
23
|
+
--md-sys-color-on-surface: #e1e3e4;
|
|
24
|
+
--md-sys-color-surface-variant: #40484c;
|
|
25
|
+
--md-sys-color-on-surface-variant: #c0c8cc;
|
|
26
|
+
--md-sys-color-outline: #8a9296;
|
|
27
|
+
--md-sys-color-outline-variant: #40484c;
|
|
28
|
+
--md-sys-color-shadow: #000000;
|
|
29
|
+
--md-sys-color-scrim: #000000;
|
|
30
|
+
--md-sys-color-inverse-surface: #e1e3e4;
|
|
31
|
+
--md-sys-color-inverse-on-surface: #2e3132;
|
|
32
|
+
--md-sys-color-inverse-primary: #006782;
|
|
33
|
+
--md-sys-color-surface-dim: #111415;
|
|
34
|
+
--md-sys-color-surface-bright: #373a3b;
|
|
35
|
+
--md-sys-color-surface-container-lowest: #0c0f10;
|
|
36
|
+
--md-sys-color-surface-container-low: #191c1e;
|
|
37
|
+
--md-sys-color-surface-container: #1d2022;
|
|
38
|
+
--md-sys-color-surface-container-high: #272a2c;
|
|
39
|
+
--md-sys-color-surface-container-highest: #323537
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
:root[data-theme="dark"] {
|
|
43
|
+
--md-sys-color-primary: #60d4fe;
|
|
44
|
+
--md-sys-color-on-primary: #003545;
|
|
45
|
+
--md-sys-color-primary-container: #004d62;
|
|
46
|
+
--md-sys-color-on-primary-container: #baeaff;
|
|
47
|
+
--md-sys-color-secondary: #b4cad5;
|
|
48
|
+
--md-sys-color-on-secondary: #1e333c;
|
|
49
|
+
--md-sys-color-secondary-container: #354a53;
|
|
50
|
+
--md-sys-color-on-secondary-container: #cfe6f1;
|
|
51
|
+
--md-sys-color-tertiary: #c4c3ea;
|
|
52
|
+
--md-sys-color-on-tertiary: #2d2d4d;
|
|
53
|
+
--md-sys-color-tertiary-container: #444465;
|
|
54
|
+
--md-sys-color-on-tertiary-container: #e2dfff;
|
|
55
|
+
--md-sys-color-error: #ffb4ab;
|
|
56
|
+
--md-sys-color-on-error: #690005;
|
|
57
|
+
--md-sys-color-error-container: #93000a;
|
|
58
|
+
--md-sys-color-on-error-container: #ffb4ab;
|
|
59
|
+
--md-sys-color-background: #191c1e;
|
|
60
|
+
--md-sys-color-on-background: #e1e3e4;
|
|
61
|
+
--md-sys-color-surface: #191c1e;
|
|
62
|
+
--md-sys-color-on-surface: #e1e3e4;
|
|
63
|
+
--md-sys-color-surface-variant: #40484c;
|
|
64
|
+
--md-sys-color-on-surface-variant: #c0c8cc;
|
|
65
|
+
--md-sys-color-outline: #8a9296;
|
|
66
|
+
--md-sys-color-outline-variant: #40484c;
|
|
67
|
+
--md-sys-color-shadow: #000000;
|
|
68
|
+
--md-sys-color-scrim: #000000;
|
|
69
|
+
--md-sys-color-inverse-surface: #e1e3e4;
|
|
70
|
+
--md-sys-color-inverse-on-surface: #2e3132;
|
|
71
|
+
--md-sys-color-inverse-primary: #006782;
|
|
72
|
+
--md-sys-color-surface-dim: #111415;
|
|
73
|
+
--md-sys-color-surface-bright: #373a3b;
|
|
74
|
+
--md-sys-color-surface-container-lowest: #0c0f10;
|
|
75
|
+
--md-sys-color-surface-container-low: #191c1e;
|
|
76
|
+
--md-sys-color-surface-container: #1d2022;
|
|
77
|
+
--md-sys-color-surface-container-high: #272a2c;
|
|
78
|
+
--md-sys-color-surface-container-highest: #323537
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
@media (prefers-color-scheme: light) {
|
|
82
|
+
:root {
|
|
83
|
+
--md-sys-color-primary: #006782;
|
|
84
|
+
--md-sys-color-on-primary: #ffffff;
|
|
85
|
+
--md-sys-color-primary-container: #baeaff;
|
|
86
|
+
--md-sys-color-on-primary-container: #001f29;
|
|
87
|
+
--md-sys-color-secondary: #4c616b;
|
|
88
|
+
--md-sys-color-on-secondary: #ffffff;
|
|
89
|
+
--md-sys-color-secondary-container: #cfe6f1;
|
|
90
|
+
--md-sys-color-on-secondary-container: #071e26;
|
|
91
|
+
--md-sys-color-tertiary: #5c5b7e;
|
|
92
|
+
--md-sys-color-on-tertiary: #ffffff;
|
|
93
|
+
--md-sys-color-tertiary-container: #e2dfff;
|
|
94
|
+
--md-sys-color-on-tertiary-container: #181837;
|
|
95
|
+
--md-sys-color-error: #ba1a1a;
|
|
96
|
+
--md-sys-color-on-error: #ffffff;
|
|
97
|
+
--md-sys-color-error-container: #ffdad6;
|
|
98
|
+
--md-sys-color-on-error-container: #410002;
|
|
99
|
+
--md-sys-color-background: #fbfcfe;
|
|
100
|
+
--md-sys-color-on-background: #191c1e;
|
|
101
|
+
--md-sys-color-surface: #fbfcfe;
|
|
102
|
+
--md-sys-color-on-surface: #191c1e;
|
|
103
|
+
--md-sys-color-surface-variant: #dce4e8;
|
|
104
|
+
--md-sys-color-on-surface-variant: #40484c;
|
|
105
|
+
--md-sys-color-outline: #70787d;
|
|
106
|
+
--md-sys-color-outline-variant: #c0c8cc;
|
|
107
|
+
--md-sys-color-shadow: #000000;
|
|
108
|
+
--md-sys-color-scrim: #000000;
|
|
109
|
+
--md-sys-color-inverse-surface: #2e3132;
|
|
110
|
+
--md-sys-color-inverse-on-surface: #eff1f3;
|
|
111
|
+
--md-sys-color-inverse-primary: #60d4fe;
|
|
112
|
+
--md-sys-color-surface-dim: #d8dadc;
|
|
113
|
+
--md-sys-color-surface-bright: #f8f9fb;
|
|
114
|
+
--md-sys-color-surface-container-lowest: #ffffff;
|
|
115
|
+
--md-sys-color-surface-container-low: #f2f4f5;
|
|
116
|
+
--md-sys-color-surface-container: #eceef0;
|
|
117
|
+
--md-sys-color-surface-container-high: #e7e8ea;
|
|
118
|
+
--md-sys-color-surface-container-highest: #e1e3e4
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
:root[data-theme="light"] {
|
|
122
|
+
--md-sys-color-primary: #006782;
|
|
123
|
+
--md-sys-color-on-primary: #ffffff;
|
|
124
|
+
--md-sys-color-primary-container: #baeaff;
|
|
125
|
+
--md-sys-color-on-primary-container: #001f29;
|
|
126
|
+
--md-sys-color-secondary: #4c616b;
|
|
127
|
+
--md-sys-color-on-secondary: #ffffff;
|
|
128
|
+
--md-sys-color-secondary-container: #cfe6f1;
|
|
129
|
+
--md-sys-color-on-secondary-container: #071e26;
|
|
130
|
+
--md-sys-color-tertiary: #5c5b7e;
|
|
131
|
+
--md-sys-color-on-tertiary: #ffffff;
|
|
132
|
+
--md-sys-color-tertiary-container: #e2dfff;
|
|
133
|
+
--md-sys-color-on-tertiary-container: #181837;
|
|
134
|
+
--md-sys-color-error: #ba1a1a;
|
|
135
|
+
--md-sys-color-on-error: #ffffff;
|
|
136
|
+
--md-sys-color-error-container: #ffdad6;
|
|
137
|
+
--md-sys-color-on-error-container: #410002;
|
|
138
|
+
--md-sys-color-background: #fbfcfe;
|
|
139
|
+
--md-sys-color-on-background: #191c1e;
|
|
140
|
+
--md-sys-color-surface: #fbfcfe;
|
|
141
|
+
--md-sys-color-on-surface: #191c1e;
|
|
142
|
+
--md-sys-color-surface-variant: #dce4e8;
|
|
143
|
+
--md-sys-color-on-surface-variant: #40484c;
|
|
144
|
+
--md-sys-color-outline: #70787d;
|
|
145
|
+
--md-sys-color-outline-variant: #c0c8cc;
|
|
146
|
+
--md-sys-color-shadow: #000000;
|
|
147
|
+
--md-sys-color-scrim: #000000;
|
|
148
|
+
--md-sys-color-inverse-surface: #2e3132;
|
|
149
|
+
--md-sys-color-inverse-on-surface: #eff1f3;
|
|
150
|
+
--md-sys-color-inverse-primary: #60d4fe;
|
|
151
|
+
--md-sys-color-surface-dim: #d8dadc;
|
|
152
|
+
--md-sys-color-surface-bright: #f8f9fb;
|
|
153
|
+
--md-sys-color-surface-container-lowest: #ffffff;
|
|
154
|
+
--md-sys-color-surface-container-low: #f2f4f5;
|
|
155
|
+
--md-sys-color-surface-container: #eceef0;
|
|
156
|
+
--md-sys-color-surface-container-high: #e7e8ea;
|
|
157
|
+
--md-sys-color-surface-container-highest: #e1e3e4
|
|
158
|
+
}
|
|
159
|
+
</style><link rel="stylesheet" href="../assets/material-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Kvaser CanKing GUI Extensions SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Kvaser CanKing GUI Extensions SDK</a></li><li><a href="../modules/hooks.html">hooks</a></li><li><a href="hooks.useOnlineStatus.html">useOnlineStatus</a></li></ul><h1>Function useOnlineStatus</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A hook for online status.</p>
|
|
160
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useOnlineStatus" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Online<wbr/>Status</span><span class="tsd-signature-symbol">(</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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><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>
|
|
161
|
+
<div class="tsd-comment tsd-typography"></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"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>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"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Kvaser CanKing GUI Extensions SDK</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p>Copyright KVASER AB 2024</p></footer><div class="overlay"></div><script>
|
|
162
|
+
try {
|
|
163
|
+
const generateLinkElement = document.querySelector(".tsd-generator a");
|
|
164
|
+
const link = document.createElement("a");
|
|
165
|
+
Object.assign(link, {
|
|
166
|
+
href: "https://github.com/dmnsgn/typedoc-material-theme",
|
|
167
|
+
target: "_blank",
|
|
168
|
+
rel: "noreferrer",
|
|
169
|
+
innerText: "typedoc-material-theme."
|
|
170
|
+
});
|
|
171
|
+
generateLinkElement.insertAdjacentElement("afterend", link);
|
|
172
|
+
generateLinkElement.insertAdjacentText("afterend", " with ");
|
|
173
|
+
} catch (error) {
|
|
174
|
+
|
|
175
|
+
}
|
|
176
|
+
</script></body></html>
|
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useOverallStatusLevel | Kvaser CanKing GUI Extensions SDK</title><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><style>
|
|
2
|
+
@media (prefers-color-scheme: dark) {
|
|
3
|
+
:root {
|
|
4
|
+
--md-sys-color-primary: #60d4fe;
|
|
5
|
+
--md-sys-color-on-primary: #003545;
|
|
6
|
+
--md-sys-color-primary-container: #004d62;
|
|
7
|
+
--md-sys-color-on-primary-container: #baeaff;
|
|
8
|
+
--md-sys-color-secondary: #b4cad5;
|
|
9
|
+
--md-sys-color-on-secondary: #1e333c;
|
|
10
|
+
--md-sys-color-secondary-container: #354a53;
|
|
11
|
+
--md-sys-color-on-secondary-container: #cfe6f1;
|
|
12
|
+
--md-sys-color-tertiary: #c4c3ea;
|
|
13
|
+
--md-sys-color-on-tertiary: #2d2d4d;
|
|
14
|
+
--md-sys-color-tertiary-container: #444465;
|
|
15
|
+
--md-sys-color-on-tertiary-container: #e2dfff;
|
|
16
|
+
--md-sys-color-error: #ffb4ab;
|
|
17
|
+
--md-sys-color-on-error: #690005;
|
|
18
|
+
--md-sys-color-error-container: #93000a;
|
|
19
|
+
--md-sys-color-on-error-container: #ffb4ab;
|
|
20
|
+
--md-sys-color-background: #191c1e;
|
|
21
|
+
--md-sys-color-on-background: #e1e3e4;
|
|
22
|
+
--md-sys-color-surface: #191c1e;
|
|
23
|
+
--md-sys-color-on-surface: #e1e3e4;
|
|
24
|
+
--md-sys-color-surface-variant: #40484c;
|
|
25
|
+
--md-sys-color-on-surface-variant: #c0c8cc;
|
|
26
|
+
--md-sys-color-outline: #8a9296;
|
|
27
|
+
--md-sys-color-outline-variant: #40484c;
|
|
28
|
+
--md-sys-color-shadow: #000000;
|
|
29
|
+
--md-sys-color-scrim: #000000;
|
|
30
|
+
--md-sys-color-inverse-surface: #e1e3e4;
|
|
31
|
+
--md-sys-color-inverse-on-surface: #2e3132;
|
|
32
|
+
--md-sys-color-inverse-primary: #006782;
|
|
33
|
+
--md-sys-color-surface-dim: #111415;
|
|
34
|
+
--md-sys-color-surface-bright: #373a3b;
|
|
35
|
+
--md-sys-color-surface-container-lowest: #0c0f10;
|
|
36
|
+
--md-sys-color-surface-container-low: #191c1e;
|
|
37
|
+
--md-sys-color-surface-container: #1d2022;
|
|
38
|
+
--md-sys-color-surface-container-high: #272a2c;
|
|
39
|
+
--md-sys-color-surface-container-highest: #323537
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
:root[data-theme="dark"] {
|
|
43
|
+
--md-sys-color-primary: #60d4fe;
|
|
44
|
+
--md-sys-color-on-primary: #003545;
|
|
45
|
+
--md-sys-color-primary-container: #004d62;
|
|
46
|
+
--md-sys-color-on-primary-container: #baeaff;
|
|
47
|
+
--md-sys-color-secondary: #b4cad5;
|
|
48
|
+
--md-sys-color-on-secondary: #1e333c;
|
|
49
|
+
--md-sys-color-secondary-container: #354a53;
|
|
50
|
+
--md-sys-color-on-secondary-container: #cfe6f1;
|
|
51
|
+
--md-sys-color-tertiary: #c4c3ea;
|
|
52
|
+
--md-sys-color-on-tertiary: #2d2d4d;
|
|
53
|
+
--md-sys-color-tertiary-container: #444465;
|
|
54
|
+
--md-sys-color-on-tertiary-container: #e2dfff;
|
|
55
|
+
--md-sys-color-error: #ffb4ab;
|
|
56
|
+
--md-sys-color-on-error: #690005;
|
|
57
|
+
--md-sys-color-error-container: #93000a;
|
|
58
|
+
--md-sys-color-on-error-container: #ffb4ab;
|
|
59
|
+
--md-sys-color-background: #191c1e;
|
|
60
|
+
--md-sys-color-on-background: #e1e3e4;
|
|
61
|
+
--md-sys-color-surface: #191c1e;
|
|
62
|
+
--md-sys-color-on-surface: #e1e3e4;
|
|
63
|
+
--md-sys-color-surface-variant: #40484c;
|
|
64
|
+
--md-sys-color-on-surface-variant: #c0c8cc;
|
|
65
|
+
--md-sys-color-outline: #8a9296;
|
|
66
|
+
--md-sys-color-outline-variant: #40484c;
|
|
67
|
+
--md-sys-color-shadow: #000000;
|
|
68
|
+
--md-sys-color-scrim: #000000;
|
|
69
|
+
--md-sys-color-inverse-surface: #e1e3e4;
|
|
70
|
+
--md-sys-color-inverse-on-surface: #2e3132;
|
|
71
|
+
--md-sys-color-inverse-primary: #006782;
|
|
72
|
+
--md-sys-color-surface-dim: #111415;
|
|
73
|
+
--md-sys-color-surface-bright: #373a3b;
|
|
74
|
+
--md-sys-color-surface-container-lowest: #0c0f10;
|
|
75
|
+
--md-sys-color-surface-container-low: #191c1e;
|
|
76
|
+
--md-sys-color-surface-container: #1d2022;
|
|
77
|
+
--md-sys-color-surface-container-high: #272a2c;
|
|
78
|
+
--md-sys-color-surface-container-highest: #323537
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
@media (prefers-color-scheme: light) {
|
|
82
|
+
:root {
|
|
83
|
+
--md-sys-color-primary: #006782;
|
|
84
|
+
--md-sys-color-on-primary: #ffffff;
|
|
85
|
+
--md-sys-color-primary-container: #baeaff;
|
|
86
|
+
--md-sys-color-on-primary-container: #001f29;
|
|
87
|
+
--md-sys-color-secondary: #4c616b;
|
|
88
|
+
--md-sys-color-on-secondary: #ffffff;
|
|
89
|
+
--md-sys-color-secondary-container: #cfe6f1;
|
|
90
|
+
--md-sys-color-on-secondary-container: #071e26;
|
|
91
|
+
--md-sys-color-tertiary: #5c5b7e;
|
|
92
|
+
--md-sys-color-on-tertiary: #ffffff;
|
|
93
|
+
--md-sys-color-tertiary-container: #e2dfff;
|
|
94
|
+
--md-sys-color-on-tertiary-container: #181837;
|
|
95
|
+
--md-sys-color-error: #ba1a1a;
|
|
96
|
+
--md-sys-color-on-error: #ffffff;
|
|
97
|
+
--md-sys-color-error-container: #ffdad6;
|
|
98
|
+
--md-sys-color-on-error-container: #410002;
|
|
99
|
+
--md-sys-color-background: #fbfcfe;
|
|
100
|
+
--md-sys-color-on-background: #191c1e;
|
|
101
|
+
--md-sys-color-surface: #fbfcfe;
|
|
102
|
+
--md-sys-color-on-surface: #191c1e;
|
|
103
|
+
--md-sys-color-surface-variant: #dce4e8;
|
|
104
|
+
--md-sys-color-on-surface-variant: #40484c;
|
|
105
|
+
--md-sys-color-outline: #70787d;
|
|
106
|
+
--md-sys-color-outline-variant: #c0c8cc;
|
|
107
|
+
--md-sys-color-shadow: #000000;
|
|
108
|
+
--md-sys-color-scrim: #000000;
|
|
109
|
+
--md-sys-color-inverse-surface: #2e3132;
|
|
110
|
+
--md-sys-color-inverse-on-surface: #eff1f3;
|
|
111
|
+
--md-sys-color-inverse-primary: #60d4fe;
|
|
112
|
+
--md-sys-color-surface-dim: #d8dadc;
|
|
113
|
+
--md-sys-color-surface-bright: #f8f9fb;
|
|
114
|
+
--md-sys-color-surface-container-lowest: #ffffff;
|
|
115
|
+
--md-sys-color-surface-container-low: #f2f4f5;
|
|
116
|
+
--md-sys-color-surface-container: #eceef0;
|
|
117
|
+
--md-sys-color-surface-container-high: #e7e8ea;
|
|
118
|
+
--md-sys-color-surface-container-highest: #e1e3e4
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
:root[data-theme="light"] {
|
|
122
|
+
--md-sys-color-primary: #006782;
|
|
123
|
+
--md-sys-color-on-primary: #ffffff;
|
|
124
|
+
--md-sys-color-primary-container: #baeaff;
|
|
125
|
+
--md-sys-color-on-primary-container: #001f29;
|
|
126
|
+
--md-sys-color-secondary: #4c616b;
|
|
127
|
+
--md-sys-color-on-secondary: #ffffff;
|
|
128
|
+
--md-sys-color-secondary-container: #cfe6f1;
|
|
129
|
+
--md-sys-color-on-secondary-container: #071e26;
|
|
130
|
+
--md-sys-color-tertiary: #5c5b7e;
|
|
131
|
+
--md-sys-color-on-tertiary: #ffffff;
|
|
132
|
+
--md-sys-color-tertiary-container: #e2dfff;
|
|
133
|
+
--md-sys-color-on-tertiary-container: #181837;
|
|
134
|
+
--md-sys-color-error: #ba1a1a;
|
|
135
|
+
--md-sys-color-on-error: #ffffff;
|
|
136
|
+
--md-sys-color-error-container: #ffdad6;
|
|
137
|
+
--md-sys-color-on-error-container: #410002;
|
|
138
|
+
--md-sys-color-background: #fbfcfe;
|
|
139
|
+
--md-sys-color-on-background: #191c1e;
|
|
140
|
+
--md-sys-color-surface: #fbfcfe;
|
|
141
|
+
--md-sys-color-on-surface: #191c1e;
|
|
142
|
+
--md-sys-color-surface-variant: #dce4e8;
|
|
143
|
+
--md-sys-color-on-surface-variant: #40484c;
|
|
144
|
+
--md-sys-color-outline: #70787d;
|
|
145
|
+
--md-sys-color-outline-variant: #c0c8cc;
|
|
146
|
+
--md-sys-color-shadow: #000000;
|
|
147
|
+
--md-sys-color-scrim: #000000;
|
|
148
|
+
--md-sys-color-inverse-surface: #2e3132;
|
|
149
|
+
--md-sys-color-inverse-on-surface: #eff1f3;
|
|
150
|
+
--md-sys-color-inverse-primary: #60d4fe;
|
|
151
|
+
--md-sys-color-surface-dim: #d8dadc;
|
|
152
|
+
--md-sys-color-surface-bright: #f8f9fb;
|
|
153
|
+
--md-sys-color-surface-container-lowest: #ffffff;
|
|
154
|
+
--md-sys-color-surface-container-low: #f2f4f5;
|
|
155
|
+
--md-sys-color-surface-container: #eceef0;
|
|
156
|
+
--md-sys-color-surface-container-high: #e7e8ea;
|
|
157
|
+
--md-sys-color-surface-container-highest: #e1e3e4
|
|
158
|
+
}
|
|
159
|
+
</style><link rel="stylesheet" href="../assets/material-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Kvaser CanKing GUI Extensions SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Kvaser CanKing GUI Extensions SDK</a></li><li><a href="../modules/hooks.html">hooks</a></li><li><a href="hooks.useOverallStatusLevel.html">useOverallStatusLevel</a></li></ul><h1>Function useOverallStatusLevel</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Hook to get the measurement's highest overall status level.</p>
|
|
160
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useOverallStatusLevel" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Overall<wbr/>Status<wbr/>Level</span><span class="tsd-signature-symbol">(</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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><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>
|
|
161
|
+
<div class="tsd-comment tsd-typography"></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"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>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"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Kvaser CanKing GUI Extensions SDK</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p>Copyright KVASER AB 2024</p></footer><div class="overlay"></div><script>
|
|
162
|
+
try {
|
|
163
|
+
const generateLinkElement = document.querySelector(".tsd-generator a");
|
|
164
|
+
const link = document.createElement("a");
|
|
165
|
+
Object.assign(link, {
|
|
166
|
+
href: "https://github.com/dmnsgn/typedoc-material-theme",
|
|
167
|
+
target: "_blank",
|
|
168
|
+
rel: "noreferrer",
|
|
169
|
+
innerText: "typedoc-material-theme."
|
|
170
|
+
});
|
|
171
|
+
generateLinkElement.insertAdjacentElement("afterend", link);
|
|
172
|
+
generateLinkElement.insertAdjacentText("afterend", " with ");
|
|
173
|
+
} catch (error) {
|
|
174
|
+
|
|
175
|
+
}
|
|
176
|
+
</script></body></html>
|
|
@@ -0,0 +1,178 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>useProjectData | Kvaser CanKing GUI Extensions SDK</title><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><style>
|
|
2
|
+
@media (prefers-color-scheme: dark) {
|
|
3
|
+
:root {
|
|
4
|
+
--md-sys-color-primary: #60d4fe;
|
|
5
|
+
--md-sys-color-on-primary: #003545;
|
|
6
|
+
--md-sys-color-primary-container: #004d62;
|
|
7
|
+
--md-sys-color-on-primary-container: #baeaff;
|
|
8
|
+
--md-sys-color-secondary: #b4cad5;
|
|
9
|
+
--md-sys-color-on-secondary: #1e333c;
|
|
10
|
+
--md-sys-color-secondary-container: #354a53;
|
|
11
|
+
--md-sys-color-on-secondary-container: #cfe6f1;
|
|
12
|
+
--md-sys-color-tertiary: #c4c3ea;
|
|
13
|
+
--md-sys-color-on-tertiary: #2d2d4d;
|
|
14
|
+
--md-sys-color-tertiary-container: #444465;
|
|
15
|
+
--md-sys-color-on-tertiary-container: #e2dfff;
|
|
16
|
+
--md-sys-color-error: #ffb4ab;
|
|
17
|
+
--md-sys-color-on-error: #690005;
|
|
18
|
+
--md-sys-color-error-container: #93000a;
|
|
19
|
+
--md-sys-color-on-error-container: #ffb4ab;
|
|
20
|
+
--md-sys-color-background: #191c1e;
|
|
21
|
+
--md-sys-color-on-background: #e1e3e4;
|
|
22
|
+
--md-sys-color-surface: #191c1e;
|
|
23
|
+
--md-sys-color-on-surface: #e1e3e4;
|
|
24
|
+
--md-sys-color-surface-variant: #40484c;
|
|
25
|
+
--md-sys-color-on-surface-variant: #c0c8cc;
|
|
26
|
+
--md-sys-color-outline: #8a9296;
|
|
27
|
+
--md-sys-color-outline-variant: #40484c;
|
|
28
|
+
--md-sys-color-shadow: #000000;
|
|
29
|
+
--md-sys-color-scrim: #000000;
|
|
30
|
+
--md-sys-color-inverse-surface: #e1e3e4;
|
|
31
|
+
--md-sys-color-inverse-on-surface: #2e3132;
|
|
32
|
+
--md-sys-color-inverse-primary: #006782;
|
|
33
|
+
--md-sys-color-surface-dim: #111415;
|
|
34
|
+
--md-sys-color-surface-bright: #373a3b;
|
|
35
|
+
--md-sys-color-surface-container-lowest: #0c0f10;
|
|
36
|
+
--md-sys-color-surface-container-low: #191c1e;
|
|
37
|
+
--md-sys-color-surface-container: #1d2022;
|
|
38
|
+
--md-sys-color-surface-container-high: #272a2c;
|
|
39
|
+
--md-sys-color-surface-container-highest: #323537
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
:root[data-theme="dark"] {
|
|
43
|
+
--md-sys-color-primary: #60d4fe;
|
|
44
|
+
--md-sys-color-on-primary: #003545;
|
|
45
|
+
--md-sys-color-primary-container: #004d62;
|
|
46
|
+
--md-sys-color-on-primary-container: #baeaff;
|
|
47
|
+
--md-sys-color-secondary: #b4cad5;
|
|
48
|
+
--md-sys-color-on-secondary: #1e333c;
|
|
49
|
+
--md-sys-color-secondary-container: #354a53;
|
|
50
|
+
--md-sys-color-on-secondary-container: #cfe6f1;
|
|
51
|
+
--md-sys-color-tertiary: #c4c3ea;
|
|
52
|
+
--md-sys-color-on-tertiary: #2d2d4d;
|
|
53
|
+
--md-sys-color-tertiary-container: #444465;
|
|
54
|
+
--md-sys-color-on-tertiary-container: #e2dfff;
|
|
55
|
+
--md-sys-color-error: #ffb4ab;
|
|
56
|
+
--md-sys-color-on-error: #690005;
|
|
57
|
+
--md-sys-color-error-container: #93000a;
|
|
58
|
+
--md-sys-color-on-error-container: #ffb4ab;
|
|
59
|
+
--md-sys-color-background: #191c1e;
|
|
60
|
+
--md-sys-color-on-background: #e1e3e4;
|
|
61
|
+
--md-sys-color-surface: #191c1e;
|
|
62
|
+
--md-sys-color-on-surface: #e1e3e4;
|
|
63
|
+
--md-sys-color-surface-variant: #40484c;
|
|
64
|
+
--md-sys-color-on-surface-variant: #c0c8cc;
|
|
65
|
+
--md-sys-color-outline: #8a9296;
|
|
66
|
+
--md-sys-color-outline-variant: #40484c;
|
|
67
|
+
--md-sys-color-shadow: #000000;
|
|
68
|
+
--md-sys-color-scrim: #000000;
|
|
69
|
+
--md-sys-color-inverse-surface: #e1e3e4;
|
|
70
|
+
--md-sys-color-inverse-on-surface: #2e3132;
|
|
71
|
+
--md-sys-color-inverse-primary: #006782;
|
|
72
|
+
--md-sys-color-surface-dim: #111415;
|
|
73
|
+
--md-sys-color-surface-bright: #373a3b;
|
|
74
|
+
--md-sys-color-surface-container-lowest: #0c0f10;
|
|
75
|
+
--md-sys-color-surface-container-low: #191c1e;
|
|
76
|
+
--md-sys-color-surface-container: #1d2022;
|
|
77
|
+
--md-sys-color-surface-container-high: #272a2c;
|
|
78
|
+
--md-sys-color-surface-container-highest: #323537
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
@media (prefers-color-scheme: light) {
|
|
82
|
+
:root {
|
|
83
|
+
--md-sys-color-primary: #006782;
|
|
84
|
+
--md-sys-color-on-primary: #ffffff;
|
|
85
|
+
--md-sys-color-primary-container: #baeaff;
|
|
86
|
+
--md-sys-color-on-primary-container: #001f29;
|
|
87
|
+
--md-sys-color-secondary: #4c616b;
|
|
88
|
+
--md-sys-color-on-secondary: #ffffff;
|
|
89
|
+
--md-sys-color-secondary-container: #cfe6f1;
|
|
90
|
+
--md-sys-color-on-secondary-container: #071e26;
|
|
91
|
+
--md-sys-color-tertiary: #5c5b7e;
|
|
92
|
+
--md-sys-color-on-tertiary: #ffffff;
|
|
93
|
+
--md-sys-color-tertiary-container: #e2dfff;
|
|
94
|
+
--md-sys-color-on-tertiary-container: #181837;
|
|
95
|
+
--md-sys-color-error: #ba1a1a;
|
|
96
|
+
--md-sys-color-on-error: #ffffff;
|
|
97
|
+
--md-sys-color-error-container: #ffdad6;
|
|
98
|
+
--md-sys-color-on-error-container: #410002;
|
|
99
|
+
--md-sys-color-background: #fbfcfe;
|
|
100
|
+
--md-sys-color-on-background: #191c1e;
|
|
101
|
+
--md-sys-color-surface: #fbfcfe;
|
|
102
|
+
--md-sys-color-on-surface: #191c1e;
|
|
103
|
+
--md-sys-color-surface-variant: #dce4e8;
|
|
104
|
+
--md-sys-color-on-surface-variant: #40484c;
|
|
105
|
+
--md-sys-color-outline: #70787d;
|
|
106
|
+
--md-sys-color-outline-variant: #c0c8cc;
|
|
107
|
+
--md-sys-color-shadow: #000000;
|
|
108
|
+
--md-sys-color-scrim: #000000;
|
|
109
|
+
--md-sys-color-inverse-surface: #2e3132;
|
|
110
|
+
--md-sys-color-inverse-on-surface: #eff1f3;
|
|
111
|
+
--md-sys-color-inverse-primary: #60d4fe;
|
|
112
|
+
--md-sys-color-surface-dim: #d8dadc;
|
|
113
|
+
--md-sys-color-surface-bright: #f8f9fb;
|
|
114
|
+
--md-sys-color-surface-container-lowest: #ffffff;
|
|
115
|
+
--md-sys-color-surface-container-low: #f2f4f5;
|
|
116
|
+
--md-sys-color-surface-container: #eceef0;
|
|
117
|
+
--md-sys-color-surface-container-high: #e7e8ea;
|
|
118
|
+
--md-sys-color-surface-container-highest: #e1e3e4
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
:root[data-theme="light"] {
|
|
122
|
+
--md-sys-color-primary: #006782;
|
|
123
|
+
--md-sys-color-on-primary: #ffffff;
|
|
124
|
+
--md-sys-color-primary-container: #baeaff;
|
|
125
|
+
--md-sys-color-on-primary-container: #001f29;
|
|
126
|
+
--md-sys-color-secondary: #4c616b;
|
|
127
|
+
--md-sys-color-on-secondary: #ffffff;
|
|
128
|
+
--md-sys-color-secondary-container: #cfe6f1;
|
|
129
|
+
--md-sys-color-on-secondary-container: #071e26;
|
|
130
|
+
--md-sys-color-tertiary: #5c5b7e;
|
|
131
|
+
--md-sys-color-on-tertiary: #ffffff;
|
|
132
|
+
--md-sys-color-tertiary-container: #e2dfff;
|
|
133
|
+
--md-sys-color-on-tertiary-container: #181837;
|
|
134
|
+
--md-sys-color-error: #ba1a1a;
|
|
135
|
+
--md-sys-color-on-error: #ffffff;
|
|
136
|
+
--md-sys-color-error-container: #ffdad6;
|
|
137
|
+
--md-sys-color-on-error-container: #410002;
|
|
138
|
+
--md-sys-color-background: #fbfcfe;
|
|
139
|
+
--md-sys-color-on-background: #191c1e;
|
|
140
|
+
--md-sys-color-surface: #fbfcfe;
|
|
141
|
+
--md-sys-color-on-surface: #191c1e;
|
|
142
|
+
--md-sys-color-surface-variant: #dce4e8;
|
|
143
|
+
--md-sys-color-on-surface-variant: #40484c;
|
|
144
|
+
--md-sys-color-outline: #70787d;
|
|
145
|
+
--md-sys-color-outline-variant: #c0c8cc;
|
|
146
|
+
--md-sys-color-shadow: #000000;
|
|
147
|
+
--md-sys-color-scrim: #000000;
|
|
148
|
+
--md-sys-color-inverse-surface: #2e3132;
|
|
149
|
+
--md-sys-color-inverse-on-surface: #eff1f3;
|
|
150
|
+
--md-sys-color-inverse-primary: #60d4fe;
|
|
151
|
+
--md-sys-color-surface-dim: #d8dadc;
|
|
152
|
+
--md-sys-color-surface-bright: #f8f9fb;
|
|
153
|
+
--md-sys-color-surface-container-lowest: #ffffff;
|
|
154
|
+
--md-sys-color-surface-container-low: #f2f4f5;
|
|
155
|
+
--md-sys-color-surface-container: #eceef0;
|
|
156
|
+
--md-sys-color-surface-container-high: #e7e8ea;
|
|
157
|
+
--md-sys-color-surface-container-highest: #e1e3e4
|
|
158
|
+
}
|
|
159
|
+
</style><link rel="stylesheet" href="../assets/material-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Kvaser CanKing GUI Extensions SDK</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Kvaser CanKing GUI Extensions SDK</a></li><li><a href="../modules/hooks.html">hooks</a></li><li><a href="hooks.useProjectData.html">useProjectData</a></li></ul><h1>Function useProjectData</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A hook for data that should be saved to the current project.</p>
|
|
160
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="useProjectData" class="tsd-anchor"></a><span class="tsd-kind-call-signature">use<wbr/>Project<wbr/>Data</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="hooks.useProjectData.html#useProjectData.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">defaultValue</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">projectData</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="hooks.useProjectData.html#useProjectData.T">T</a><span class="tsd-signature-symbol">; </span><br/><span> </span><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> </span><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="hooks.useProjectData.html#useProjectData.T">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"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="useProjectData.T" class="tsd-anchor"></a><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.</p>
|
|
161
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">defaultValue</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="hooks.useProjectData.html#useProjectData.T">T</a></span><div class="tsd-comment tsd-typography"><p>The default value or a callback to set default value.</p>
|
|
162
|
+
</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> </span><span class="tsd-kind-property">projectData</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="hooks.useProjectData.html#useProjectData.T">T</a><span class="tsd-signature-symbol">; </span><br/><span> </span><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> </span><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="hooks.useProjectData.html#useProjectData.T">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>
|
|
163
|
+
<ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">project<wbr/>Data</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="hooks.useProjectData.html#useProjectData.T">T</a></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">project<wbr/>Data<wbr/>Is<wbr/>Initialized</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">set<wbr/>Project<wbr/>Data</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="hooks.useProjectData.html#useProjectData.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h5></li></ul><div class="tsd-comment tsd-typography"></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"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>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"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Kvaser CanKing GUI Extensions SDK</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p>Copyright KVASER AB 2024</p></footer><div class="overlay"></div><script>
|
|
164
|
+
try {
|
|
165
|
+
const generateLinkElement = document.querySelector(".tsd-generator a");
|
|
166
|
+
const link = document.createElement("a");
|
|
167
|
+
Object.assign(link, {
|
|
168
|
+
href: "https://github.com/dmnsgn/typedoc-material-theme",
|
|
169
|
+
target: "_blank",
|
|
170
|
+
rel: "noreferrer",
|
|
171
|
+
innerText: "typedoc-material-theme."
|
|
172
|
+
});
|
|
173
|
+
generateLinkElement.insertAdjacentElement("afterend", link);
|
|
174
|
+
generateLinkElement.insertAdjacentText("afterend", " with ");
|
|
175
|
+
} catch (error) {
|
|
176
|
+
|
|
177
|
+
}
|
|
178
|
+
</script></body></html>
|