Incorporando SDK
Nesta página
Você pode incorporar um gráfico ou painel em um aplicativo da Web com o SDK de incorporação, o que permite ajustes mais flexíveis de configurações e renderização.
Para saber mais, consulte Introdução à incorporação do SDK.
Instalar o SDK de incorporação
Se você tiver um aplicativo Web simples, poderá fazer referência ao SDK de incorporação a partir de uma marca de script e nenhuma instalação será necessária. Você pode utilizar o UMD para executar o @mongodb-js/charts-embed-sdk diretamente no navegador.
<script src="https://unpkg.com/@mongodb-js/charts-embed-dom"></script>
Se você estiver criando um aplicativo Web mais complexo e estiver usando npm ou yarn, poderá instalar o SDK de incorporação para que ele possa ser usado diretamente de seus arquivos de script.
Para instalar o SDK incorporado com npm, utilize o seguinte comando:
npm install @mongodb-js/charts-embed-dom
Para instalar com yarn:
yarn add @mongodb-js/charts-embed-dom
Exemplos
Um exemplo de aplicativo usando o SDK de incorporação pode ser encontrado em codesandbox.io. O exemplo de aplicativo demonstra algumas das funcionalidades interativas disponíveis para o SDK de incorporação, incluindo um filtro interativo e um botão de atualização manual.
O aplicativo de exemplo é configurado com uma ID de gráfico e uma URL base que são específicas para o aplicativo. Certifique-se de configurar seus próprios aplicativos com o ID do gráfico ou do painel e o URL base corretos.
O aplicativo de exemplo usa dois métodos do SDK:
Método | Descrição | Args | Devoluções |
|---|---|---|---|
refresh() | Recarrega o gráfico com os dados mais recentes de sua fonte de dados. | none | Promessa<void> |
setFilter() | Filtra seu gráfico incorporado com base em um documento de filtroMQL especificado. Quaisquer campos incluídos no filtro devem ser especificados no modal Incorporar Gráfico. Consulte Filtrar gráficos incorporados com o SDK. | objeto de filtro | Promessa<void> |
Outros exemplos estão disponíveis no repositório do GitHub do MongoDB Embedding SDK Examples.