#Interface: IBlockTablePropertyItem experimental

Beta

A property item which supports Block Table 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

---

#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

#addOrUpdateEntry()

addOrUpdateEntry(block, blockInfo): void

Beta

#Parameters

#block

any

a new entry in the block table.

#blockInfo

IBlockTableEntryInfo

block info for the entry in the block table.

#Returns

void

#Remarks

Create new or update an existing entry in the block table

---

#deleteEntry()

deleteEntry(block): void

Beta

#Parameters

#block

string

an entry in the block table.

#Returns

void

#Remarks

Delete entry in the block table, by block name

---

#getEntry()

getEntry(block): IBlockTableEntryInfo | undefined

Beta

#Parameters

#block

any

an entry in the block table.

#Returns

IBlockTableEntryInfo | undefined

#Remarks

Read entry from the block table, by block name

---

#setTitle()

setTitle(title): void

Beta

#Parameters

#title

LocalizedString

New title.

#Returns

void

#Remarks

Updates title of the property item.

---

#updateEntries()

updateEntries(entries): void

Beta

#Parameters

#entries

Map<string, IBlockTableEntryInfo>

The new value for the block table.

#Returns

void

#Remarks

Update the block table entries