Interface RendererInitializationOptions

Declarative Initialization Options. Everything here can be changed at runtime with the appropriate call

interface RendererInitializationOptions {
    key?: string;
    ecoRenderingOn?: boolean;
    gui?: {
        useContextMenu?: boolean;
        useSettingsWindow?: boolean;
        usePropertiesWindow?: boolean;
        useDesignTreeWindow?: boolean;
        useFilterElementsWindow?: boolean;
        useSnapshotWindow?: boolean;
        useExportToMap?: boolean;
        useSplitElements?: boolean;
        useMessageBoxes?: boolean;
        useViewsWindows?: boolean;
        viewsDataBinding?: BimCTViewsDataBinding;
        viewsSavingOptions?: BimCTViewsOptions;
        useShareWindow?: boolean;
        sharesDataBinding?: BimCTSharesDataBinding;
        customElementProperties?: {
            editEnabled?: boolean;
            dataBinding?: BimCTCustomElementPropertiesDataBinding;
        };
        map?: {
            visible?: boolean;
            type?: "2D"
            | "3D";
            syncToModelStateChanges?: boolean;
        };
        settings?: {
            showGeneral?: boolean;
            showRenderer?: boolean;
            showEnvironment?: boolean;
        };
        useWebXRWindow?: boolean;
        useToolbar?: boolean;
        useLeftToolbar?: boolean;
        useHomeToolbar?: boolean;
        useTimeChanger?: boolean;
        useTouchWidget?: boolean;
        useQuantitiesLabel?: boolean;
        enableTransformButton?: boolean;
        splashScreenImageURL?: string;
        leftToolbarCustomItems?: BimCTCustomToolbarButton[];
    };
    preloadProperties?: boolean;
    createSQLiteDB?: boolean;
    persistSQLiteDB?: boolean;
    rollOverEnabled?: boolean;
    measurementSystem?: MEASUREMENT_SYSTEM;
    display?: {
        language?: Language;
        decimalSeparator?: DECIMAL_SEPARATOR;
        decimalPlaces?: DecimalPlaces;
        useImperialFractions?: boolean;
    };
    maps?: {
        allowed?: MAP_SERVER[];
        default?: { server: MAP_SERVER; type: MAP_TILE_TYPE };
        terrain?: {
            mapTiler?: { apiKey?: string; selfHostedUrl?: string };
            nomitech?: { hostUrl?: string };
        };
        google?: { apiKey: string };
        layers?: { clientId: string };
        search?: {
            allowDetectUserLocation?: boolean;
            service: MAP_SEARCH_SERVICE;
            apiKey?: string;
        };
        timezone?: TimezoneOptions;
        elevation?: { allowed?: boolean; googleApiKey?: string };
    };
    snappingEnabled?: boolean;
    glassHover?: boolean;
    cube?: RendererCubeOptions;
    assetsPath?: string;
    bimctServerBasePath?: string;
    bimctViewerBasePath?: string;
    logging?: RendererLoggingOptions;
    measurementsDefaults?: MeasurementsDefaults;
    highlightColor?: RGB;
    highlightAlpha?: number;
    highlightXRayAlpha?: number;
    highlightBorderColor?: RGB;
    highlightPointColor?: RGB;
    xRayHighlights?: boolean;
    hybridIgnoreTransparentElements?: boolean;
    hybridAlphaTransparency?: number;
    hybridColorizedAlphaTransparency?: number;
    ambientColor?: RGB;
    backgroundColor?: RGB;
    backgroundColorStart?: RGB;
    backgroundColorEnd?: RGB;
    paperColor?: RGB;
    skymapId?: "grass"
    | "desert"
    | "farm";
    grid?: RendererGridOptions;
    transformationGismo?: TransformationGismoOptions;
    groundShadow?: boolean;
    shadowMaps?: boolean;
    sunLight?: boolean;
    sunFlare?: boolean;
    enhancedSilhouettes?: boolean;
    linesOn?: boolean;
    hatchesOn?: boolean;
    shading?: SHADING_MODE;
    pickMode?: RENDERER_PICK_MODE;
    modelLocation?: ModelLocation;
}

Properties

`Optional`key

key?: string

