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

    Interface CanIdentifierGeneratorControlProps

    Properties of the CanIdentifierGeneratorControl React component.

    interface CanIdentifierGeneratorControlProps {
        canIdentifier: string;
        canIdentifierGeneratorSettingsError?: MutableRefObject<boolean>;
        canIdentifierType: canIdentifierType;
        collapsed?: boolean;
        collapsedChange?: (value: boolean) => void;
        collapsible?: boolean;
        disabled?: boolean;
        fullScreen?: boolean;
        identifierGeneratorType: canIdentifierGeneratorType;
        maxCanIdentifier: string;
        minCanIdentifier: string;
        nodeIdentifier?: string;
        onChange: (
            newCanIdentifier: string,
            newIdentifierGeneratorType: canIdentifierGeneratorType,
            newMinCanIdentifier: string,
            newMaxCanIdentifier: string,
            newIdentifierType: canIdentifierType,
        ) => void;
        onErrorsChange?: (errors: boolean) => void;
        parentDialogTitle?: string;
        showSignalValuesTable: (value: boolean) => void;
    }
    Index

    Properties

    canIdentifier canIdentifierGeneratorSettingsError? canIdentifierType collapsed? collapsedChange? collapsible? disabled? fullScreen? identifierGeneratorType maxCanIdentifier minCanIdentifier nodeIdentifier? onChange onErrorsChange? parentDialogTitle? showSignalValuesTable

    Properties

    canIdentifier: string

    The CAN identifier.

    canIdentifierGeneratorSettingsError?: MutableRefObject<boolean>

    The current error state.

    canIdentifierType: canIdentifierType

    The CAN identifier type that will be used, '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.

    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: canIdentifierGeneratorType

    The generator type: 'constant' | 'random' | 'scan' 'constant': The CAN identifier set to canIdentifier will be used for all generated messages. 'random': A random CAN identifier between minCanIdentifier and maxCanIdentifier will be used. 'scan': A CAN identifier will be picked from minCanIdentifier to maxCanIdentifier.

    maxCanIdentifier: string

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

    minCanIdentifier: string

    The min CAN 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: (
        newCanIdentifier: string,
        newIdentifierGeneratorType: canIdentifierGeneratorType,
        newMinCanIdentifier: string,
        newMaxCanIdentifier: string,
        newIdentifierType: canIdentifierType,
    ) => void

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

    Type Declaration

      • (
            newCanIdentifier: string,
            newIdentifierGeneratorType: canIdentifierGeneratorType,
            newMinCanIdentifier: string,
            newMaxCanIdentifier: string,
            newIdentifierType: canIdentifierType,
        ): void

      • Parameters

        • newCanIdentifier: string

          The new constant CAN identifier.

        • newIdentifierGeneratorType: canIdentifierGeneratorType

          The new generator type.

        • newMinCanIdentifier: string

          The new min CAN identifier.

        • newMaxCanIdentifier: string

          The new max CAN identifier.

        • newIdentifierType: canIdentifierType

        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