.. role:: ts-api-decorator

########
Instance
########

.. js:module:: Sc
   :noindex:

.. container:: ts-api-section

   .. js:class:: Instance



.. container:: api-index-section

   .. rubric:: Properties

   .. rst-class:: api-index-list-item api-kind-property api-parent-kind-interface

   * :js:attr:`~Sc.Instance.Image`
   * :js:attr:`~Sc.Instance.Matrix`
   * :js:attr:`~Sc.Instance.MeshData`
   * :js:attr:`~Sc.Instance.MeshDataBuilder`
   * :js:attr:`~Sc.Instance.MeshInstance`
   * :js:attr:`~Sc.Instance.Overlay`
   * :js:attr:`~Sc.Instance.allowHighDpi`
   * :js:attr:`~Sc.Instance.canvas`
   * :js:attr:`~Sc.Instance.containers`
   * :js:attr:`~Sc.Instance.wrappers`



.. container:: api-index-section

   .. rubric:: Methods

   .. rst-class:: api-index-list-item api-kind-method api-parent-kind-interface

   * :js:meth:`~Sc.Instance._loseWebGlContext`
   * :js:meth:`~Sc.Instance.addCuttingSection`
   * :js:meth:`~Sc.Instance.addDrawContext`
   * :js:meth:`~Sc.Instance.addLight`
   * :js:meth:`~Sc.Instance.advanceExportToSvg`
   * :js:meth:`~Sc.Instance.advanceVolumeSelection`
   * :js:meth:`~Sc.Instance.attachModels`
   * :js:meth:`~Sc.Instance.attachScsBuffer`
   * :js:meth:`~Sc.Instance.attachScsModelByKey`
   * :js:meth:`~Sc.Instance.beginConvexPolyhedronSelection`
   * :js:meth:`~Sc.Instance.beginExportToSvg`
   * :js:meth:`~Sc.Instance.beginRayDrillSelection`
   * :js:meth:`~Sc.Instance.beginScreenAreaSelection`
   * :js:meth:`~Sc.Instance.beginSphereSelection`
   * :js:meth:`~Sc.Instance.clearLights`
   * :js:meth:`~Sc.Instance.createFloorplanMesh`
   * :js:meth:`~Sc.Instance.cuttingSectionLimits`
   * :js:meth:`~Sc.Instance.debug_log`
   * :js:meth:`~Sc.Instance.debug_stateFailure`
   * :js:meth:`~Sc.Instance.debug_sync`
   * :js:meth:`~Sc.Instance.demandMeshInstances`
   * :js:meth:`~Sc.Instance.detachInclusions`
   * :js:meth:`~Sc.Instance.disableCapping`
   * :js:meth:`~Sc.Instance.disconnectNetwork`
   * :js:meth:`~Sc.Instance.enableCapping`
   * :js:meth:`~Sc.Instance.endComparison`
   * :js:meth:`~Sc.Instance.endVolumeSelection`
   * :js:meth:`~Sc.Instance.explode`
   * :js:meth:`~Sc.Instance.exportToSvg`
   * :js:meth:`~Sc.Instance.feedScsBuffer`
   * :js:meth:`~Sc.Instance.flushMetaDataCache`
   * :js:meth:`~Sc.Instance.getAmbientOcclusionEnabled`
   * :js:meth:`~Sc.Instance.getAmbientOcclusionRadius`
   * :js:meth:`~Sc.Instance.getBackFacesVisible`
   * :js:meth:`~Sc.Instance.getBackgroundGradient`
   * :js:meth:`~Sc.Instance.getCamera`
   * :js:meth:`~Sc.Instance.getCameraPromise`
   * :js:meth:`~Sc.Instance.getCappedInstances`
   * :js:meth:`~Sc.Instance.getCuttingSections`
   * :js:meth:`~Sc.Instance.getDefaultDepthRange`
   * :js:meth:`~Sc.Instance.getElementCount`
   * :js:meth:`~Sc.Instance.getEyeDomeLightingBlurEdgeDistance`
   * :js:meth:`~Sc.Instance.getEyeDomeLightingBlurInterval`
   * :js:meth:`~Sc.Instance.getEyeDomeLightingBlurSamples`
   * :js:meth:`~Sc.Instance.getEyeDomeLightingEnabled`
   * :js:meth:`~Sc.Instance.getEyeDomeLightingOpacity`
   * :js:meth:`~Sc.Instance.getEyeDomeLightingShadingEdgeDistance`
   * :js:meth:`~Sc.Instance.getFaceWindingFlipped`
   * :js:meth:`~Sc.Instance.getFacesVisible`
   * :js:meth:`~Sc.Instance.getFrontFacesVisible`
   * :js:meth:`~Sc.Instance.getInteractiveDrawLimitIncreaseEnabled`
   * :js:meth:`~Sc.Instance.getLight`
   * :js:meth:`~Sc.Instance.getLightKeys`
   * :js:meth:`~Sc.Instance.getLinesVisible`
   * :js:meth:`~Sc.Instance.getLooseBounding`
   * :js:meth:`~Sc.Instance.getMetaData`
   * :js:meth:`~Sc.Instance.getMinFrameRate`
   * :js:meth:`~Sc.Instance.getNetworkVersion`
   * :js:meth:`~Sc.Instance.getPointShape`
   * :js:meth:`~Sc.Instance.getPointSize`
   * :js:meth:`~Sc.Instance.getPointSizeUnit`
   * :js:meth:`~Sc.Instance.getPointsVisible`
   * :js:meth:`~Sc.Instance.getStatistics`
   * :js:meth:`~Sc.Instance.getStreamVersion`
   * :js:meth:`~Sc.Instance.getStreamedBounding`
   * :js:meth:`~Sc.Instance.getTriangleCount`
   * :js:meth:`~Sc.Instance.load`
   * :js:meth:`~Sc.Instance.markAllMeshInstancesInteresting`
   * :js:meth:`~Sc.Instance.markCameraAsEmpty`
   * :js:meth:`~Sc.Instance.meshInstanceKeyInfo`
   * :js:meth:`~Sc.Instance.metaDataKeyInfo`
   * :js:meth:`~Sc.Instance.modelKeysFromInclusionKeys`
   * :js:meth:`~Sc.Instance.onResize`
   * :js:meth:`~Sc.Instance.pauseCapping`
   * :js:meth:`~Sc.Instance.primaryModelKey`
   * :js:meth:`~Sc.Instance.queueRedraw`
   * :js:meth:`~Sc.Instance.registerBimInstances`
   * :js:meth:`~Sc.Instance.removeAllCuttingSections`
   * :js:meth:`~Sc.Instance.removeCuttingSections`
   * :js:meth:`~Sc.Instance.removeDrawContext`
   * :js:meth:`~Sc.Instance.removeLight`
   * :js:meth:`~Sc.Instance.replaceCuttingSection`
   * :js:meth:`~Sc.Instance.requestGroups`
   * :js:meth:`~Sc.Instance.requestImages`
   * :js:meth:`~Sc.Instance.requestMeshInstances`
   * :js:meth:`~Sc.Instance.requestMeshInstancesByGroup`
   * :js:meth:`~Sc.Instance.resetExplode`
   * :js:meth:`~Sc.Instance.resetToEmpty`
   * :js:meth:`~Sc.Instance.resumeCapping`
   * :js:meth:`~Sc.Instance.resumeDrawing`
   * :js:meth:`~Sc.Instance.screenSelectByRay`
   * :js:meth:`~Sc.Instance.serverSideRendering`
   * :js:meth:`~Sc.Instance.setAmbientLightColor`
   * :js:meth:`~Sc.Instance.setAmbientOcclusionBias`
   * :js:meth:`~Sc.Instance.setAmbientOcclusionBlurInterval`
   * :js:meth:`~Sc.Instance.setAmbientOcclusionBlurSamples`
   * :js:meth:`~Sc.Instance.setAmbientOcclusionContrast`
   * :js:meth:`~Sc.Instance.setAmbientOcclusionEdgeDistance`
   * :js:meth:`~Sc.Instance.setAmbientOcclusionEnabled`
   * :js:meth:`~Sc.Instance.setAmbientOcclusionIntensity`
   * :js:meth:`~Sc.Instance.setAmbientOcclusionNoiseSize`
   * :js:meth:`~Sc.Instance.setAmbientOcclusionOpacity`
   * :js:meth:`~Sc.Instance.setAmbientOcclusionRadius`
   * :js:meth:`~Sc.Instance.setAmbientOcclusionSamples`
   * :js:meth:`~Sc.Instance.setAntiAliasingMode`
   * :js:meth:`~Sc.Instance.setBackFacesVisible`
   * :js:meth:`~Sc.Instance.setBackgroundColor`
   * :js:meth:`~Sc.Instance.setBackgroundGradient`
   * :js:meth:`~Sc.Instance.setBloomBlurInterval`
   * :js:meth:`~Sc.Instance.setBloomBlurSamples`
   * :js:meth:`~Sc.Instance.setBloomEnabled`
   * :js:meth:`~Sc.Instance.setBloomIntensity`
   * :js:meth:`~Sc.Instance.setBloomIntensityScale`
   * :js:meth:`~Sc.Instance.setBloomLayerCount`
   * :js:meth:`~Sc.Instance.setBloomThreshold`
   * :js:meth:`~Sc.Instance.setBloomThresholdRampWidth`
   * :js:meth:`~Sc.Instance.setBoundingDebugLevel`
   * :js:meth:`~Sc.Instance.setBoundingPreviewColor`
   * :js:meth:`~Sc.Instance.setBoundingPreviewEjected`
   * :js:meth:`~Sc.Instance.setBoundingPreviewEjectedColor`
   * :js:meth:`~Sc.Instance.setBoundingPreviewTested`
   * :js:meth:`~Sc.Instance.setBoundingPreviewTestedColor`
   * :js:meth:`~Sc.Instance.setBoundingPreviewUnderdraw`
   * :js:meth:`~Sc.Instance.setBoundingPreviewUnderdrawColor`
   * :js:meth:`~Sc.Instance.setCamera`
   * :js:meth:`~Sc.Instance.setCappingIdleHookEnabled`
   * :js:meth:`~Sc.Instance.setClumpingEnabled`
   * :js:meth:`~Sc.Instance.setComparisonColors`
   * :js:meth:`~Sc.Instance.setCurrentView`
   * :js:meth:`~Sc.Instance.setDefaultDepthRange`
   * :js:meth:`~Sc.Instance.setDefaultGloss`
   * :js:meth:`~Sc.Instance.setDefaultMirror`
   * :js:meth:`~Sc.Instance.setDefaultSpecularMix`
   * :js:meth:`~Sc.Instance.setDefaultSphereMap`
   * :js:meth:`~Sc.Instance.setDisplayIncompleteFrames`
   * :js:meth:`~Sc.Instance.setDrawIdleDelay`
   * :js:meth:`~Sc.Instance.setDrawMode`
   * :js:meth:`~Sc.Instance.setDrawStrategy`
   * :js:meth:`~Sc.Instance.setEventHandler`
   * :js:meth:`~Sc.Instance.setEyeDomeLightingBlurEdgeDistance`
   * :js:meth:`~Sc.Instance.setEyeDomeLightingBlurInterval`
   * :js:meth:`~Sc.Instance.setEyeDomeLightingBlurSamples`
   * :js:meth:`~Sc.Instance.setEyeDomeLightingEnabled`
   * :js:meth:`~Sc.Instance.setEyeDomeLightingOpacity`
   * :js:meth:`~Sc.Instance.setEyeDomeLightingShadingEdgeDistance`
   * :js:meth:`~Sc.Instance.setFaceWindingFlipped`
   * :js:meth:`~Sc.Instance.setFacesVisible`
   * :js:meth:`~Sc.Instance.setFixedDrawLimit`
   * :js:meth:`~Sc.Instance.setFrontFacesVisible`
   * :js:meth:`~Sc.Instance.setGoochBaseColorProminence`
   * :js:meth:`~Sc.Instance.setGoochBlue`
   * :js:meth:`~Sc.Instance.setGoochLuminanceShiftStrength`
   * :js:meth:`~Sc.Instance.setGoochYellow`
   * :js:meth:`~Sc.Instance.setGroundPlane`
   * :js:meth:`~Sc.Instance.setGroundPlaneWithPosition`
   * :js:meth:`~Sc.Instance.setHardEdgeColor`
   * :js:meth:`~Sc.Instance.setHardEdgeOpacity`
   * :js:meth:`~Sc.Instance.setHardEdgeThreshold`
   * :js:meth:`~Sc.Instance.setHardEdgeThresholdRampWidth`
   * :js:meth:`~Sc.Instance.setHardEdgesEnabled`
   * :js:meth:`~Sc.Instance.setHiddenLineHiddenLineColor`
   * :js:meth:`~Sc.Instance.setHiddenLineHighlightedElementFillColor`
   * :js:meth:`~Sc.Instance.setHiddenLineHighlightedElementOutlineColor`
   * :js:meth:`~Sc.Instance.setHiddenLineHighlightedInstanceFillColor`
   * :js:meth:`~Sc.Instance.setHiddenLineHighlightedInstanceOutlineColor`
   * :js:meth:`~Sc.Instance.setHiddenLineVisibleLineColor`
   * :js:meth:`~Sc.Instance.setHighlightColorizeCompression`
   * :js:meth:`~Sc.Instance.setHighlightMode`
   * :js:meth:`~Sc.Instance.setHighlightedElementColor`
   * :js:meth:`~Sc.Instance.setHighlightedElementFilter`
   * :js:meth:`~Sc.Instance.setHighlightedElementOutlineColor`
   * :js:meth:`~Sc.Instance.setHighlightedInstanceColor`
   * :js:meth:`~Sc.Instance.setHighlightedInstanceFilter`
   * :js:meth:`~Sc.Instance.setHighlightedInstanceOutlineColor`
   * :js:meth:`~Sc.Instance.setImageBasedLightingEnabled`
   * :js:meth:`~Sc.Instance.setImageBasedLightingEnvironment`
   * :js:meth:`~Sc.Instance.setImageBasedLightingEnvironmentToDefault`
   * :js:meth:`~Sc.Instance.setImageBasedLightingIntensity`
   * :js:meth:`~Sc.Instance.setImageBasedLightingMatrix`
   * :js:meth:`~Sc.Instance.setInstancingEnabled`
   * :js:meth:`~Sc.Instance.setInteractiveDrawLimitIncreaseEnabled`
   * :js:meth:`~Sc.Instance.setInteractiveDrawLimitIncreaseInterval`
   * :js:meth:`~Sc.Instance.setLightingEnabled`
   * :js:meth:`~Sc.Instance.setLineJitterEnabled`
   * :js:meth:`~Sc.Instance.setLineJitterFrequency`
   * :js:meth:`~Sc.Instance.setLineJitterInstanceCount`
   * :js:meth:`~Sc.Instance.setLineJitterRadius`
   * :js:meth:`~Sc.Instance.setLinesVisible`
   * :js:meth:`~Sc.Instance.setMeshLevel`
   * :js:meth:`~Sc.Instance.setMetallicRoughnessMaterialOverride`
   * :js:meth:`~Sc.Instance.setMinDrawLimit`
   * :js:meth:`~Sc.Instance.setMinFrameRate`
   * :js:meth:`~Sc.Instance.setMinIncrementalFrameRate`
   * :js:meth:`~Sc.Instance.setMinInteractiveFrameRate`
   * :js:meth:`~Sc.Instance.setPointShape`
   * :js:meth:`~Sc.Instance.setPointSize`
   * :js:meth:`~Sc.Instance.setPointVisibilityTest`
   * :js:meth:`~Sc.Instance.setPointsVisible`
   * :js:meth:`~Sc.Instance.setPostInputDelay`
   * :js:meth:`~Sc.Instance.setSilhouetteColor`
   * :js:meth:`~Sc.Instance.setSilhouetteEnabled`
   * :js:meth:`~Sc.Instance.setSilhouetteOpacity`
   * :js:meth:`~Sc.Instance.setSilhouetteThreshold`
   * :js:meth:`~Sc.Instance.setSilhouetteThresholdRampWidth`
   * :js:meth:`~Sc.Instance.setSimpleReflectionAttenuation`
   * :js:meth:`~Sc.Instance.setSimpleReflectionBlurInterval`
   * :js:meth:`~Sc.Instance.setSimpleReflectionBlurSamples`
   * :js:meth:`~Sc.Instance.setSimpleReflectionEnabled`
   * :js:meth:`~Sc.Instance.setSimpleReflectionFadeAngle`
   * :js:meth:`~Sc.Instance.setSimpleReflectionOpacity`
   * :js:meth:`~Sc.Instance.setSimpleShadowBlurInterval`
   * :js:meth:`~Sc.Instance.setSimpleShadowBlurSamples`
   * :js:meth:`~Sc.Instance.setSimpleShadowColor`
   * :js:meth:`~Sc.Instance.setSimpleShadowEnabled`
   * :js:meth:`~Sc.Instance.setSimpleShadowInteractiveUpdateEnabled`
   * :js:meth:`~Sc.Instance.setSimpleShadowOpacity`
   * :js:meth:`~Sc.Instance.setSimpleShadowResolution`
   * :js:meth:`~Sc.Instance.setSsrQuality`
   * :js:meth:`~Sc.Instance.setStreamCutoffScale`
   * :js:meth:`~Sc.Instance.setStreamIdleMarker`
   * :js:meth:`~Sc.Instance.setToonBandCount`
   * :js:meth:`~Sc.Instance.setToonSpecularFactor`
   * :js:meth:`~Sc.Instance.setTransparencyMode`
   * :js:meth:`~Sc.Instance.setUnhighlightedColor`
   * :js:meth:`~Sc.Instance.setUnhighlightedFilter`
   * :js:meth:`~Sc.Instance.setVisibilityByAttachment`
   * :js:meth:`~Sc.Instance.setXRayMaterial`
   * :js:meth:`~Sc.Instance.setXRayOpacity`
   * :js:meth:`~Sc.Instance.setXRayTransparencyMode`
   * :js:meth:`~Sc.Instance.shutDown`
   * :js:meth:`~Sc.Instance.startComparison`
   * :js:meth:`~Sc.Instance.startExplode`
   * :js:meth:`~Sc.Instance.suspendDrawing`
   * :js:meth:`~Sc.Instance.testPointVisibility`
   * :js:meth:`~Sc.Instance.throttleLoad`
   * :js:meth:`~Sc.Instance.triangulatePolygon`
   * :js:meth:`~Sc.Instance.truncateMetaData`
   * :js:meth:`~Sc.Instance.unsetAllColors`
   * :js:meth:`~Sc.Instance.unsetAllHighlighted`
   * :js:meth:`~Sc.Instance.unsetAllOpacity`
   * :js:meth:`~Sc.Instance.unsetAllXRay`
   * :js:meth:`~Sc.Instance.unsetCurrentView`
   * :js:meth:`~Sc.Instance.unsetEventHandler`
   * :js:meth:`~Sc.Instance.unsetXRayMaterial`
   * :js:meth:`~Sc.Instance.updateLight`
   * :js:meth:`~Sc.Instance.waitForImageDecoding`
   * :js:meth:`~Sc.Instance.worldSelectByRay`





