Interface AnnotationState

Represents the state of the annotation.

The state is returned by MarkerArea.getState() and can be used to restore the annotation in MarkerArea with MarkerArea.restoreState() or passed to MakerView.show() or Renderer.rasterize().

interface AnnotationState {
    defaultFilter?: string;
    height: number;
    markers: MarkerBaseState[];
    version?: number;
    width: number;
}

Index

Properties

defaultFilter? height markers version? width

Properties

`Optional`defaultFilter

defaultFilter?: string

Default SVG filter to apply to markers in the annotation. (e.g. drop shadow, outline, glow)

Since

3.2.0

height

height: number

Height of the annotation.

markers

markers: MarkerBaseState[]

Array of marker states for markers in the annotation.

`Optional`version

version?: number

Version of the annotation state format.

Equals to 3 for the current version.

width

width: number

Width of the annotation.