ComPDFKit Web SDK
    Preparing search index...

    Class CalloutCreateTool

    ToolNames.POLYLINE: each click adds a vertex, the last segment follows the pointer, double-click or Enter completes, Escape abandons. After disableCreationOverAnnotation, a first click on an existing annotation does not start drawing. After setSnapMode, points snap to the page's vector content.

    Hierarchy (View Summary)

    Index
    • get ALLOW_ANNOTS_OUTSIDE_PAGE(): boolean

      Whether annotations can be dragged outside the page (off by default: dragging stops at the page edge and does not move in a direction where the annotation is larger than the page).

      Returns boolean

    • set ALLOW_ANNOTS_OUTSIDE_PAGE(allow: boolean): void

      Whether annotations can be dragged outside the page (off by default: dragging stops at the page edge and does not move in a direction where the annotation is larger than the page).

      Parameters

      • allow: boolean

      Returns void

    • With the link tool on, pressing a hand-drawn link selects, drags and resizes it (otherwise a click follows it).

      Returns boolean

    • Adds a listener for an event. Adding the same function twice for one event has no effect.

      Type Parameters

      • K extends keyof ToolEvents

      Parameters

      • name: K

        Event name.

      • fn: (...args: ToolEvents[K]) => void

        Listener, called with the event arguments.

      • Optionaloptions: { once?: boolean }

        Listener options.

        • Optionalonce?: boolean

          When true, the listener is removed after it runs once.

      Returns void

    • Called when the context menu is requested on the viewer; does nothing in the base class.

      Parameters

      • _e: MouseEvent

        The mouse event.

      Returns void

    • Turns off auto-sized text boxes for new callouts (only the setting is stored).

      Returns void

    • Turns off automatic text selection by the edit tool (sets ENABLE_AUTO_SWITCH to false).

      Returns void

    • Turns on auto-sized text boxes for new callouts (only the setting is stored).

      Returns void

    • Turns on automatic text selection by the edit tool (sets ENABLE_AUTO_SWITCH to true).

      Returns void

    • Removes the "drawing" look before adding to the document (the dashed edge back to the first point becomes the polygon's own edge).

      Returns void

    • Viewport event → the page and page coordinates under the pointer (unrotated page, top-left origin, pt).

      Parameters

      • e: Pick<MouseEvent, "clientX" | "clientY">

      Returns MouseLocation

    • Snap mode (a SnapModes value or combination): once set, snaps to the page's vector content both before and while drawing (see tools/snapping.ts).

      Returns number | undefined

    • The editor of the text box currently open.

      Returns boolean

    • Called when a key is pressed while the viewer has focus; does nothing in the base class.

      Parameters

      • e: KeyboardEvent

      Returns void

    • Double-clicking an existing annotation: same as the selection tool (fires annotationDoubleClicked; free text enters inline editing).

      Parameters

      • e: MouseEvent

      Returns void

    • Press: while editing, only ends editing; the first click sets the arrow (only deselects when something is selected, like FreeText), the second the knee, the third places the text box.

      Parameters

      • e: PointerEvent

      Returns void

    • Called when the left mouse button or a touch is released; does nothing in the base class.

      Parameters

      • e: PointerEvent

      Returns void

    • Called when the pointer moves over the viewer; does nothing in the base class.

      Parameters

      • e: PointerEvent

      Returns void

    • Called when the right mouse button goes down on the viewer; does nothing in the base class.

      Parameters

      • _e: PointerEvent

        The pointer event.

      Returns void

    • Removes a listener, or every listener of the event when fn is omitted.

      Type Parameters

      • K extends keyof ToolEvents

      Parameters

      • name: K

        Event name.

      • Optionalfn: (...args: ToolEvents[K]) => void

        The function that was passed to addEventListener.

      Returns void

    • Sets the minimum size when resizing annotations (static, shared by all select / edit tools).

      Parameters

      • getter: SizeGetter | null

      Returns void

    • Sets the name of the tool.

      Parameters

      • name: string

        The tool name.

      Returns void

    • Changes the tool's default style (used by annotations created afterwards); fires toolUpdated.

      Parameters

      • styles: Record<string, unknown>

      Returns void

      const { documentViewer, Annotations, Tools } = instance.Core;
      const freeTextTool = documentViewer.getTool(Tools.ToolNames.FREETEXT);
      freeTextTool.setStyles({ TextColor: new Annotations.Color(0, 0, 0), FontSize: '14pt', Font: 'Helvetica' });
      documentViewer.getTool(Tools.ToolNames.HIGHLIGHT).setStyles({ StrokeColor: new Annotations.Color(0, 255, 0), Opacity: 0.6 });
    • Sets the source of the initial text of new callout text boxes (static); with text, inline editing starts right after creation.

      Parameters

      • handler: CalloutTextHandler

      Returns void

    • Called on a tap (a touch press and release without moving); does nothing in the base class.

      Parameters

      • _e: PointerEvent

        The pointer event.

      Returns void

    • A listener that throws does not affect the others; the error is reported through logger.error.

      Type Parameters

      • K extends keyof ToolEvents

      Parameters

      • name: K
      • Optionalargs: ToolEvents[K]

      Returns void

    • Like trigger, but awaits the Promise returned by each listener in turn; a failing listener does not affect the others.

      Type Parameters

      • K extends keyof ToolEvents

      Parameters

      • name: K
      • Optionalargs: ToolEvents[K]

      Returns Promise<void>

    annotation: Core.Annotations.Annotation | null

    The annotation being drawn, not yet added to the document.

    cursor: string

    The tool's own cursor: used when switching in and when hovering over empty space (default for the edit tool, crosshair for creation tools, text for text tools, grab for pan...).

    defaults: Record<string, unknown>

    Default style of annotations created by the tool (such as StrokeColor, StrokeThickness, Opacity); changed with setStyles.

    ENABLE_ANNOTATION_HOVER_CURSORS: boolean

    Changes the cursor on hover by what is under the pointer (annotations, handles, text); the stamp, attachment, eraser and marquee zoom tools turn it off, and it is turned back on when they switch out (Tool.ENABLE_ANNOTATION_HOVER_CURSORS).

    ENABLE_AUTO_SWITCH: boolean

    Whether the edit tool selects text automatically when hovering over text (the edit tool selects text itself, so when this is off it neither selects text nor shows the text cursor; the instance enable / disableTextSelection must also be on). Turned off on touch screens.

    initialText: string

    Content at creation: empty by default (selected, no editor; double-click to edit); when set to non-empty, it is filled in and inline editing starts right away.

    name: string

    Name the tool is registered under (one of ToolNames).