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

    Interface LinIdentifierControlProps

    Properties of the LinIdentifierControl React component.

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

    Properties

    collapsed? collapsedChange? collapsible? disabled? disableSelectMessageButton? disableSelectSignalButton? fullScreen? hideSection? hideSelectMessageButton? linIdentifier nodeIdentifier? onErrorsChange? onLinIdentifierChange onSignalChange? parentDialogTitle? showSelectSignalButton?

    Properties

    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.

    linIdentifier: string

    The current LIN identifier.

    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.

    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

    onLinIdentifierChange: (identifier: string) => void

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

    Type Declaration

      • (identifier: string): void

      • Parameters

        • identifier: string

          The new LIN identifier.

        Returns void

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

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

    Type Declaration

      • (identifier: string, signal: SignalDefinition): void

      • Parameters

        • identifier: string

          The new LIN identifier.

        • signal: SignalDefinition

          The new signal or undefined if no signal is selected.

        Returns void

    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