Interface MarkupAPI

The API for operations related to Markups.

Hierarchy

MarkupAPI

Index

Methods

Methods

addArrowMarkups

addArrowMarkups(arrowMarkups: ArrowMarkup[]): Promise<ArrowMarkup[]>

Add new or update existing arrow markups in the viewer. Existing arrow markup is replaced if 'id' property points to an existing markup, otherwise, a new arrow markup is created.

Parameters
- arrowMarkups: ArrowMarkup[]
  
  The arrow markup objects.
Returns Promise<ArrowMarkup[]>
The awaitable containing the ArrowMarkup objects added to the viewer.

addCloudMarkup

addCloudMarkup(cloudMarkups: CloudMarkup[]): Promise<CloudMarkup[]>

Add new or update existing cloud markups in the viewer. Existing cloud markup is replaced if 'id' property points to an existing markup, otherwise, a new cloud markup is created.

Parameters
- cloudMarkups: CloudMarkup[]
  
  The cloud markup objects.
Returns Promise<CloudMarkup[]>
The awaitable task containing the CloudMarkup objects added to the viewer.

addLineMarkups

addLineMarkups(lineMarkups: LineMarkup[]): Promise<LineMarkup[]>

Add new or update existing line markups in the viewer. Existing line markup is replaced if 'id' property points to an existing markup, otherwise a new line markup is created.

Parameters
- lineMarkups: LineMarkup[]
  
  The section markup objects.
Returns Promise<LineMarkup[]>
The awaitable containing the LineMarkup objects added to the viewer.

addMeasurementMarkups

addMeasurementMarkups(measurements: MeasurementMarkup[]): Promise<MeasurementMarkup[]>

Add new or update existing measurement markups in the viewer. Existing markup is replaced if 'id' property points to an existing markup, otherwise a new markup is created.

Parameters
- measurements: MeasurementMarkup[]
  
  The measurement markup objects
Returns Promise<MeasurementMarkup[]>
The awaitable task containing the MeasurementMarkup objects added to the viewer.

addSinglePointMarkups

addSinglePointMarkups(pointMarkups: PointMarkup[]): Promise<PointMarkup[]>

Add new or update existing single point markups in the viewer. Existing single point markup is replaced if 'id' property points to an existing markup, otherwise, a new single point markup is created.

Parameters
- pointMarkups: PointMarkup[]
  
  The single point markup objects.
Returns Promise<PointMarkup[]>
The awaitable task containing the CloudMarkup objects added to the viewer.

addTextMarkup

addTextMarkup(textMarkups: TextMarkup[]): Promise<TextMarkup[]>

Add new or update existing text markups in the viewer. Existing text markup is replaced if 'id' property points to an existing markup, otherwise a new text markup is created.

Parameters
- textMarkups: TextMarkup[]
  
  The text markup objects.
Returns Promise<TextMarkup[]>
The awaitable task containing the LineMarkup objects added to the viewer.

getArrowMarkups

getArrowMarkups(): Promise<ArrowMarkup[]>

Gets the arrow markups in the viewer.

Returns Promise<ArrowMarkup[]>
The awaitable containing the ArrowMarkup objects currently in the viewer.

getCloudMarkups

getCloudMarkups(): Promise<CloudMarkup[]>

Gets the cloud markups in the viewer.

Returns Promise<CloudMarkup[]>
The awaitable containing the CloudMarkup objects currently in the viewer.

getLineMarkups

getLineMarkups(): Promise<LineMarkup[]>

Gets the line markups in the viewer.

Returns Promise<LineMarkup[]>
The awaitable containing the LineMarkup objects currently in the viewer.

getMeasurementMarkups

getMeasurementMarkups(): Promise<MeasurementMarkup[]>

Gets the measurement markups in the viewer

Returns Promise<MeasurementMarkup[]>
The awaitable containing the MeasurementMarkup objects currently in the viewer

getSinglePointMarkups

getSinglePointMarkups(): Promise<PointMarkup[]>

Gets the single point markups in the viewer.

Returns Promise<PointMarkup[]>
The awaitable containing the PointMarkup objects currently in the viewer.

getTextMarkups

getTextMarkups(): Promise<TextMarkup[]>

Gets the text markups in the viewer.

Returns Promise<TextMarkup[]>
The awaitable containing the TextMarkup objects currently in the viewer.

removeMarkups

removeMarkups(ids: undefined | number[]): Promise<void>

Removes the markups in the viewer.

Parameters
- ids: undefined | number[]
  
  The markup ids to be removed. If the parameter is undefined, all markups will be removed.
Returns Promise<void>
The awaitable task.