Kvaser CanKing GUI Extensions SDK - v7.3.0
    Preparing search index...

    Interface CanIdentifierGeneratorSettingsControlProps

    Properties of the CanIdentifierGeneratorSettingsControl React component.

    interface CanIdentifierGeneratorSettingsControlProps {
        canIdentifierGeneratorSettingsError?: MutableRefObject<boolean>;
        collapsed?: boolean;
        collapsedChange?: (value: boolean) => void;
        collapsible?: boolean;
        disabled?: boolean;
        fullScreen?: boolean;
        nodeIdentifier?: string;
        onErrorsChange?: (errors: boolean) => void;
        onSettingsChange: (value: PeriodicTransmissionSettings) => void;
        parentDialogTitle?: string;
        settings: PeriodicTransmissionSettings;
        showSignalValuesTable: (value: boolean) => void;
    }
    Index

    Properties

    canIdentifierGeneratorSettingsError?: MutableRefObject<boolean>

    The current error state.

    collapsed?: boolean

    Current collapse state of the SectionControl.

    collapsedChange?: (value: boolean) => void

    Callback that will be called when collapse state has changed.

    Type Declaration

      • (value: boolean): void
      • Parameters

        • value: boolean

          The new collapse state.

        Returns void

    collapsible?: boolean

    Set to true if the SectionControl should be collapsible.

    disabled?: boolean

    Set to true to disable this control.

    fullScreen?: boolean

    Set to true if the select message dialog should be a full screen dialog.

    nodeIdentifier?: string

    Identifier of the node that will be used to filter messages in the select dialog. Leave undefined if no filtering should be done.

    onErrorsChange?: (errors: boolean) => void

    Callback that will be called when the errors state has changed.

    Type Declaration

      • (errors: boolean): void
      • Parameters

        • errors: boolean

          The new errors state.

        Returns void

    onSettingsChange: (value: PeriodicTransmissionSettings) => void

    Callback that will be called when the settings are updated after the CAN identifiers have changed.

    Type Declaration

    parentDialogTitle?: string

    Name of a parent dialog, if any, that is used as the parent for the select message dialog. Leave undefined if there is no parent dialog.

    The settings object that holds the CAN identifier(s) generator settings.

    showSignalValuesTable: (value: boolean) => void

    Callback for specifying if the signal values table should be visible.