#Interface: ITagContainerPropertyItem experimental

inventory

Beta

A property item which supports Tag Container properties

#Extends

• IPropertyItemBase

#Properties

#enable

enable: boolean

Beta

#Remarks

If the item is enabled in the UI.

#Inherited from

IPropertyItemBase.enable

---

#id

readonly id: string

Beta

#Remarks

Unique ID for the property item.

#Inherited from

IPropertyItemBase.id

---

#paneId

readonly paneId: string

Beta

#Remarks

The parent pane id.

#Inherited from

IPropertyItemBase.paneId

---

#tags

readonly tags: readonly string[]

Beta

#Remarks

Current tags value of the property item.

---

#tagsPool

readonly tagsPool: readonly string[]

Beta

#Remarks

Current tags pool value of the property item.

---

#typeName

readonly typeName: PropertyItemType

Beta

#Remarks

The type name of the target property.

#Inherited from

IPropertyItemBase.typeName

---

#visible

visible: boolean

Beta

#Remarks

If the item should be visible in the UI.

#Inherited from

IPropertyItemBase.visible

#Methods

#addTag()

addTag(tag): void

Beta

#Parameters

#tag

string

Tag to add.

#Returns

void

#Remarks

Adds a tag to the current tags.

---

#addTagToPool()

addTagToPool(tag): void

Beta

#Parameters

#tag

string

Tag to add to the pool.

#Returns

void

#Remarks

Adds a tag to the tags pool.

---

#removeTag()

removeTag(tag): void

Beta

#Parameters

#tag

string

Tag to remove.

#Returns

void

#Remarks

Removes a tag from the current tags.

---

#removeTagFromPool()

removeTagFromPool(tag): void

Beta

#Parameters

#tag

string

Tag to remove from the pool.

#Returns

void

#Remarks

Removes a tag from the tags pool.

---

#setTags()

setTags(tags): void

Beta

#Parameters

#tags

string[] | undefined

New tags array.

#Returns

void

#Remarks

Updates all tags.

---

#setTagsPool()

setTagsPool(tagsPool): void

Beta

#Parameters

#tagsPool

string[] | undefined

New tags pool array.

#Returns

void

#Remarks

Updates the tags pool.

---

#setTitle()

setTitle(title): void

Beta

#Parameters

#title

LocalizedString

New title.

#Returns

void

#Remarks

Set title of the property item.

---

#setVariant()

setVariant(variant): void

Beta

#Parameters

#variant

TagContainerVariant | undefined

New variant.

#Returns

void

#Remarks

Sets the visual variant of the tag container.

#同领域相关

• IMenuContainer
• IModalToolContainer
• ITagContainerPropertyItemOptions
• SelectionContainerBase
• SelectionContainerEntity
• SelectionContainerVolume