Documentation - v19.12.0-dev
    Preparing search index...

    Interface LoadTwinCommandOptions

    Options for LoadTwinCommand.

    interface LoadTwinCommandOptions {
        axis?: Vector3;
        endpoint?: string;
        fieldSelectionRules?: TwinObjectProperty[];
        filter?: TeiaSearchFilter;
        geometryType?: TwinObjectGeometryType;
        onlySetSource?: boolean;
    }
    Index

    Properties

    axis? endpoint? fieldSelectionRules? filter? geometryType? onlySetSource?

    Properties

    axis?: Vector3

    Projection axis used when loading 2D or Original geometries. Backend defaults to Y (0, 1, 0) when omitted.

    endpoint?: string

    Twin api endpoint to get the geometry from.

    "objects"
    fieldSelectionRules?: TwinObjectProperty[]
    filter?: TeiaSearchFilter
    geometryType?: TwinObjectGeometryType

    The type of geometry to load.

    • 2D: load only the 2D projected geometry along axis
    • 3D: load only the 3D geometry
    • Original: load the original geometry (3D or original 2D along axis)

    Original

    onlySetSource?: boolean

    Whether to only set the current viewer source without loading objects

    Settings

    Member Visibility

    On This Page

    Properties