Mapspace API Reference

Class: Annotations

Annotations

An action for any control that activates interactions in a Mapspace.global.Viewer to make annotations.

new Annotations( [options])

Parameters:
Name Type Argument Description
options Mapspace.action.WorkspaceActionOptions <optional>

Options.
Source:
mapspace-global/actions/annotations.js

Extends

Members

<nullable> localStorageKey :string

This is a key that can be used to store content locally in the action.

Inherited From:
Source:
mapspace/actions/workspaceaction.js

<nullable> workspace :Mapspace.Workspace

This is the workspace this action will be tied to.

Inherited From:
Source:
mapspace/actions/workspaceaction.js

Methods

changeAnnotation(aType, viewType)

Changes the current annotation tool in the viewer.

Parameters:
Name Type Argument Description
aType Mapspace.AnnotationType <nullable>

The type of annotation or null or undefined to deactivate all annotations.
viewType Mapspace.ViewType

The view type.
Source:
mapspace-global/actions/annotations.js