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 | undefined | ViewFlags | If supplied, the ViewFlags applied by the display style. |
Inherited properties
| Name | Type | Inherited from | Description |
|---|---|---|---|
| analysisFraction | undefined | number | Omit | See analysisFraction. |
| analysisStyle | undefined | AnalysisStyleProps | Omit | See analysisStyle. |
| ao | undefined | Props | Omit | See ambientOcclusionSettings. |
| backgroundMap | undefined | PersistentBackgroundMapProps | Omit | See backgroundMap. |
| clipStyle | undefined | ClipStyleProps | Omit | See clipStyle. |
| contextRealityModels | undefined | ContextRealityModelProps[] | Omit | See contextRealityModels. |
| environment | undefined | EnvironmentProps | Omit | See [[DisplayStyle3dSettings.environment. |
| excludedElements | string | Id64Array | Omit | Ids of elements not to be displayed in the view. |
| hline | undefined | SettingsProps | Omit | See [[DisplayStyle3dSettings.hiddenLineSettings. |
| lights | undefined | LightSettingsProps | Omit | See DisplayStyle3dSettings.lights. |
| mapImagery | undefined | MapImageryProps | Omit | See mapImagery. |
| modelOvr | undefined | DisplayStyleModelAppearanceProps[] | Omit | Overrides applied to the appearance of models in the view. |
| monochromeColor | undefined | number | Omit | See monochromeColor. |
| monochromeMode | undefined | MonochromeMode | Omit | See monochromeMode. |
| planProjections | undefined | { T } | Omit | See [[DisplayStyle3dSettings.planProjections. |
| planarClipOvr | undefined | DisplayStylePlanarClipMaskProps[] | Omit | See planarClipMasks. |
| realityModelDisplay | undefined | DisplayStyleRealityModelDisplayProps[] | Omit | Display settings applied to specific reality models in the view. |
| renderTimeline | undefined | string | Omit | See renderTimeline. |
| solarShadows | undefined | SolarShadowSettingsProps | Omit | See solarShadows. |
| subCategoryOvr | undefined | DisplayStyleSubCategoryProps[] | Omit | Overrides applied to the appearances of subcategories in the view. |
| thematic | undefined | ThematicDisplayProps | Omit | See [[DisplayStyle3dSettings.thematic. |
| timePoint | undefined | number | Omit | See timePoint. |
| viewflags | undefined | ViewFlagProps | Omit | See viewFlags. |
| whiteOnWhiteReversal | undefined | WhiteOnWhiteReversalProps | Omit | See whiteOnWhiteReversal. |
Defined in
- backend/src/DisplayStyle.ts Line 189
Last Updated: 30 November, 2023