Shared options for embedding

### Hierarchy

- SharedEmbedOptions
  - EmbedChartOptions
  - EmbedDashboardOptions

## Index

### Properties

- autoRefresh
- background
- baseUrl
- getUserToken
- height
- maxDataAge
- showAttribution
- theme
- width

## Properties

### Optional autoRefresh

autoRefresh: undefined | false | true

Whether the embedded object should be automatically refreshed.

### Optional background

background: undefined | string

The background color to use for the embedded object.

If no background is provided, it will set a default background color based on the theme.

To control the background color using CSS and classes, set to `transparent`.

### baseUrl

baseUrl: string

The base url for your MongoDB EmbedSDK instance.

This should look something like: `https://charts.mongodb.com/charts-example-url-zdvkh`

### Optional getUserToken

getUserToken: undefined | (() => string | Promise<string>)

A function that returns a valid JWT that will be used to authenticate the user.

This function will be called when the embedded object is first rendered, and then successively when the SDK needs to refresh an invalid token.

See also getRealmUserToken

### Optional height

height: string | number

The height of the embedded object.

If no height is provided, it will default to stretching to the height of it's container. If a value is provided without units, it will be assumed to be pixels (px).

### Optional maxDataAge

maxDataAge: undefined | number

How long in seconds data is considered fresh.

By default, staleness tolerance is 1 hour.

### Optional showAttribution

showAttribution: undefined | false | true

Whether to show the MongoDB attribution logo.

By default, this is set to `true`

### Optional theme

theme: Theme

The color scheme to apply.

If the theme is set to 'dark' and you have specified a custom background color, you should ensure that your background color has appropriate contrast.

### Optional width

width: string | number

The width of the embedded object.

If no width is provided, it will default to stretching to the width of it's container. If a value is provided without units, it will be assumed to be pixels (px).

Generated using TypeDoc