DisplayStyle3dSettings Class

Provides access to the settings defined by a DisplayStyle3d or DisplayStyle3dState, and ensures that the style's JSON properties are kept in sync.



Name Description
constructor(jsonProperties: object): DisplayStyle3dSettings    
getPlanProjectionSettings(modelId: Id64String): PlanProjectionSettings | undefined Get the plan projection settings associated with the specified model, if defined. Beta
setPlanProjectionSettings(modelId: Id64String, settings: PlanProjectionSettings | undefined): void Set or clear the plan projection settings associated with the specified model. Beta

Inherited methods

Name Inherited from Description
addExcludedElements(id: Id64String): void DisplayStyleSettings Add an element to the set of excluded elements defined by the display style.
dropExcludedElement(id: Id64String): void DisplayStyleSettings Remove an element from the set of excluded elements defined by the display style.
dropSubCategoryOverride(id: Id64String): void DisplayStyleSettings Remove any SubCategoryOverride applied to a SubCategoryAppearance by this style.
getSubCategoryOverride(id: Id64String): SubCategoryOverride | undefined DisplayStyleSettings Obtain the override applied to a SubCategoryAppearance by this style.
overrideSubCategory(id: Id64String, ovr: SubCategoryOverride): void DisplayStyleSettings Customize the way geometry belonging to a SubCategory is drawn by this display style.


Name Type Description
ambientOcclusionSettings Accessor AmbientOcclusion.Settings The settings that control how ambient occlusion is displayed.  
hiddenLineSettings Accessor HiddenLine.Settings The settings that control how visible and hidden edges are displayed.  
lights Accessor LightSettings    
planProjectionSettings Accessor ReadOnly Iterable<[Id64String, PlanProjectionSettings]> | undefined An iterator over all of the defined plan projection settings. Beta
solarShadows Accessor SolarShadowSettings The settings that control how solar shadows are displayed.  
thematic Accessor ThematicDisplay The settings that control thematic display. Beta

Inherited properties

Name Type Inherited from Description
_json Protected DisplayStyleSettingsProps DisplayStyleSettings  
backgroundColor Accessor ColorDef DisplayStyleSettings The background color.
backgroundMap Accessor BackgroundMapSettings DisplayStyleSettings Settings controlling display of the background map within the view.
excludedElements Accessor ReadOnly Set<Id64String> DisplayStyleSettings The set of elements that the display style will exclude.
hasSubCategoryOverride Accessor ReadOnly boolean DisplayStyleSettings Returns true if an [[SubCategoryOverride]s are defined by this style.
monochromeColor Accessor ColorDef DisplayStyleSettings The color used to draw geometry in monochrome mode.
monochromeMode Accessor MonochromeMode DisplayStyleSettings The style in which DisplayStyleSettings.monochromeColor is applied.
subCategoryOverrides Accessor ReadOnly Map<Id64String, SubCategoryOverride> DisplayStyleSettings The overrides applied by this style.
timePoint Accessor number | undefined DisplayStyleSettings The point in time reflected by the view, in UNIX seconds.
This identifies a point on the timeline of the DisplayStyleSettings.scheduleScript, if any; it may also affect display of four-dimensional reality models.
viewFlags Accessor ViewFlags DisplayStyleSettings The ViewFlags associated with the display style.

Defined in

Last Updated: 07 July, 2020