Interface IBlockTablePropertyItem

A property item which supports Block Table properties

interface IBlockTablePropertyItem {
    enable: boolean;
    id: string;
    paneId: string;
    typeName: PropertyItemType;
    visible: boolean;
    addOrUpdateEntry(
        block: string | BlockType,
        blockInfo: IBlockTableEntryInfo,
    ): void;
    deleteEntry(block: string): void;
    getEntry(block: string | BlockType): IBlockTableEntryInfo;
    setTitle(title: LocalizedString): void;
    updateEntries(entries: Map<string, IBlockTableEntryInfo>): void;
}

Hierarchy (View Summary)

IPropertyItemBase
- IBlockTablePropertyItem

Index

Properties

enable id paneId typeName visible

Methods

addOrUpdateEntry deleteEntry getEntry setTitle updateEntries

Properties

enable

enable: boolean

Remarks

If the item is enabled in the UI.

`Readonly`id

id: string

Remarks

Unique ID for the property item.

`Readonly`paneId

paneId: string

Remarks

The parent pane id.

`Readonly`typeName

typeName: PropertyItemType

Remarks

The type name of the target property.

visible

visible: boolean

Remarks

If the item should be visible in the UI.

Methods

addOrUpdateEntry

addOrUpdateEntry(
block: string | BlockType,
blockInfo: IBlockTableEntryInfo,
): void
Parameters
- block: string | BlockType
  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: string): void
Parameters
- block: string
  an entry in the block table.
Returns void
Remarks
Delete entry in the block table, by block name

getEntry

getEntry(block: string | BlockType): IBlockTableEntryInfo
Parameters
- block: string | BlockType
  an entry in the block table.
Returns IBlockTableEntryInfo
Remarks
Read entry from the block table, by block name

setTitle

setTitle(title: LocalizedString): void
Parameters
- title: LocalizedString
  New title.
Returns void
Remarks
Updates title of the property item.

updateEntries

updateEntries(entries: Map<string, IBlockTableEntryInfo>): void
Parameters
- entries: Map<string, IBlockTableEntryInfo>
  The new value for the block table.
Returns void
Remarks
Update the block table entries