DisplayStyleOverridesOptions Interface

Controls which settings are serialized by DisplayStyleSettings.toOverrides. A display style includes some settings that are specific to a given iModel - for example, the subcategory overrides are indexed by subcategory Ids and model appearance overrides are indexed by model ids. Other settings are specific to a given project, like the set of displayed context reality models. Such settings can be useful when creating display style overrides intended for use with a specific iModel or project, but should be omitted when creating general-purpose display style overrides intended for use with any iModel or project. This is the default behavior if no more specific options are provided.

Properties

Name Type Description
includeAll undefined | "true" Serialize all settings.  
includeBackgroundMap undefined | "true" Serialize the background map settings.  
includeDrawingAids undefined | "true" Serialize settings related to drawing aid decorations (the ACS triad and the grid).  
includeIModelSpecific undefined | "true" Serialize iModel-specific settings.  
includeProjectSpecific undefined | "true" Serialize project-specific settings.  

Defined in

Last Updated: 12 June, 2024