Vertex Viewer SDK
    Preparing search index...

    Interface VertexViewerPinTool

    interface VertexViewerPinTool {
        accentColor: string | Color.Color | undefined;
        mode: ViewerPinToolMode;
        pinController?: PinController;
        pinModel: PinModel;
        primaryColor: string | Color.Color | undefined;
        tool: ViewerPinToolType;
        viewer?: HTMLVertexViewerElement;
    }
    Index
    accentColor mode pinController? pinModel primaryColor tool viewer?
    accentColor: string | Color.Color | undefined

    The accent color for new pins. Setting this will override the accent template color, and will be used for any new pins created with this vertex-viewer-pin-tool. This styling applies to some background colors, etc

    mode: ViewerPinToolMode

    The mode of the pin tool

    'view'
    pinController?: PinController

    The controller that is responsible for drawing pins and updating the model

    pinModel: PinModel

    The model that contains the entities and outcomes from performing pin annotations

    new PinModel()
    primaryColor: string | Color.Color | undefined

    The primary color for new pins. Setting this will override the primary template color, and will be used for any new pins created with this vertex-viewer-pin-tool. This styling applies to pin anchors, and borders, etc.

    tool: ViewerPinToolType

    The type of pin.

    This property will automatically be set.

    'pin-icon'
    viewer?: HTMLVertexViewerElement

    The viewer that this component is bound to. This is automatically assigned if added to the light-dom of a parent viewer element.

    Settings
    Member Visibility

    On This Page
    Properties