Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface VertexViewerMarkupTool

Hierarchy

  • VertexViewerMarkupTool

Index

Properties

arrowTemplateId?: string

An HTML template that describes the HTML to use for new arrow markup. It's expected that the template contains a <vertex-viewer-markup-arrow>.

centeringBehavior?: MarkupCenteringBehavior

Defines the behavior of the provided markup when the originating viewport is smaller than the current viewport, or is scaled to a size smaller than the current viewport using the scale property.

Options: - x-only: Markup will be centered horizontally, but not vertically. - y-only: Markup will be centered vertically, but not horizontally. - both: Markup will be centered both horizontally and vertically. - none: Markup will not be centered (default).

circleTemplateId?: string

An HTML template that describes the HTML to use for new circle markup. It's expected that the template contains a <vertex-viewer-markup-circle>.

disabled?: boolean

Disables markups.

This property will automatically be set when a child of a <vertex-viewer-markup> element.

endLineAnchorStyle?: LineAnchorStyle

The style of the ending anchor. This defaults to 'arrow-triangle.'

freeformTemplateId?: string

An HTML template that describes the HTML to use for new freeform markup. It's expected that the template contains a <vertex-viewer-markup-freeform>.

offset?: Point

The current offset of the visible viewport. This value is used to determine where markup should be rendered relative to the current viewport, enabling some markup to appear "off-screen".

When provided, all computed coordinates will be offset by this amount.

originatingViewport?: Dimensions

The original viewport dimensions where this markup was created. This value is used to determine where the markup should be rendered relative to the current viewport, enabling some markup to appear "off-screen".

When provided, all NDC values will be considered relative to this viewport.

scale?: number

The scale to render this markup at. This value is used to scale the element's bounds along with any offset to determine the final computed coordinates.

When provided, all computed coordinates will be scaled by this amount.

startLineAnchorStyle?: LineAnchorStyle

The style of the starting anchor. This defaults to none.

tool?: ViewerMarkupToolType

The type of markup.

This property will automatically be set when a child of a <vertex-viewer-markup> element.

viewer?: HTMLVertexViewerElement

The viewer to connect to markup.

This property will automatically be set when a child of a <vertex-viewer-markup> or <vertex-viewer> element.

Methods