---
url: https://docs.ridgedata.ai/reference/embed-api/Interface.RidgeEmbed.md
---
# Interface: RidgeEmbed

The dashboard handle returned immediately by `embed()`.

## Properties

| Property | Modifier | Type | Description |
| ------ | ------ | ------ | ------ |
|  `ready` | `readonly` | `Promise`<`RidgeEmbed`> | Resolves with this handle when the dashboard is ready for state reads and updates. |

## Methods

### exportImage()

```ts
exportImage(type?: "png" | "jpeg" | "svg" | "blob" | "pixelData"): Promise<string | Blob | Uint8ClampedArray<ArrayBufferLike> | null>;
```

Export the dashboard image, once it has rendered the latest state.

* `"png"` (default), `"jpeg"`, and `"svg"` return data URL strings usable as an image's `src`.
* `"blob"` returns a PNG `Blob`.
* `"pixelData"` returns a `Uint8ClampedArray` of RGBA pixel values.

Returns `null` if no dashboard image is available. Export failures reject the promise.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `type?` | `"png"` | `"jpeg"` | `"svg"` | `"blob"` | `"pixelData"` |

#### Returns

`Promise`<`string` | `Blob` | `Uint8ClampedArray`<`ArrayBufferLike`> | `null`>

***

### getFilters()

```ts
getFilters(): FilterValues;
```

#### Returns

[`FilterValues`](TypeAlias.FilterValues.md)

***

### getState()

#### Call Signature

```ts
getState(): StateValues;
```

##### Returns

[`StateValues`](TypeAlias.StateValues.md)

#### Call Signature

```ts
getState(id: string): ComponentState | null;
```

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `id` | `string` |

##### Returns

[`ComponentState`](TypeAlias.ComponentState.md) | `null`

***

### getStateSchema()

```ts
getStateSchema(): StateSchema;
```

The complete state schema, keyed by component id and state key.

#### Returns

[`StateSchema`](TypeAlias.StateSchema.md)

***

### on()

```ts
on<K extends keyof RidgeEmbedEventMap>(event: K, listener: (value: RidgeEmbedEventMap[K]) => void): () => void;
```

Register an event listener. Returns a function to remove it. Safe to call before `ready`.

#### Type Parameters

| Type Parameter |
| ------ |
| `K` *extends* keyof [`RidgeEmbedEventMap`](Interface.RidgeEmbedEventMap.md) |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `event` | `K` |
| `listener` | (`value`: [`RidgeEmbedEventMap`](Interface.RidgeEmbedEventMap.md)\[`K`]) => `void` |

#### Returns

() => `void`

***

### setFilters()

```ts
setFilters(values: FilterValues, options?: StateWriteOptions): Promise<FilterUpdateResult>;
```

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `values` | [`FilterValues`](TypeAlias.FilterValues.md) |
| `options?` | [`StateWriteOptions`](Interface.StateWriteOptions.md) |

#### Returns

`Promise`<[`FilterUpdateResult`](Interface.FilterUpdateResult.md)>

***

### setState()

```ts
setState(values: StateValues, options?: StateWriteOptions): Promise<StateUpdateResult>;
```

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `values` | [`StateValues`](TypeAlias.StateValues.md) |
| `options?` | [`StateWriteOptions`](Interface.StateWriteOptions.md) |

#### Returns

`Promise`<[`StateUpdateResult`](Interface.StateUpdateResult.md)>

***

### unmount()

```ts
unmount(): void;
```

#### Returns

`void`