------------

Properties
==========

.. container:: ts-api-section

   .. js:attribute:: Instance.Image

      :type: ImageInterface





.. container:: ts-api-section

   .. js:attribute:: Instance.Matrix

      :type: MatrixInterface





.. container:: ts-api-section

   .. js:attribute:: Instance.MeshData

      :type: MeshDataInterface





.. container:: ts-api-section

   .. js:attribute:: Instance.MeshDataBuilder

      :type: function




      .. js:function:: MeshDataBuilder()
         :noindex:



         :rtype: MeshDataBuilder





.. container:: ts-api-section

   .. js:attribute:: Instance.MeshInstance

      :type: MeshInstanceInterface





.. container:: ts-api-section

   .. js:attribute:: Instance.Overlay

      :type: OverlayInterface





.. container:: ts-api-section

   .. js:attribute:: Instance.allowHighDpi

      :type: boolean





.. container:: ts-api-section

   .. js:attribute:: Instance.canvas

      :type: OffscreenCanvas | HTMLCanvasElement





.. container:: ts-api-section

   .. js:attribute:: Instance.containers

      :type: Map <ViewKey, Element>





.. container:: ts-api-section

   .. js:attribute:: Instance.wrappers

      :type: Map <ViewKey, HTMLDivElement>





Methods
=======

.. rst-class:: ts-api-section

_loseWebGlContext
-----------------

.. js:method:: Instance._loseWebGlContext()



   :rtype: boolean

.. rst-class:: ts-api-section

addCuttingSection
-----------------

.. js:method:: Instance.addCuttingSection( cuttingPlanes)

   :param cuttingPlanes: None
   :type cuttingPlanes: [Vector4]


   :rtype: Promise <CuttingSectionKey>

.. rst-class:: ts-api-section

addDrawContext
--------------

.. js:method:: Instance.addDrawContext()



   :rtype: Promise <ViewKey>

.. rst-class:: ts-api-section

addLight
--------

.. js:method:: Instance.addLight( viewKey, type, space, position, color)

   :param viewKey: None
   :type viewKey: ViewKey
   :param type: None
   :type type: LightType
   :param space: None
   :type space: LightSpace
   :param position: None
   :type position: Vector3
   :param color: None
   :type color: Vector3


   :rtype: Promise <LightKey>

.. rst-class:: ts-api-section

advanceExportToSvg
------------------

.. js:method:: Instance.advanceExportToSvg()



   :rtype: Promise <[number]>

.. rst-class:: ts-api-section

advanceVolumeSelection
----------------------

.. js:method:: Instance.advanceVolumeSelection( handle, batchCapacity)

   :param handle: None
   :type handle: number
   :param batchCapacity: None
   :type batchCapacity: number


   :rtype: Promise <InstanceIncs>

.. rst-class:: ts-api-section

