InterfaceAnnotationOptions

Options to configure an annotation.

interface AnnotationOptions {
    anchor?: {
        x: number;
        y: number;
    };
    anchorOffset?: {
        x: number;
        y: number;
    };
    node: (() => HTMLElement);
    position: Coordinates | MapPoint;
}

Properties

anchor? anchorOffset? node position

Properties

Optionalanchor

anchor?: {
    x: number;
    y: number;
}

The proportional anchor point of the element.

Default Value

{ x: 0.5, y: 0.5 }

See

Annotation.anchor

OptionalanchorOffset

anchorOffset?: {
    x: number;
    y: number;
}

The relative anchor point of the element in CSS pixels.

Default Value

{ x: 0, y: 0 }

See

Annotation.anchorOffset

node

node: (() => HTMLElement)

A factory which generates an HTML element to represent the annotation. The element will be added to the DOM.

Remarks

Nodes may be created lazily by the annotation layer.

position

position: Coordinates | MapPoint

The position of the annotation.

Settings

Member Visibility

On This Page

Properties