Interface AnnotationState

Represents the state of the annotation.

The state is used to store and pass around the annotation data. Set it as the annotation prop of the MarkerArea and MarkerView components.

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

Properties

defaultFilter?: string

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

height: number

Height of the annotation.

Array of marker states for markers in the annotation.

version?: number

Version of the annotation state format.

Equals to 3 for the current version.

width: number

Width of the annotation.