# Interface IDashboard

Dashboard service interface.

interface IDashboard {
getSnapshot(options?: DashboardUpdateOptions): DashboardSnapshot;
render(options?: DashboardUpdateOptions): string;
getConfig(): DashboardConfig;
updateConfig(config: Partial<DashboardConfig>): void;
subscribe(callback: (snapshot: DashboardSnapshot) => void): () => void;
}

#### Implemented by

- Dashboard

- Defined in packages/nexus-agents/src/observability/dashboard-types.ts:207

##### Index

### Methods

getSnapshot
render
getConfig
updateConfig
subscribe

## Methods

### getSnapshot

- getSnapshot(options?: DashboardUpdateOptions): DashboardSnapshot

  Get current dashboard snapshot.

  #### Parameters

  - `Optional` options: DashboardUpdateOptions

  #### Returns DashboardSnapshot

  - Defined in packages/nexus-agents/src/observability/dashboard-types.ts:211

### render

- render(options?: DashboardUpdateOptions): string

  Render dashboard to string in configured format.

  #### Parameters

  - `Optional` options: DashboardUpdateOptions

  #### Returns string

  - Defined in packages/nexus-agents/src/observability/dashboard-types.ts:216

### getConfig

- getConfig(): DashboardConfig

  Get dashboard configuration.

  #### Returns DashboardConfig

  - Defined in packages/nexus-agents/src/observability/dashboard-types.ts:221

### updateConfig

- updateConfig(config: Partial<DashboardConfig>): void

  Update dashboard configuration.

  #### Parameters

  - config: Partial<DashboardConfig>

  #### Returns void

  - Defined in packages/nexus-agents/src/observability/dashboard-types.ts:226

### subscribe

- subscribe(callback: (snapshot: DashboardSnapshot) => void): () => void

  Subscribe to dashboard updates.

  #### Parameters

  - callback: (snapshot: DashboardSnapshot) => void

  #### Returns () => void

  - Defined in packages/nexus-agents/src/observability/dashboard-types.ts:231