ClassAnnotation

A single annotation.

Fires

Annotation#click - Fired when the user clicks on the annotation.

Hierarchy

Configuring Annotations

position

Configuring Layout

anchor anchorOffset

Creating Annotations

constructor

Other

addEventListener dispatchEvent removeEventListener

Configuring Annotations

position

Configuring Layout

anchor

  • get anchor(): {
        x: number;
        y: number;
    }

  • The proportional anchor point of the element.

    Returns {
        x: number;
        y: number;
    }

    • x: number
    • y: number

    Remarks

    A value of { x: 0, y: 0 } would render the annotation such that the top-left of its bounding box would be at the specified position.

    Updating this value will affect the annotation on the screen.

  • set anchor(newValue): void

  • Parameters

    • newValue: {
          x: number;
          y: number;
      }
      • x: number
      • y: number

    Returns void

anchorOffset

  • get anchorOffset(): {
        x: number;
        y: number;
    }

  • The relative anchor point of the element in CSS pixels.

    Returns {
        x: number;
        y: number;
    }

    • x: number
    • y: number

    Remarks

    The anchor offset is applied additionally to the anchor.

    Updating this value will affect the annotation on the screen.

  • set anchorOffset(newValue): void

  • Parameters

    • newValue: {
          x: number;
          y: number;
      }
      • x: number
      • y: number

    Returns void

Creating Annotations

constructor

  • new Annotation(options): Annotation

  • Creates an annotation with the provided options.

    Parameters

    Returns Annotation

Other

addEventListener

  • addEventListener(type, callback, options?): void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    MDN Reference

    Parameters

    • type: string
    • callback: null | EventListenerOrEventListenerObject
    • Optionaloptions: boolean | AddEventListenerOptions

    Returns void

dispatchEvent

  • dispatchEvent(event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    MDN Reference

    Parameters

    Returns boolean

removeEventListener

  • removeEventListener(type, callback, options?): void

  • Removes the event listener in target's event listener list with the same type, callback, and options.

    MDN Reference

    Parameters

    • type: string
    • callback: null | EventListenerOrEventListenerObject
    • Optionaloptions: boolean | EventListenerOptions

    Returns void

Settings

Member Visibility

On This Page

Configuring Annotations
Configuring Layout
Creating Annotations
Other