SettingsPriority Namespace

Variable

Name Description
SettingsPriority.application Settings supplied by an application at runtime.
SettingsPriority.branch Settings that apply to all branches of an iModel.
SettingsPriority.defaults Settings that originate from default setting files loaded automatically at the start of a session.
SettingsPriority.iModel Settings that apply to a specific iModel.
SettingsPriority.iTwin Settings that apply to all iModels in an iTwin.
SettingsPriority.organization Settings that apply to all iTwins for an organization.

Defined in

SettingsPriority Type

SettingsPriority = number

Defines the precedence of a SettingsDictionary. Settings may contain multiple dictionaries containing different values for the same SettingName. When resolving the value of a Setting, the value from the highest-priority dictionary is used. Priorities are grouped into coarse categories like application and SettingsPriority.iModel. Settings with priorities less than or equal to application are stored in appWorkspace, while those with priorities higher than application are stored inside workspace.

Defined in

Last Updated: 17 December, 2024