DrawingCategory Class
Categorizes 2d GeometricElements.
Extends
Implements
Methods
Name |
Description |
|
create(iModelDb: IModelDb, definitionModelId: Id64String, name: string): DrawingCategory Static |
Create a new DrawingCategory |
|
createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code Static |
Create a Code for a DrawingCategory 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 DrawingCategory objects. |
|
insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, defaultAppearance: Props): Id64String Static |
Insert a new DrawingCategory |
|
queryCategoryIdByName(iModel: IModelDb, scopeModelId: Id64String, categoryName: string): Id64String | undefined Static |
Looks up the CategoryId of a DrawingCategory by model and name |
|
Inherited methods
Name |
Inherited from |
Description |
buildConcurrencyControlRequest(opcode: DbOpcode): void |
Element |
Add a request for locks, code reservations, and anything else that would be needed to carry out the specified operation. |
delete(): void |
Element |
Delete this Element from the iModel. |
forEachProperty(func: PropertyCallback, includeCustom: boolean = false): void |
Entity |
Call a function for each property of this Entity. |
getClassMetaData(): EntityMetaData | undefined |
Element |
Get the class metadata for this element. |
getDisplayLabel(): string |
Element |
Get a display label for this Element. |
getJsonProperty(nameSpace: string): any |
Element |
Get a JSON property of this element, by namespace |
getToolTipMessage(): string[] |
Element |
Get a list of HTML strings that describe this Element for the tooltip. |
getUserProperties(namespace: string): any |
Element |
Get a set of JSON user properties by namespace |
insert(): string |
Element |
Insert this Element into the iModel. |
myDefaultSubCategoryId(): Id64String |
Category |
Get the Id of the default SubCategory for this Category. |
removeUserProperties(nameSpace: string): void |
Element |
Remove a set of JSON user properties, specified by namespace, from this Element |
setDefaultAppearance(props: Props): void |
Category |
Set the appearance of the default SubCategory for this Category |
setJsonProperty(nameSpace: string, value: any): void |
Element |
|
setUserProperties(nameSpace: string, value: any): void |
Element |
Change a set of user JSON properties of this Element by namespace. |
update(): void |
Element |
Update this Element in the iModel. |
onAllInputsHandled(_id: Id64String, _iModel: IModelDb): void ProtectedStatic |
Element |
|
onBeforeOutputsHandled(_id: Id64String, _iModel: IModelDb): void ProtectedStatic |
Element |
|
onDelete(_props: ElementProps, _iModel: IModelDb): void ProtectedStatic |
Element |
Called before an Element is deleted. |
onDeleted(_props: ElementProps, _iModel: IModelDb): void ProtectedStatic |
Element |
Called after an Element was deleted. |
onInsert(_props: ElementProps, _iModel: IModelDb): void ProtectedStatic |
Element |
Called before a new Element is inserted. |
onInserted(_props: ElementProps, _iModel: IModelDb): void ProtectedStatic |
Element |
Called after a new Element was inserted. |
onUpdate(_props: ElementProps, _iModel: IModelDb): void ProtectedStatic |
Element |
Called before an Element is updated. |
onUpdated(_props: ElementProps, _iModel: IModelDb): void ProtectedStatic |
Element |
Called after an Element was updated. |
Inherited properties
Defined in
Last Updated:
08 January, 2020