Interface IOptions

Viewer options interface.

interface IOptions {
    ambientOcclusion?: boolean;
    antialiasing?: boolean;
    cameraAnimation?: boolean;
    cameraAxisXSpeed?: number;
    cameraAxisYSpeed?: number;
    cuttingPlaneFillColor?: RGB;
    edgeModel: boolean;
    edgesColor?: { b: number; g: number; r: number };
    edgesOverlap?: boolean;
    edgesVisibility?: boolean;
    enableCustomHighlight?: boolean;
    enableGestures: boolean;
    enablePartialMode?: boolean;
    enableStreamingMode?: boolean;
    enableZoomWheel: boolean;
    facesColor?: { b: number; g: number; r: number };
    facesOverlap?: boolean;
    facesTransparancy?: number;
    geometryType?: string;
    groundShadow?: boolean;
    memoryLimit?: number;
    resetToDefaults?: (fields?: string[]) => void;
    reverseZoomWheel: boolean;
    rulerUnit: string;
    sceneGraph: boolean;
    shadows?: boolean;
    showWCS?: boolean;
}

Properties

ambientOcclusion? antialiasing? cameraAnimation? cameraAxisXSpeed? cameraAxisYSpeed? cuttingPlaneFillColor? edgeModel edgesColor? edgesOverlap? edgesVisibility? enableCustomHighlight? enableGestures enablePartialMode? enableStreamingMode? enableZoomWheel facesColor? facesOverlap? facesTransparancy? geometryType? groundShadow? memoryLimit? resetToDefaults? reverseZoomWheel rulerUnit sceneGraph shadows? showWCS?

Properties

OptionalambientOcclusion

ambientOcclusion?: boolean

Enable ambient occlusion.

Default Value

false

Optionalantialiasing

antialiasing?: boolean

Enable anti-aliasing using FXAA.

Default Value

true

OptionalcameraAnimation

cameraAnimation?: boolean

Enable camera animation.

Default Value

true

OptionalcameraAxisXSpeed

cameraAxisXSpeed?: number

Camera speed on X axis.

Default Value

4

OptionalcameraAxisYSpeed

cameraAxisYSpeed?: number

Camera speed on Y axis.

Default Value

1

OptionalcuttingPlaneFillColor

cuttingPlaneFillColor?: RGB

Cutting planes fill color.

Default Value

{ red: 0xff, green: 0x98, blue: 0x00 }

edgeModel

edgeModel: boolean

Show the edges of the model:

  • false - No model edges are displayed. Usefull for less memory consumption.
  • true - Display isolines.

OptionaledgesColor

edgesColor?: { b: number; g: number; r: number }

Edges highlight color.

OptionaledgesOverlap

edgesOverlap?: boolean

Show highlighted edges over drawing.

OptionaledgesVisibility

edgesVisibility?: boolean

Show highlighted edges.

OptionalenableCustomHighlight

enableCustomHighlight?: boolean

Enable custom highlight settings.

enableGestures

enableGestures: boolean

Enable touch gestures.

This option will be ignored when mouse wheel zooming is disabled, since gestures contains touch zoom.

OptionalenablePartialMode

enablePartialMode?: boolean

Enable partial streaming mode to be able open large drawing.

In partial streaming mode, the viewer keeps only visible objects in memory and loads other objects when the camera changes.

Only used if streaming is enabled. If partial streaming is enabled, then scene graph will be disabled.

Default Value

false

OptionalenableStreamingMode

enableStreamingMode?: boolean

Enable streaming of drawings from the server.

If streaming is disabled, the file/assembly will be loaded in one go. The viewer will only update once the loading is complete, which may take a while.

If streaming is enabled, partial streaming mode may be enabled as well.

Default Value

true

enableZoomWheel

enableZoomWheel: boolean

Enable mouse wheel zooming.

OptionalfacesColor

facesColor?: { b: number; g: number; r: number }

Faces highlight color.

OptionalfacesOverlap

facesOverlap?: boolean

Show highlighted faces over drawing.

OptionalfacesTransparancy

facesTransparancy?: number

Highlighted faces transparency value, from 0 to 255.

OptionalgeometryType

geometryType?: string

Deprecated since 25.8.

OptionalgroundShadow

groundShadow?: boolean

Show ground shadows below the model.

Default Value

false

OptionalmemoryLimit

memoryLimit?: number

The size of the memory buffer for graphics data, in bytes.

Default Value

3294967296

OptionalresetToDefaults

resetToDefaults?: (fields?: string[]) => void

Resets options to default values.

Type declaration

    • (fields?: string[]): void

    • Parameters

      • Optionalfields: string[]

        Name of fields to be reset.

      Returns void

reverseZoomWheel

reverseZoomWheel: boolean

Reverse the mouse wheel direction for zooming:

  • false - Moving the wheel up zooms in, moving down zooms out.
  • true - Moving the wheel up zooms out, moving down zooms in.

rulerUnit

rulerUnit: string

Ruler unit.

Available values: Default, Millimeters, Centimeters, Meters, Feet, Inches, Yards, Kilometers, Miles, Micrometers, MicroInches

Default Value

Default

sceneGraph

sceneGraph: boolean

Enable scene graph.

Scene graph increases perfomance improvement, but consumes memory. If scene graph is enabled, then partial streaming mode will be disabled.

Optionalshadows

shadows?: boolean

Enable ambient shadows.

Default Value

false

OptionalshowWCS

showWCS?: boolean

Show the world coordinate system axes in the bottom-left corner of the viewer.

Default Value

true

Settings

Member Visibility

On This Page

Properties