API Reference › core-backend› ElementAspects › SheetInformationAspect

SheetInformationAspect Class @beta

An ElementUniqueAspect that captures common metadata about a single Sheet. Use getSheetInformation to retrieve the metadata for a Sheet and setSheetInformation to create, update, or delete it.

Extends

Methods

Name Description
toJSON(): SheetInformationAspectProps Obtain the JSON representation of this Entity.  
getSheetInformation(sheetId: string, iModel: IModelDb): undefined | SheetInformation Static Retrieves the metadata hosted by the aspect on the specified sheet, returning undefined if no such metadata could be retrieved.  
onInsert(arg: OnAspectPropsArg): void Protected Static Called before a new ElementAspect is inserted.  
setSheetInformation(information: SheetInformation, sheetId: string, iModel: IModelDb): void Static Sets the information for the Sheet element specified by ``sheetId`.  

Inherited methods

Name Inherited from Description
collectReferenceIds(_referenceIds: EntityReferenceSet): void Protected Inherited ElementUniqueAspect Collect the Ids of this entity's references at this level of the class hierarchy.
forEach(func: PropertyHandler, includeCustom: boolean = true): void Inherited ElementUniqueAspect Call a function for each property of this Entity.
forEachProperty(func: PropertyCallback, includeCustom: boolean = true): void Inherited ElementUniqueAspect Call a function for each property of this Entity.
getMetaData(): Promise<EntityClass | RelationshipClass> Inherited ElementUniqueAspect Query metadata for this entity class from the iModel's schema.
getReferenceIds(): EntityReferenceSet Inherited ElementUniqueAspect Get the set of this entity's entity references, EntityReferenceSet.
deserialize(props: DeserializeEntityArgs): EntityProps Static Inherited ElementUniqueAspect Converts an ECSqlRow of an Entity to an EntityProps.
is(otherClass: Entity): boolean Static Inherited ElementUniqueAspect return whether this Entity class is a subclass of another Entity class
onDelete(arg: OnAspectIdArg): void Protected Static Inherited ElementUniqueAspect Called before an ElementAspect is deleted.
onDeleted(_arg: OnAspectIdArg): void Protected Static Inherited ElementUniqueAspect Called after an ElementAspect was deleted.
onInserted(_arg: OnAspectPropsArg): void Protected Static Inherited ElementUniqueAspect Called after a new ElementAspect was inserted.
onUpdate(arg: OnAspectPropsArg): void Protected Static Inherited ElementUniqueAspect Called before an ElementAspect is updated.
onUpdated(_arg: OnAspectPropsArg): void Protected Static Inherited ElementUniqueAspect Called after an ElementAspect was updated.
serialize(props: EntityProps, _iModel: IModelDb): ECSqlRow Static Inherited ElementUniqueAspect Converts an EntityProps to an ECSqlRow.

Properties

Name Type Description
className Accessor Static ReadOnly string The name of the BIS class associated with this class.  
sheetInformation SheetInformation The sheet's metadata.  

Inherited properties

Name Type Inherited from Description
_customHandledProps Protected Static Readonly Inherited CustomHandledProperty[] ElementUniqueAspect List of properties that are need to be custom handled during deserialization and serialization.
_metadata Protected Inherited EntityClass | RelationshipClass ElementUniqueAspect Cached Metadata for the ECClass
classFullName Accessor Inherited ReadOnly string ElementUniqueAspect Get the full BIS class name of this Entity in the form "schema:class".
classFullName Accessor Static Inherited ReadOnly string ElementUniqueAspect Get the full BIS class name of this Entity in the form "schema:class"
className Accessor Inherited ReadOnly string ElementUniqueAspect The name of the BIS class associated with this class.
element Inherited RelatedElement ElementUniqueAspect  
id Inherited string ElementUniqueAspect The Id of this Entity.
iModel Inherited IModelDb ElementUniqueAspect The IModelDb that contains this Entity
isInstanceOfEntity Readonly Inherited "true" ElementUniqueAspect An immutable property used to discriminate between Entity and EntityProps, used to inform the TypeScript compiler that these two types
schema Static Inherited Schema ElementUniqueAspect The Schema that defines this class.
schemaItemKey Accessor Inherited ReadOnly SchemaItemKey ElementUniqueAspect Get the item key used by the ecschema-metadata package to identify this entity class
schemaItemKey Accessor Static Inherited ReadOnly SchemaItemKey ElementUniqueAspect Serves as a unique identifier for this class. Typed variant of classFullName.
schemaName Accessor Inherited ReadOnly string ElementUniqueAspect The name of the BIS Schema that defines this class

Defined in

Last Updated: 11 November, 2025