@drayman/elements
Options
All
  • Public
  • Public/Protected
  • All
Menu

<drayman-superset />

Apache Superset dashboard integration element powered by the Superset Embedded SDK.

Example of usage

 
export const component: DraymanComponent = async ({ forceUpdate }) => {

    return () => {
        const dashboardUiConfig = {
            hideTitle: true,
            hideTab: true,
            hideChartControls: false,
            filters: {
                visible: true,
                expanded: false,
            },
        };

        return (
            <drayman-superset
                supersetDomain="http://superset"
                embedId="01879ce0-6016-4332-b535-f5f1950f9364"
                onFetchGuestToken={async () => {
                    return `token`;
                }}
                dashboardUiConfig={dashboardUiConfig}
            />
        );
    }
}

Hierarchy

Index

Properties

Properties

Optional dashboardUiConfig

dashboardUiConfig: { filters?: { expanded?: boolean; visible?: boolean }; hideChartControls?: boolean; hideTab?: boolean; hideTitle?: boolean; urlParams?: {} }

Dashboard UI configuration passed to the Superset Embedded SDK.

Type declaration

  • Optional filters?: { expanded?: boolean; visible?: boolean }
    • [key: string]: boolean | undefined
    • Optional expanded?: boolean
    • Optional visible?: boolean
  • Optional hideChartControls?: boolean
  • Optional hideTab?: boolean
  • Optional hideTitle?: boolean
  • Optional urlParams?: {}
    • [key: string]: string | number | boolean

embedId

embedId: string

Embed identifier generated by the Superset embedding UI.

Optional iframeSandboxExtras

iframeSandboxExtras: string[]

Additional iframe sandbox permissions.

onFetchGuestToken

onFetchGuestToken: ElementEvent<{}>

Called by the element when Superset needs a guest token.

Optional ref

ref: string

Optional referrerPolicy

referrerPolicy: ReferrerPolicy

Referrer policy applied to the embedded iframe request.

Optional style

style: CSS

supersetDomain

supersetDomain: string

Superset instance URL, including protocol.