attachModels
------------

.. js:method:: Instance.attachModels( attachScope, modelNameWithTransform, attachMeasurementUnit, attachInvisibly)

   :param attachScope: None
   :type attachScope: AttachScope
   :param modelNameWithTransform: None
   :type modelNameWithTransform: [(string, Matrix12)]
   :param attachMeasurementUnit: None
   :type attachMeasurementUnit: number
   :param attachInvisibly: None
   :type attachInvisibly: boolean


   :rtype: Promise <void>

.. rst-class:: ts-api-section

attachScsBuffer
---------------

.. js:method:: Instance.attachScsBuffer( attachScope, buffer, inclusionMatrix, attachMeasurementUnit, attachInvisibly, resolveOnFullyLoaded, cancelUnitMatrix)

   :param attachScope: None
   :type attachScope: AttachScope
   :param buffer: None
   :type buffer: Uint8Array
   :param inclusionMatrix: None
   :type inclusionMatrix: Matrix12
   :param attachMeasurementUnit: None
   :type attachMeasurementUnit: number
   :param attachInvisibly: None
   :type attachInvisibly: boolean
   :param resolveOnFullyLoaded: None
   :type resolveOnFullyLoaded: boolean
   :param cancelUnitMatrix: None
   :type cancelUnitMatrix: boolean


   :rtype: Promise <void>

.. rst-class:: ts-api-section

attachScsModelByKey
-------------------

.. js:method:: Instance.attachScsModelByKey( attachScope, matrix, modelKey, attachMeasurementUnit, attachInvisibly)

   :param attachScope: None
   :type attachScope: AttachScope
   :param matrix: None
   :type matrix: Matrix12
   :param modelKey: None
   :type modelKey: ModelKey
   :param attachMeasurementUnit: None
   :type attachMeasurementUnit: number
   :param attachInvisibly: None
   :type attachInvisibly: boolean


   :rtype: InclusionKey

.. rst-class:: ts-api-section

beginConvexPolyhedronSelection
------------------------------

.. js:method:: Instance.beginConvexPolyhedronSelection( volumePlaneCoeffs, heuristicOrigin, config, viewKey)

   :param volumePlaneCoeffs: None
   :type volumePlaneCoeffs: [Vector4]
   :param heuristicOrigin: None
   :type heuristicOrigin: Vector3
   :param config: None
   :type config: VolumeSelectionConfig
   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: Promise <number>

.. rst-class:: ts-api-section

beginExportToSvg
----------------

.. js:method:: Instance.beginExportToSvg( config)

   :param config: None
   :type config: SvgConfig


   :rtype: Promise <void>

.. rst-class:: ts-api-section

beginRayDrillSelection
----------------------

.. js:method:: Instance.beginRayDrillSelection( viewKey, rayCssOriginX, rayCssOriginY, rayCssBoxRadius, config)

   :param viewKey: None
   :type viewKey: ViewKey
   :param rayCssOriginX: None
   :type rayCssOriginX: number
   :param rayCssOriginY: None
   :type rayCssOriginY: number
   :param rayCssBoxRadius: None
   :type rayCssBoxRadius: number
   :param config: None
   :type config: VolumeSelectionConfig


   :rtype: Promise <number>

.. rst-class:: ts-api-section

beginScreenAreaSelection
------------------------

.. js:method:: Instance.beginScreenAreaSelection( viewKey, areaCssMinX, areaCssMinY, areaCssMaxX, areaCssMaxY, config)

   :param viewKey: None
   :type viewKey: ViewKey
   :param areaCssMinX: None
   :type areaCssMinX: number
   :param areaCssMinY: None
   :type areaCssMinY: number
   :param areaCssMaxX: None
   :type areaCssMaxX: number
   :param areaCssMaxY: None
   :type areaCssMaxY: number
   :param config: None
   :type config: VolumeSelectionConfig


   :rtype: Promise <number>

.. rst-class:: ts-api-section

beginSphereSelection
--------------------

.. js:method:: Instance.beginSphereSelection( viewKey, sphereCenter, sphereRadius, config)

   :param viewKey: None
   :type viewKey: ViewKey
   :param sphereCenter: None
   :type sphereCenter: Vector3
   :param sphereRadius: None
   :type sphereRadius: number
   :param config: None
   :type config: VolumeSelectionConfig


   :rtype: Promise <number>

.. rst-class:: ts-api-section

clearLights
-----------