The domain key ti be used with the BimCT Server, if you dont set it the viewer will only run o localhost environments, a watermakr will be displayed on unlicensed domains. To get a domain key for a web application please contact BimCT Sales

`Optional`ecoRenderingOn

ecoRenderingOn?: boolean

Eco Rendering means always draw render loop, otherwise rendering will stop after 5 seconds of inactivity See also: BaseRenderer.refreshRedrawNeeded

`Optional`gui

gui?: {
    useContextMenu?: boolean;
    useSettingsWindow?: boolean;
    usePropertiesWindow?: boolean;
    useDesignTreeWindow?: boolean;
    useFilterElementsWindow?: boolean;
    useSnapshotWindow?: boolean;
    useExportToMap?: boolean;
    useSplitElements?: boolean;
    useMessageBoxes?: boolean;
    useViewsWindows?: boolean;
    viewsDataBinding?: BimCTViewsDataBinding;
    viewsSavingOptions?: BimCTViewsOptions;
    useShareWindow?: boolean;
    sharesDataBinding?: BimCTSharesDataBinding;
    customElementProperties?: {
        editEnabled?: boolean;
        dataBinding?: BimCTCustomElementPropertiesDataBinding;
    };
    map?: {
        visible?: boolean;
        type?: "2D"
        | "3D";
        syncToModelStateChanges?: boolean;
    };
    settings?: {
        showGeneral?: boolean;
        showRenderer?: boolean;
        showEnvironment?: boolean;
    };
    useWebXRWindow?: boolean;
    useToolbar?: boolean;
    useLeftToolbar?: boolean;
    useHomeToolbar?: boolean;
    useTimeChanger?: boolean;
    useTouchWidget?: boolean;
    useQuantitiesLabel?: boolean;
    enableTransformButton?: boolean;
    splashScreenImageURL?: string;
    leftToolbarCustomItems?: BimCTCustomToolbarButton[];
}

Use the BimCT UI by default everything is set to non used (false)

Type declaration

OptionaluseContextMenu?: boolean
Use Right Click Menu
OptionaluseSettingsWindow?: boolean
Use Settings Window
OptionalusePropertiesWindow?: boolean
Use Properties Window
OptionaluseDesignTreeWindow?: boolean
Use Properties Window
OptionaluseFilterElementsWindow?: boolean
Use Filter Elements
OptionaluseSnapshotWindow?: boolean
Take Snapshots
OptionaluseExportToMap?: boolean
Export Design Model to Tile Layers (requires BimCT Tile Layer server license)
OptionaluseSplitElements?: boolean
Use Split Elements, allow UI for splitting elements into smaller parts, this will also enable the Split Elements Tool in the Toolbar
OptionaluseMessageBoxes?: boolean
Message Boxes
OptionaluseViewsWindows?: boolean
Enable Views Windows
OptionalviewsDataBinding?: BimCTViewsDataBinding
OptionalviewsSavingOptions?: BimCTViewsOptions
OptionaluseShareWindow?: boolean
Use Share Window
OptionalsharesDataBinding?: BimCTSharesDataBinding
OptionalcustomElementProperties?: { editEnabled?: boolean; dataBinding?: BimCTCustomElementPropertiesDataBinding }
Use Custom Properties
Optionalmap?: { visible?: boolean; type?: "2D" | "3D"; syncToModelStateChanges?: boolean }
- Optionalvisible?: boolean
  whether to start the viewer with the map visible default is false
- Optionaltype?: "2D" | "3D"
  whether to start the viewer with the map in 3D or 2D mode default is 2D
- OptionalsyncToModelStateChanges?: boolean
  use this to sync the map model image with what is happening in the viewer (selection changes, visibibily changes, measurements etc), WARNING: this may cause performance issues with big files it is recommended to use this only with smaller files, every time a click is performed an image is made if turning this on
