Releases: mongodb-js/charts-embed-sdk
Releases · mongodb-js/charts-embed-sdk
v3.3.1 (@mongodb-js/charts-embed-dom)
New
- Set
preFilterfor embedded dashboard, embedded chart or embedded dashboard chart withsetPreFiltermethod. - Set
preFilterfor embedded dashboard or embedded chart throughEmbedDashboardOptionsorEmbedChartOptions. - Get
preFilterfor embedded dashboard, embedded chart or embedded dashboard chart withgetPreFiltermethod.
Fixed
- A critical bug fix for v3.3.0 (deprecated)
v3.2.1 (@mongodb-js/charts-embed-dom)
v3.2.0 (@mongodb-js/charts-embed-dom)
New
- Set customizations for an embedded chart with
setRenderingSpecOverridemethod. - Set customizations for an embedded chart for the initial render with
renderingSpecproperty inEmbedChartOptions. - Get customizations set on an embedded chart with
getRenderingSpecOverridemethod. - Get chart channels for an embedded chart with
getChannelsmethod. - Get customizable chart axes for an embedded chart with
getCustomizableAxesmethod.
See rendering specification for more documentation
v3.1.0 (@mongodb-js/charts-embed-dom)
Dashboard embedding new methods and embedding options 🥳
- Get an image of an embedded dashboard by using the new
getImage()method to get PNG inbase64orbinaryencoding - Get the chart data from an embedded dashboard chart by using the new method
getData()for dashboard charts - Added a new
chartsfield in the dashboard embedding options forcreateDashboard()that allows you to configure the charts individually in an embedded dashboard. For now, you can specify a different filter for every chart in the embedded dashboard.
v3.0.0 (@mongodb-js/charts-embed-dom)
Breaking Changes
- Minimum
refresh tolerancewhenautoRefreshis enabled for embedded chart and dashboard is increased from 10 seconds to 60 seconds. Please see API doc for more information underRefresh Tolerancesection. setFiltermethod for embedded chart and dashboard now will only accept aJavaScript plain objectwith valid query operators. If an array is supplied, an exception will be raised.- The return format of
getFilterandgetHighlightmethods for embedded chart is updated from EJSON to deserialised EJSON. E.g.{ beds: {$gt: {$numberInt: '2'}}}will now become{ beds: {$gt: 2}}.
New
Dashboard Embedding
-
Dashboard
- You can now set filter on a dashboard level for embedded dashboard through:
setFiltermethod for embedded dashboard.filteroption during embedded dashboard initialisation- Have a play on an example app here
- Added
getFiltermethod to retrieve the current filter set to the embedded dashboard
- You can now set filter on a dashboard level for embedded dashboard through:
Chart Embedding
getImagemethod to get png of the embedded chart inbase64orbinaryencoding.Table Chartis not supported for this method.
v3.0.0-beta.0 (@mongodb-js/charts-embed-dom)
Breaking Changes
- Minimum
refresh tolerancewhenautoRefreshis enabled for embedded chart and dashboard is increased from 10 seconds to 60 seconds. Please see API doc for more information underRefresh Tolerancesection. setFiltermethod for embedded chart and dashboard now will only accept aJavaScript plain objectwith valid query operators. If an array is supplied, an exception will be raised.- The return format of
getFilterandgetHighlightmethods for embedded chart is updated from EJSON to deserialised EJSON. E.g.{ beds: {$gt: {$numberInt: '2'}}}will now become{ beds: {$gt: 2}}.
New
Dashboard Embedding
-
Dashboard
- You can now set filter on a dashboard level for embedded dashboard through:
setFiltermethod for embedded dashboard.filteroption during embedded dashboard initialisation
- Added
getFiltermethod to retrieve the current filter set to the embedded dashboard
- You can now set filter on a dashboard level for embedded dashboard through:
-
Dashboard Chart
- N/A
Chart Embedding
getImagemethod to get png of the embedded chart inbase64orbinaryencoding.Table Chartis not supported for this method.
v2.3.1 (@mongodb-js/charts-embed-dom)
v2.3.0 (@mongodb-js/charts-embed-dom)
Dashboard embedding new methods
- Set/Get a filter for a chart in an embedded dashboard.
setFilterandgetFilterfor embedded dashboard charts.
- Set/Get a highlight for a chart in an embedded dashboard.
setHighlightandgetHighlightfor embedded dashboard charts
Authenticated Embedding
- Add support for authenticated chart and dashboard embedding with
realm-webSDK.