Properties of the CanIdentifierFrameControl React component.

interface CanIdentifierFrameControlProps {
    collapsed?: boolean;
    collapsedChange?: (value: boolean) => void;
    collapsible?: boolean;
    disableSelectMessageButton?: boolean;
    disableSelectSignalButton?: boolean;
    frame: WriteFrame;
    hideSection?: boolean;
    hideSelectMessageButton?: boolean;
    onErrorsChange?: (errors: boolean) => void;
    onFrameChange: (value: WriteFrame) => void;
    showSelectMessageDialogChange?: (value: boolean) => void;
    showSelectSignalButton?: boolean;
    showSelectSignalDialogChange?: (value: boolean) => void;
}

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.

disableSelectSignalButton?: boolean

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

frame: WriteFrame

The frame object that holds the CAN identifier.

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 shouldn't be visible.

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 CAN identifier has changed.

Type declaration

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

showSelectSignalButton?: boolean

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

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