Optionalsettings?: { showGeneral?: boolean; showRenderer?: boolean; showEnvironment?: boolean }
whether to show the general, renderer and environment tabs in the settings window
OptionaluseWebXRWindow?: boolean
WebXR
OptionaluseToolbar?: boolean
Use Default Toolbar
OptionaluseLeftToolbar?: boolean
Use Left Toolbar
OptionaluseHomeToolbar?: boolean
Use Left Toolbar
OptionaluseTimeChanger?: boolean
Show Time Changer (on/off)
OptionaluseTouchWidget?: boolean
Use TouchWidget
OptionaluseQuantitiesLabel?: boolean
Use Quantitites Label
OptionalenableTransformButton?: boolean
Use Quantitites Label
OptionalsplashScreenImageURL?: string
URL of Splash Screen Image
OptionalleftToolbarCustomItems?: BimCTCustomToolbarButton[]
Custom Buttonm Items for the Left Toolbar

`Optional`preloadProperties

preloadProperties?: boolean

Properties Preloaded to ElementInfo, increases the memory of javascript

`Optional`createSQLiteDB

createSQLiteDB?: boolean

Creates an SQLite DataBase than contains the 3D Models Loaded, this will increase the loading time but will allow to use features like SQL Queries using the BimCTMetadataAccessor's DatabaseManager after loading

`Optional`persistSQLiteDB

persistSQLiteDB?: boolean

Persist the SQLite Database in the Browser Storage so that it is available on next sessions

`Optional`rollOverEnabled

rollOverEnabled?: boolean

Eco Rendering means always draw render loop, otherwise rendering will stop after 5 seconds of inactivity See also: BaseRenderer.refreshRedrawNeeded

`Optional`measurementSystem

measurementSystem?: MEASUREMENT_SYSTEM

Define the Measurement System (Imperial or Metric)

`Optional`display

display?: {
    language?: Language;
    decimalSeparator?: DECIMAL_SEPARATOR;
    decimalPlaces?: DecimalPlaces;
    useImperialFractions?: boolean;
}

Display Format and Language for Numbers and Text

`Optional`maps

maps?: {
    allowed?: MAP_SERVER[];
    default?: { server: MAP_SERVER; type: MAP_TILE_TYPE };
    terrain?: {
        mapTiler?: { apiKey?: string; selfHostedUrl?: string };
        nomitech?: { hostUrl?: string };
    };
    google?: { apiKey: string };
    layers?: { clientId: string };
    search?: {
        allowDetectUserLocation?: boolean;
        service: MAP_SEARCH_SERVICE;
        apiKey?: string;
    };
    timezone?: TimezoneOptions;
    elevation?: { allowed?: boolean; googleApiKey?: string };
}

`Optional`snappingEnabled

snappingEnabled?: boolean

Snapping Enabled, will increase the Emscripten Memory and every time you show or hide an element the points will be racomputed

`Optional`glassHover

glassHover?: boolean

Glass Hover over windows

`Optional`cube

cube?: RendererCubeOptions

3D rotation cube Widget Options

`Optional`assetsPath

assetsPath?: string

Assets Base Path, use this to change the assets location

`Optional`bimctServerBasePath

bimctServerBasePath?: string

BimCT Server URL for additional functions lile OCR text, isometric, template matching GIS etc, the license must also support theses features

`Optional`bimctViewerBasePath

bimctViewerBasePath?: string

BimCT Viewer Base Path, place where the bimct-viewer.js is located for creating i-frames for functions like side by side comparison

`Optional`logging

logging?: RendererLoggingOptions

Enable/Disable logging. Default false

`Optional`measurementsDefaults

measurementsDefaults?: MeasurementsDefaults

Defaults for Measurements, used to set the default values for measurements in the viewer

`Optional`highlightColor

highlightColor?: RGB

Highlight Color

`Optional`highlightAlpha

highlightAlpha?: number

Highlight Color Alpha (default 0.8)

`Optional`highlightXRayAlpha

highlightXRayAlpha?: number

Highlight Color Aplha for XRay Mode (default 0.4)

`Optional`highlightBorderColor

highlightBorderColor?: RGB

Highlight Border Color

`Optional`highlightPointColor

highlightPointColor?: RGB

Highlight Point Color

`Optional`xRayHighlights

xRayHighlights?: boolean

Whether to use XRay effect on Highlighted Elements Faces and Measurements

`Optional`hybridIgnoreTransparentElements

hybridIgnoreTransparentElements?: boolean

Whether to ignore transparent element selection in hybrid mode

