CategorySelector Class

Holds a list of Ids of Categories to be displayed in a view.

see CategorySelectorState See [how to create a CategorySelector]$(docs/learning/backend/CreateElements.md#CategorySelector).

Extends

Implements

Methods

Name Description
create(iModelDb: IModelDb, definitionModelId: Id64String, name: string, categories: Id64Array): CategorySelector Static Create a CategorySelector which is used to select which categories are displayed by a ViewDefinition.  
createCode(iModel: IModelDb, scopeModelId: CodeScopeProps, codeValue: string): Code Static Create a Code for a CategorySelector given a name that is meant to be unique within the scope of the specified DefinitionModel.  
insert(iModelDb: IModelDb, definitionModelId: Id64String, name: string, categories: Id64Array): Id64String Static Insert a CategorySelector which is used to select which categories are displayed by a ViewDefinition.  

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.
clone(): this Entity Make a deep copy of this Entity
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.
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.
removeUserProperties(nameSpace: string): void Element Remove a set of JSON user properties, specified by namespace, from this Element
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 Static Element  
onBeforeOutputsHandled(_id: Id64String, _iModel: IModelDb): void Static Element  
onDelete(_props: ElementProps, _iModel: IModelDb): IModelStatus Static Element  
onDeleted(_props: ElementProps, _iModel: IModelDb): void Static Element  
onInsert(_props: ElementProps, _iModel: IModelDb): IModelStatus Static Element  
onInserted(_props: ElementProps, _iModel: IModelDb): void Static Element  
onUpdate(_props: ElementProps, _iModel: IModelDb): IModelStatus Static Element  
onUpdated(_props: ElementProps, _iModel: IModelDb): void Static Element  

Properties

Name Type Description
categories string[] The array of element Ids of the Categories selected by this CategorySelector  
className Accessor StaticReadOnly string    

Inherited properties

Name Type Inherited from Description
classFullName Accessor ReadOnly string Entity Get the full BIS class name of this Entity in the form "schema:class".
classFullName Accessor StaticReadOnly string Entity Get the full BIS class name of this Entity in the form "schema:class"
className Accessor ReadOnly string Entity Get the BIS Class name for this class
code Code Element The Code for this element
federationGuid undefined | GuidString Element A FederationGuid assigned to this element by some other federated database
id Id64String Entity The Id of this Entity.
iModel IModelDb Entity The Entity.IModelDb that contains this Entity
isPrivate boolean DefinitionElement If true, don't show this DefinitionElement in user interface lists.
jsonProperties [key: string]: any Element Optional json properties of this element.
model Id64String Element The ModelId of the Model containing this element
parent undefined | RelatedElement Element The parent element, if present, of this element.
schema Static Schema Entity The Schema that defines this class.
schemaName Accessor ReadOnly string Entity Get the name of the Bis Schema that defines this class
userLabel undefined | string Element A user-assigned label for this element.

Defined in

Last Updated: 13 May, 2019