DisplayStyles

Types for describing how the contents of Views should be rendered.

Classes

Name Description  
AmbientLight Describes the ambient light associated with a LightSettings.  
BackgroundMapSettings Normalized representation of a BackgroundMapProps for which type and provider have been validated and default values have been applied where explicit values not defined.  
DisplayStyle3dSettings Provides access to the settings defined by a DisplayStyle3d or DisplayStyle3dState, and ensures that  
DisplayStyleSettings Provides access to the settings defined by a DisplayStyle or DisplayStyleState, and ensures that  
GroundPlane A circle drawn at a Z elevation, whose diameter is the the XY diagonal of the project extents, used to represent the ground as a reference point within a spatial view.  
HemisphereLights Describes a pair of hemisphere lights associated with a LightSettings.  
LightSettings Describes the lighting for a 3d scene, associated with a DisplayStyle3dSettings in turn associated with a DisplayStyle3d or DisplayStyle3dState.  
PlanProjectionSettings An immutable description of how to draw a "plan projection" models. Beta
SolarLight Describes the solar directional light associated with a LightSettings.  
SolarShadowSettings Settings controlling display of solar shadows for a DisplayStyle3dSettings.  
SubCategoryOverride Overrides selected aspects of a SubCategoryAppearance in the context of a DisplayStyleState.  
TerrainSettings Normalized version of TerrainProps for which provider has been validated and default values of all members are used.  
ViewFlagOverrides Overrides a subset of ViewFlags.  
ViewFlags Flags for controlling how graphics appear within a View.  

Enumerations

Name Description  
BackgroundMapType Describes the type of background map displayed by a DisplayStyle  
GlobeMode Describes the projection of the background map  
MonochromeMode Describes the style in which monochrome color is applied by a DisplayStyleSettings.  
RenderMode Enumerates the available rendering modes.  
SkyBoxImageType Enumerates the supported types of SkyBox images.  
TerrainHeightOriginMode Correction modes for terrain height  
ViewFlagPresence Values used by ViewFlagOverrides to indicate which aspects of the ViewFlags are overridden.  

Interfaces

Name Description  
AmbientLightProps Wire format for the ambient light associated with a LightSettingsProps.  
BackgroundMapProps JSON representation of the settings associated with a background map displayed by a DisplayStyle.  
ContextRealityModelProps JSON representation of a context reality model  
DisplayStyle3dProps JSON representation of a DisplayStyle3d or DisplayStyle3dState.  
DisplayStyle3dSettingsProps JSON representation of settings associated with a DisplayStyle3dProps.  
DisplayStyleModelAppearanceProps Describes the FeatureAppearance overrides applied to a model by a DisplayStyle. Beta
DisplayStyleOverridesOptions Controls which settings are serialized by DisplayStyleSettings.toOverrides. Beta
DisplayStyleProps JSON representation of a DisplayStyle or DisplayStyleState.  
DisplayStyleSettingsProps JSON representation of the settings associated with a DisplayStyleProps.  
DisplayStyleSubCategoryProps Describes the SubCategoryOverrides applied to a SubCategory by a DisplayStyle.  
EnvironmentProps JSON representation of the environment setup of a DisplayStyle3d.  
GroundPlaneProps JSON representation of a GroundPlane.  
HemisphereLightsProps Wire format for a pair of hemisphere lights associated with a LightSettingsProps.  
LightSettingsProps Wire format for a LightSettings describing lighting for a 3d scene.  
PlanProjectionSettingsProps Describes how to draw a "plan projection" model. Beta
SkyBoxImageProps JSON representation of an image or images used by a SkySphere or SkyCube.  
SkyBoxProps JSON representation of a SkyBox.  
SkyCubeProps JSON representation of a set of images used by a SkyCube.  
SolarLightProps Wire format for the solar directional light associated with a LightSettingsProps.  
SolarShadowSettingsProps JSON representation of SolarShadowSettings.  
TerrainProps JSON representation of the settings of the terrain applied to background map display by a DisplayStyle.  
ViewFlagOverridesProps JSON representation of ViewFlagOverrides.  
ViewFlagProps JSON representation of ViewFlags  

Namespaces

Name Description  
AmbientOcclusion Namespace containing types controlling how ambient occlusion should be drawn.  
HiddenLine Namespace containing types controlling how edges and surfaces should be drawn in "hidden line" and "solid fill" RenderModes.  
RenderSchedule A schedule (or script) for controlling the visibility, position and symbology of a series of elements over a period of time. Beta
SpatialClassificationProps Geometry may be classified by its spatial location. Beta

Type Aliases

Name Description  
BackgroundMapProviderName The current set of supported background map providers.  
TerrainProviderName The current set of supported terrain providers.  

Last Updated: 02 September, 2020