`Optional`hybridAlphaTransparency

hybridAlphaTransparency?: number

The alpha transparency of the hybrid mode. Default 0.1

`Optional`hybridColorizedAlphaTransparency

hybridColorizedAlphaTransparency?: number

The alpha transparency of the hybrid mode for colorized elements. Default 0.1

`Optional`ambientColor

ambientColor?: RGB

Ambient lighting color. Default rgb(0.7, 0.7, 0.7), applys to non Realistic Modes

`Optional`backgroundColor

backgroundColor?: RGB

Background color. Default rgb(1, 1, 1)

`Optional`backgroundColorStart

backgroundColorStart?: RGB

Background colors for gradient image. Default rgb(1, 1, 1)

`Optional`backgroundColorEnd

backgroundColorEnd?: RGB

`Optional`paperColor

paperColor?: RGB

Paper Color

`Optional`skymapId

skymapId?: "grass" | "desert" | "farm"

Skymap image id available values (desert, grass or null)

`Optional`grid

grid?: RendererGridOptions

Grid on bottom of the design model

`Optional`transformationGismo

transformationGismo?: TransformationGismoOptions

Transformation Gismo Options

`Optional`groundShadow

groundShadow?: boolean

Ground shadow on/off

`Optional`shadowMaps

shadowMaps?: boolean

Shadows on/off (realistic mode only)

`Optional`sunLight

sunLight?: boolean

Sun Light on/off (realistic mode only)

`Optional`sunFlare

sunFlare?: boolean

Sun Flare on/off (realistic mode only)

`Optional`enhancedSilhouettes

enhancedSilhouettes?: boolean

Enhance silhouettes to emphasize edges

`Optional`linesOn

linesOn?: boolean

Lines on/off

`Optional`hatchesOn

hatchesOn?: boolean

Hatches on/off

`Optional`shading

shading?: SHADING_MODE

Initial shading mode

`Optional`pickMode

pickMode?: RENDERER_PICK_MODE

Initial picking mode

`Optional`modelLocation

modelLocation?: ModelLocation

Override Default Model Location (used for true alignment of Sun-Light in the Scene) will used those values instead of those found in design file

Interface RendererInitializationOptions

Index

Properties

Properties

Optionalkey

OptionalecoRenderingOn

Optionalgui

Type declaration

OptionaluseContextMenu?: boolean

OptionaluseSettingsWindow?: boolean

OptionalusePropertiesWindow?: boolean

OptionaluseDesignTreeWindow?: boolean

OptionaluseFilterElementsWindow?: boolean

OptionaluseSnapshotWindow?: boolean

OptionaluseExportToMap?: boolean

OptionaluseSplitElements?: boolean

OptionaluseMessageBoxes?: boolean

OptionaluseViewsWindows?: boolean

OptionalviewsDataBinding?: BimCTViewsDataBinding

OptionalviewsSavingOptions?: BimCTViewsOptions

OptionaluseShareWindow?: boolean

OptionalsharesDataBinding?: BimCTSharesDataBinding

OptionalcustomElementProperties?: { editEnabled?: boolean; dataBinding?: BimCTCustomElementPropertiesDataBinding }

Optionalmap?: { visible?: boolean; type?: "2D" | "3D"; syncToModelStateChanges?: boolean }

Optionalvisible?: boolean

Optionaltype?: "2D" | "3D"

OptionalsyncToModelStateChanges?: boolean

Optionalsettings?: { showGeneral?: boolean; showRenderer?: boolean; showEnvironment?: boolean }

OptionaluseWebXRWindow?: boolean

OptionaluseToolbar?: boolean

OptionaluseLeftToolbar?: boolean

OptionaluseHomeToolbar?: boolean

OptionaluseTimeChanger?: boolean

OptionaluseTouchWidget?: boolean

OptionaluseQuantitiesLabel?: boolean

OptionalenableTransformButton?: boolean

OptionalsplashScreenImageURL?: string

OptionalleftToolbarCustomItems?: BimCTCustomToolbarButton[]

OptionalpreloadProperties

OptionalcreateSQLiteDB

OptionalpersistSQLiteDB

OptionalrollOverEnabled

OptionalmeasurementSystem

Optionaldisplay

