@inweb/viewer-visualize
    Preparing search index...

    Interface IOptions

    Viewer options interface.

    interface IOptions {
        ambientOcclusion?: boolean;
        antialiasing?: string | boolean;
        cameraAnimation?: boolean;
        cameraAxisXSpeed?: number;
        cameraAxisYSpeed?: number;
        cameraMode?: CameraMode;
        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;
        rulerPrecision?: any;
        rulerUnit?: string;
        sceneGraph: boolean;
        shadows?: boolean;
        showWCS?: boolean;
        snapshotMimeType?: string;
        snapshotQuality?: number;
    }
    Index

    Properties

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

    Properties

    ambientOcclusion?: boolean

    Enable ambient occlusion.

    false
    antialiasing?: string | boolean

    Enable anti-aliasing. Can be one of:

    • false - Disable anti-aliasing.
    • true - Enable anti-aliasing using MSAA.
    • fxaa - Enable Fast Approximate anti-aliasing (FXAA).
    • smaa - Enable Subpixel Morphological anti-aliasing (SMAA).
    • msaa - Enable Multisample anti-aliasing (MSAA), if the underlying WebGL context supports it.
    true
    cameraAnimation?: boolean

    Enable camera animation.

    true
    cameraAxisXSpeed?: number

    Camera speed on X axis.

    4
    cameraAxisYSpeed?: number

    Camera speed on Y axis.

    1
    cameraMode?: CameraMode

    Camera projection mode:

    • perspective - Perspective camera with field of view.
    • orthographic - Orthographic camera with parallel projection.
    "perspective"
    cuttingPlaneFillColor?: RGB

    Cutting planes fill color.

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

    Show the edges of the model:

    • false - No model edges are displayed. Usefull for less memory consumption.
    • true - Display isolines.
    edgesColor?: { b: number; g: number; r: number }

    Edges highlight color.

    edgesOverlap?: boolean

    Show highlighted edges over drawing.

    edgesVisibility?: boolean

    Show highlighted edges.

    enableCustomHighlight?: boolean

    Enable custom highlight settings.

    enableGestures: boolean

    Enable touch gestures.

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

    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.

    false
    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.

    true
    enableZoomWheel: boolean

    Enable mouse wheel zooming.

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

    Faces highlight color.

    facesOverlap?: boolean

    Show highlighted faces over drawing.

    facesTransparancy?: number

    Highlighted faces transparency value, from 0 to 255.

    geometryType?: string

    Preferred viewer for newely uploaded files. Can be one of:

    • vsfx - VSFX (default), for opening a file in VisualizeJS viewer.
    • gltf - glTF, for opening a file in Three.js viewer.
    groundShadow?: boolean

    Show ground shadows below the model.

    false
    memoryLimit?: number

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

    3294967296
    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: 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.
    rulerPrecision?: any

    Number of decimal places to display in ruler measurements.

    Controls the precision of distance values shown by the ruler tool. Higher values provide more precision but may clutter the display with unnecessary digits.

    Available values:

    • Default - Use file's native units precision, if supported, otherwise use 2 digits.
    • Auto - Automatically choose precision based on distance value.
    • 0...10 - Use specified number of decimal places (range 0-10, inclusive).
    2
    rulerUnit?: string

    Unit of measurement for the ruler tool (distance measurements).

    When set to Default, the ruler uses the file's native units. Otherwise, distances are automatically converted to the specified unit.

    Available values:

    • Default - Use file's native units (recommended)
    • Millimeters, mm - Metric: 0.001 m
    • Centimeters, cm - Metric: 0.01 m
    • Meters, m - Metric: 1 m (base unit)
    • Kilometers, km - Metric: 1000 m
    • Micrometers, µm - Metric: 0.000001 m
    • Inches, in - Imperial: 0.0254 m
    • Feet, ft - Imperial: 0.3048 m
    • Yards, yd - Imperial: 0.9144 m
    • Miles, mi - Imperial: 1609.344 m
    • Mils, mil - Imperial: 0.0000254 m
    • MicroInches, µin - Imperial: 0.0000000254 m
    "Default"
    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.

    shadows?: boolean

    Enable ambient shadows.

    false
    showWCS?: boolean

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

    true
    snapshotMimeType?: string

    Default MIME type for snapshot images.

    Supported formats:

    • image/png - PNG format with lossless compression (recommended for quality)
    • image/jpeg - JPEG format with lossy compression (smaller file size)
    • image/webp - WebP format (modern browsers only)
    "image/jpeg"
    snapshotQuality?: number

    Default quality level for snapshot images when using lossy formats (JPEG, WebP).

    A number between 0 and 1, where:

    • 0 - Lowest quality, smallest file size
    • 1 - Highest quality, largest file size
    • 0.25 - Good balance between quality and size (recommended)

    This parameter is ignored for lossless formats like PNG.

    0.25

    Settings

    Member Visibility

    On This Page

    Properties