.. js:method:: Instance.clearLights( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: void

.. rst-class:: ts-api-section

createFloorplanMesh
-------------------

.. js:method:: Instance.createFloorplanMesh( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: Promise <InstanceIncs>

.. rst-class:: ts-api-section

cuttingSectionLimits
--------------------

.. js:method:: Instance.cuttingSectionLimits()



   :rtype: CuttingSectionLimits

.. rst-class:: ts-api-section

debug_log
---------

.. js:method:: Instance.debug_log( message)

   :param message: None
   :type message: string


   :rtype: Promise <void>

.. rst-class:: ts-api-section

debug_stateFailure
------------------

.. js:method:: Instance.debug_stateFailure( stateFailureValue)

   :param stateFailureValue: None
   :type stateFailureValue: number


   :rtype: Promise <void>

.. rst-class:: ts-api-section

debug_sync
----------

.. js:method:: Instance.debug_sync()



   :rtype: Promise <void>

.. rst-class:: ts-api-section

demandMeshInstances
-------------------

.. js:method:: Instance.demandMeshInstances( incs)

   :param incs: None
   :type incs: InstanceIncs


   :rtype: void

.. rst-class:: ts-api-section

detachInclusions
----------------

.. js:method:: Instance.detachInclusions( inclusionKeys)

   :param inclusionKeys: None
   :type inclusionKeys: [InclusionKey]


   :rtype: Promise <void>

.. rst-class:: ts-api-section

disableCapping
--------------

.. js:method:: Instance.disableCapping( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: void

.. rst-class:: ts-api-section

disconnectNetwork
-----------------

.. js:method:: Instance.disconnectNetwork()



   :rtype: void

.. rst-class:: ts-api-section

enableCapping
-------------

.. js:method:: Instance.enableCapping( viewKey, lineColor, faceColor, quantizationGranularity)

   :param viewKey: None
   :type viewKey: ViewKey
   :param lineColor: None
   :type lineColor: Vector4
   :param faceColor: None
   :type faceColor: Vector4
   :param quantizationGranularity: None
   :type quantizationGranularity: number


   :rtype: void

.. rst-class:: ts-api-section

endComparison
-------------

.. js:method:: Instance.endComparison( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: void

.. rst-class:: ts-api-section

endVolumeSelection
------------------

.. js:method:: Instance.endVolumeSelection( handle)

   :param handle: None
   :type handle: number


   :rtype: void

.. rst-class:: ts-api-section

explode
-------

.. js:method:: Instance.explode( distance)

   :param distance: None
   :type distance: number


   :rtype: void

.. rst-class:: ts-api-section

exportToSvg
-----------

.. js:method:: Instance.exportToSvg( config)

   :param config: None
   :type config: SvgConfig


   :rtype: Promise <[number]>

.. rst-class:: ts-api-section

feedScsBuffer
-------------

.. js:method:: Instance.feedScsBuffer( attachScope, buffer)

   :param attachScope: None
   :type attachScope: AttachScope
   :param buffer: None
   :type buffer: null | Uint8Array


   :rtype: void

.. rst-class:: ts-api-section

flushMetaDataCache
------------------

.. js:method:: Instance.flushMetaDataCache()



   :rtype: void

.. rst-class:: ts-api-section

getAmbientOcclusionEnabled
--------------------------

.. js:method:: Instance.getAmbientOcclusionEnabled( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: Promise <boolean>

.. rst-class:: ts-api-section

getAmbientOcclusionRadius
-------------------------

.. js:method:: Instance.getAmbientOcclusionRadius( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: Promise <number>

.. rst-class:: ts-api-section

getBackFacesVisible
-------------------

.. js:method:: Instance.getBackFacesVisible( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: Promise <boolean>

.. rst-class:: ts-api-section

getBackgroundGradient
---------------------

.. js:method:: Instance.getBackgroundGradient( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: Promise <(Vector4, Vector4)>

.. rst-class:: ts-api-section

getCamera
---------

.. js:method:: Instance.getCamera( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: Camera

.. rst-class:: ts-api-section

getCameraPromise
----------------

.. js:method:: Instance.getCameraPromise( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: Promise <Camera>

.. rst-class:: ts-api-section

getCappedInstances
------------------

.. js:method:: Instance.getCappedInstances()



   :rtype: Promise <InstanceIncs>

.. rst-class:: ts-api-section

getCuttingSections
------------------

.. js:method:: Instance.getCuttingSections( sectionKeys)

   :param sectionKeys: None
   :type sectionKeys: [CuttingSectionKey]


   :rtype: Promise <[Vector4]>

.. rst-class:: ts-api-section

getDefaultDepthRange
--------------------

.. js:method:: Instance.getDefaultDepthRange( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: Promise <Range>

.. rst-class:: ts-api-section

getElementCount
---------------

.. js:method:: Instance.getElementCount()



   :rtype: Promise <number>

.. rst-class:: ts-api-section

getEyeDomeLightingBlurEdgeDistance
----------------------------------

.. js:method:: Instance.getEyeDomeLightingBlurEdgeDistance( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: Promise <number>

.. rst-class:: ts-api-section

getEyeDomeLightingBlurInterval
------------------------------

.. js:method:: Instance.getEyeDomeLightingBlurInterval( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: Promise <number>

.. rst-class:: ts-api-section

getEyeDomeLightingBlurSamples
-----------------------------

.. js:method:: Instance.getEyeDomeLightingBlurSamples( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: Promise <number>

.. rst-class:: ts-api-section

getEyeDomeLightingEnabled
-------------------------

.. js:method:: Instance.getEyeDomeLightingEnabled( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: Promise <boolean>

.. rst-class:: ts-api-section

getEyeDomeLightingOpacity
-------------------------

.. js:method:: Instance.getEyeDomeLightingOpacity( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: Promise <number>

.. rst-class:: ts-api-section

getEyeDomeLightingShadingEdgeDistance
-------------------------------------

.. js:method:: Instance.getEyeDomeLightingShadingEdgeDistance( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: Promise <number>

.. rst-class:: ts-api-section

getFaceWindingFlipped
---------------------

.. js:method:: Instance.getFaceWindingFlipped( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: Promise <boolean>

.. rst-class:: ts-api-section

getFacesVisible
---------------

.. js:method:: Instance.getFacesVisible( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: Promise <boolean>

.. rst-class:: ts-api-section

getFrontFacesVisible
--------------------

.. js:method:: Instance.getFrontFacesVisible( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: Promise <boolean>

.. rst-class:: ts-api-section

getInteractiveDrawLimitIncreaseEnabled
--------------------------------------

.. js:method:: Instance.getInteractiveDrawLimitIncreaseEnabled( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: Promise <boolean>

.. rst-class:: ts-api-section

getLight
--------

.. js:method:: Instance.getLight( viewKey, key)

   :param viewKey: None
   :type viewKey: ViewKey
   :param key: None
   :type key: LightKey


   :rtype: Promise <Light>

.. rst-class:: ts-api-section

getLightKeys
------------

.. js:method:: Instance.getLightKeys( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: Promise <[LightKey]>

.. rst-class:: ts-api-section

getLinesVisible
---------------

.. js:method:: Instance.getLinesVisible( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: Promise <boolean>

.. rst-class:: ts-api-section

getLooseBounding
----------------

.. js:method:: Instance.getLooseBounding()



   :rtype: Promise <IBox>

.. rst-class:: ts-api-section

getMetaData
-----------

.. js:method:: Instance.getMetaData( ids)

   :param ids: None
   :type ids: DataIds


   :rtype: Promise <[Uint8Array]>

.. rst-class:: ts-api-section

getMinFrameRate
---------------

.. js:method:: Instance.getMinFrameRate( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: Promise <number>

.. rst-class:: ts-api-section

getNetworkVersion
-----------------

.. js:method:: Instance.getNetworkVersion()



   :rtype: number

.. rst-class:: ts-api-section

getPointShape
-------------

.. js:method:: Instance.getPointShape( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: Promise <PointShape>

.. rst-class:: ts-api-section

getPointSize
------------

.. js:method:: Instance.getPointSize( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: Promise <number>

.. rst-class:: ts-api-section

getPointSizeUnit
----------------

.. js:method:: Instance.getPointSizeUnit( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: Promise <PointSizeUnit>

.. rst-class:: ts-api-section

getPointsVisible
----------------

.. js:method:: Instance.getPointsVisible( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: Promise <boolean>

.. rst-class:: ts-api-section

getStatistics
-------------

.. js:method:: Instance.getStatistics()



   :rtype: Promise <Statistics>

.. rst-class:: ts-api-section

getStreamVersion
----------------

.. js:method:: Instance.getStreamVersion()



   :rtype: number

.. rst-class:: ts-api-section

getStreamedBounding
-------------------

.. js:method:: Instance.getStreamedBounding()



   :rtype: Promise <IBox>

.. rst-class:: ts-api-section

getTriangleCount
----------------

.. js:method:: Instance.getTriangleCount()



   :rtype: Promise <number>

.. rst-class:: ts-api-section

load
----

.. js:method:: Instance.load( configuration)

   :param configuration: None
   :type configuration: LoadConfig


   :rtype: SessionType

.. rst-class:: ts-api-section

markAllMeshInstancesInteresting
-------------------------------

.. js:method:: Instance.markAllMeshInstancesInteresting( interesting)

   :param interesting: None
   :type interesting: boolean


   :rtype: void

.. rst-class:: ts-api-section

markCameraAsEmpty
-----------------

.. js:method:: Instance.markCameraAsEmpty( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: void

.. rst-class:: ts-api-section

meshInstanceKeyInfo
-------------------

.. js:method:: Instance.meshInstanceKeyInfo( modelKeyOrAttachScope, byModel, keyCountOnly)

   :param modelKeyOrAttachScope: None
   :type modelKeyOrAttachScope: ModelKey | AttachScope
   :param byModel: None
   :type byModel: boolean
   :param keyCountOnly: None
   :type keyCountOnly: boolean


   :rtype: Promise <(number) | [ModelKey | InstanceKey]>

.. rst-class:: ts-api-section

metaDataKeyInfo
---------------

.. js:method:: Instance.metaDataKeyInfo( modelKeyOrAttachScope, byModel, keyCountOnly)

   :param modelKeyOrAttachScope: None
   :type modelKeyOrAttachScope: ModelKey | AttachScope
   :param byModel: None
   :type byModel: boolean
   :param keyCountOnly: None
   :type keyCountOnly: boolean


   :rtype: Promise <(number) | [ModelKey | DataKey]>

.. rst-class:: ts-api-section

modelKeysFromInclusionKeys
--------------------------

.. js:method:: Instance.modelKeysFromInclusionKeys( inclusionKeys)

   :param inclusionKeys: None
   :type inclusionKeys: [InclusionKey]


   :rtype: Promise <[ModelKey]>

.. rst-class:: ts-api-section

onResize
--------

.. js:method:: Instance.onResize( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: void

.. rst-class:: ts-api-section

pauseCapping
------------

.. js:method:: Instance.pauseCapping()



   :rtype: void

.. rst-class:: ts-api-section

primaryModelKey
---------------

.. js:method:: Instance.primaryModelKey()



   :rtype: Promise <ModelKey>

.. rst-class:: ts-api-section

queueRedraw
-----------

.. js:method:: Instance.queueRedraw( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: void

.. rst-class:: ts-api-section

registerBimInstances
--------------------

.. js:method:: Instance.registerBimInstances( incs, bimType)

   :param incs: None
   :type incs: InstanceIncs
   :param bimType: None
   :type bimType: BimType


   :rtype: void

.. rst-class:: ts-api-section

removeAllCuttingSections
------------------------

.. js:method:: Instance.removeAllCuttingSections()



   :rtype: void

.. rst-class:: ts-api-section

removeCuttingSections
---------------------

.. js:method:: Instance.removeCuttingSections( sectionHandles)

   :param sectionHandles: None
   :type sectionHandles: [CuttingSectionKey]


   :rtype: Promise <void>

.. rst-class:: ts-api-section

removeDrawContext
-----------------

.. js:method:: Instance.removeDrawContext( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: void

.. rst-class:: ts-api-section

removeLight
-----------

.. js:method:: Instance.removeLight( viewKey, key)

   :param viewKey: None
   :type viewKey: ViewKey
   :param key: None
   :type key: LightKey


   :rtype: void

.. rst-class:: ts-api-section

replaceCuttingSection
---------------------

.. js:method:: Instance.replaceCuttingSection( cuttingPlanes, key)

   :param cuttingPlanes: None
   :type cuttingPlanes: [Vector4]
   :param key: None
   :type key: CuttingSectionKey


   :rtype: Promise <void>

.. rst-class:: ts-api-section

requestGroups
-------------

.. js:method:: Instance.requestGroups( groupIds, obtainDependentGroups)

   :param groupIds: None
   :type groupIds: GroupIds
   :param obtainDependentGroups: None
   :type obtainDependentGroups: boolean


   :rtype: Promise <void>

.. rst-class:: ts-api-section

requestImages
-------------

.. js:method:: Instance.requestImages( imageIds, wantThumbnails)

   :param imageIds: None
   :type imageIds: ImageIds
   :param wantThumbnails: None
   :type wantThumbnails: boolean


   :rtype: Promise <void>

.. rst-class:: ts-api-section

requestMeshInstances
--------------------

.. js:method:: Instance.requestMeshInstances( incs, withMeshData, ignoreFailure)

   :param incs: None
   :type incs: InstanceIncs
   :param withMeshData: None
   :type withMeshData: boolean
   :param ignoreFailure: None
   :type ignoreFailure: boolean


   :rtype: Promise <void>

.. rst-class:: ts-api-section

requestMeshInstancesByGroup
---------------------------

.. js:method:: Instance.requestMeshInstancesByGroup( groupId, withMeshData, expandGroups)

   :param groupId: None
   :type groupId: GroupIds
   :param withMeshData: None
   :type withMeshData: boolean
   :param expandGroups: None
   :type expandGroups: boolean


   :rtype: Promise <void>

.. rst-class:: ts-api-section

resetExplode
------------

.. js:method:: Instance.resetExplode()



   :rtype: void

.. rst-class:: ts-api-section

resetToEmpty
------------

.. js:method:: Instance.resetToEmpty( whitelistInstances, whitelistMeshes)

   :param whitelistInstances: None
   :type whitelistInstances: [InstanceKey]
   :param whitelistMeshes: None
   :type whitelistMeshes: [MeshKey]


   :rtype: Promise <void>

.. rst-class:: ts-api-section

resumeCapping
-------------

.. js:method:: Instance.resumeCapping()



   :rtype: void

.. rst-class:: ts-api-section

resumeDrawing
-------------

.. js:method:: Instance.resumeDrawing( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: void

.. rst-class:: ts-api-section

screenSelectByRay
-----------------

.. js:method:: Instance.screenSelectByRay( viewKey, elementMask, canvasX, canvasY, maxPixelTolerance, config)

   :param viewKey: None
   :type viewKey: ViewKey
   :param elementMask: None
   :type elementMask: number
   :param canvasX: None
   :type canvasX: number
   :param canvasY: None
   :type canvasY: number
   :param maxPixelTolerance: None
   :type maxPixelTolerance: number
   :param config: None
   :type config: RaySelectionConfig


   :rtype: Promise <PickResult>

.. rst-class:: ts-api-section

serverSideRendering
-------------------

.. js:method:: Instance.serverSideRendering()



   :rtype: boolean

.. rst-class:: ts-api-section

setAmbientLightColor
--------------------

.. js:method:: Instance.setAmbientLightColor( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: Vector3


   :rtype: void

.. rst-class:: ts-api-section

setAmbientOcclusionBias
-----------------------

.. js:method:: Instance.setAmbientOcclusionBias( viewKey, bias)

   :param viewKey: None
   :type viewKey: ViewKey
   :param bias: None
   :type bias: number


   :rtype: void

.. rst-class:: ts-api-section

setAmbientOcclusionBlurInterval
-------------------------------

.. js:method:: Instance.setAmbientOcclusionBlurInterval( viewKey, interval)

   :param viewKey: None
   :type viewKey: ViewKey
   :param interval: None
   :type interval: number


   :rtype: void

.. rst-class:: ts-api-section

setAmbientOcclusionBlurSamples
------------------------------

.. js:method:: Instance.setAmbientOcclusionBlurSamples( viewKey, samples)

   :param viewKey: None
   :type viewKey: ViewKey
   :param samples: None
   :type samples: number


   :rtype: void

.. rst-class:: ts-api-section

setAmbientOcclusionContrast
---------------------------

.. js:method:: Instance.setAmbientOcclusionContrast( viewKey, contrast)

   :param viewKey: None
   :type viewKey: ViewKey
   :param contrast: None
   :type contrast: number


   :rtype: void

.. rst-class:: ts-api-section

setAmbientOcclusionEdgeDistance
-------------------------------

.. js:method:: Instance.setAmbientOcclusionEdgeDistance( viewKey, distance)

   :param viewKey: None
   :type viewKey: ViewKey
   :param distance: None
   :type distance: number


   :rtype: void

.. rst-class:: ts-api-section

setAmbientOcclusionEnabled
--------------------------

.. js:method:: Instance.setAmbientOcclusionEnabled( viewKey, enabled)

   :param viewKey: None
   :type viewKey: ViewKey
   :param enabled: None
   :type enabled: boolean


   :rtype: void

.. rst-class:: ts-api-section

setAmbientOcclusionIntensity
----------------------------

.. js:method:: Instance.setAmbientOcclusionIntensity( viewKey, intensity)

   :param viewKey: None
   :type viewKey: ViewKey
   :param intensity: None
   :type intensity: number


   :rtype: void

.. rst-class:: ts-api-section

setAmbientOcclusionNoiseSize
----------------------------

.. js:method:: Instance.setAmbientOcclusionNoiseSize( viewKey, size)

   :param viewKey: None
   :type viewKey: ViewKey
   :param size: None
   :type size: number


   :rtype: void

.. rst-class:: ts-api-section

setAmbientOcclusionOpacity
--------------------------

.. js:method:: Instance.setAmbientOcclusionOpacity( viewKey, opacity)

   :param viewKey: None
   :type viewKey: ViewKey
   :param opacity: None
   :type opacity: number


   :rtype: void

.. rst-class:: ts-api-section

setAmbientOcclusionRadius
-------------------------

.. js:method:: Instance.setAmbientOcclusionRadius( viewKey, radius)

   :param viewKey: None
   :type viewKey: ViewKey
   :param radius: None
   :type radius: number


   :rtype: void

.. rst-class:: ts-api-section

setAmbientOcclusionSamples
--------------------------

.. js:method:: Instance.setAmbientOcclusionSamples( viewKey, samples)

   :param viewKey: None
   :type viewKey: ViewKey
   :param samples: None
   :type samples: number


   :rtype: void

.. rst-class:: ts-api-section

setAntiAliasingMode
-------------------

.. js:method:: Instance.setAntiAliasingMode( viewKey, antiAliasingMode)

   :param viewKey: None
   :type viewKey: ViewKey
   :param antiAliasingMode: None
   :type antiAliasingMode: AntiAliasingMode


   :rtype: void

.. rst-class:: ts-api-section

setBackFacesVisible
-------------------

.. js:method:: Instance.setBackFacesVisible( viewKey, visible)

   :param viewKey: None
   :type viewKey: ViewKey
   :param visible: None
   :type visible: boolean


   :rtype: void

.. rst-class:: ts-api-section

setBackgroundColor
------------------

.. js:method:: Instance.setBackgroundColor( viewKey, color)

   :param viewKey: None
   :type viewKey: ViewKey
   :param color: None
   :type color: Vector4


   :rtype: void

.. rst-class:: ts-api-section

setBackgroundGradient
---------------------

.. js:method:: Instance.setBackgroundGradient( viewKey, top, bottom)

   :param viewKey: None
   :type viewKey: ViewKey
   :param top: None
   :type top: Vector4
   :param bottom: None
   :type bottom: Vector4


   :rtype: void

.. rst-class:: ts-api-section

setBloomBlurInterval
--------------------

.. js:method:: Instance.setBloomBlurInterval( viewKey, layer, value, unit)

   :param viewKey: None
   :type viewKey: ViewKey
   :param layer: None
   :type layer: number
   :param value: None
   :type value: number
   :param unit: None
   :type unit: BlurIntervalUnit


   :rtype: void

.. rst-class:: ts-api-section

setBloomBlurSamples
-------------------

.. js:method:: Instance.setBloomBlurSamples( viewKey, layer, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param layer: None
   :type layer: number
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setBloomEnabled
---------------

.. js:method:: Instance.setBloomEnabled( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: boolean


   :rtype: void

.. rst-class:: ts-api-section

setBloomIntensity
-----------------

.. js:method:: Instance.setBloomIntensity( viewKey, layer, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param layer: None
   :type layer: number
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setBloomIntensityScale
----------------------

.. js:method:: Instance.setBloomIntensityScale( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setBloomLayerCount
------------------

.. js:method:: Instance.setBloomLayerCount( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setBloomThreshold
-----------------

.. js:method:: Instance.setBloomThreshold( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setBloomThresholdRampWidth
--------------------------

.. js:method:: Instance.setBloomThresholdRampWidth( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setBoundingDebugLevel
---------------------

.. js:method:: Instance.setBoundingDebugLevel( viewKey, level)

   :param viewKey: None
   :type viewKey: ViewKey
   :param level: None
   :type level: number


   :rtype: void

.. rst-class:: ts-api-section

setBoundingPreviewColor
-----------------------

.. js:method:: Instance.setBoundingPreviewColor( viewKey, color)

   :param viewKey: None
   :type viewKey: ViewKey
   :param color: None
   :type color: Vector4


   :rtype: void

.. rst-class:: ts-api-section

setBoundingPreviewEjected
-------------------------

.. js:method:: Instance.setBoundingPreviewEjected( points, viewKey)

   :param points: None
   :type points: [Vector3]
   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: void

.. rst-class:: ts-api-section

setBoundingPreviewEjectedColor
------------------------------

.. js:method:: Instance.setBoundingPreviewEjectedColor( viewKey, color)

   :param viewKey: None
   :type viewKey: ViewKey
   :param color: None
   :type color: Vector4


   :rtype: void

.. rst-class:: ts-api-section

setBoundingPreviewTested
------------------------

.. js:method:: Instance.setBoundingPreviewTested( points, viewKey)

   :param points: None
   :type points: [Vector3]
   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: void

.. rst-class:: ts-api-section

setBoundingPreviewTestedColor
-----------------------------

.. js:method:: Instance.setBoundingPreviewTestedColor( viewKey, color)

   :param viewKey: None
   :type viewKey: ViewKey
   :param color: None
   :type color: Vector4


   :rtype: void

.. rst-class:: ts-api-section

setBoundingPreviewUnderdraw
---------------------------

.. js:method:: Instance.setBoundingPreviewUnderdraw( points, viewKey)

   :param points: None
   :type points: [Vector3]
   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: void

.. rst-class:: ts-api-section

setBoundingPreviewUnderdrawColor
--------------------------------

.. js:method:: Instance.setBoundingPreviewUnderdrawColor( viewKey, color)

   :param viewKey: None
   :type viewKey: ViewKey
   :param color: None
   :type color: Vector4


   :rtype: void

.. rst-class:: ts-api-section

setCamera
---------

.. js:method:: Instance.setCamera( viewKey, camera)

   :param viewKey: None
   :type viewKey: ViewKey
   :param camera: None
   :type camera: Camera


   :rtype: void

.. rst-class:: ts-api-section

setCappingIdleHookEnabled
-------------------------

.. js:method:: Instance.setCappingIdleHookEnabled( enable)

   :param enable: None
   :type enable: boolean


   :rtype: Promise <boolean>

.. rst-class:: ts-api-section

setClumpingEnabled
------------------

.. js:method:: Instance.setClumpingEnabled( value)

   :param value: None
   :type value: boolean


   :rtype: void

.. rst-class:: ts-api-section

setComparisonColors
-------------------

.. js:method:: Instance.setComparisonColors( viewKey, sameColor, only1Color, only2Color)

   :param viewKey: None
   :type viewKey: ViewKey
   :param sameColor: None
   :type sameColor: Vector3
   :param only1Color: None
   :type only1Color: Vector3
   :param only2Color: None
   :type only2Color: Vector3


   :rtype: void

.. rst-class:: ts-api-section

setCurrentView
--------------

.. js:method:: Instance.setCurrentView( viewKey, view)

   :param viewKey: None
   :type viewKey: ViewKey
   :param view: None
   :type view: ViewKey


   :rtype: void

.. rst-class:: ts-api-section

setDefaultDepthRange
--------------------

.. js:method:: Instance.setDefaultDepthRange( viewKey, min, max)

   :param viewKey: None
   :type viewKey: ViewKey
   :param min: None
   :type min: number
   :param max: None
   :type max: number


   :rtype: void

.. rst-class:: ts-api-section

setDefaultGloss
---------------

.. js:method:: Instance.setDefaultGloss( viewKey, gloss)

   :param viewKey: None
   :type viewKey: ViewKey
   :param gloss: None
   :type gloss: number


   :rtype: void

.. rst-class:: ts-api-section

setDefaultMirror
----------------

.. js:method:: Instance.setDefaultMirror( viewKey, mirror)

   :param viewKey: None
   :type viewKey: ViewKey
   :param mirror: None
   :type mirror: number


   :rtype: void

.. rst-class:: ts-api-section

setDefaultSpecularMix
---------------------

.. js:method:: Instance.setDefaultSpecularMix( viewKey, mix)

   :param viewKey: None
   :type viewKey: ViewKey
   :param mix: None
   :type mix: number


   :rtype: void

.. rst-class:: ts-api-section

setDefaultSphereMap
-------------------

.. js:method:: Instance.setDefaultSphereMap( viewKey, imageId)

   :param viewKey: None
   :type viewKey: ViewKey
   :param imageId: None
   :type imageId: ImageId


   :rtype: void

.. rst-class:: ts-api-section

setDisplayIncompleteFrames
--------------------------

.. js:method:: Instance.setDisplayIncompleteFrames( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: boolean


   :rtype: void

.. rst-class:: ts-api-section

setDrawIdleDelay
----------------

.. js:method:: Instance.setDrawIdleDelay( viewKey, delay)

   :param viewKey: None
   :type viewKey: ViewKey
   :param delay: None
   :type delay: number


   :rtype: void

.. rst-class:: ts-api-section

setDrawMode
-----------

.. js:method:: Instance.setDrawMode( viewKey, drawMode)

   :param viewKey: None
   :type viewKey: ViewKey
   :param drawMode: None
   :type drawMode: DrawMode


   :rtype: void

.. rst-class:: ts-api-section

setDrawStrategy
---------------

.. js:method:: Instance.setDrawStrategy( viewKey, strategy)

   :param viewKey: None
   :type viewKey: ViewKey
   :param strategy: None
   :type strategy: DrawStrategy


   :rtype: void

.. rst-class:: ts-api-section

setEventHandler
---------------

.. js:method:: Instance.setEventHandler( eventName, callback)

   :param eventName: None
   :type eventName: announce_model
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, attachScope, masterModelKey)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param attachScope: None
      :type attachScope: AttachScope
      :param masterModelKey: None
      :type masterModelKey: MasterModelKey


      :rtype: void



.. js:method:: Instance.setEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: bad_data
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, data)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param data: None
      :type data: BadDataData


      :rtype: void



.. js:method:: Instance.setEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: bounding
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName)
      :noindex:

      :param eventName: None
      :type eventName: string


      :rtype: void



.. js:method:: Instance.setEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: camera_set
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, viewKey)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param viewKey: None
      :type viewKey: ViewKey


      :rtype: void



.. js:method:: Instance.setEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: capping_idle
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, isIdle, cappedInstanceCount)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param isIdle: None
      :type isIdle: boolean
      :param cappedInstanceCount: None
      :type cappedInstanceCount: number


      :rtype: void



.. js:method:: Instance.setEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: client_message
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, data)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param data: None
      :type data: string


      :rtype: void



.. js:method:: Instance.setEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: draw_complete
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, viewKey)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param viewKey: None
      :type viewKey: ViewKey


      :rtype: void



.. js:method:: Instance.setEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: draw_idle
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, viewKey)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param viewKey: None
      :type viewKey: ViewKey


      :rtype: void



.. js:method:: Instance.setEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: first_instance
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName)
      :noindex:

      :param eventName: None
      :type eventName: string


      :rtype: void



.. js:method:: Instance.setEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: inclusion
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, attachScope, inclusionKey, modelKey)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param attachScope: None
      :type attachScope: AttachScope
      :param inclusionKey: None
      :type inclusionKey: InclusionKey
      :param modelKey: None
      :type modelKey: ModelKey


      :rtype: void



.. js:method:: Instance.setEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: meta_data
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, modelKey, dataKey, data)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param modelKey: None
      :type modelKey: ModelKey
      :param dataKey: None
      :type dataKey: DataKey
      :param data: None
      :type data: Uint8Array


      :rtype: void



.. js:method:: Instance.setEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: missing_model
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, attachScope, modelPath)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param attachScope: None
      :type attachScope: AttachScope
      :param modelPath: None
      :type modelPath: string


      :rtype: void



.. js:method:: Instance.setEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: network_receive_data
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, dataSize)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param dataSize: None
      :type dataSize: number


      :rtype: void



.. js:method:: Instance.setEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: open_model_failed
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, data)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param data: None
      :type data: OpenModelFailedData


      :rtype: void



.. js:method:: Instance.setEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: post_draw
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, draw_index, stats, camera, visiblePoints)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param draw_index: None
      :type draw_index: ViewKey
      :param stats: None
      :type stats: FrameStats
      :param camera: None
      :type camera: Camera
      :param visiblePoints: None
      :type visiblePoints: [number]


      :rtype: void



.. js:method:: Instance.setEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: post_draw_json
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, metadataJson)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param metadataJson: None
      :type metadataJson: string


      :rtype: void



.. js:method:: Instance.setEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: priority_meta_data_sent
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, attachScope, prototypeInstanceCount)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param attachScope: None
      :type attachScope: AttachScope
      :param prototypeInstanceCount: None
      :type prototypeInstanceCount: number


      :rtype: void



.. js:method:: Instance.setEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: remap_inclusion
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, attachScope, effectiveModelKey, effectiveInclusionKey, originalInclusionKey)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param attachScope: None
      :type attachScope: AttachScope
      :param effectiveModelKey: None
      :type effectiveModelKey: ModelKey
      :param effectiveInclusionKey: None
      :type effectiveInclusionKey: InclusionKey
      :param originalInclusionKey: None
      :type originalInclusionKey: InclusionKey


      :rtype: void



.. js:method:: Instance.setEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: remap_model
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, attachScope, effectiveModelKey, originalModelKey)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param attachScope: None
      :type attachScope: AttachScope
      :param effectiveModelKey: None
      :type effectiveModelKey: ModelKey
      :param originalModelKey: None
      :type originalModelKey: ModelKey


      :rtype: void



.. js:method:: Instance.setEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: session_started
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, primaryModelKey)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param primaryModelKey: None
      :type primaryModelKey: ModelKey


      :rtype: void



.. js:method:: Instance.setEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: socket_error
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName)
      :noindex:

      :param eventName: None
      :type eventName: string


      :rtype: void



.. js:method:: Instance.setEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: socket_open_failed
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName)
      :noindex:

      :param eventName: None
      :type eventName: string


      :rtype: void



.. js:method:: Instance.setEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: stream_active
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName)
      :noindex:

      :param eventName: None
      :type eventName: string


      :rtype: void



.. js:method:: Instance.setEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: stream_idle
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName)
      :noindex:

      :param eventName: None
      :type eventName: string


      :rtype: void



.. js:method:: Instance.setEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: webgl_context_lost
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName)
      :noindex:

      :param eventName: None
      :type eventName: string


      :rtype: void



.. js:method:: Instance.setEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: websocket_connection_closed
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName)
      :noindex:

      :param eventName: None
      :type eventName: string


      :rtype: void



.. rst-class:: ts-api-section

setEyeDomeLightingBlurEdgeDistance
----------------------------------

.. js:method:: Instance.setEyeDomeLightingBlurEdgeDistance( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setEyeDomeLightingBlurInterval
------------------------------

.. js:method:: Instance.setEyeDomeLightingBlurInterval( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setEyeDomeLightingBlurSamples
-----------------------------

.. js:method:: Instance.setEyeDomeLightingBlurSamples( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setEyeDomeLightingEnabled
-------------------------

.. js:method:: Instance.setEyeDomeLightingEnabled( viewKey, enabled)

   :param viewKey: None
   :type viewKey: ViewKey
   :param enabled: None
   :type enabled: boolean


   :rtype: void

.. rst-class:: ts-api-section

setEyeDomeLightingOpacity
-------------------------

.. js:method:: Instance.setEyeDomeLightingOpacity( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setEyeDomeLightingShadingEdgeDistance
-------------------------------------

.. js:method:: Instance.setEyeDomeLightingShadingEdgeDistance( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setFaceWindingFlipped
---------------------

.. js:method:: Instance.setFaceWindingFlipped( viewKey, flipped)

   :param viewKey: None
   :type viewKey: ViewKey
   :param flipped: None
   :type flipped: boolean


   :rtype: void

.. rst-class:: ts-api-section

setFacesVisible
---------------

.. js:method:: Instance.setFacesVisible( viewKey, visible)

   :param viewKey: None
   :type viewKey: ViewKey
   :param visible: None
   :type visible: boolean


   :rtype: void

.. rst-class:: ts-api-section

setFixedDrawLimit
-----------------

.. js:method:: Instance.setFixedDrawLimit( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setFrontFacesVisible
--------------------

.. js:method:: Instance.setFrontFacesVisible( viewKey, visible)

   :param viewKey: None
   :type viewKey: ViewKey
   :param visible: None
   :type visible: boolean


   :rtype: void

.. rst-class:: ts-api-section

setGoochBaseColorProminence
---------------------------

.. js:method:: Instance.setGoochBaseColorProminence( viewKey, prominence)

   :param viewKey: None
   :type viewKey: ViewKey
   :param prominence: None
   :type prominence: number


   :rtype: void

.. rst-class:: ts-api-section

setGoochBlue
------------

.. js:method:: Instance.setGoochBlue( viewKey, blue)

   :param viewKey: None
   :type viewKey: ViewKey
   :param blue: None
   :type blue: number


   :rtype: void

.. rst-class:: ts-api-section

setGoochLuminanceShiftStrength
------------------------------

.. js:method:: Instance.setGoochLuminanceShiftStrength( viewKey, shiftStrength)

   :param viewKey: None
   :type viewKey: ViewKey
   :param shiftStrength: None
   :type shiftStrength: number


   :rtype: void

.. rst-class:: ts-api-section

setGoochYellow
--------------

.. js:method:: Instance.setGoochYellow( viewKey, yellow)

   :param viewKey: None
   :type viewKey: ViewKey
   :param yellow: None
   :type yellow: number


   :rtype: void

.. rst-class:: ts-api-section

setGroundPlane
--------------

.. js:method:: Instance.setGroundPlane( viewKey, normal)

   :param viewKey: None
   :type viewKey: ViewKey
   :param normal: None
   :type normal: Vector3


   :rtype: void

.. rst-class:: ts-api-section

setGroundPlaneWithPosition
--------------------------

.. js:method:: Instance.setGroundPlaneWithPosition( viewKey, normal[, position])

   :param viewKey: None
   :type viewKey: ViewKey
   :param normal: None
   :type normal: Vector3
   :param position: :ts-api-decorator:`optional` None
   :type position: Vector3


   :rtype: void

.. rst-class:: ts-api-section

setHardEdgeColor
----------------

.. js:method:: Instance.setHardEdgeColor( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: Vector3


   :rtype: void

.. rst-class:: ts-api-section

setHardEdgeOpacity
------------------

.. js:method:: Instance.setHardEdgeOpacity( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setHardEdgeThreshold
--------------------

.. js:method:: Instance.setHardEdgeThreshold( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setHardEdgeThresholdRampWidth
-----------------------------

.. js:method:: Instance.setHardEdgeThresholdRampWidth( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setHardEdgesEnabled
-------------------

.. js:method:: Instance.setHardEdgesEnabled( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: boolean


   :rtype: void

.. rst-class:: ts-api-section

setHiddenLineHiddenLineColor
----------------------------

.. js:method:: Instance.setHiddenLineHiddenLineColor( viewKey, color)

   :param viewKey: None
   :type viewKey: ViewKey
   :param color: None
   :type color: Vector4


   :rtype: void

.. rst-class:: ts-api-section

setHiddenLineHighlightedElementFillColor
----------------------------------------

.. js:method:: Instance.setHiddenLineHighlightedElementFillColor( viewKey, color)

   :param viewKey: None
   :type viewKey: ViewKey
   :param color: None
   :type color: Vector4


   :rtype: void

.. rst-class:: ts-api-section

setHiddenLineHighlightedElementOutlineColor
-------------------------------------------

.. js:method:: Instance.setHiddenLineHighlightedElementOutlineColor( viewKey, color)

   :param viewKey: None
   :type viewKey: ViewKey
   :param color: None
   :type color: Vector4


   :rtype: void

.. rst-class:: ts-api-section

setHiddenLineHighlightedInstanceFillColor
-----------------------------------------

.. js:method:: Instance.setHiddenLineHighlightedInstanceFillColor( viewKey, color)

   :param viewKey: None
   :type viewKey: ViewKey
   :param color: None
   :type color: Vector4


   :rtype: void

.. rst-class:: ts-api-section

setHiddenLineHighlightedInstanceOutlineColor
--------------------------------------------

.. js:method:: Instance.setHiddenLineHighlightedInstanceOutlineColor( viewKey, color)

   :param viewKey: None
   :type viewKey: ViewKey
   :param color: None
   :type color: Vector4


   :rtype: void

.. rst-class:: ts-api-section

setHiddenLineVisibleLineColor
-----------------------------

.. js:method:: Instance.setHiddenLineVisibleLineColor( viewKey, color)

   :param viewKey: None
   :type viewKey: ViewKey
   :param color: None
   :type color: Vector4


   :rtype: void

.. rst-class:: ts-api-section

setHighlightColorizeCompression
-------------------------------

.. js:method:: Instance.setHighlightColorizeCompression( viewKey, compressionLevel)

   :param viewKey: None
   :type viewKey: ViewKey
   :param compressionLevel: None
   :type compressionLevel: number


   :rtype: void

.. rst-class:: ts-api-section

setHighlightMode
----------------

.. js:method:: Instance.setHighlightMode( viewKey, highlightMode)

   :param viewKey: None
   :type viewKey: ViewKey
   :param highlightMode: None
   :type highlightMode: HighlightMode


   :rtype: void

.. rst-class:: ts-api-section

setHighlightedElementColor
--------------------------

.. js:method:: Instance.setHighlightedElementColor( viewKey, color)

   :param viewKey: None
   :type viewKey: ViewKey
   :param color: None
   :type color: Vector4


   :rtype: void

.. rst-class:: ts-api-section

setHighlightedElementFilter
---------------------------

.. js:method:: Instance.setHighlightedElementFilter( viewKey, highlightedFilter)

   :param viewKey: None
   :type viewKey: ViewKey
   :param highlightedFilter: None
   :type highlightedFilter: HighlightFilter


   :rtype: void

.. rst-class:: ts-api-section

setHighlightedElementOutlineColor
---------------------------------

.. js:method:: Instance.setHighlightedElementOutlineColor( viewKey, highlightedOutlineColor)

   :param viewKey: None
   :type viewKey: ViewKey
   :param highlightedOutlineColor: None
   :type highlightedOutlineColor: Vector4


   :rtype: void

.. rst-class:: ts-api-section

setHighlightedInstanceColor
---------------------------

.. js:method:: Instance.setHighlightedInstanceColor( viewKey, color)

   :param viewKey: None
   :type viewKey: ViewKey
   :param color: None
   :type color: Vector4


   :rtype: void

.. rst-class:: ts-api-section

setHighlightedInstanceFilter
----------------------------

.. js:method:: Instance.setHighlightedInstanceFilter( viewKey, highlightedFilter)

   :param viewKey: None
   :type viewKey: ViewKey
   :param highlightedFilter: None
   :type highlightedFilter: HighlightFilter


   :rtype: void

.. rst-class:: ts-api-section

setHighlightedInstanceOutlineColor
----------------------------------

.. js:method:: Instance.setHighlightedInstanceOutlineColor( viewKey, highlightedOutlineColor)

   :param viewKey: None
   :type viewKey: ViewKey
   :param highlightedOutlineColor: None
   :type highlightedOutlineColor: Vector4


   :rtype: void

.. rst-class:: ts-api-section

setImageBasedLightingEnabled
----------------------------

.. js:method:: Instance.setImageBasedLightingEnabled( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: boolean


   :rtype: void

.. rst-class:: ts-api-section

setImageBasedLightingEnvironment
--------------------------------

.. js:method:: Instance.setImageBasedLightingEnvironment( viewKey, data)

   :param viewKey: None
   :type viewKey: ViewKey
   :param data: None
   :type data: Uint8Array


   :rtype: void

.. rst-class:: ts-api-section

setImageBasedLightingEnvironmentToDefault
-----------------------------------------

.. js:method:: Instance.setImageBasedLightingEnvironmentToDefault( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: void

.. rst-class:: ts-api-section

setImageBasedLightingIntensity
------------------------------

.. js:method:: Instance.setImageBasedLightingIntensity( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setImageBasedLightingMatrix
---------------------------

.. js:method:: Instance.setImageBasedLightingMatrix( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: Matrix9


   :rtype: void

.. rst-class:: ts-api-section

setInstancingEnabled
--------------------

.. js:method:: Instance.setInstancingEnabled( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: boolean


   :rtype: void

.. rst-class:: ts-api-section

setInteractiveDrawLimitIncreaseEnabled
--------------------------------------

.. js:method:: Instance.setInteractiveDrawLimitIncreaseEnabled( viewKey, enable)

   :param viewKey: None
   :type viewKey: ViewKey
   :param enable: None
   :type enable: boolean


   :rtype: void

.. rst-class:: ts-api-section

setInteractiveDrawLimitIncreaseInterval
---------------------------------------

.. js:method:: Instance.setInteractiveDrawLimitIncreaseInterval( viewKey, milliseconds)

   :param viewKey: None
   :type viewKey: ViewKey
   :param milliseconds: None
   :type milliseconds: number


   :rtype: void

.. rst-class:: ts-api-section

setLightingEnabled
------------------

.. js:method:: Instance.setLightingEnabled( viewKey, enabled)

   :param viewKey: None
   :type viewKey: ViewKey
   :param enabled: None
   :type enabled: boolean


   :rtype: void

.. rst-class:: ts-api-section

setLineJitterEnabled
--------------------

.. js:method:: Instance.setLineJitterEnabled( viewKey, enabled)

   :param viewKey: None
   :type viewKey: ViewKey
   :param enabled: None
   :type enabled: boolean


   :rtype: void

.. rst-class:: ts-api-section

setLineJitterFrequency
----------------------

.. js:method:: Instance.setLineJitterFrequency( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setLineJitterInstanceCount
--------------------------

.. js:method:: Instance.setLineJitterInstanceCount( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setLineJitterRadius
-------------------

.. js:method:: Instance.setLineJitterRadius( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setLinesVisible
---------------

.. js:method:: Instance.setLinesVisible( viewKey, visible)

   :param viewKey: None
   :type viewKey: ViewKey
   :param visible: None
   :type visible: boolean


   :rtype: void

.. rst-class:: ts-api-section

setMeshLevel
------------

.. js:method:: Instance.setMeshLevel( incs, level)

   :param incs: None
   :type incs: InstanceIncs
   :param level: None
   :type level: number


   :rtype: void

.. rst-class:: ts-api-section

setMetallicRoughnessMaterialOverride
------------------------------------

.. js:method:: Instance.setMetallicRoughnessMaterialOverride( defaultMetallicFactor, defaultRoughnessFactor)

   :param defaultMetallicFactor: None
   :type defaultMetallicFactor: number
   :param defaultRoughnessFactor: None
   :type defaultRoughnessFactor: number


   :rtype: void

.. rst-class:: ts-api-section

setMinDrawLimit
---------------

.. js:method:: Instance.setMinDrawLimit( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setMinFrameRate
---------------

.. js:method:: Instance.setMinFrameRate( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setMinIncrementalFrameRate
--------------------------

.. js:method:: Instance.setMinIncrementalFrameRate( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setMinInteractiveFrameRate
--------------------------

.. js:method:: Instance.setMinInteractiveFrameRate( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setPointShape
-------------

.. js:method:: Instance.setPointShape( viewKey, shape)

   :param viewKey: None
   :type viewKey: ViewKey
   :param shape: None
   :type shape: PointShape


   :rtype: void

.. rst-class:: ts-api-section

setPointSize
------------

.. js:method:: Instance.setPointSize( viewKey, size, unit)

   :param viewKey: None
   :type viewKey: ViewKey
   :param size: None
   :type size: number
   :param unit: None
   :type unit: PointSizeUnit


   :rtype: void

.. rst-class:: ts-api-section

setPointVisibilityTest
----------------------

.. js:method:: Instance.setPointVisibilityTest( points, viewKey)

   :param points: None
   :type points: [Vector3]
   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: void

.. rst-class:: ts-api-section

setPointsVisible
----------------

.. js:method:: Instance.setPointsVisible( viewKey, visible)

   :param viewKey: None
   :type viewKey: ViewKey
   :param visible: None
   :type visible: boolean


   :rtype: void

.. rst-class:: ts-api-section

setPostInputDelay
-----------------

.. js:method:: Instance.setPostInputDelay( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setSilhouetteColor
------------------

.. js:method:: Instance.setSilhouetteColor( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: Vector3


   :rtype: void

.. rst-class:: ts-api-section

setSilhouetteEnabled
--------------------

.. js:method:: Instance.setSilhouetteEnabled( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: boolean


   :rtype: void

.. rst-class:: ts-api-section

setSilhouetteOpacity
--------------------

.. js:method:: Instance.setSilhouetteOpacity( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setSilhouetteThreshold
----------------------

.. js:method:: Instance.setSilhouetteThreshold( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setSilhouetteThresholdRampWidth
-------------------------------

.. js:method:: Instance.setSilhouetteThresholdRampWidth( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setSimpleReflectionAttenuation
------------------------------

.. js:method:: Instance.setSimpleReflectionAttenuation( viewKey, nearDistance, farDistance, unit)

   :param viewKey: None
   :type viewKey: ViewKey
   :param nearDistance: None
   :type nearDistance: number
   :param farDistance: None
   :type farDistance: number
   :param unit: None
   :type unit: SimpleReflectionAttenuationUnit


   :rtype: void

.. rst-class:: ts-api-section

setSimpleReflectionBlurInterval
-------------------------------

.. js:method:: Instance.setSimpleReflectionBlurInterval( viewKey, value, unit)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: number
   :param unit: None
   :type unit: BlurIntervalUnit


   :rtype: void

.. rst-class:: ts-api-section

setSimpleReflectionBlurSamples
------------------------------

.. js:method:: Instance.setSimpleReflectionBlurSamples( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setSimpleReflectionEnabled
--------------------------

.. js:method:: Instance.setSimpleReflectionEnabled( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: boolean


   :rtype: void

.. rst-class:: ts-api-section

setSimpleReflectionFadeAngle
----------------------------

.. js:method:: Instance.setSimpleReflectionFadeAngle( viewKey, degrees)

   :param viewKey: None
   :type viewKey: ViewKey
   :param degrees: None
   :type degrees: number


   :rtype: void

.. rst-class:: ts-api-section

setSimpleReflectionOpacity
--------------------------

.. js:method:: Instance.setSimpleReflectionOpacity( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setSimpleShadowBlurInterval
---------------------------

.. js:method:: Instance.setSimpleShadowBlurInterval( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setSimpleShadowBlurSamples
--------------------------

.. js:method:: Instance.setSimpleShadowBlurSamples( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setSimpleShadowColor
--------------------

.. js:method:: Instance.setSimpleShadowColor( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: Vector3


   :rtype: void

.. rst-class:: ts-api-section

setSimpleShadowEnabled
----------------------

.. js:method:: Instance.setSimpleShadowEnabled( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: boolean


   :rtype: void

.. rst-class:: ts-api-section

setSimpleShadowInteractiveUpdateEnabled
---------------------------------------

.. js:method:: Instance.setSimpleShadowInteractiveUpdateEnabled( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: boolean


   :rtype: void

.. rst-class:: ts-api-section

setSimpleShadowOpacity
----------------------

.. js:method:: Instance.setSimpleShadowOpacity( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setSimpleShadowResolution
-------------------------

.. js:method:: Instance.setSimpleShadowResolution( viewKey, pixels)

   :param viewKey: None
   :type viewKey: ViewKey
   :param pixels: None
   :type pixels: number


   :rtype: void

.. rst-class:: ts-api-section

setSsrQuality
-------------

.. js:method:: Instance.setSsrQuality( opts)

   :param opts: None
   :type opts: SsrQualityConfig


   :rtype: void

.. rst-class:: ts-api-section

setStreamCutoffScale
--------------------

.. js:method:: Instance.setStreamCutoffScale( value)

   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setStreamIdleMarker
-------------------

.. js:method:: Instance.setStreamIdleMarker()



   :rtype: Promise <void>

.. rst-class:: ts-api-section

setToonBandCount
----------------

.. js:method:: Instance.setToonBandCount( viewKey, bandCount)

   :param viewKey: None
   :type viewKey: ViewKey
   :param bandCount: None
   :type bandCount: number


   :rtype: void

.. rst-class:: ts-api-section

setToonSpecularFactor
---------------------

.. js:method:: Instance.setToonSpecularFactor( viewKey, specularFactor)

   :param viewKey: None
   :type viewKey: ViewKey
   :param specularFactor: None
   :type specularFactor: number


   :rtype: void

.. rst-class:: ts-api-section

setTransparencyMode
-------------------

.. js:method:: Instance.setTransparencyMode( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: TransparencyMode


   :rtype: void

.. rst-class:: ts-api-section

setUnhighlightedColor
---------------------

.. js:method:: Instance.setUnhighlightedColor( viewKey, color)

   :param viewKey: None
   :type viewKey: ViewKey
   :param color: None
   :type color: Vector4


   :rtype: void

.. rst-class:: ts-api-section

setUnhighlightedFilter
----------------------

.. js:method:: Instance.setUnhighlightedFilter( viewKey, highlightedFilter)

   :param viewKey: None
   :type viewKey: ViewKey
   :param highlightedFilter: None
   :type highlightedFilter: HighlightFilter


   :rtype: void

.. rst-class:: ts-api-section

setVisibilityByAttachment
-------------------------

.. js:method:: Instance.setVisibilityByAttachment( attachScope, setVisibility)

   :param attachScope: None
   :type attachScope: AttachScope
   :param setVisibility: None
   :type setVisibility: SetVisibility


   :rtype: void

.. rst-class:: ts-api-section

setXRayMaterial
---------------

.. js:method:: Instance.setXRayMaterial( viewKey, group, element, color)

   :param viewKey: None
   :type viewKey: ViewKey
   :param group: None
   :type group: XRayGroup
   :param element: None
   :type element: ElementType
   :param color: None
   :type color: Vector4


   :rtype: void

.. rst-class:: ts-api-section

setXRayOpacity
--------------

.. js:method:: Instance.setXRayOpacity( viewKey, element, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param element: None
   :type element: ElementType
   :param value: None
   :type value: number


   :rtype: void

.. rst-class:: ts-api-section

setXRayTransparencyMode
-----------------------

.. js:method:: Instance.setXRayTransparencyMode( viewKey, value)

   :param viewKey: None
   :type viewKey: ViewKey
   :param value: None
   :type value: TransparencyMode


   :rtype: void

.. rst-class:: ts-api-section

shutDown
--------

.. js:method:: Instance.shutDown()



   :rtype: void

.. rst-class:: ts-api-section

startComparison
---------------

.. js:method:: Instance.startComparison( viewKey, instanceSet1, instanceSet2)

   :param viewKey: None
   :type viewKey: ViewKey
   :param instanceSet1: None
   :type instanceSet1: InstanceIncs
   :param instanceSet2: None
   :type instanceSet2: InstanceIncs


   :rtype: void

.. rst-class:: ts-api-section

startExplode
------------

.. js:method:: Instance.startExplode( incs, center)

   :param incs: None
   :type incs: InstanceIncs
   :param center: None
   :type center: Vector3


   :rtype: void

.. rst-class:: ts-api-section

suspendDrawing
--------------

.. js:method:: Instance.suspendDrawing( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: void

.. rst-class:: ts-api-section

testPointVisibility
-------------------

.. js:method:: Instance.testPointVisibility( points, viewKey)

   :param points: None
   :type points: [Vector3]
   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: Promise <[number]>

.. rst-class:: ts-api-section

throttleLoad
------------

.. js:method:: Instance.throttleLoad( newPauseInterval, throttleDuration)

   :param newPauseInterval: None
   :type newPauseInterval: number
   :param throttleDuration: None
   :type throttleDuration: number


   :rtype: void

.. rst-class:: ts-api-section

triangulatePolygon
------------------

.. js:method:: Instance.triangulatePolygon( polygonPoints, normal)

   :param polygonPoints: None
   :type polygonPoints: Float32Array | [number]
   :param normal: None
   :type normal: Vector3


   :rtype: [number]

.. rst-class:: ts-api-section

truncateMetaData
----------------

.. js:method:: Instance.truncateMetaData( dataIds)

   :param dataIds: None
   :type dataIds: DataIds


   :rtype: Promise <void>

.. rst-class:: ts-api-section

unsetAllColors
--------------

.. js:method:: Instance.unsetAllColors()



   :rtype: void

.. rst-class:: ts-api-section

unsetAllHighlighted
-------------------

.. js:method:: Instance.unsetAllHighlighted()



   :rtype: void

.. rst-class:: ts-api-section

unsetAllOpacity
---------------

.. js:method:: Instance.unsetAllOpacity()



   :rtype: void

.. rst-class:: ts-api-section

unsetAllXRay
------------

.. js:method:: Instance.unsetAllXRay()



   :rtype: void

.. rst-class:: ts-api-section

unsetCurrentView
----------------

.. js:method:: Instance.unsetCurrentView( viewKey)

   :param viewKey: None
   :type viewKey: ViewKey


   :rtype: void

.. rst-class:: ts-api-section

unsetEventHandler
-----------------

.. js:method:: Instance.unsetEventHandler( eventName, callback)

   :param eventName: None
   :type eventName: announce_model
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, attachScope, modelKey)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param attachScope: None
      :type attachScope: AttachScope
      :param modelKey: None
      :type modelKey: ModelKey


      :rtype: void



.. js:method:: Instance.unsetEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: bad_data
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, data)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param data: None
      :type data: BadDataData


      :rtype: void



.. js:method:: Instance.unsetEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: bounding
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName)
      :noindex:

      :param eventName: None
      :type eventName: string


      :rtype: void



.. js:method:: Instance.unsetEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: camera_set
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, viewKey)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param viewKey: None
      :type viewKey: ViewKey


      :rtype: void



.. js:method:: Instance.unsetEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: capping_idle
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, isIdle, cappedInstanceCount)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param isIdle: None
      :type isIdle: boolean
      :param cappedInstanceCount: None
      :type cappedInstanceCount: number


      :rtype: void



.. js:method:: Instance.unsetEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: client_message
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, data)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param data: None
      :type data: string


      :rtype: void



.. js:method:: Instance.unsetEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: draw_complete
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, viewKey)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param viewKey: None
      :type viewKey: ViewKey


      :rtype: void



.. js:method:: Instance.unsetEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: draw_idle
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, viewKey)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param viewKey: None
      :type viewKey: ViewKey


      :rtype: void



.. js:method:: Instance.unsetEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: inclusion
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, attachScope, inclusionKey, modelKey)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param attachScope: None
      :type attachScope: AttachScope
      :param inclusionKey: None
      :type inclusionKey: InclusionKey
      :param modelKey: None
      :type modelKey: ModelKey


      :rtype: void



.. js:method:: Instance.unsetEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: meta_data
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, modelKey, dataKey, data)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param modelKey: None
      :type modelKey: ModelKey
      :param dataKey: None
      :type dataKey: DataKey
      :param data: None
      :type data: Uint8Array


      :rtype: void



.. js:method:: Instance.unsetEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: missing_model
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, attachScope, modelPath)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param attachScope: None
      :type attachScope: AttachScope
      :param modelPath: None
      :type modelPath: string


      :rtype: void



.. js:method:: Instance.unsetEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: network_receive_data
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, dataSize)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param dataSize: None
      :type dataSize: number


      :rtype: void



.. js:method:: Instance.unsetEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: open_model_failed
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, data)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param data: None
      :type data: OpenModelFailedData


      :rtype: void



.. js:method:: Instance.unsetEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: post_draw
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, draw_index, stats, camera, visiblePoints)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param draw_index: None
      :type draw_index: ViewKey
      :param stats: None
      :type stats: FrameStats
      :param camera: None
      :type camera: Camera
      :param visiblePoints: None
      :type visiblePoints: [number]


      :rtype: void



.. js:method:: Instance.unsetEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: post_draw_json
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, metadataJson)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param metadataJson: None
      :type metadataJson: string


      :rtype: void



.. js:method:: Instance.unsetEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: priority_meta_data_sent
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, attachScope, prototypeInstanceCount)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param attachScope: None
      :type attachScope: AttachScope
      :param prototypeInstanceCount: None
      :type prototypeInstanceCount: number


      :rtype: void



.. js:method:: Instance.unsetEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: remap_inclusion
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, attachScope, effectiveModelKey, effectiveInclusionKey, originalInclusionKey)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param attachScope: None
      :type attachScope: AttachScope
      :param effectiveModelKey: None
      :type effectiveModelKey: ModelKey
      :param effectiveInclusionKey: None
      :type effectiveInclusionKey: InclusionKey
      :param originalInclusionKey: None
      :type originalInclusionKey: InclusionKey


      :rtype: void



.. js:method:: Instance.unsetEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: remap_model
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, attachScope, effectiveModelKey, originalModelKey)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param attachScope: None
      :type attachScope: AttachScope
      :param effectiveModelKey: None
      :type effectiveModelKey: ModelKey
      :param originalModelKey: None
      :type originalModelKey: ModelKey


      :rtype: void



.. js:method:: Instance.unsetEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: session_started
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName, primaryModelKey)
      :noindex:

      :param eventName: None
      :type eventName: string
      :param primaryModelKey: None
      :type primaryModelKey: ModelKey


      :rtype: void



.. js:method:: Instance.unsetEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: socket_error
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName)
      :noindex:

      :param eventName: None
      :type eventName: string


      :rtype: void



.. js:method:: Instance.unsetEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: socket_open_failed
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName)
      :noindex:

      :param eventName: None
      :type eventName: string


      :rtype: void



.. js:method:: Instance.unsetEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: stream_active
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName)
      :noindex:

      :param eventName: None
      :type eventName: string


      :rtype: void



.. js:method:: Instance.unsetEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: stream_idle
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName)
      :noindex:

      :param eventName: None
      :type eventName: string


      :rtype: void



.. js:method:: Instance.unsetEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: webgl_context_lost
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName)
      :noindex:

      :param eventName: None
      :type eventName: string


      :rtype: void



.. js:method:: Instance.unsetEventHandler( eventName, callback)
   :noindex:

   :param eventName: None
   :type eventName: websocket_connection_closed
   :param callback: None
   :type callback: function


   :rtype: void




   .. js:function:: callback( eventName)
      :noindex:

      :param eventName: None
      :type eventName: string


      :rtype: void



.. rst-class:: ts-api-section

unsetXRayMaterial
-----------------

.. js:method:: Instance.unsetXRayMaterial( viewKey, group, element)

   :param viewKey: None
   :type viewKey: ViewKey
   :param group: None
   :type group: XRayGroup
   :param element: None
   :type element: ElementType


   :rtype: Promise <void>

.. rst-class:: ts-api-section

updateLight
-----------

.. js:method:: Instance.updateLight( viewKey, key, type, space, position, color)

   :param viewKey: None
   :type viewKey: ViewKey
   :param key: None
   :type key: LightKey
   :param type: None
   :type type: LightType
   :param space: None
   :type space: LightSpace
   :param position: None
   :type position: Vector3
   :param color: None
   :type color: Vector3


   :rtype: void

.. rst-class:: ts-api-section

waitForImageDecoding
--------------------

.. js:method:: Instance.waitForImageDecoding()



   :rtype: Promise <void>

.. rst-class:: ts-api-section

worldSelectByRay
----------------

.. js:method:: Instance.worldSelectByRay( viewKey, ray, config)

   :param viewKey: None
   :type viewKey: ViewKey
   :param ray: None
   :type ray: IRay
   :param config: None
   :type config: RaySelectionConfig


   :rtype: Promise <PickResult>

