API Reference › core-backend› Elements › TemplateRecipe2d

TemplateRecipe2d Class

A recipe that uses a 2D template for creating new instances.

Extends

Methods

Name Description
constructor(props: ElementProps, iModel: IModelDb): TemplateRecipe2d Protected    
create(iModelDb: IModelDb, definitionModelId: string, name: string, isPrivate?: boolean): TemplateRecipe2d Static Create a TemplateRecipe2d  
createCode(iModelDb: IModelDb, definitionModelId: string, codeValue: string): Code Static Create a Code for a TemplateRecipe2d given a name that is meant to be unique within the scope of its Model.  
insert(iModelDb: IModelDb, definitionModelId: string, name: string, isPrivate?: boolean): string Static Insert a TemplateRecipe2d and a DrawingModel (sub-model) that will contain the 2d template elements.  

Inherited methods

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

Properties

Name Type Description
className Accessor Static ReadOnly string    

Inherited properties

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

Defined in

Last Updated: 21 November, 2024