API Reference › core-backend › Elements › FunctionalComposite

FunctionalComposite Class

Extends

Methods

Name Description
constructor(props: FunctionalElementProps, iModel: IModelDb): FunctionalComposite Protected    

Inherited methods

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

Inherited properties

Name Type Inherited from Description
classFullName Accessor ReadOnly string FunctionalBreakdownElement Get the full BIS class name of this Entity in the form "schema:class".
classFullName Accessor StaticReadOnly string FunctionalBreakdownElement Get the full BIS class name of this Entity in the form "schema:class"
className Accessor ReadOnly string FunctionalBreakdownElement The name of the BIS class associated with this class.
code Code FunctionalBreakdownElement The Code for this element
federationGuid undefined | string FunctionalBreakdownElement A FederationGuid assigned to this element by some other federated database
id string FunctionalBreakdownElement The Id of this Entity.
iModel IModelDb FunctionalBreakdownElement The IModelDb that contains this Entity
isInstanceOfEntity Readonly "true" FunctionalBreakdownElement An immutable property used to discriminate between Entity and EntityProps, used to inform the TypeScript compiler that these two types
jsonProperties Readonly { T } FunctionalBreakdownElement Optional json properties of this element.
model Readonly string FunctionalBreakdownElement The ModelId of the Model containing this element
parent undefined | RelatedElement FunctionalBreakdownElement The parent element, if present, of this element.
requiredReferenceKeys StaticReadonly undefined FunctionalBreakdownElement A required reference is an element that had to be inserted before this element could have been inserted.
schema Static undefined FunctionalBreakdownElement The Schema that defines this class.
schemaName Accessor ReadOnly string FunctionalBreakdownElement The name of the BIS Schema that defines this class
userLabel undefined | string FunctionalBreakdownElement A user-assigned label for this element.

Defined in

Last Updated: 16 April, 2024