Skip to main content

novorender-api-docs / namespaces / DataJsAPI / Bookmark

Interface: Bookmark

Bookmark, used to store camera parameters such as postion, rotation, fov etc.

Properties​

camera?​

optional camera: CameraProperties;

Bookmark camera position.


clippingPlanes?​

optional clippingPlanes: ClippingPlanes;

Clipping planes


clippingVolume?​

optional clippingVolume: ClippingVolume;

Clipping volume


defaultVisibility?​

optional defaultVisibility: "neutral" | "semiTransparent" | "transparent";

description?​

optional description: string;

Bookmark description.


followPath?​

optional followPath: object;

Follow path

currentCenter?​

optional currentCenter: vec3;

id​

id: number;

profile​

profile: number;

grid?​

optional grid: object;

Grid settings

axisX​

axisX: ReadonlyVec3;

X axis of the grid, length determines the distance between lines

axisY​

axisY: ReadonlyVec3;

Y axis of the grid, length determines the distance between lines

enabled​

enabled: boolean;

Enable grid plane.

majorColor​

majorColor: ReadonlyVec3;

Color of major grid lines

majorLineCount​

majorLineCount: number;

Number of major lines, odd number needed to have lines go through origo.

minorColor​

minorColor: ReadonlyVec3;

Color of minor grid lines

minorLineCount​

minorLineCount: number;

Number of minor lines between major lines.

origo​

origo: ReadonlyVec3;

Origo of the grid


grouping?​

optional grouping: string;

Grouping.


id?​

optional id: string;

Bookmark id.


img?​

optional img: string;

Bookmark preview image as base64 encoded.


measurement?​

optional measurement: vec3[];

Measurement points


name​

name: string;

Bookmark name.


objectGroups?​

optional objectGroups: ObjectGroup[];

Bookmark objects groups.


objectMeasurement?​

optional objectMeasurement: MeasureObjectPoint[];

Measurement objects points


ortho?​

optional ortho: OrthoControllerParams;

Bookmark ortho camera.


selectedOnly​

selectedOnly: boolean;

Show selection only in 3D


selectionBasket?​

optional selectionBasket: object;

Selection basket

ids​

ids: number[];

mode​

mode: number;