Interface: PanelService

Defined in: packages/sdk/src/panel-service.ts:26

Tab-chrome verbs for a dock panel tab of any DockPanelKind — the bundled Chat transcript, a web viewer, a third-party panel. Target id is the panel's own dockview id — the same string a "panel/tab" context-menu hit or a "panel" toolbar hit carries as panelId.

Parallel to EditorService / TerminalService, which offer the same TabAdornmentMethods scoped to their own kind — a panel tab is a first-class third citizen for icon/highlight/indicator/activity chrome, not a special case extensions have to work around.

To enumerate a workspace's recorded panels rather than adorn one you were already handed, read Workspace.panels and take each entry's DockPanelRecord.panelId — that field is the id these methods want. Don't compose it from DockPanelRecord.id and DockPanelRecord.kindId: the format is host-owned and may change.

Extends

• TabAdornmentMethods

Methods

setIcon()

setIcon(targetId, adornment): void;

Defined in: packages/sdk/src/tab-adornment.ts:229

Parameters

targetId

string

adornment

TabIconAdornment

Returns

void

Inherited from

TabAdornmentMethods.setIcon

---

clearIcon()

clearIcon(targetId, adornmentId): void;

Defined in: packages/sdk/src/tab-adornment.ts:230

Parameters

targetId

string

adornmentId

string

Returns

void

Inherited from

TabAdornmentMethods.clearIcon

---

bindIcon()

bindIcon(binder): Disposable;

Defined in: packages/sdk/src/tab-adornment.ts:231

Parameters

binder

TabIconBinder

Returns

Disposable

Inherited from

TabAdornmentMethods.bindIcon

---

setHighlight()

setHighlight(targetId, adornment): void;

Defined in: packages/sdk/src/tab-adornment.ts:233

Parameters

targetId

string

adornment

TabHighlightAdornment

Returns

void

Inherited from

TabAdornmentMethods.setHighlight

---

clearHighlight()

clearHighlight(targetId, adornmentId): void;

Defined in: packages/sdk/src/tab-adornment.ts:234

Parameters

targetId

string

adornmentId

string

Returns

void

Inherited from

TabAdornmentMethods.clearHighlight

---

bindHighlight()

bindHighlight(binder): Disposable;

Defined in: packages/sdk/src/tab-adornment.ts:235

Parameters

binder

TabHighlightBinder

Returns

Disposable

Inherited from

TabAdornmentMethods.bindHighlight

---

setIndicator()

setIndicator(targetId, adornment): void;

Defined in: packages/sdk/src/tab-adornment.ts:237

Parameters

targetId

string

adornment

TabIndicatorAdornment

Returns

void

Inherited from

TabAdornmentMethods.setIndicator

---

clearIndicator()

clearIndicator(targetId, adornmentId): void;

Defined in: packages/sdk/src/tab-adornment.ts:238

Parameters

targetId

string

adornmentId

string

Returns

void

Inherited from

TabAdornmentMethods.clearIndicator

---

flashIndicator()

flashIndicator(targetId, flash): void;

Defined in: packages/sdk/src/tab-adornment.ts:239

Parameters

targetId

string

flash

TabIndicatorFlash

Returns

void

Inherited from

TabAdornmentMethods.flashIndicator

---

bindIndicator()

bindIndicator(binder): Disposable;

Defined in: packages/sdk/src/tab-adornment.ts:240

Parameters

binder

TabIndicatorBinder

Returns

Disposable

Inherited from

TabAdornmentMethods.bindIndicator

---

setActivity()

setActivity(targetId, adornment): void;

Defined in: packages/sdk/src/tab-adornment.ts:242

Parameters

targetId

string

adornment

TabActivityAdornment

Returns

void

Inherited from

TabAdornmentMethods.setActivity

---

clearActivity()

clearActivity(targetId, adornmentId): void;

Defined in: packages/sdk/src/tab-adornment.ts:243

Parameters

targetId

string

adornmentId

string

Returns

void

Inherited from

TabAdornmentMethods.clearActivity

---

flashActivity()

flashActivity(targetId, flash): void;

Defined in: packages/sdk/src/tab-adornment.ts:244

Parameters

targetId

string

flash

TabActivityFlash

Returns

void

Inherited from

TabAdornmentMethods.flashActivity

---

bindActivity()

bindActivity(binder): Disposable;

Defined in: packages/sdk/src/tab-adornment.ts:245

Parameters

binder

TabActivityBinder

Returns

Disposable

Inherited from

TabAdornmentMethods.bindActivity

---

getIcons()

getIcons(targetId): TabIconAdornment[];

Defined in: packages/sdk/src/tab-adornment.ts:248

All leading icons for targetId, in set/bind order.

Parameters

targetId

string

Returns

TabIconAdornment[]

Inherited from

TabAdornmentMethods.getIcons

---

getHighlight()

getHighlight(targetId): TabHighlightAdornment | null;

Defined in: packages/sdk/src/tab-adornment.ts:253

The whole-tab highlight for targetId, or null if none. At most one applies — first found across set/bind order.

Parameters

targetId

string

Returns

TabHighlightAdornment | null

Inherited from

TabAdornmentMethods.getHighlight

---

getIndicators()

getIndicators(targetId): TabIndicatorAdornment[];

Defined in: packages/sdk/src/tab-adornment.ts:255

All trailing indicators for targetId, in set/bind/flash order.

Parameters

targetId

string

Returns

TabIndicatorAdornment[]

Inherited from

TabAdornmentMethods.getIndicators

---

getActivities()

getActivities(targetId): TabActivityAdornment[];

Defined in: packages/sdk/src/tab-adornment.ts:257

All trailing activities for targetId, in set/bind/flash order.

Parameters

targetId

string

Returns

TabActivityAdornment[]

Inherited from

TabAdornmentMethods.getActivities

---

invalidateTabAdornments()

invalidateTabAdornments(): void;

Defined in: packages/sdk/src/tab-adornment.ts:259

Signal that binder data changed — re-query provide and re-render.

Returns

void

Inherited from

TabAdornmentMethods.invalidateTabAdornments

---

subscribeTabAdornments()

subscribeTabAdornments(listener): Disposable;

Defined in: packages/sdk/src/tab-adornment.ts:260

Parameters

listener

() => void

Returns

Disposable

Inherited from

TabAdornmentMethods.subscribeTabAdornments