Embedded analytics SDK API
    Preparing search index...

    Function StaticQuestion

    • A question component without drill-downs.

      Parameters

      • __namedParameters: StaticQuestionProps
        • OptionalclassName?: string

          A custom class name to be added to the root element.

        • Optionalheight?: Height<string | number>

          A number or string specifying a CSS size value that specifies the height of the component

        • OptionalinitialSqlParameters?: SqlParameterValues

          Initial values for the SQL parameters.

        • questionId: null | SdkQuestionId
        • Optionalstyle?: CSSProperties

          A custom style object to be added to the root element.

        • Optionaltitle?: SdkQuestionTitleProps

          Determines whether the question title is displayed, and allows a custom title to be displayed instead of the default question title. Shown by default. Only applicable to interactive questions when using the default layout.

        • Optionalwidth?: Width<string | number>

          A number or string specifying a CSS size value that specifies the width of the component

        • OptionalwithChartTypeSelector?: boolean

          Determines whether the chart type selector and corresponding settings button are shown. Only relevant when using the default layout.

        • OptionalwithDownloads?: boolean

          Enables the ability to download results in the interactive question.

      Returns null | Element

    Index

    InteractiveQuestion

    Breakout BreakoutDropdown ChartTypeDropdown ChartTypeSelector DownloadWidget DownloadWidgetDropdown Filter FilterDropdown QuestionSettings QuestionSettingsDropdown QuestionVisualization ResetButton Summarize SummarizeDropdown Title

    InteractiveQuestion

    Breakout: () => null | Element

    Type declaration

      • (): null | Element
      • Function

        A set of badges for managing data groupings (breakouts). Uses question context for breakout functionality.

        Returns null | Element

    BreakoutDropdown: (
        props: InteractiveQuestionBreakoutDropdownProps,
    ) => null | Element

    Type declaration

    ChartTypeDropdown: (props: MenuProps) => Element

    Type declaration

      • (props: MenuProps): Element
      • Function

        Dropdown for selecting the visualization type (bar chart, line chart, table, etc.). Automatically updates to show recommended visualization types for the current data.

        Parameters

        Returns Element

    ChartTypeSelector: (props: StackProps) => Element

    Type declaration

    DownloadWidget: (props: StackProps) => null | Element

    Type declaration

      • (props: StackProps): null | Element
      • Function

        Provides a UI widget for downloading data in different formats (CSV, XLSX, JSON, and PNG depending on the visualization).

        Parameters

        Returns null | Element

    DownloadWidgetDropdown: (props: PopoverProps) => Element

    Type declaration

    Filter: (props: InteractiveQuestionFilterProps) => Element

    Type declaration

    FilterDropdown: (
        props: InteractiveQuestionFilterDropdownProps,
    ) => null | Element

    Type declaration

    QuestionSettings: (props: StackProps) => null | Element

    Type declaration

      • (props: StackProps): null | Element
      • Function

        Settings panel for configuring visualization options like axes, colors, and formatting. Uses question context for settings.

        Parameters

        Returns null | Element

    QuestionSettingsDropdown: (
        props?: InteractiveQuestionQuestionSettingsDropdownProps,
    ) => Element

    Type declaration

    QuestionVisualization: (
        props: { className?: string; style?: CSSProperties } & {
            height?: Height<string | number>;
            width?: Width<string | number>;
        } & {},
    ) => Element

    Type declaration

      • (
            props: { className?: string; style?: CSSProperties } & {
                height?: Height<string | number>;
                width?: Width<string | number>;
            } & {},
        ): Element
      • Function

        The main visualization component that renders the question results as a chart, table, or other visualization type.

        Parameters

        • props: { className?: string; style?: CSSProperties } & {
              height?: Height<string | number>;
              width?: Width<string | number>;
          } & {}
          • OptionalclassName?: string

            A custom class name to be added to the root element.

          • Optionalstyle?: CSSProperties

            A custom style object to be added to the root element.

          • Optionalheight?: Height<string | number>

            A number or string specifying a CSS size value that specifies the height of the component

          • Optionalwidth?: Width<string | number>

            A number or string specifying a CSS size value that specifies the width of the component

          Returns Element

      ResetButton: (props?: ButtonProps) => null | Element

      Type declaration

        • (props?: ButtonProps): null | Element
        • Function

          Button to reset question modifications. Only appears when there are unsaved changes to the question.

          Parameters

          Returns null | Element

      Summarize: () => Element

      Type declaration

        • (): Element
        • Function

          Interface for adding and managing data summaries (like counts, sums, averages). Displays as a set of badges. Uses question context for summarization functionality.

          Returns Element

      SummarizeDropdown: (props: InteractiveQuestionSummarizeDropdownProps) => Element

      Type declaration

      Title: (
          props: { className?: string; style?: CSSProperties },
      ) => undefined | Element

      Type declaration

        • (props: { className?: string; style?: CSSProperties }): undefined | Element
        • Function

          Displays a title based on the question's state. Shows:

          • The question's display name if it's saved
          • An auto-generated description for ad-hoc questions (non-native queries)

          Parameters

          • props: { className?: string; style?: CSSProperties }
            • OptionalclassName?: string

              A custom class name to be added to the root element.

            • Optionalstyle?: CSSProperties

              A custom style object to be added to the root element.

          Returns undefined | Element

      Settings

      On This Page

      InteractiveQuestion