add - presentation-frontend

add Method

Overloads
add(field, projectId?, imodelId?)	Deprecated
add(field, imodel, scope)

Adds favorite properties into a certain scope.

add(field: Field, projectId?: string, imodelId?: string): Promise<void>

Parameter	Type	Description
field	Field	Field that contains properties. If field contains multiple properties, all of them will be favorited.
projectId	string	Project Id, if the favorite property is specific to a project, otherwise undefined.
imodelId	string	iModel Id, if the favorite property is specific to a iModel, otherwise undefined. The projectId must be specified if iModelId is specified.

Returns - Promise<void>

Adds favorite properties into a certain scope.

add(field: Field, imodel: IModelConnection, scope: FavoritePropertiesScope): Promise<void>

note initializeConnection must be called with the imodel before calling this function.

Parameter	Type	Description
field	Field	Field that contains properties. If field contains multiple properties, all of them will be favorited.
imodel	IModelConnection	IModelConnection.
scope	FavoritePropertiesScope	FavoritePropertiesScope to put the favorite properties into.

Returns - Promise<void>

Last Updated: 11 June, 2024