Skip to content

Main Navigation Guide Reference Ridge AI

Appearance

Sidebar Navigation

Reference

Overview

REST API

JavaScript API

RidgeEmbed

RidgeEmbedEventMap

EmbedOptions

FilterValues

FilterUpdateResult

FilterChangeEvent

StateChangeEvent

StateUpdateResult

StateWriteOptions

embed

embedStateToParams

parseEmbedState

Iframe protocol

EmbedMessage

HostToEmbedMessage

EmbedToHostMessage

EmbedProtocolMessage

isEmbedProtocolMessage

Shared values

StateValues

ComponentState

StateSchema

StateValueSchema

StateError

StateErrorCode

JsonValue

On this page

Function: embed()

ts

function embed(options: EmbedOptions): RidgeEmbed;

Parameters

Parameter	Type
`options`	`EmbedOptions`

Returns

Pager

Previous pageStateWriteOptions

Next pageembedStateToParams

© 2026 Ridge AI