Package io.jmix.supersetflowui.kit.component

Class JmixSupersetDashboard

java.lang.Object
com.vaadin.flow.component.Component
io.jmix.supersetflowui.kit.component.JmixSupersetDashboard
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, Serializable
Direct Known Subclasses:
SupersetDashboard
@Tag("jmix-superset-dashboard") @NpmPackage(value="@superset-ui/embedded-sdk", version="0.1.0-alpha.10") @JsModule("./src/superset-dashboard/jmix-superset-dashboard.js") public class JmixSupersetDashboard extends com.vaadin.flow.component.Component implements com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    JmixSupersetDashboard()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    fetchGuestToken()
     
    String
    getEmbeddedId()
     
    boolean
    isChartControlsVisible()
     
    boolean
    isFiltersExpanded()
     
    boolean
    isTitleVisible()
     
    void
    setChartControlsVisible(boolean chartControlsVisible)
    Sets whether the chart's kebab menu should be visible.
    void
    setEmbeddedId(String embeddedId)
    Sets an embedded dashboard ID.
    void
    setFiltersExpanded(boolean filtersExpanded)
    Sets whether the filter's bar should be expanded.
    protected void
    setGuestTokenInternal(String guestToken)
     
    void
    setTitleVisible(boolean titleVisible)
    Sets whether the dashboard title should be visible.
    protected void
    setUrlInternal(String url)
     

    Methods inherited from class com.vaadin.flow.component.Component

    addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.vaadin.flow.component.AttachNotifier

    addAttachListener

    Methods inherited from interface com.vaadin.flow.component.DetachNotifier

    addDetachListener

    Methods inherited from interface com.vaadin.flow.component.HasElement

    getElement

    Methods inherited from interface com.vaadin.flow.component.HasSize

    getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

    Methods inherited from interface com.vaadin.flow.component.HasStyle

    addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

  • Constructor Details

    • JmixSupersetDashboard

      public JmixSupersetDashboard()

  • Method Details

    • getEmbeddedId

      public String getEmbeddedId()
      Returns:
      dashboard embedded ID or null if not set

    • setEmbeddedId

      public void setEmbeddedId(String embeddedId)
      Sets an embedded dashboard ID. This ID can be taken from dashboard if Superset has EMBEDDED_SUPERSET feature flag. Without an embedded ID, the component won't start the request for fetching guest token.

      Note that every time the embedded ID is set to the component, it will start a process of fetching a guest token and handling its expiration.

      Parameters:
      embeddedId - a dashboard embedded ID

    • isTitleVisible

      public boolean isTitleVisible()
      Returns:
      true if dashboard title is visible

    • setTitleVisible

      public void setTitleVisible(boolean titleVisible)
      Sets whether the dashboard title should be visible. The default value is false.
      Parameters:
      titleVisible - title visible option

    • isChartControlsVisible

      public boolean isChartControlsVisible()

    • setChartControlsVisible

      public void setChartControlsVisible(boolean chartControlsVisible)
      Sets whether the chart's kebab menu should be visible. The default value is false.
      Parameters:
      chartControlsVisible - chart control visible option

    • setFiltersExpanded

      public void setFiltersExpanded(boolean filtersExpanded)
      Sets whether the filter's bar should be expanded. The default value is false.
      Parameters:
      filtersExpanded - filters expanded option

    • isFiltersExpanded

      public boolean isFiltersExpanded()
      Returns:
      true if filter's bar is expanded

    • setGuestTokenInternal

      protected void setGuestTokenInternal(String guestToken)

    • setUrlInternal

      protected void setUrlInternal(String url)

    • fetchGuestToken

      @ClientCallable protected void fetchGuestToken()