Interface IBlockTablePropertyItem

A property item which supports Block Table properties

Hierarchy

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

  • 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

  • Parameters

    • block: string

      an entry in the block table.

    Returns void

    Remarks

    Delete entry in the block table, by block name

getEntry

  • Parameters

    • block: string | BlockType

      an entry in the block table.

    Returns undefined | IBlockTableEntryInfo

    Remarks

    Read entry from the block table, by block name

setTitle

  • Parameters

    Returns void

    Remarks

    Updates title of the property item.

updateEntries

  • Parameters

    Returns void

    Remarks

    Update the block table entries

Settings

Member Visibility

Theme

On This Page