3d-wrapper

@cognite/3d-wrapper-react > ViewerProps

Interface: ViewerProps

Hierarchy

ViewerProps

Index

Properties


Properties

<Optional> boundingBox

● boundingBox: BoundingBox

Defined in interfaces.ts:76

Bounding Box of the extents to load in the 3D viewer. Relative to the Model Coordinates. Used for partial loading of 3D models type: {BoundingBox}

memberof: ViewerProps


<Optional> cache

● cache: ViewerCache

Defined in interfaces.ts:85

Long-life storage container for the 3D viewers WARNING: THIS IS ONLY ASSIGNABLE ON VIEWER CREATION type: {ViewerCache}

memberof: ViewerProps


<Optional> cameraPosition

● cameraPosition: Camera

Defined in interfaces.ts:115

Initial Camera location of the camera inside the viewer. Camera will be reset to this value when this prop is updated type: {Camera}

memberof: ViewerProps


modelId

● modelId: number

Defined in interfaces.ts:60

ModelID of the 3D model to load type: {number}

memberof: ViewerProps


<Optional> nodeStyles

● nodeStyles: NodeStyle[]

Defined in interfaces.ts:131

List of node styling rules to apply to the model. Order of the rules matter. The first rule will be applied and then subsequent rules will be. type: {NodeStyle[]}

memberof: ViewerProps


<Optional> onCameraChange

● onCameraChange: * undefined | function *

Defined in interfaces.ts:122

Callback with new camera location and target when camera has changed. WARNING: Callbacks can be called frequently. It is not recomended to use setState on other props (e.g. the camera prop) inside this function memberof: ViewerProps


<Optional> onClick

● onClick: * undefined | function *

Defined in interfaces.ts:93

Callback for a click on the 3D viewers canvas. Optimized for 3D interaction. memberof: ViewerProps


<Optional> onLoadComplete

● onLoadComplete: * undefined | function *

Defined in interfaces.ts:106

Callback function executed when a model has finished loading. memberof: ViewerProps


<Optional> onLoadProgress

● onLoadProgress: * undefined | function *

Defined in interfaces.ts:100

Callback function executed during model loading with progress updates. memberof: ViewerProps


projectName

● projectName: string

Defined in interfaces.ts:53

Name of the project (tenant) to which the 3D model is attached type: {string}

memberof: ViewerProps


revisionId

● revisionId: number

Defined in interfaces.ts:67

RevisionID of the 3D model to load type: {number}

memberof: ViewerProps


<Optional> style

● style: React.CSSProperties

Defined in interfaces.ts:147

Style of the div containing the 3d-viewer type: {React.CSSProperties}

memberof: ViewerProps


<Optional> viewCube

● viewCube: * “topleft” | “topright” | “bottomleft” | “bottomright” *

Defined in interfaces.ts:140

Location of viewcube on the screen. Undefined corresponds to hidden type: {(“topleft” | “topright” | “bottomleft” | “bottomright”)}

memberof: ViewerProps