Name |
Inherited from |
Description |
collectPredecessorIds(predecessorIds: EntityReferenceSet): void Protected |
Category |
Collect the Ids of this element's references at this level of the class hierarchy. |
collectReferenceIds(referenceIds: EntityReferenceSet): void Protected |
Category |
Collect the Ids of this entity's references at this level of the class hierarchy. |
delete(): void |
Category |
Delete this Element from the iModel. |
forEachProperty(func: PropertyCallback, includeCustom: booleantrue): void |
Category |
Call a function for each property of this Entity. |
getClassMetaData(): undefined | EntityMetaData |
Category |
Get the class metadata for this element. |
getDisplayLabel(): string |
Category |
Get a display label for this Element. |
getJsonProperty(nameSpace: string): any |
Category |
Get a JSON property of this element, by namespace |
getPredecessorIds(): Id64Set |
Category |
Get the Ids of this element's references. |
getReferenceIds(): EntityReferenceSet |
Category |
Get the set of this entity's entity references, EntityReferenceSet. |
getToolTipMessage(): string[] |
Category |
Get a list of HTML strings that describe this Element for the tooltip. |
getUserProperties(namespace: string): any |
Category |
Get a set of JSON user properties by namespace |
insert(): string |
Category |
Insert this Element into the iModel. |
myDefaultSubCategoryId(): string |
Category |
Get the Id of the default SubCategory for this Category. |
removeUserProperties(nameSpace: string): void |
Category |
Remove a set of JSON user properties, specified by namespace, from this Element |
setDefaultAppearance(props: SubCategoryAppearance | SubCategoryAppearance.Props): void |
Category |
Set the appearance of the default SubCategory for this Category |
setJsonProperty(nameSpace: string, value: any): void |
Category |
|
setUserProperties(nameSpace: string, value: any): void |
Category |
Change a set of user JSON properties of this Element by namespace. |
toJSON(): CategoryProps |
Category |
Obtain the JSON representation of this Entity. |
update(): void |
Category |
Update this Element in the iModel. |
is(otherClass: ): boolean Static |
Category |
return whether this Entity class is a subclass of another Entity class |
onAllInputsHandled(_id: string, _iModel: IModelDb): void Protected Static |
Category |
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 Protected Static |
Category |
Called when a root element in a subgraph is changed and before its outputs are processed. |
onChildAdd(_arg: OnChildElementPropsArg): void Protected Static |
Category |
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 Protected Static |
Category |
Called after an existing element has been updated so that an instance of this class is its new parent. |
onChildDelete(_arg: OnChildElementIdArg): void Protected Static |
Category |
Called when an element with an instance of this class as its parent is about to be deleted. |
onChildDeleted(_arg: OnChildElementIdArg): void Protected Static |
Category |
Called after an element with an instance of this class as its parent was successfully deleted. |
onChildDrop(_arg: OnChildElementIdArg): void Protected Static |
Category |
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 Protected Static |
Category |
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 Protected Static |
Category |
Called when a new element with an instance of this class as its parent is about to be inserted. |
onChildInserted(_arg: OnChildElementIdArg): void Protected Static |
Category |
Called after a new element with an instance of this class as its parent was inserted. |
onChildUpdate(_arg: OnChildElementPropsArg): void Protected Static |
Category |
Called when an element with an instance of this class as its parent is about to be updated. |
onChildUpdated(_arg: OnChildElementIdArg): void Protected Static |
Category |
Called after an element with an instance of this the class as its parent was updated. |
onCloned(_context: IModelElementCloneContext, _sourceProps: ElementProps, _targetProps: ElementProps): void Protected Static |
Category |
Called during the iModel transformation process after an Element from the source iModel was cloned for the target iModel. |
onDelete(arg: OnElementIdArg): void Protected Static |
Category |
Called before an Element is deleted. |
onDeleted(_arg: OnElementIdArg): void Protected Static |
Category |
Called after an Element was deleted. |
onInsert(arg: OnElementPropsArg): void Protected Static |
Category |
Called before a new Element is inserted. |
onInserted(arg: OnElementIdArg): void Protected Static |
Category |
Called after a new Element was inserted. |
onSubModelDelete(_arg: OnSubModelIdArg): void Protected Static |
Category |
Called when a sub-model of an instance of this class is being deleted. |
onSubModelDeleted(_arg: OnSubModelIdArg): void Protected Static |
Category |
Called after a sub-model of an instance of this class was deleted. |
onSubModelInsert(_arg: OnSubModelPropsArg): void Protected Static |
Category |
Called when an instance of this class is being sub-modeled by a new Model. |
onSubModelInserted(_arg: OnSubModelIdArg): void Protected Static |
Category |
Called after an instance of this class was sub-modeled by a new Model. |
onUpdate(arg: OnElementPropsArg): void Protected Static |
Category |
Called before an Element is updated. |
onUpdated(_arg: OnElementIdArg): void Protected Static |
Category |
Called after an Element was updated. |