Class ComponentPickerSettings

The ComponentPickerSettings class stores user settings for the component picker such as favorite components and most recently used components.

Hierarchy (View Summary)

UserProjectSettingsBase<ComponentPickerSettings>
- ComponentPickerSettings

Index

Constructors

Properties

favoriteComponentTypes showOnlyProjectComponents

Accessors

Methods

assign markAsDirty

Events

Constructors

constructor

new ComponentPickerSettings(): ComponentPickerSettings

Returns ComponentPickerSettings

Inherited from UserProjectSettingsBase.constructor

Properties

`Readonly`favoriteComponentTypes

favoriteComponentTypes: Set<string>

The component names that have been favorited by the user.

showOnlyProjectComponents

showOnlyProjectComponents: boolean

Only show project components in the UI.

Accessors

isGlobal

get isGlobal(): boolean

Gets the settings.

Returns boolean

Overrides UserProjectSettingsBase.isGlobal

Methods

assign

assign(other: Readonly<T>): void
Copies all properties defined by the prototype of other to this instance.
Parameters
- other: Readonly<T>
Returns void

Inherited from UserProjectSettingsBase.assign

markAsDirty

markAsDirty(): void

Marks the settings as dirty and invokes the onDirty event handler.

Returns void

Note
This method should be invoked after making a change, so subsystems such as a viewport cna be updated. If the settings are the shared editor settings, the editor settings will be marked for autosave.

Inherited from UserProjectSettingsBase.markAsDirty

Events

`Readonly`onDirty

onDirty: Event<[ComponentPickerSettings], void>

Invoked when the settings changed.

Warning

This is an internal event. Do not subscribe directly to it, use UserProjectSettings.onSettingsChanged.