DisplayStyleCreationOptions Interface
Describes initial settings for a new DisplayStyle3d. Most properties are inherited from DisplayStyle3dSettingsProps, but for backwards compatibility reasons, this interface is slightly awkward:
- It adds a
viewFlagsmember that differs only in case and type from DisplayStyleSettingsProps.viewflags; and - It extends the type of DisplayStyleSettingsProps.backgroundColor to include ColorDef. These idiosyncrasies will be addressed in a future version of core-backend.
@see DisplayStyle3d.create.
Extends
- Omit<DisplayStyle3dSettingsProps, "backgroundColor" | "scheduleScript">
Properties
| Name | Type | Description | |
|---|---|---|---|
| backgroundColor | number | ColorDef | ||
| viewFlags | ViewFlags | undefined | If supplied, the ViewFlags applied by the display style. |
Inherited properties
| Name | Type | Inherited from | Description |
|---|---|---|---|
| analysisFraction | number | undefined | Omit | See DisplayStyleSettings.analysisFraction. |
| analysisStyle | AnalysisStyleProps | undefined | Omit | See DisplayStyleSettings.analysisStyle. |
| ao | AmbientOcclusion.Props | undefined | Omit | See DisplayStyle3dSettings.ambientOcclusionSettings. |
| backgroundMap | PersistentBackgroundMapProps | undefined | Omit | See DisplayStyleSettings.backgroundMap. |
| clipStyle | ClipStyleProps | undefined | Omit | See DisplayStyleSettings.clipStyle. |
| contextRealityModels | ContextRealityModelProps[] | undefined | Omit | See DisplayStyleSettings.contextRealityModels. |
| environment | EnvironmentProps | undefined | Omit | See DisplayStyle3dSettings.environment. |
| excludedElements | string | Id64Array | Omit | Ids of elements not to be displayed in the view. |
| hline | HiddenLine.SettingsProps | undefined | Omit | See DisplayStyle3dSettings.hiddenLineSettings. |
| lights | LightSettingsProps | undefined | Omit | See DisplayStyle3dSettings.lights. |
| mapImagery | MapImageryProps | undefined | Omit | See DisplayStyleSettings.mapImagery. |
| modelOvr | DisplayStyleModelAppearanceProps[] | undefined | Omit | Overrides applied to the appearance of models in the view. |
| monochromeColor | number | undefined | Omit | See DisplayStyleSettings.monochromeColor. |
| monochromeMode | MonochromeMode | undefined | Omit | See DisplayStyleSettings.monochromeMode. |
| planProjections | [modelId: string]: PlanProjectionSettingsProps | undefined | Omit | See DisplayStyle3dSettings.planProjections. |
| planarClipOvr | DisplayStylePlanarClipMaskProps[] | undefined | Omit | See DisplayStyleSettings.planarClipMasks. |
| realityModelDisplay | DisplayStyleRealityModelDisplayProps[] | undefined | Omit | Display settings applied to specific reality models in the view. |
| renderTimeline | string | undefined | Omit | See DisplayStyleSettings.renderTimeline. |
| solarShadows | SolarShadowSettingsProps | undefined | Omit | See DisplayStyle3dSettings.solarShadows. |
| subCategoryOvr | DisplayStyleSubCategoryProps[] | undefined | Omit | Overrides applied to the appearances of subcategories in the view. |
| thematic | ThematicDisplayProps | undefined | Omit | See DisplayStyle3dSettings.thematic. |
| timePoint | number | undefined | Omit | See DisplayStyleSettings.timePoint. |
| viewflags | ViewFlagProps | undefined | Omit | See DisplayStyleSettings.viewFlags. |
| whiteOnWhiteReversal | WhiteOnWhiteReversalProps | undefined | Omit | See DisplayStyleSettings.whiteOnWhiteReversal. |
Defined in
- core/backend/src/DisplayStyle.ts Line 186
Last Updated: 17 May, 2024
Found something wrong, missing, or unclear on this page?Raise an issue in our repo.