API Reference > core-backend > Categories > SubCategory

SubCategory Class

Defines the appearance for graphics in Geometric elements

Extends

Methods

Name Description
getCategoryId(): string Get the Id of this SubCategory's parent Category.  
getSubCategoryId(): string Get the Id of the SubCategory.  
getSubCategoryName(): string Get the SubCategory's name (its Code value).  
create(iModelDb: IModelDb, parentCategoryId: string, name: string, appearance: Props | SubCategoryAppearance): SubCategory Static Create a new SubCategory  
createCode(iModel: IModelDb, parentCategoryId: string, codeValue: string): Code Static Create a Code for a SubCategory given a name that is meant to be unique within the scope of the specified parent Category.  
insert(iModelDb: IModelDb, parentCategoryId: string, name: string, appearance: Props | SubCategoryAppearance): string Static Insert a new SubCategory  

Inherited methods

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

Properties

Name Type Description
appearance SubCategoryAppearance The Appearance parameters for this SubCategory  
description undefined | string Optional description of this SubCategory.  
isDefaultSubCategory Accessor ReadOnly boolean Check if this is the default SubCategory of its parent Category.  

Inherited properties

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

Defined in

Last Updated: 30 November, 2023