Optionalmaps

OptionalsnappingEnabled

OptionalglassHover

Optionalcube

OptionalassetsPath

OptionalbimctServerBasePath

OptionalbimctViewerBasePath

Optionallogging

OptionalmeasurementsDefaults

OptionalhighlightColor

OptionalhighlightAlpha

OptionalhighlightXRayAlpha

OptionalhighlightBorderColor

OptionalhighlightPointColor

OptionalxRayHighlights

OptionalhybridIgnoreTransparentElements

OptionalhybridAlphaTransparency

OptionalhybridColorizedAlphaTransparency

OptionalambientColor

OptionalbackgroundColor

OptionalbackgroundColorStart

OptionalbackgroundColorEnd

OptionalpaperColor

OptionalskymapId

Optionalgrid

OptionaltransformationGismo

OptionalgroundShadow

OptionalshadowMaps

OptionalsunLight

OptionalsunFlare

OptionalenhancedSilhouettes

OptionallinesOn

OptionalhatchesOn

Optionalshading

OptionalpickMode

OptionalmodelLocation

`Optional`key

`Optional`ecoRenderingOn

`Optional`gui

`Optional`useContextMenu?: boolean

`Optional`useSettingsWindow?: boolean

`Optional`usePropertiesWindow?: boolean

`Optional`useDesignTreeWindow?: boolean

`Optional`useFilterElementsWindow?: boolean

`Optional`useSnapshotWindow?: boolean

`Optional`useExportToMap?: boolean

`Optional`useSplitElements?: boolean

`Optional`useMessageBoxes?: boolean

`Optional`useViewsWindows?: boolean

`Optional`viewsDataBinding?: BimCTViewsDataBinding

`Optional`viewsSavingOptions?: BimCTViewsOptions

`Optional`useShareWindow?: boolean

`Optional`sharesDataBinding?: BimCTSharesDataBinding

`Optional`customElementProperties?: { editEnabled?: boolean; dataBinding?: BimCTCustomElementPropertiesDataBinding }

`Optional`map?: { visible?: boolean; type?: "2D" | "3D"; syncToModelStateChanges?: boolean }

`Optional`visible?: boolean

`Optional`type?: "2D" | "3D"

`Optional`syncToModelStateChanges?: boolean

`Optional`settings?: { showGeneral?: boolean; showRenderer?: boolean; showEnvironment?: boolean }

`Optional`useWebXRWindow?: boolean

`Optional`useToolbar?: boolean

`Optional`useLeftToolbar?: boolean

`Optional`useHomeToolbar?: boolean

`Optional`useTimeChanger?: boolean

`Optional`useTouchWidget?: boolean

`Optional`useQuantitiesLabel?: boolean

`Optional`enableTransformButton?: boolean

`Optional`splashScreenImageURL?: string

`Optional`leftToolbarCustomItems?: BimCTCustomToolbarButton[]

`Optional`preloadProperties

`Optional`createSQLiteDB

`Optional`persistSQLiteDB

`Optional`rollOverEnabled

`Optional`measurementSystem

`Optional`display

`Optional`maps

`Optional`snappingEnabled

`Optional`glassHover

`Optional`cube

`Optional`assetsPath

`Optional`bimctServerBasePath

`Optional`bimctViewerBasePath

`Optional`logging

`Optional`measurementsDefaults

`Optional`highlightColor

`Optional`highlightAlpha

`Optional`highlightXRayAlpha

`Optional`highlightBorderColor

`Optional`highlightPointColor

`Optional`xRayHighlights

`Optional`hybridIgnoreTransparentElements

`Optional`hybridAlphaTransparency

`Optional`hybridColorizedAlphaTransparency

`Optional`ambientColor

`Optional`backgroundColor

`Optional`backgroundColorStart

`Optional`backgroundColorEnd

`Optional`paperColor

`Optional`skymapId

`Optional`grid

`Optional`transformationGismo

`Optional`groundShadow

`Optional`shadowMaps

`Optional`sunLight

`Optional`sunFlare

`Optional`enhancedSilhouettes

`Optional`linesOn

`Optional`hatchesOn

`Optional`shading

`Optional`pickMode

`Optional`modelLocation