Interface IMarkup

fontSize

34
Copy

lineType

lineWidth

4
Copy

clearOverlay

• clearOverlay(): void

  Deletes all markup objects and clears the markup overlay.

  Returns void

clearSelected

• clearSelected(): void

  Clears the markup objects selection.

  Returns void

colorizeAllMarkup

• colorizeAllMarkup(r: number, g: number, b: number): void

  Colors all markup objects with the specified color.

  Parameters

  • r: number

    The red component of the color, as a number between 0 and 255.
  • g: number

    The green component of the color, as a number between 0 and 255.
  • b: number

    The blue component of the color, as a number between 0 and 255.

  Returns void

colorizeSelectedMarkups

• colorizeSelectedMarkups(r: number, g: number, b: number): void

  Colors the selected markup objects with the specified color.

  Parameters

  • r: number

    The red component of the color, as a number between 0 and 255.
  • g: number

    The green component of the color, as a number between 0 and 255.
  • b: number

    The blue component of the color, as a number between 0 and 255.

  Returns void

createObject

• createObject(type: string, params: any): IMarkupObject

  Creates a markup object.

  Parameters

  • type: string

    Markup object type. Can be Line, Text, Rectangle, Ellipse, Arrow, Image or Cloud.
  • params: any

    Parameters for creating a markup object. Must match the object type:

    • Line - IMarkupLineParams
    • Text - IMarkupTextParams
    • Rectangle - IMarkupRectangleParams
    • Ellipse - IMarkupEllipseParams
    • Arrow - IMarkupArrowParams
    • Image - IMarkupImageParams
    • Cloud - IMarkupCloudParams

  Returns IMarkupObject

dispose

• dispose(): void

  Releases resources allocated in the initialize().

  Returns void

enableEditMode

• enableEditMode(mode: false | MarkupMode): this

  Enables mouse interactions to select or draw markups.

  Parameters

  • mode: false | MarkupMode

    Edit mode. Matches the type of markup object being created. Specify false to exit edit mode.

  Returns this

getMarkupColor

• getMarkupColor(): { b: number; g: number; r: number }

  Returns the color of new markup objects.

  Returns { b: number; g: number; r: number }

getObjects

• getObjects(): IMarkupObject[]

  Returns the list of all markup objects.

  Returns IMarkupObject[]

getSelectedObjects

• getSelectedObjects(): IMarkupObject[]

  Returns the list of selected markup objects.

  Returns IMarkupObject[]

getViewpoint

• getViewpoint(viewpoint: IViewpoint): IViewpoint

  Saves the markup state at the viewpoint.

  Parameters

  • viewpoint: IViewpoint

  Returns IViewpoint

initialize

• initialize(
      container: HTMLElement,
      containerEvents?: string[],
      viewer?: IEventEmitter,
      worldTransformer?: IWorldTransform,
  ): void

  Initializes the markup instance. Call dispose() to release allocated resources.

  Parameters

  • container: HTMLElement

    Container element used to operate on. This is usually a <canvas> or <div> on top of which the markup is drawn. If the container is a <canvas> element, its content will be combined with the markup in the viewpoint snapshot.
  • OptionalcontainerEvents: string[]

    List of container events, such as mouse events or pointer events or touch events that the markup should redirect to the viewer.
  • Optionalviewer: IEventEmitter

    Viewer instance that receives pointing device events.
  • OptionalworldTransformer: IWorldTransform

    Transformer of screen space into the viewer world space and vice versa. If a transformer is defined, markup objects will be stored at the viewpoint in world coordinates, otherwise in screen coordinates.

  Returns void

selectObjects

• selectObjects(objects: IMarkupObject[]): void

  Selects the specified markup objects.

  Parameters

  • objects: IMarkupObject[]

    The list of markup objects.

  Returns void

setMarkupColor

• setMarkupColor(r: number, g: number, b: number): void

  Sets the default color of new markup objects.

  Parameters

  • r: number

    The red component of the color, as a number between 0 and 255.
  • g: number

    The green component of the color, as a number between 0 and 255.
  • b: number

    The blue component of the color, as a number between 0 and 255.

  Returns void

setViewpoint

• setViewpoint(viewpoint: IViewpoint): void

  Sets the markup state to the specified viewpoint.

  Parameters

  • viewpoint: IViewpoint

    Viewpoint data.

  Returns void

syncOverlay

• syncOverlay(): void

  Creates the markup overlay.

  Returns void