Class: AnnotationUI

OSDPaperjsAnnotation.AnnotationUI(annotationToolkit, opts)

A class for creating and managing the annotation UI

Constructor

new AnnotationUI(annotationToolkit, opts)

Creates an instance of AnnotationUI.
Parameters:
Name Type Description
annotationToolkit Object The annotation toolkit object.
opts Object The options for the AnnotationUI.
Properties
Name Type Attributes Default Description
autoOpen boolean <optional>
 true Determines if the AnnotationUI should be automatically opened.
featureCollections Array <optional>
 [] An array of feature collections to load.
addButton boolean <optional>
 true Determines if the AnnotationUI button should be added.
addToolbar boolean <optional>
 true Determines if the AnnotationToolbar should be added.
tools Array.<string> <optional>
 null An array of tool names to use in the AnnotationToolbar. If not provided, all available tools will be used.
addLayerUI boolean <optional>
 true Determines if the LayerUI dialog should be added.
addFileButton boolean <optional>
 true Determines if the file button should be added for saving/loading annotations.
buttonTogglesToolbar boolean <optional>
 true Determines if the AnnotationToolbar visibility is toggled by the AnnotationUI button.
buttonTogglesLayerUI boolean <optional>
 true Determines if the LayerUI visibility is toggled by the AnnotationUI button.
Source:

Methods

_addToViewer()

Set up the grid that adds the UI to the viewer
Source:

destroy()

Destroys the AnnotationUI and cleans up its resources.
Source:

hideToolbar()

Hide the toolbar
Source:

hideUI()

Hide the LayerUI interface
Source:

showToolbar()

Show the toolbar
Source:

showUI()

Show the LayerUI interface
Source: