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;
    hideSection?: boolean;
    hideSelectMessageButton?: boolean;
    onCanIdentifierChange: (
        identifier: string,
        idType: canIdentifierType,
    ) => void;
    onErrorsChange?: (errors: boolean) => void;
    showSelectMessageDialogChange?: (value: boolean) => void;
    showSelectSignalButton?: boolean;
    showSelectSignalDialogChange?: (value: boolean) => void;
}

Properties

canIdentifier canIdentifierType collapsed? collapsedChange? collapsible? disabled? disableSelectMessageButton? disableSelectSignalButton? hideSection? hideSelectMessageButton? onCanIdentifierChange onErrorsChange? showSelectMessageDialogChange? showSelectSignalButton? showSelectSignalDialogChange?

Properties

canIdentifier

canIdentifier: string

The current CAN identifier.

canIdentifierType

canIdentifierType: canIdentifierType

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

Optionalcollapsed

collapsed?: boolean

Current collapse state of the SectionControl.

OptionalcollapsedChange

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

Optionalcollapsible

collapsible?: boolean

Set to true if the SectionControl should be collapsible, ignored if hideSectionControl is true.

Optionaldisabled

disabled?: boolean

Set to true to disable this control.

OptionaldisableSelectMessageButton

disableSelectMessageButton?: boolean

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

OptionaldisableSelectSignalButton

disableSelectSignalButton?: boolean

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

OptionalhideSection

hideSection?: boolean

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

OptionalhideSelectMessageButton

hideSelectMessageButton?: boolean

Set to true if the select message button shouldn't be visible.

onCanIdentifierChange

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

OptionalonErrorsChange

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

OptionalshowSelectMessageDialogChange

showSelectMessageDialogChange?: (value: boolean) => void

Callback that will be called when the select message dialog has been opened or closed.

Type declaration

    • (value: boolean): void

    • Parameters

      • value: boolean

        The new show select message dialog state.

      Returns void

OptionalshowSelectSignalButton

showSelectSignalButton?: boolean

Set to true if the select signal button shouldn't be visible.

OptionalshowSelectSignalDialogChange

showSelectSignalDialogChange?: (value: boolean) => void

Callback that will be called when the select signal dialog has been opened or closed.

Type declaration

    • (value: boolean): void

    • Parameters

      • value: boolean

        The new show select signal dialog state.

      Returns void

Settings

Member Visibility

On This Page

Properties