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

    Interface IExtensionDialogViewProps<TArgs, TResult>

    Properties for an extension dialog component, rendered in its own CanKing window rather than in the extension's workspace pane.

    interface IExtensionDialogViewProps<TArgs = unknown, TResult = unknown> {
        args?: TArgs;
        close: (result?: TResult) => void;
        dialogId: string;
        height: number;
        id: number;
        width: number;
    }

    Type Parameters

    • TArgs = unknown

      Type of the arguments passed by whoever opened the dialog.

    • TResult = unknown

      Type of the value the dialog returns when it closes.

    Index
    args?: TArgs

    Arguments supplied by the opener, or undefined if none were passed.

    close: (result?: TResult) => void

    Closes the window and resolves the opener's openExtensionDialog promise with result. Closing the window any other way resolves it with no result.

    dialogId: string

    The dialog id this window was opened for.

    height: number

    Height of the dialog component.

    id: number

    The id of the WorkspaceView that opened this dialog. Use it with the data hooks to share state with the pane; project data slices are kept in sync between the two windows.

    width: number

    Width of the dialog component.