An open API service indexing awesome lists of open source software.

https://github.com/mongodb-js/charts-embed-sdk

The easiest way to embed MongoDB Charts visualisations into your web app
https://github.com/mongodb-js/charts-embed-sdk

data-visualisation javascript mongodb

Last synced: 5 months ago
JSON representation

The easiest way to embed MongoDB Charts visualisations into your web app

Awesome Lists containing this project

README

          

MongoDB Charts Embedding SDK

Programmatically **embed** and **control** MongoDB Charts in your application.

[![npm](https://img.shields.io/npm/v/@mongodb-js/charts-embed-dom.svg)](https://www.npmjs.com/package/@mongodb-js/charts-embed-dom/)
[![npm](https://img.shields.io/npm/l/@mongodb-js/charts-embed-dom.svg)](https://www.npmjs.com/package/@mongodb-js/charts-embed-dom/)

[Explore this example yourself!](https://codesandbox.io/s/github/mongodb-js/charts-embed-sdk/tree/master/examples/charts/unauthenticated)

## Installation

```sh
# If you use npm:
npm install @mongodb-js/charts-embed-dom

# Or if you use Yarn:
yarn add @mongodb-js/charts-embed-dom

```

## Documentation 📖

- [Installation & MongoDB Docs](https://docs.mongodb.com/charts/master/embedding-charts-sdk/)
- [Embedding SDK API Reference](https://www.npmjs.com/package/@mongodb-js/charts-embed-dom)
- [Examples](https://github.com/mongodb-js/charts-embed-sdk/tree/master/examples)
- [Embedded Chart Rendering Specification](https://github.com/mongodb-js/charts-embed-sdk/tree/master/docs/rendering-spec.md)

### Embedded Chart Guides

- [Getting started with the MongoDB Charts SDK](https://github.com/mongodb-js/charts-embed-sdk/tree/master/examples/charts/unauthenticated)
- [Getting started with custom JWT authentication](https://github.com/mongodb-js/charts-embed-sdk/tree/master/examples/charts/authenticated-custom-jwt)
- [Getting started with App Services authentication via Realm Web SDK](https://github.com/mongodb-js/charts-embed-sdk/tree/master/examples/charts/authenticated-realm-web)
- [Getting started with Google authentication](https://github.com/mongodb-js/charts-embed-sdk/tree/master/examples/charts/authenticated-google)
- [Getting started with click events](https://github.com/mongodb-js/charts-embed-sdk/tree/master/examples/charts/click-events-basic)
- [Interactive filtering using click events](https://github.com/mongodb-js/charts-embed-sdk/tree/master/examples/charts/click-events-filtering)
- [Programmatic highlighting](https://github.com/mongodb-js/charts-embed-sdk/tree/master/examples/charts/programmatic-highlighting)
- [Timeline Chart (React Example)](https://github.com/mongodb-js/charts-embed-sdk/tree/master/examples/charts/timeline-charts-example)

### Embedded Dashboard Guides

- [Embedding an unauthenticated dashboard](https://github.com/mongodb-js/charts-embed-sdk/tree/master/examples/dashboard/unauthenticated)
- [Dashboard embedding with custom JWT authentication](https://github.com/mongodb-js/charts-embed-sdk/tree/master/examples/dashboard/authenticated-custom-jwt)
- [Dashboard embedding with App Services authentication via Realm Web SDK](https://github.com/mongodb-js/charts-embed-sdk/tree/master/examples/dashboard/authenticated-realm-web)
- [Dashboard embedding with Google authentication](https://github.com/mongodb-js/charts-embed-sdk/tree/master/examples/dashboard/authenticated-google)
- [Accessing a Chart instance via Dashboard class](https://github.com/mongodb-js/charts-embed-sdk/tree/master/examples/dashboard/unauthenticated-get-chart)