#Interface: IListPanePropertyItem experimental

Beta

A property item which supports Sub Pane properties

#Extends

• IPropertyItemBase.IPane

#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

---

#slotCount

readonly slotCount: number

Beta

#Remarks

Count of the slots managed by the list.

---

#typeName

readonly typeName: PropertyItemType

Beta

#Remarks

The type name of the target property.

#Inherited from

IPropertyItemBase.typeName

---

#viewControlPane

readonly viewControlPane: IListViewControlPane | undefined

Beta

#Remarks

View control pane for the list

---

#viewSortType

readonly viewSortType: ListPaneViewSortType

Beta

#Remarks

Current sorting type for the pane slots

---

#visible

visible: boolean

Beta

#Remarks

If the item should be visible in the UI.

#Inherited from

IPropertyItemBase.visible

#Methods

#addSlot()

addSlot(params): IListPaneSlot

Beta

#Parameters

#params

ListPaneSlotCreationProps

#Returns

IListPaneSlot

#Remarks

Adds a new slot to the list.

---

#buildViewControl()

buildViewControl(options): IListViewControlPane

Beta

#Parameters

#options

IListPaneViewControlPaneOptions

#Returns

IListViewControlPane

#Remarks

Creates a pane that displays view and filtering configurations for the list if the parent container supports it.

---

#getSlotById()

getSlotById(id): IListPaneSlot | undefined

Beta

#Parameters

#id

string

Unique identifier of the slot.

#Returns

IListPaneSlot | undefined

#Remarks

Finds the slot with the identifier.

---

#getSlotByIndex()

getSlotByIndex(index): IListPaneSlot | undefined

Beta

#Parameters

#index

number

Index of the slot in the component list.

#Returns

IListPaneSlot | undefined

#Remarks

Finds the slot with the index.

---

#getViewFilter()

getViewFilter(): ListPaneViewFilter | undefined

Beta

#Returns

ListPaneViewFilter | undefined

Active view filter

#Remarks

---

#hide()

hide(): void

Beta

#Returns

void

#Remarks

Hide the pane.

#Inherited from

IPane.hide

---

#removeSlot()

removeSlot(id): void

Beta

#Parameters

#id

string

Unique identifier of the slot.

#Returns

void

#Remarks

Removes the slot from the list.

---

#selectSlot()

selectSlot(id, deselectOtherSlots?): void

Beta

#Parameters

#id

string

Unique identifier of the slot.

#deselectOtherSlots?

boolean

Deselects already selected slots if defined.

#Returns

void

#Remarks

Selects slot by id.

---

#setViewFilter()

setViewFilter(filter): void

Beta

#Parameters

#filter

ListPaneViewFilter | undefined

Slots that don't match filter properties won't be included.

#Returns

void

#Remarks

Filters displaying slots to match the define properties

---

#setViewSortType()

setViewSortType(sortType): void

Beta

#Parameters

#sortType

ListPaneViewSortType | undefined

New sort type, it undefined Default will be used.

#Returns

void

#Remarks

Updates how slots will be sorted in the view

---

#show()

show(): void

Beta

#Returns

void

#Remarks

Show the pane and all of its items.

#Inherited from

IPane.show

---

#updateSlots()

updateSlots(newSlots): void

Beta

#Parameters

#newSlots

ListPaneSlotCreationProps[]

Creation properties for the new slots.

#Returns

void

#Remarks

Updates all slots with the new list.