Interface IListPaneSlot

List Pane slot

interface IListPaneSlot {
    entryCount: number;
    id: string;
    paneId: string;
    selected: boolean;
    tags: readonly string[];
    title: LocalizedString;
    getEntry<K extends ListPaneEntryType = undefined>(
        index: number,
        type?: K,
    ): K extends ListPaneEntryType ? ListPaneEntryMap[K<K>] : IListPaneEntry;
    getUserData(): unknown;
    setSelected(selected: boolean): void;
    setTags(tags: string[]): void;
    setTitle(title: LocalizedString): void;
    setUserData(data: unknown): void;
}

Index

Properties

entryCount id paneId selected tags title

Methods

getEntry getUserData setSelected setTags setTitle setUserData

Properties

`Readonly`entryCount

entryCount: number

Remarks

Count of entries.

`Readonly`id

id: string

Remarks

Unique identifier of the slot.

`Readonly`paneId

paneId: string

Remarks

Unique identifier of the parent pane.

`Readonly`selected

selected: boolean

Remarks

Selected state of the slot.

`Readonly`tags

tags: readonly string[]

Remarks

List of tags associated with the slot.

`Readonly`title

title: LocalizedString

Remarks

Count of entries.

Methods

getEntry

getEntry<K extends ListPaneEntryType = undefined>(
index: number,
type?: K,
): K extends ListPaneEntryType ? ListPaneEntryMap[K<K>] : IListPaneEntry
Type Parameters
- K extends ListPaneEntryType = undefined
Parameters
- index: number
  Sequence index of the entry in the slot.
- Optionaltype: K
  Optional type check for the entry.
Returns K extends ListPaneEntryType ? ListPaneEntryMap[K<K>] : IListPaneEntry
Remarks
Finds the entry with the index if it exists.

getUserData

getUserData(): unknown
Returns unknown
User data associated with the slot.

Remarks

setSelected

setSelected(selected: boolean): void
Parameters
- selected: boolean
  New selected state.
Returns void
Remarks
Updates selected state of the slot.

setTags

setTags(tags: string[]): void
Parameters
- tags: string[]
  New tag list.
Returns void
Remarks
Updates tags of the slot.

setTitle

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

setUserData

setUserData(data: unknown): void
Parameters
- data: unknown
  New user data.
Returns void
Remarks
Updates user data associated with the slot