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

    Interface CanIdentifierControlProps

    Properties of the CanIdentifierControl React component.

    interface CanIdentifierControlProps {
        canIdentifier: string;
        canIdentifierType: canIdentifierType;
        collapsed?: boolean;
        collapsedChange?: (value: boolean) => void;
        collapsible?: boolean;
        disabled?: boolean;
        disableSelectMessageButton?: boolean;
        disableSelectSignalButton?: boolean;
        fullScreen?: boolean;
        hideSection?: boolean;
        hideSelectMessageButton?: boolean;
        nodeIdentifier?: string;
        onCanIdentifierChange: (
            identifier: string,
            idType: canIdentifierType,
        ) => void;
        onErrorsChange?: (errors: boolean) => void;
        onSignalChange?: (
            identifier: string,
            idType: canIdentifierType,
            signal: SignalDefinition,
        ) => void;
        parentDialogTitle?: string;
        showSelectSignalButton?: boolean;
    }
    Index

    Properties

    canIdentifier canIdentifierType collapsed? collapsedChange? collapsible? disabled? disableSelectMessageButton? disableSelectSignalButton? fullScreen? hideSection? hideSelectMessageButton? nodeIdentifier? onCanIdentifierChange onErrorsChange? onSignalChange? parentDialogTitle? showSelectSignalButton?

    Properties

    canIdentifier: string

    The current CAN identifier.

    canIdentifierType: canIdentifierType

    The current CAN identifier type, 'extended or 'standard'.

    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, ignored if hideSectionControl is true.

    disabled?: boolean

    Set to true to disable this control.

    disableSelectMessageButton?: boolean

    Set to true if the select message button should be disabled.

    disableSelectSignalButton?: boolean

    Set to true if the select signal button should be disabled.

    fullScreen?: boolean

    Set to true if the select message and select signal dialogs should be full screen dialogs.

    hideSection?: boolean

    Set to true if this control shouldn't be encapsulated inside a SectionControl.

    hideSelectMessageButton?: boolean

    Set to true if the select message button should be hidden.

    nodeIdentifier?: string

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

    onCanIdentifierChange: (identifier: string, idType: canIdentifierType) => void

    Callback that will be called when the CAN identifier has changed.

    Type Declaration

      • (identifier: string, idType: canIdentifierType): void

      • Parameters

        • identifier: string

          The new CAN identifier.

        • idType: canIdentifierType

          The new CAN identifier type.

        Returns void

    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

    onSignalChange?: (
        identifier: string,
        idType: canIdentifierType,
        signal: SignalDefinition,
    ) => void

    Callback that will be called when the settings have changed after selecting a signal. If this property is set, then the onCanIdentifierChange callback will not be called.

    Type Declaration

    parentDialogTitle?: string

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

    showSelectSignalButton?: boolean

    Set to true if the select signal button should be visible. If set to true, then the select message button will be hidden.

    Settings

    Member Visibility

    On This Page

    Properties