Interface IListPanePropertyItem

A property item which supports Sub Pane properties

interface IListPanePropertyItem {
    enable: boolean;
    id: string;
    paneId: string;
    slotCount: number;
    typeName: PropertyItemType;
    viewSortType: ListPaneViewSortType;
    visible: boolean;
    addSlot(params: ListPaneSlotCreationProps): IListPaneSlot;
    getSlotById(id: string): IListPaneSlot;
    getSlotByIndex(index: number): IListPaneSlot;
    getViewFilter(): ListPaneViewFilter;
    hide(): void;
    removeSlot(id: string): void;
    selectSlot(id: string, deselectOtherSlots?: boolean): void;
    setViewFilter(filter: ListPaneViewFilter): void;
    setViewSortType(sortType: ListPaneViewSortType): void;
    show(): void;
    updateSlots(newSlots: ListPaneSlotCreationProps[]): void;
}

Hierarchy (View Summary)

IPropertyItemBase
IPane
- IListPanePropertyItem

Index

Properties

enable id paneId slotCount typeName viewSortType visible

Methods

addSlot getSlotById getSlotByIndex getViewFilter hide removeSlot selectSlot setViewFilter setViewSortType show updateSlots

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`slotCount

slotCount: number

Remarks

Count of the slots managed by the list.

`Readonly`typeName

typeName: PropertyItemType

Remarks

The type name of the target property.

`Readonly`viewSortType

viewSortType: ListPaneViewSortType

Remarks

Current sorting type for the pane slots

visible

visible: boolean

Remarks

If the item should be visible in the UI.

Methods

addSlot

addSlot(params: ListPaneSlotCreationProps): IListPaneSlot
Parameters
- params: ListPaneSlotCreationProps
Returns IListPaneSlot
Remarks
Adds a new slot to the list.

getSlotById

getSlotById(id: string): IListPaneSlot
Parameters
- id: string
  Unique identifier of the slot.
Returns IListPaneSlot
Remarks
Finds the slot with the identifier.

getSlotByIndex

getSlotByIndex(index: number): IListPaneSlot
Parameters
- index: number
  Index of the slot in the component list.
Returns IListPaneSlot
Remarks
Finds the slot with the index.

getViewFilter

getViewFilter(): ListPaneViewFilter
Returns ListPaneViewFilter
Active view filter

Remarks

hide

hide(): void
Returns void
Remarks
Hide the pane.

Inherited from IPane.hide

removeSlot

removeSlot(id: string): void
Parameters
- id: string
  Unique identifier of the slot.
Returns void
Remarks
Removes the slot from the list.

selectSlot

selectSlot(id: string, deselectOtherSlots?: boolean): void
Parameters
- id: string
  Unique identifier of the slot.
- OptionaldeselectOtherSlots: boolean
  Deselects already selected slots if defined.
Returns void
Remarks
Selects slot by id.

setViewFilter

setViewFilter(filter: ListPaneViewFilter): void
Parameters
- filter: ListPaneViewFilter
  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: ListPaneViewSortType): void
Parameters
- sortType: ListPaneViewSortType
  New sort type, it undefined Default will be used.
Returns void
Remarks
Updates how slots will be sorted in the view

show

show(): void
Returns void
Remarks
Show the pane and all of its items.

Inherited from IPane.show

updateSlots

updateSlots(newSlots: ListPaneSlotCreationProps[]): void
Parameters
- newSlots: ListPaneSlotCreationProps[]
  Creation properties for the new slots.
Returns void
Remarks
Updates all slots with the new list.