Interface CanChannelSelectControlProps

Properties of the CanChannelSelectControl React component.

interface CanChannelSelectControlProps {
    channelIdentifier: string;
    collapsed?: boolean;
    collapsedChange?: (value: boolean) => void;
    collapsible?: boolean;
    disabled?: boolean;
    hideSectionControl?: boolean;
    hideSilentChannels?: boolean;
    onChannelIdentifierChange: (
        identifier: string,
        canFdSupport: boolean,
    ) => void;
}

Properties

channelIdentifier collapsed? collapsedChange? collapsible? disabled? hideSectionControl? hideSilentChannels? onChannelIdentifierChange

Properties

channelIdentifier

channelIdentifier: string

Identifier of the selected channel.

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.

OptionalhideSectionControl

hideSectionControl?: boolean

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

OptionalhideSilentChannels

hideSilentChannels?: boolean

Set to true to hide all silent channels e.g., when the control is used for selecting output channel.

onChannelIdentifierChange

onChannelIdentifierChange: (identifier: string, canFdSupport: boolean) => void

Callback that will be called when a new channel has been selected.

Type declaration

    • (identifier: string, canFdSupport: boolean): void

    • Parameters

      • identifier: string

        The new channel identifier.

      • canFdSupport: boolean

        True if the new CAN channel supports CAN-FD.

      Returns void

Settings

Member Visibility

On This Page

Properties