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

    Interface LinIdentifierGeneratorControlProps

    Properties of the LinIdentifierGeneratorControl React component.

    interface LinIdentifierGeneratorControlProps {
        collapsed?: boolean;
        collapsedChange?: (value: boolean) => void;
        collapsible?: boolean;
        disabled?: boolean;
        fullScreen?: boolean;
        identifierGeneratorType: linIdentifierGeneratorType;
        linIdentifier: string;
        linIdentifierGeneratorSettingsError?: MutableRefObject<boolean>;
        maxLinIdentifier: string;
        minLinIdentifier: string;
        nodeIdentifier?: string;
        onChange: (
            newLinIdentifier: string,
            newIdentifierGeneratorType: linIdentifierGeneratorType,
            newMinLinIdentifier: string,
            newMaxLinIdentifier: string,
        ) => void;
        onErrorsChange?: (errors: boolean) => void;
        parentDialogTitle?: string;
        showSignalValuesTable: (value: boolean) => void;
    }
    Index

    Properties

    collapsed? collapsedChange? collapsible? disabled? fullScreen? identifierGeneratorType linIdentifier linIdentifierGeneratorSettingsError? maxLinIdentifier minLinIdentifier nodeIdentifier? onChange onErrorsChange? parentDialogTitle? showSignalValuesTable

    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.

    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.

    identifierGeneratorType: linIdentifierGeneratorType

    The generator type: 'constant' | 'random' | 'scan' 'constant': The LIN identifier set to linIdentifier will be used for all generated messages. 'random': A random LIN identifier between minLinIdentifier and maxLinIdentifier will be used. 'scan': A LIN identifier will be picked from minLinIdentifier to maxLinIdentifier.

    linIdentifier: string

    The LIN identifier.

    linIdentifierGeneratorSettingsError?: MutableRefObject<boolean>

    The current error state.

    maxLinIdentifier: string

    The max LIN identifier that will be used if identifierGeneratorType is 'random' or 'scan'.

    minLinIdentifier: string

    The min LIN identifier that will be used if identifierGeneratorType is 'random' or 'scan'.

    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.

    onChange: (
        newLinIdentifier: string,
        newIdentifierGeneratorType: linIdentifierGeneratorType,
        newMinLinIdentifier: string,
        newMaxLinIdentifier: string,
    ) => void

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

    Type Declaration

      • (
            newLinIdentifier: string,
            newIdentifierGeneratorType: linIdentifierGeneratorType,
            newMinLinIdentifier: string,
            newMaxLinIdentifier: string,
        ): void

      • Parameters

        • newLinIdentifier: string

          The new constant LIN identifier.

        • newIdentifierGeneratorType: linIdentifierGeneratorType

          The new generator type.

        • newMinLinIdentifier: string

          The new min LIN identifier.

        • newMaxLinIdentifier: string

          The new max LIN identifier.

        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

    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.

    showSignalValuesTable: (value: boolean) => void

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

    Settings

    Member Visibility

    On This Page

    Properties