Security News
The Push to Ban Ransom Payments Is Gaining Momentum
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
superset-dashboard-sdk
Advanced tools
Superset Dashboard visualization component with improved specs.
Readme
Superset Dashboard is a library to help you publish your dashboards outside of the Superset application. This plugin does not use the Superset default @superset-ui/embedded-sdk but my own implementation written starting from the base plugin.
npm i -S superset-dashboard-sdk
Superset Dashboard provide a basic Dashboard
component that you can use to
render a dashboard and a DefaultDataProvider
that follows Superset API
standards to retrieve and provide a valid guest token. In addition to that,
you can create your own DataProvider
implementing DataProviderInterface
.
The DataProviderInterface
requires you to implement the following methods:
fetchGuestToken
: to retrieve a valid guest token and return a Promise
with the token string value.To publish a dashboard, you need to create a Dashboard
component and pass
required props (described below) to it.
// MyDashboard.tsx
import { Dashboard, DefaultDataProvider } from "superset-dashboard";
const dataProvider = new DataProvider("http://localhost:8088", {
username: "<guest account>",
password: "<guest password>",
});
const MyDashboard = () => {
return (
<Dashboard
dataProvider={dataProvider}
domain="http://localhost:8088"
guestToken={"<guest token>"}
uuid={"<embedded dashboard id>"}
nativeFilters={[
{
id: "NATIVE_FILTER_ID",
value: "NATIVE_FILTER_VALUE",
operator: "NATIVE_FILTER_OPERATOR",
value: ["NATIVE_FILTER_VALUE_1", "NATIVE_FILTER_VALUE_2"],
},
]}
/>
);
};
The Dashboard
component requires the following props:
dataProvider
: an instance of class implementing DataProviderInterface
to retrieve data from Superset.domain
: the domain where Superset is running.uuid
: the uuid of the dashboard to render.guestToken
: you can pass a guest token to the component. If not provided,
the component will use the dataProvider
to retrieve one.nativeFilters
: an array of filters to apply to the dashboard. Default: []
.You can query the dashboard to retrieve basic informations and json_metadata
from which you can prepare your custom forms to "pre-filter" dashboards before
rendering them.
Using previous instanced dataProvider
, you can query the dashboard like in this example:
const guestToken = await dataProvider.fetchGuestToken(["<dashboard id>"]);
const dashboard = await dataProvider.fetchDashboard(guestToken, "<integer id>");
// Extract list of "native filters" from dashboard json_metadata:
const jsonMetadata = dashboard.getJsonMetadata();
const nativeFilters = jsonMetadata?.native_filter_configuration ?? [];
Using that data you can render your custom filter form and use them before rendering the dashboard.
Before install switch to node 16.9.1 (the same used in superset):
nvm use
To build the library:
npm run build
To run the tests:
npm run test
To run playground tests:
cd playground
npm start
To use storybook:
npm run storybook
For every command add :watch to run in watch mode.
FAQs
Superset Dashboard visualization component with improved specs.
We found that superset-dashboard-sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
Application Security
New SEC disclosure rules aim to enforce timely cyber incident reporting, but fear of job loss and inadequate resources lead to significant underreporting.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).