Skip to content

Latest commit

 

History

History

viewer-markup-tool

readme.md

vertex-viewer-markup-tool

Properties

Property Attribute Description Type Default
arrowTemplateId arrow-template-id 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>. string | undefined undefined
circleTemplateId circle-template-id 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>. string | undefined undefined
disabled disabled Disables markups. This property will automatically be set when a child of a <vertex-viewer-markup> element. boolean false
endLineAnchorStyle end-line-anchor-style The style of the ending anchor. This defaults to 'arrow-triangle.' "arrow-line" | "arrow-triangle" | "dot" | "hash" | "none" 'arrow-triangle'
freeformTemplateId freeform-template-id 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>. string | undefined undefined
startLineAnchorStyle start-line-anchor-style The style of the starting anchor. This defaults to none. "arrow-line" | "arrow-triangle" | "dot" | "hash" | "none" 'none'
tool tool The type of markup. This property will automatically be set when a child of a <vertex-viewer-markup> element. "arrow" | "circle" | "freeform" 'arrow'
viewer -- The viewer to connect to markup. This property will automatically be set when a child of a <vertex-viewer-markup> or <vertex-viewer> element. HTMLVertexViewerElement | undefined undefined

Events

Event Description Type
markupBegin An event that is dispatched when a user begins a new markup. CustomEvent<void>
markupEnd An event that is dispatched when a user has finished their markup. CustomEvent<ArrowMarkup | CircleMarkup | FreeformMarkup>

Methods

reset() => Promise<void>

Resets the state of the internally managed markup element to allow for creating a new markup. This state is automatically managed when this element is placed as a child of a <vertex-viewer-markup> element.

Returns

Type: Promise<void>

Dependencies

Depends on

Graph

graph TD;
  vertex-viewer-markup-tool --> vertex-viewer-markup-arrow
  vertex-viewer-markup-tool --> vertex-viewer-markup-circle
  vertex-viewer-markup-tool --> vertex-viewer-markup-freeform
  style vertex-viewer-markup-tool fill:#f9f,stroke:#333,stroke-width:4px
Loading

Built with StencilJS