Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface VertexViewerMarkup

Hierarchy

  • VertexViewerMarkup

Index

Properties

Methods

Properties

Optional arrowTemplateId

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

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).

Optional circleTemplateId

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

disabled: boolean

If true, disables adding or editing of markup through user interaction.

endLineAnchorStyle

endLineAnchorStyle: LineAnchorStyle

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

Optional freeformTemplateId

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>.

Optional offset

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.

Optional originatingViewport

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

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.

selectNew

selectNew: boolean

Indicates if new markup should be automatically selected.

Optional selectedMarkupId

selectedMarkupId?: string

The ID of the markup that is selected.

startLineAnchorStyle

startLineAnchorStyle: LineAnchorStyle

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

tool

tool: ViewerMarkupToolType

The type of markup to perform.

Optional viewer

viewer?: HTMLVertexViewerElement

The viewer to connect to markup. If nested within a , this property will be populated automatically.

Methods

addMarkup

  • addMarkup(markup: Markup): Promise<HTMLVertexViewerMarkupArrowElement | HTMLVertexViewerMarkupCircleElement | HTMLVertexViewerMarkupFreeformElement>

  • Adds a new markup as a child to this component. A new markup component will be created from the template specified by arrow-template-id, circle-template-id, or if undefined a default element will be created.

    see

    {@link ViewerMarkups.arrowTemplateId }

    see

    {@link ViewerMarkups.circleTemplateId }

    Parameters

    • markup: Markup

      The markup to add.

    Returns Promise<HTMLVertexViewerMarkupArrowElement | HTMLVertexViewerMarkupCircleElement | HTMLVertexViewerMarkupFreeformElement>

    The markup element that was created.

getMarkupElement

  • getMarkupElement(id: string): Promise<undefined | HTMLVertexViewerMarkupArrowElement | HTMLVertexViewerMarkupCircleElement | HTMLVertexViewerMarkupFreeformElement>

  • Returns the markup element associated to the given ID.

    see

    {@link ViewerMarkup.getMarkupElements}

    Parameters

    • id: string

      The ID of the markup element to return.

    Returns Promise<undefined | HTMLVertexViewerMarkupArrowElement | HTMLVertexViewerMarkupCircleElement | HTMLVertexViewerMarkupFreeformElement>

    A markup element, or undefined.

getMarkupElements

  • getMarkupElements(): Promise<(HTMLVertexViewerMarkupArrowElement | HTMLVertexViewerMarkupCircleElement | HTMLVertexViewerMarkupFreeformElement)[]>

  • Returns a list of markup elements that are children of this component.

    see

    {@link ViewerMarkup.getMarkupElement}

    Returns Promise<(HTMLVertexViewerMarkupArrowElement | HTMLVertexViewerMarkupCircleElement | HTMLVertexViewerMarkupFreeformElement)[]>

    A list of all markups.

removeMarkup

  • removeMarkup(id: string): Promise<undefined | HTMLVertexViewerMarkupArrowElement | HTMLVertexViewerMarkupCircleElement | HTMLVertexViewerMarkupFreeformElement>

  • Removes a markup with the given ID, and returns the HTML element associated to the markup. Returns undefined if no markup is found.

    Parameters

    • id: string

      The ID of the markup to remove.

    Returns Promise<undefined | HTMLVertexViewerMarkupArrowElement | HTMLVertexViewerMarkupCircleElement | HTMLVertexViewerMarkupFreeformElement>

    The markup element, or undefined.