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

    Interface SelectSignalDialogProps

    Properties of the SelectSignalDialog React component.

    interface SelectSignalDialogProps {
        checkboxSelection?: boolean;
        modal?: boolean;
        multiSelect?: boolean;
        nodeIdentifier?: string;
        onClose: () => void;
        onMultiSelect?: (
            messages: FrameDefinition[],
            signals: SignalDefinition[],
        ) => void;
        onMultiSelectSignalInfos?: (args: SelectedSignalInfoChangeArgs[]) => void;
        onSelect?: (message: FrameDefinition, signal: SignalDefinition) => void;
        onSelectSignalInfo?: (args: SelectedSignalInfoChangeArgs) => void;
        open: boolean;
        parentDialogTitle?: string;
        selectedMessages?: string[];
        selectedSignalInfos?: SelectedSignalInfo[];
        selectedSignals?: string[];
        sourceIdFilter?: string;
    }
    Index

    Properties

    checkboxSelection? modal? multiSelect? nodeIdentifier? onClose onMultiSelect? onMultiSelectSignalInfos? onSelect? onSelectSignalInfo? open parentDialogTitle? selectedMessages? selectedSignalInfos? selectedSignals? sourceIdFilter?

    Properties

    checkboxSelection?: boolean

    If true, checkboxes are shown for multi selection. Only used if multiSelect is true. Default is false.

    modal?: boolean

    If true, the dialog is shown as a modal dialog. If false, the dialog is shown as a full screen dialog. Default is false.

    multiSelect?: boolean

    If true, multiple signals can be selected. If false, only a single signal can be selected. Default is false.

    nodeIdentifier?: string

    Optional node identifier to limit the databases to those available on the specified node. If not specified, all databases available in the system will be shown.

    onClose: () => void

    Callback function that is called when the dialog should be closed. Set the open property to false to close the dialog.

    onMultiSelect?: (
        messages: FrameDefinition[],
        signals: SignalDefinition[],
    ) => void

    Callback function that is called when signals are selected and the Save button is clicked. Only used if multiSelect is true. The function receives the selected messages and signals as parameters. If not specified, nothing happens when the Save button is clicked. After calling the onMultiSelect callback, the onClose callback is called.

    Use onMultiSelectSignalInfos instead.

    onMultiSelectSignalInfos?: (args: SelectedSignalInfoChangeArgs[]) => void

    Callback function that is called when multiple signals are selected and the Save button is clicked. Only used if multiSelect is true. The function receives an array of selected signal informations as parameter. If not specified, nothing happens when the Save button is clicked. After calling the onMultiSelectSignalInfos callback, the onClose callback is called.

    onSelect?: (message: FrameDefinition, signal: SignalDefinition) => void

    Callback function that is called when a signal is selected. Only used if multiSelect is false. The function receives the selected message and signal as parameters. If not specified, nothing happens when a signal is selected. After calling the onSelect callback, the onClose callback is called.

    Use onSelectSignalInfo instead.

    onSelectSignalInfo?: (args: SelectedSignalInfoChangeArgs) => void

    Callback function that is called when a signal is selected. The function receives the selected signal information as parameter. Only used if multiSelect is false. If not specified, nothing happens when a signal is selected. After calling the onSelectSignalInfo callback, the onClose callback is called.

    open: boolean

    Whether the dialog is open.

    parentDialogTitle?: string

    Optional title of the parent dialog to be shown in the title bar as a breadcrumb.

    selectedMessages?: string[]

    Optional array of initially selected message qualified names. Only used if multiSelect is true. If not specified, no messages are initially selected. If specified, the messages with the specified qualified names will be initially selected. Signals of the selected messages will also be selected.

    Use selectedSignalInfos instead.

    selectedSignalInfos?: SelectedSignalInfo[]

    Optional array of initially selected signal informations. Only used if multiSelect is true. If not specified, no signals are initially selected. If specified, the signals with the specified informations will be initially selected.

    selectedSignals?: string[]

    Optional array of initially selected signal qualified names. Only used if multiSelect is true. If not specified, no signals are initially selected. If specified, the signals with the specified qualified names will be initially selected.

    Use selectedSignalInfos instead.

    sourceIdFilter?: string

    The source identifier that will be used to filter messages in the select dialog. Leave undefined if no filtering should be done.

    Settings

    Member Visibility

    On This Page

    Properties