setSheetInformation MethodStatic

setSheetInformation(information, sheetId, iModel)

Deprecated  in 5.1.9 - will not be removed until after 2027-05-04. Use SheetInformationAspect.setSheetInformation(txn, ...) instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.

Sets the information for the Sheet element specified by ``sheetId. If informationisundefined`, any existing aspect will be deleted. Otherwise, a new aspect will be inserted, or an existing aspect will be updated with the new metadata.

setSheetInformation(information: SheetInformation, sheetId: string, iModel: IModelDb): void

@throws Error if the iModel contains a version of the BisCore schema older than 01.00.25.

Parameter	Type	Description
information	SheetInformation
sheetId	string
iModel	IModelDb

Returns - void

setSheetInformation(txn, information, sheetId) @beta

Sets the information for the Sheet element specified by sheetId, using an explicit EditTxn. If information is undefined, any existing aspect will be deleted. Otherwise, a new aspect will be inserted, or an existing aspect will be updated with the new metadata.

setSheetInformation(txn: EditTxn, information: SheetInformation, sheetId: string): void

@throws Error if the iModel contains a version of the BisCore schema older than 01.00.25.

@throws EditTxnError if the EditTxn is not active.

Parameter	Type	Description
txn	EditTxn
information	SheetInformation
sheetId	string

Returns - void

Defined in

• backend/src/ElementAspect.ts Line 223