FavoritePropertiesManager Class
The favorite property manager which lets to store favorite properties and check if field contains favorite properties.
Implements
Methods
| Name | Description | |
|---|---|---|
| constructor(props: FavoritePropertiesManagerProps): FavoritePropertiesManager | ||
| add(field: Field, imodel: IModelConnection, scope: FavoritePropertiesScope): Promise<void> | Adds favorite properties into a certain scope. | |
| changeFieldPriority(imodel: IModelConnection, field: Field, afterField: Field, visibleFields: Field[]): Promise<void> | Changes field properties priorities to lower than another fields priority | |
| clear(imodel: IModelConnection, scope: FavoritePropertiesScope): Promise<void> | Removes all favorite properties from a certain scope. | |
| dispose(): void | Disposes of any resources owned by this object. | |
| has(field: Field, imodel: IModelConnection, scope: FavoritePropertiesScope): boolean | Check if field contains at least one favorite property. | Deprecated |
| hasAsync(field: Field, imodel: IModelConnection, scope: FavoritePropertiesScope): Promise<boolean> | Check if field contains at least one favorite property. | |
| initializeConnection(imodel: IModelConnection): Promise<void> | Initialize favorite properties for the provided IModelConnection. | Deprecated |
| remove(field: Field, imodel: IModelConnection, scope: FavoritePropertiesScope): Promise<void> | Removes favorite properties from a scope specified and all the more general scopes. | |
| sortFields(imodel: IModelConnection, fields: Field[]): Field[] | Sorts an array of fields with respect to favorite property order. | Deprecated |
| sortFieldsAsync(imodel: IModelConnection, fields: Field[]): Promise<Field[]> | Sorts an array of fields with respect to favorite property order. |
Properties
| Name | Type | Description | |
|---|---|---|---|
| onFavoritesChanged | BeEvent<() => void> | Event raised after favorite properties have changed. |
Defined in
Last Updated: 24 June, 2025
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.