API Reference > core-backend > Categories > SpatialCategory

SpatialCategory Class

Categorizes SpatialElements. See [how to create a SpatialCategory]$(docs/learning/backend/CreateElements.md#SpatialCategory).

Extends

Methods

Name Description
create(iModelDb: IModelDb, definitionModelId: string, name: string): SpatialCategory Static Create a new SpatialCategory  
createCode(iModel: IModelDb, scopeModelId: string, codeValue: string): Code Static Create a Code for a SpatialCategory given a name that is meant to be unique within the scope of the specified DefinitionModel.  
getCodeSpecName(): string Static Get the name of the CodeSpec that is used by SpatialCategory objects.  
insert(iModelDb: IModelDb, definitionModelId: string, name: string, defaultAppearance: Props | SubCategoryAppearance): string Static Insert a new SpatialCategory  
queryCategoryIdByName(iModel: IModelDb, scopeModelId: string, categoryName: string): undefined | string Static Looks up the CategoryId of a SpatialCategory by model and name  

Inherited methods

Name Inherited from Description
collectPredecessorIds(predecessorIds: Id64Set): void Protected Category Collect the Ids of this element's references at this level of the class hierarchy.
collectReferenceIds(referenceIds: Set<string>): 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: boolean = true): 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(): Set<string> Category Get the Ids of this element's references.
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: Props | SubCategoryAppearance): 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.
update(): void Category Update this Element in the iModel.
is(otherClass: undefined): boolean Static Category return whether this Entity class is a subclass of another Entity class
onAllInputsHandled(_id: string, _iModel: IModelDb): void ProtectedStatic 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 ProtectedStatic Category Called when a root element in a subgraph is changed and before its outputs are processed.
onChildAdd(_arg: OnChildElementPropsArg): void ProtectedStatic 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 ProtectedStatic Category Called after an existing element has been updated so that an instance of this class is its new parent.
onChildDelete(_arg: OnChildElementIdArg): void ProtectedStatic Category Called when an element with an instance of this class as its parent is about to be deleted.
onChildDeleted(_arg: OnChildElementIdArg): void ProtectedStatic Category Called after an element with an instance of this class as its parent was successfully deleted.
onChildDrop(_arg: OnChildElementIdArg): void ProtectedStatic 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 ProtectedStatic 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 ProtectedStatic Category Called when a new element with an instance of this class as its parent is about to be inserted.
onChildInserted(_arg: OnChildElementIdArg): void ProtectedStatic Category Called after a new element with an instance of this class as its parent was inserted.
onChildUpdate(_arg: OnChildElementPropsArg): void ProtectedStatic Category Called when an element with an instance of this class as its parent is about to be updated.
onChildUpdated(_arg: OnChildElementIdArg): void ProtectedStatic 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 ProtectedStatic Category Called during the iModel transformation process after an Element from the source iModel was cloned for the target iModel.
onDelete(arg: OnElementIdArg): void ProtectedStatic Category Called before an Element is deleted.
onDeleted(_arg: OnElementIdArg): void ProtectedStatic Category Called after an Element was deleted.
onInsert(arg: OnElementPropsArg): void ProtectedStatic Category Called before a new Element is inserted.
onInserted(arg: OnElementIdArg): void ProtectedStatic Category Called after a new Element was inserted.
onSubModelDelete(_arg: OnSubModelIdArg): void ProtectedStatic Category Called when a sub-model of an instance of this class is being deleted.
onSubModelDeleted(_arg: OnSubModelIdArg): void ProtectedStatic Category Called after a sub-model of an instance of this class was deleted.
onSubModelInsert(_arg: OnSubModelPropsArg): void ProtectedStatic Category Called when an instance of this class is being sub-modeled by a new Model.
onSubModelInserted(_arg: OnSubModelIdArg): void ProtectedStatic Category Called after an instance of this class was sub-modeled by a new Model.
onUpdate(arg: OnElementPropsArg): void ProtectedStatic Category Called before an Element is updated.
onUpdated(_arg: OnElementIdArg): void ProtectedStatic Category Called after an Element was updated.

Inherited properties

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

Defined in

Last Updated: 30 November, 2023