This is a lower-level API. Lower-level APIs are not recommended for most projects, and may not be available on all plans. See our page on recommended deployment patterns for more information.
Public Method Annotations API

addDrawingArea()

Adds one drawing area. A drawing area is a rectangular zone on the page that contains one part of the drawing. Takes two values, one for the drawing id and one for the HTML element that will be the drawing container.

Examples

itemsApp.assessApp().annotationsApp().module('drawing').addDrawingArea('12', document.body);

Arguments

  • id string
    A unique string value up to 150 characters in length.
  • container object
    The DOM element upon which drawings can be made.

Return value

Value object

An object describing a rectangular bounding box, which contains individual drawings.

Properties

  • getContainerElement function

    The DOM element that was used to initialize the drawing area.

    Returns: HTML DOM Element
  • getContainerWidth function

    Returns the container width in pixels, or returns undefined if not set.

    Returns: number
  • getId function

    The id that the DrawingArea was initialized with. Returns a string value.

    Returns: string
Was this article helpful?