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

    Interface LinChannelSelectControlProps

    Properties of the LinChannelSelectControl React component.

    interface LinChannelSelectControlProps {
        channelIdentifier: string;
        collapsed?: boolean;
        collapsedChange?: (value: boolean) => void;
        collapsible?: boolean;
        disabled?: boolean;
        hideSectionControl?: boolean;
        onChannelIdentifierChange: (identifier: string) => void;
        selectMasterChannels: boolean;
    }
    Index

    Properties

    channelIdentifier: string

    Identifier of the selected channel.

    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, ignored if hideSectionControl is true.

    disabled?: boolean

    Set to true to disable this control.

    hideSectionControl?: boolean

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

    onChannelIdentifierChange: (identifier: string) => void

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

    Type Declaration

      • (identifier: string): void
      • Parameters

        • identifier: string

          The new channel identifier.

        Returns void

    selectMasterChannels: boolean

    If true, master channels will be selected and otherwise slave channels.