Options
All
  • Public
  • Public/Protected
  • All
Menu

Module Viewer

Index

Namespaces

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

AdditionalTransform

AdditionalTransform: ((executor: SceneItemQueryExecutor) => TerminalItemOperationBuilder)

Type declaration

AngleUnitType

AngleUnitType: "degrees" | "radians"

CssCursor

CssCursor: "auto" | "default" | "none" | "context-menu" | "help" | "pointer" | "progress" | "wait" | "cell" | "crosshair" | "text" | "vertical-text" | "alias" | "copy" | "move" | "no-drop" | "not-allowed" | "grab" | "grabbing" | "all-scroll" | "col-resize" | "row-resize" | "n-resize" | "e-resize" | "s-resize" | "w-resize" | "ne-resize" | "nw-resize" | "se-resize" | "sw-resize" | "ew-resize" | "ns-resize" | "nesw-resize" | "nwse-resize" | "zoom-in" | "zoom-out" | string

Represents a built-in browser CSS cursor.

Cursor

Cursor: CssCursor | CustomCursor

Represents all possible cursor types.

DistanceUnitType

DistanceUnitType: "millimeters" | "centimeters" | "meters" | "inches" | "feet" | "yards"

A type representing the different types of supported distance units.

Environment

Environment: "platdev" | "platstaging" | "platprod"

Formatter

Formatter<T>: ((value: T) => string)

Type Parameters

  • T

Type declaration

    • (value: T): string

    • A function that takes an input value and returns a formatted string.

      Parameters

      • value: T

      Returns string

JwtProvider

JwtProvider: (() => string | undefined)

Type declaration

    • (): string | undefined

    • Returns string | undefined

KeyState

KeyState: Record<string, boolean>

Markup

Markup: ArrowMarkup | CircleMarkup | FreeformMarkup

MeasurementOverlay

MeasurementOverlay: LineOverlay | DistanceVectorOverlay

MeasurementResult

MeasurementResult: MinimumDistanceMeasurementResult | PlanarAngleMeasurementResult | PlanarDistanceMeasurementResult | SurfaceAreaMeasurementResult

A type representing the possible measurement results.

MetadataKey

MetadataKey: string

MetadataMap

MetadataMap: Record<MetadataKey, string | undefined>

OperationTransform

OperationTransform: ((builder: SceneItemOperationsBuilder) => TerminalItemOperationBuilder)

Type declaration

Pin

Pin: IconPin | TextPin

QueryType

QueryType: "inclusive" | "exclusive"

Row

Row: LoadedRow | undefined

RowArg

RowArg: number | Row | Node.AsObject

RowDataProvider

RowDataProvider: ((row: Row) => Record<string, unknown>)

Type declaration

    • (row: Row): Record<string, unknown>

    • Parameters

      Returns Record<string, unknown>

SceneViewStateFeature

SceneViewStateFeature: "camera" | "cross_section" | "material_overrides" | "selection" | "transforms" | "visibility" | "phantom"

The features of a scene view state that can be applied to the current scene

TerminalItemOperationBuilder

TerminalItemOperationBuilder: SceneItemOperationsBuilder | SceneItemOperationsBuilder[]

ViewerPinToolMode

ViewerPinToolMode: "edit" | "view"

The mode of the pin tool

ViewerPinToolType

ViewerPinToolType: "pin-icon" | "pin-text"

The types of pins that can be performed by this tool.

ViewerToolbarDirection

ViewerToolbarDirection: "horizontal" | "vertical"

ViewerToolbarGroupDirection

ViewerToolbarGroupDirection: "horizontal" | "vertical"

ViewerToolbarPlacement

ViewerToolbarPlacement: "top-left" | "top-center" | "top-right" | "middle-left" | "middle-right" | "bottom-left" | "bottom-center" | "bottom-right"

Values that define where the toolbar is positioned.

VolumeIntersectionQueryMode

VolumeIntersectionQueryMode: "exclusive" | "inclusive"

VolumeIntersectionQueryType

VolumeIntersectionQueryType: "clearAndSelect" | "select" | "deselect"

Variables

Const boxQueryCursor

boxQueryCursor: { offsetX: number; offsetY: number; url: string } = ...

Type declaration

  • offsetX: number
  • offsetY: number
  • url: string

Const labelPinCursor

labelPinCursor: { offsetX: number; offsetY: number; url: string } = ...

Type declaration

  • offsetX: number
  • offsetY: number
  • url: string

Const measurementCursor

measurementCursor: { offsetX: number; offsetY: number; url: string } = ...

Type declaration

  • offsetX: number
  • offsetY: number
  • url: string

Const measurementWithArrowCursor

measurementWithArrowCursor: { offsetX: number; offsetY: number; url: string } = ...

Type declaration

  • offsetX: number
  • offsetY: number
  • url: string

Const pinCursor

pinCursor: { offsetX: number; offsetY: number; url: string } = ...

Type declaration

  • offsetX: number
  • offsetY: number
  • url: string

Functions

fromNodeProto

  • fromNodeProto(index: number, node: Node, columns: string[]): Row
  • fromNodeProto(index: number, nodes: Node[], columns: string[]): Row[]

isLoadedRow

makeMinimumDistanceResult