ComPDFKit Web SDK
    Preparing search index...

    Interface ToolRegistration

    Parameters of UI.registerTool.

    interface ToolRegistration {
        buttonGroup?: string;
        buttonImage?: string;
        buttonName?: string;
        documentViewerNumber?: number;
        showColor?: string;
        showPresets?: boolean;
        toolName: string;
        toolObject: object;
        tooltip?: string;
    }
    Index
    buttonGroup?: string

    Tool group of the button. Stored only; currently has no effect.

    buttonImage?: string

    Icon used by tool buttons of this tool that have no icon of their own.

    buttonName?: string

    dataElement of the tool's button; disabling the tool disables this element.

    documentViewerNumber?: number

    Number of the document viewer to register the tool with; 1 by default or when that viewer does not exist.

    showColor?: string

    When the button shows the tool color; 'active' by default. Stored only; currently has no effect.

    showPresets?: boolean

    Whether the tool shows style presets; true by default. Stored only; currently has no effect.

    toolName: string

    Name of the tool; used with setToolMode and as the toolName of tool buttons.

    toolObject: object

    The tool instance; its name is set to toolName.

    tooltip?: string

    Title (or translation key) used by tool buttons of this tool that have no title of their own.