FavoritePropertiesManager Class

Beta

The favorite property manager which lets to store favorite properties and check if field contains favorite properties.

Methods

Name Description
constructor(props?: FavoritePropertiesManagerProps): FavoritePropertiesManager    
add(field: Field, projectId?: string, imodelId?: string): Promise<void> Adds favorite properties into a certain scope.  
clear(projectId?: string, imodelId?: string): Promise<void> Removes all favorite properties from a certain scope.  
has(field: Field, projectId?: string, imodelId?: string): boolean Check if field contains at least one favorite property.  
remove(field: Field, projectId?: string, imodelId?: string): Promise<void> Removes favorite properties from scopes that there is info about.  

Properties

Name Type Description
onFavoritesChanged BeEvent<() => void> Event raised after favorite properties have changed.  

Defined in

Last Updated: 08 January, 2020