API Reference > imodeljs-backend > Elements > Sheet Sheet Class A digital representation of a sheet of paper. Modeled by a SheetModel. Extends Document Implements SheetProps Methods Name Description createCode(iModel: IModelDb, scopeModelId: string, codeValue: string): Code Static Create a Code for a Sheet given a name that is meant to be unique within the scope of the specified DocumentListModel. Inherited methods Name Inherited from Description buildConcurrencyControlRequest(opcode: DbOpcode): void Document Add a request for locks, code reservations, and anything else that would be needed to carry out the specified operation. delete(): void Document Delete this Element from the iModel. forEachProperty(func: PropertyCallback, includeCustom: boolean = true): void Document Call a function for each property of this Entity. getClassMetaData(): undefined | EntityMetaData Document Get the class metadata for this element. getDisplayLabel(): string Document Get a display label for this Element. getJsonProperty(nameSpace: string): any Document Get a JSON property of this element, by namespace getPredecessorIds(): Id64Set Document Get the Ids of this element's predecessors. getToolTipMessage(): string[] Document Get a list of HTML strings that describe this Element for the tooltip. getUserProperties(namespace: string): any Document Get a set of JSON user properties by namespace insert(): string Document Insert this Element into the iModel. removeUserProperties(nameSpace: string): void Document Remove a set of JSON user properties, specified by namespace, from this Element setJsonProperty(nameSpace: string, value: any): void Document setUserProperties(nameSpace: string, value: any): void Document Change a set of user JSON properties of this Element by namespace. update(): void Document Update this Element in the iModel. is(otherClass: undefined): boolean Static Document return whether this Entity class is a subclass of another Entity class onAllInputsHandled(_id: string, _iModel: IModelDb): void ProtectedStatic Document Called on an element in a graph after all of its inputs have been processed and before its outputs are processed. onBeforeOutputsHandled(_id: string, _iModel: IModelDb): void ProtectedStatic Document Called when a root element in a subgraph is changed and before its outputs are processed. onChildAdd(_arg: OnChildElementPropsArg): void ProtectedStatic Document Called when an existing element is about to be updated so that an instance of this class will become its new parent. onChildAdded(_arg: OnChildElementIdArg): void ProtectedStatic Document Called after an existing element has been updated so that an instance of this class is its new parent. onChildDelete(_arg: OnChildElementIdArg): void ProtectedStatic Document Called when an element with an instance of this class as its parent is about to be deleted. onChildDeleted(_arg: OnChildElementIdArg): void ProtectedStatic Document Called after an element with an instance of this class as its parent was successfully deleted. onChildDrop(_arg: OnChildElementIdArg): void ProtectedStatic Document Called when an element with an instance of this class as its parent is about to be updated change to a different parent. onChildDropped(_arg: OnChildElementIdArg): void ProtectedStatic Document Called after an element with an instance of this class as its previous parent was updated to have a new parent. onChildInsert(_arg: OnChildElementPropsArg): void ProtectedStatic Document Called when a new element with an instance of this class as its parent is about to be inserted. onChildInserted(_arg: OnChildElementIdArg): void ProtectedStatic Document Called after a new element with an instance of this class as its parent was inserted. onChildUpdate(_arg: OnChildElementPropsArg): void ProtectedStatic Document Called when an element with an instance of this class as its parent is about to be updated. onChildUpdated(_arg: OnChildElementIdArg): void ProtectedStatic Document Called after an element with an instance of this the class as its parent was updated. onCloned(_context: IModelCloneContext, _sourceProps: ElementProps, _targetProps: ElementProps): void ProtectedStatic Document Called during the iModel transformation process after an Element from the source iModel was cloned for the target iModel. onDelete(arg: OnElementIdArg): void ProtectedStatic Document Called before an Element is deleted. onDeleted(_arg: OnElementIdArg): void ProtectedStatic Document Called after an Element was deleted. onInsert(arg: OnElementPropsArg): void ProtectedStatic Document Called before a new Element is inserted. onInserted(arg: OnElementIdArg): void ProtectedStatic Document Called after a new Element was inserted. onSubModelDelete(_arg: OnSubModelIdArg): void ProtectedStatic Document Called when a sub-model of an instance of this class is being deleted. onSubModelDeleted(_arg: OnSubModelIdArg): void ProtectedStatic Document Called after a sub-model of an instance of this class was deleted. onSubModelInsert(_arg: OnSubModelPropsArg): void ProtectedStatic Document Called when an instance of this class is being sub-modeled by a new Model. onSubModelInserted(_arg: OnSubModelIdArg): void ProtectedStatic Document Called after an instance of this class was sub-modeled by a new Model. onUpdate(arg: OnElementPropsArg): void ProtectedStatic Document Called before an Element is updated. onUpdated(arg: OnElementIdArg): void ProtectedStatic Document Called after an Element was updated. populateRequest(req: ConcurrencyControl.Request, props: ElementProps, iModel: IModelDb, opcode: DbOpcode, original: undefined | ElementProps): void Static Document Disclose the codes and locks needed to perform the specified operation on this element Properties Name Type Description height number scale undefined | number sheetTemplate undefined | string width number Inherited properties Name Type Inherited from Description classFullName Accessor ReadOnly string Document Get the full BIS class name of this Entity in the form "schema:class". classFullName Accessor StaticReadOnly string Document Get the full BIS class name of this Entity in the form "schema:class" className Accessor ReadOnly string Document The name of the BIS class associated with this class. code Code Document The Code for this element federationGuid undefined | string Document A FederationGuid assigned to this element by some other federated database id string Document The Id of this Entity. iModel IModelDb Document The IModelDb that contains this Entity jsonProperties Readonly { T } Document Optional json properties of this element. model Readonly string Document The ModelId of the Model containing this element parent undefined | RelatedElement Document The parent element, if present, of this element. schema Static undefined Document The Schema that defines this class. schemaName Accessor ReadOnly string Document The name of the BIS Schema that defines this class userLabel undefined | string Document A user-assigned label for this element. Defined in core/backend/src/Element.ts Line 969 Last Updated: 11 June, 2024