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

    Interface LinIdentifierFrameControlProps

    Properties of the LinIdentifierFrameControl React component.

    interface LinIdentifierFrameControlProps {
        collapsed?: boolean;
        collapsedChange?: (value: boolean) => void;
        collapsible?: boolean;
        disableSelectMessageButton?: boolean;
        frame: WriteFrame;
        fullScreen?: boolean;
        hideSection?: boolean;
        hideSelectMessageButton?: boolean;
        nodeIdentifier?: string;
        onErrorsChange?: (errors: boolean) => void;
        onFrameChange: (value: WriteFrame) => void;
        parentDialogTitle?: string;
    }
    Index

    Properties

    collapsed? collapsedChange? collapsible? disableSelectMessageButton? frame fullScreen? hideSection? hideSelectMessageButton? nodeIdentifier? onErrorsChange? onFrameChange parentDialogTitle?

    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.

    disableSelectMessageButton?: boolean

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

    frame: WriteFrame

    The frame object that holds the LIN identifier.

    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.

    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

    onFrameChange: (value: WriteFrame) => void

    Callback that will be called when the frame is updated after the LIN identifier has changed.

    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.

    Settings

    Member Visibility

    On This Page

    Properties