diff --git a/.bundle/config b/.bundle/config new file mode 100644 index 0000000000..6053cd6bca --- /dev/null +++ b/.bundle/config @@ -0,0 +1,4 @@ +--- +BUNDLE_PATH: "/home/runner/work/docs.metabase.github.io/docs.metabase.github.io/vendor/bundle" +BUNDLE_DEPLOYMENT: "true" +BUNDLE_JOBS: "4" diff --git a/.marketing_repo b/.marketing_repo new file mode 160000 index 0000000000..c389e41d44 --- /dev/null +++ b/.marketing_repo @@ -0,0 +1 @@ +Subproject commit c389e41d44e8be3c9f86e2a9ed80a86c2ad99065 diff --git a/_docs/master/configuring-metabase/config-template.md b/_docs/master/configuring-metabase/config-template.md index c604d0caef..c3b673410d 100644 --- a/_docs/master/configuring-metabase/config-template.md +++ b/_docs/master/configuring-metabase/config-template.md @@ -266,7 +266,6 @@ config: surveys-enabled: true synchronous-batch-updates: false unaggregated-query-row-limit: null - update-channel: latest uploads-settings: null use-tenants: false user-visibility: all diff --git a/_docs/master/configuring-metabase/environment-variables.md b/_docs/master/configuring-metabase/environment-variables.md index ab56163aa4..6972fd3431 100644 --- a/_docs/master/configuring-metabase/environment-variables.md +++ b/_docs/master/configuring-metabase/environment-variables.md @@ -1722,15 +1722,6 @@ Maximum number of rows to return specifically on :rows type queries via the API. Must be less than 1048575, and less than the number configured in MB_AGGREGATED_QUERY_ROW_LIMIT. See also MB_AGGREGATED_QUERY_ROW_LIMIT. -### `MB_UPDATE_CHANNEL` - -- Type: string -- Default: `latest` -- [Exported as](../installation-and-operation/serialization): `update-channel`. -- [Configuration file name](./config-file): `update-channel` - -We'll notify you here when there's a new version of this type of release. - ### `MB_UPLOADS_DATABASE_ID [DEPRECATED]` > DEPRECATED: 0.50.0 diff --git a/_docs/master/configuring-metabase/localization.md b/_docs/master/configuring-metabase/localization.md index 711cf5adca..cce9f05d01 100644 --- a/_docs/master/configuring-metabase/localization.md +++ b/_docs/master/configuring-metabase/localization.md @@ -13,11 +13,15 @@ redirect_from: # Languages and localization -The **Localization** settings allow you to set global defaults for your Metabase instance. You can find **Localization** under **Admin settings** > **Settings**. +Admins can update the localization settings for the instance: -## Default language +1. Click on the **gear** icon in the upper right. +2. Click **Admin settings**. +3. In the **Settings** tab, click on **Localization** in the left sidebar. -Here you can set the default language (also called the "instance language") across your Metabase UI, system [emails](./email), [dashboard subscriptions](../dashboards/subscriptions), and [alerts](../questions/alerts). People can pick a different language from their own [account settings](../people-and-groups/account-settings). +These localization settings allow you to set global language and formatting defaults for dates, times, numbers, and currencies. + +You can also override these localization options for specific fields or questions. For more info, see [Formatting](../data-modeling/formatting). ## Supported languages @@ -68,7 +72,9 @@ The locale codes are relevant for setting the language in [static embeds](../emb ## Translations -Our community contributes to Metabase translations on our [Crowdin project](https://crowdin.com/project/metabase-i18n). If you'd like to help make Metabase available in a language you're fluent in, we'd love your help! +Our community contributes to Metabase translations on our [Crowdin project](https://crowdin.com/project/metabase-i18n). + +If you'd like to help make Metabase available in a language you're fluent in, we'd love your help! For a new language to be added to Metabase, it must reach 100%. Once it does, we add it in the next major or minor release of Metabase. All _existing_ languages in Metabase _must stay at 100%_ to continue being included in the next _major_ version of Metabase. This rule ensures that no one encounters a confusing mishmash of English and another language when using Metabase. @@ -76,7 +82,21 @@ We understand that this is a high bar, so we commit to making sure that before e Note that while we only remove languages in major releases, we are happy to add them back for minor releases, so it's always a good time to jump in and start translating. -## Report timezone +### Contributing to translations for Metabase + +If you'd like to help make Metabase available in a language you're fluent in, we'd love your help! Check out our [Crowdin project](https://crowdin.com/project/metabase-i18n). + +## Instance settings + +### Instance language + +Here you can set the default language (also called the "instance language") across your Metabase UI, system [emails](./email), [dashboard subscriptions](../dashboards/subscriptions), and [alerts](../questions/alerts). + +People can override these settings in their personal [account settings](../people-and-groups/account-settings). + +Some translations are created by the Metabase community, and might not be perfect. + +### Report timezone Use **report timezone** to set a default display time zone for dates and times in Metabase. The report timezone setting is a display setting only, so changing the report timezone won't affect the time zone of any data in your database. @@ -99,29 +119,27 @@ Report timezone is only supported for the following databases: - Redshift - Vertica -## First day of the week - -If you need to, you can change the first day of the week for your instance (the default is Sunday). Setting the first day of the week affects things like grouping by week and filtering in questions built using the [query builder](../questions/query-builder/editor). This setting doesn't affect [SQL queries](../questions/native-editor/writing-sql). +### First day of the week -## Localization options +If you need to, you can change the first day of the week for your instance (the default is Sunday). -**Localization options** allow you to set global default display formats for dates, times, numbers, and currencies. +Setting the first day of the week affects how the [query builder](../questions/query-builder/editor) filters or groups by week. People can, however, use the `week` function to override this default when filtering or grouping by week of year. See [using a different first week of the year](../questions/query-builder/expressions/week#using-a-different-first-week-of-the-year). -You can also override these localization options for specific fields or questions. For more info, see [Formatting](../data-modeling/formatting). +This setting doesn't affect [SQL queries](../questions/native-editor/writing-sql). -### Dates and times +## Dates and times - **Date style:** the way dates should be displayed in tables, axis labels, and tooltips. -- **Date separators:** you can choose between slashes (`2022/12/14`), dashes (`2022-12-14`), and dots (`2022.12.14.`). +- **Date separators:** you can choose between slashes (`2022/12/14`), dashes (`2022-12-14`), and dots (`2022.12.14`). - **Abbreviate names of days and months:** whenever a date is displayed with the day of the week and/or the month written out, turning this setting on will display e.g. "January" as "Jan" or "Monday" as "Mon". - **Time style:** choose to display the time using either a 12 or 24-hour clock (e.g., 3:00 PM or 15:00). -### Numbers +## Numbers - **Separator style:** some people use commas to separate thousands places, and others use periods. Here's where you can indicate which camp you belong to. -### Currency +## Currency - **Unit of currency:** if you do most of your business in a particular currency, you can specify that here. - **Currency label style:** whether you want to have your currencies labeled with a symbol, a code (like "USD"), or its full name. -- **Where to display the unit of currency:** this pertains specifically to tables, and lets you choose if you want the currency labels to appear only in the column heading, or next to each value in the column. +- **Where to display the unit of currency:** this pertains specifically to tables, and lets you choose whether you want the currency labels to appear only in the column heading, or next to each value in the column. diff --git a/_docs/master/embedding/sdk/api/BaseInteractiveQuestionProps.html b/_docs/master/embedding/sdk/api/BaseSdkQuestionProps.html similarity index 66% rename from _docs/master/embedding/sdk/api/BaseInteractiveQuestionProps.html rename to _docs/master/embedding/sdk/api/BaseSdkQuestionProps.html index 70e4b609e9..eb917617bd 100644 --- a/_docs/master/embedding/sdk/api/BaseInteractiveQuestionProps.html +++ b/_docs/master/embedding/sdk/api/BaseSdkQuestionProps.html @@ -4,12 +4,12 @@ show_category_breadcrumb: true show_title_breadcrumb: true category: Embedding -title: BaseInteractiveQuestionProps -source_url: 'https://github.com/metabase/metabase/blob/master/docs/embedding/sdk/api/BaseInteractiveQuestionProps.html' +title: BaseSdkQuestionProps +source_url: 'https://github.com/metabase/metabase/blob/master/docs/embedding/sdk/api/BaseSdkQuestionProps.html' layout: docs-api --- -BaseInteractiveQuestionProps | Embedded analytics SDK API{% include docs/embedded-analytics-sdk-metadata.html %}
Embedded analytics SDK API
    Preparing search index...

    Interface BaseInteractiveQuestionProps

    interface BaseInteractiveQuestionProps {
        children?: ReactNode;
        entityTypes?: EmbeddingEntityType[];
        initialSqlParameters?: SqlParameterValues;
        isSaveEnabled?: boolean;
        onBeforeSave?: (
            question: undefined | MetabaseQuestion,
            context: { isNewQuestion: boolean },
        ) => Promise<void>;
        onRun?: (question: undefined | MetabaseQuestion) => void;
        onSave?: (
            question: MetabaseQuestion,
            context: { dashboardTabId?: number; isNewQuestion: boolean },
        ) => void;
        plugins?: MetabasePluginsConfig;
        questionId: null | SdkQuestionId;
        targetCollection?: SdkCollectionId;
        withDownloads?: boolean;
    }
    Index

    Properties

    children? +BaseSdkQuestionProps | Embedded analytics SDK API{% include docs/embedded-analytics-sdk-metadata.html %}

    Interface BaseSdkQuestionProps

    interface BaseSdkQuestionProps {
        children?: ReactNode;
        entityTypes?: EmbeddingEntityType[];
        initialSqlParameters?: SqlParameterValues;
        isSaveEnabled?: boolean;
        onBeforeSave?: (
            question: undefined | MetabaseQuestion,
            context: { isNewQuestion: boolean },
        ) => Promise<void>;
        onRun?: (question: undefined | MetabaseQuestion) => void;
        onSave?: (
            question: MetabaseQuestion,
            context: { dashboardTabId?: number; isNewQuestion: boolean },
        ) => void;
        plugins?: MetabasePluginsConfig;
        questionId: null | SdkQuestionId;
        targetCollection?: SdkCollectionId;
        withDownloads?: boolean;
    }
    Index

    Properties

    children? entityTypes? initialSqlParameters? isSaveEnabled? diff --git a/_docs/master/embedding/sdk/api/CreateQuestion.html b/_docs/master/embedding/sdk/api/CreateQuestion.html index dd1d9a4f9b..e79feca847 100644 --- a/_docs/master/embedding/sdk/api/CreateQuestion.html +++ b/_docs/master/embedding/sdk/api/CreateQuestion.html @@ -9,13 +9,22 @@ layout: docs-api --- -CreateQuestion | Embedded analytics SDK API{% include docs/embedded-analytics-sdk-metadata.html %}

    Function CreateQuestion

    • Parameters

      • Optionalprops: CreateQuestionProps
        • OptionalentityTypes?: EmbeddingEntityType[]

          An array that specifies which entity types are available in the data picker

          +CreateQuestion | Embedded analytics SDK API{% include docs/embedded-analytics-sdk-metadata.html %}

          Function CreateQuestion

          • Parameters

            • Optionalprops: CreateQuestionProps
              • OptionalclassName?: string

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

                +
              • OptionalcomponentPlugins?: MetabasePluginsConfig

                Additional mapper function to override or add drill-down menu

                +
              • OptionalentityTypes?: EmbeddingEntityType[]

                An array that specifies which entity types are available in the data picker

                +
              • 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.

              • OptionalisSaveEnabled?: boolean

                Whether to show the save button.

              • OptionalonBeforeSave?: (
                    question: undefined | MetabaseQuestion,
                    context: { isNewQuestion: boolean },
                ) => Promise<void>

                A callback function that triggers before saving. Only relevant when isSaveEnabled = true

                +
              • OptionalonNavigateBack?: () => void

                A callback function that triggers when a user clicks the back button.

              • OptionalonRun?: (question: undefined | MetabaseQuestion) => void

                A callback function that triggers when a question is updated, including when a user clicks the Visualize button in the question editor

              • OptionalonSave?: (
                    question: MetabaseQuestion,
                    context: { dashboardTabId?: number; isNewQuestion: boolean },
                ) => void

                A callback function that triggers when a user saves the question. Only relevant when isSaveEnabled = true

                -
              • Optionalplugins?: MetabasePluginsConfig
              • OptionaltargetCollection?: SdkCollectionId

                The collection to save the question to. This will hide the collection picker from the save modal. Only applicable to interactive questions.

                +
              • Optionalplugins?: MetabasePluginsConfig
              • Optionalstyle?: CSSProperties

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

                +
              • OptionaltargetCollection?: SdkCollectionId

                The collection to save the question to. This will hide the collection picker from the save modal. Only applicable to interactive questions.

                +
              • 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.

                +
              • OptionalwithResetButton?: boolean

                Determines whether a reset button is displayed. Only relevant when using the default layout.

            Returns Element

            Use <InteractiveQuestion questionId="new" /> instead.

          diff --git a/_docs/master/embedding/sdk/api/CreateQuestionProps.html b/_docs/master/embedding/sdk/api/CreateQuestionProps.html index 162264812e..c3b9fb4804 100644 --- a/_docs/master/embedding/sdk/api/CreateQuestionProps.html +++ b/_docs/master/embedding/sdk/api/CreateQuestionProps.html @@ -9,21 +9,39 @@ layout: docs-api --- -CreateQuestionProps | Embedded analytics SDK API{% include docs/embedded-analytics-sdk-metadata.html %}

          Interface CreateQuestionProps

          interface CreateQuestionProps {
              entityTypes?: EmbeddingEntityType[];
              initialSqlParameters?: SqlParameterValues;
              isSaveEnabled?: boolean;
              onBeforeSave?: (
                  question: undefined | MetabaseQuestion,
                  context: { isNewQuestion: boolean },
              ) => Promise<void>;
              onRun?: (question: undefined | MetabaseQuestion) => void;
              onSave?: (
                  question: MetabaseQuestion,
                  context: { dashboardTabId?: number; isNewQuestion: boolean },
              ) => void;
              plugins?: MetabasePluginsConfig;
              targetCollection?: SdkCollectionId;
              withDownloads?: boolean;
          }
          Index

          Properties

          entityTypes? +CreateQuestionProps | Embedded analytics SDK API{% include docs/embedded-analytics-sdk-metadata.html %}

          Interface CreateQuestionProps

          interface CreateQuestionProps {
              className?: string;
              componentPlugins?: MetabasePluginsConfig;
              entityTypes?: EmbeddingEntityType[];
              height?: Height<string | number>;
              initialSqlParameters?: SqlParameterValues;
              isSaveEnabled?: boolean;
              onBeforeSave?: (
                  question: undefined | MetabaseQuestion,
                  context: { isNewQuestion: boolean },
              ) => Promise<void>;
              onNavigateBack?: () => void;
              onRun?: (question: undefined | MetabaseQuestion) => void;
              onSave?: (
                  question: MetabaseQuestion,
                  context: { dashboardTabId?: number; isNewQuestion: boolean },
              ) => void;
              plugins?: MetabasePluginsConfig;
              style?: CSSProperties;
              targetCollection?: SdkCollectionId;
              title?: SdkQuestionTitleProps;
              width?: Width<string | number>;
              withChartTypeSelector?: boolean;
              withDownloads?: boolean;
              withResetButton?: boolean;
          }
          Index

          Properties

          entityTypes?: EmbeddingEntityType[]

          An array that specifies which entity types are available in the data picker

          +withResetButton? +

          Properties

          className?: string

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

          +
          componentPlugins?: MetabasePluginsConfig

          Additional mapper function to override or add drill-down menu

          +
          entityTypes?: EmbeddingEntityType[]

          An array that specifies which entity types are available in the data picker

          +
          height?: Height<string | number>

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

          initialSqlParameters?: SqlParameterValues

          Initial values for the SQL parameters.

          isSaveEnabled?: boolean

          Whether to show the save button.

          onBeforeSave?: (
              question: undefined | MetabaseQuestion,
              context: { isNewQuestion: boolean },
          ) => Promise<void>

          A callback function that triggers before saving. Only relevant when isSaveEnabled = true

          +
          onNavigateBack?: () => void

          A callback function that triggers when a user clicks the back button.

          onRun?: (question: undefined | MetabaseQuestion) => void

          A callback function that triggers when a question is updated, including when a user clicks the Visualize button in the question editor

          onSave?: (
              question: MetabaseQuestion,
              context: { dashboardTabId?: number; isNewQuestion: boolean },
          ) => void

          A callback function that triggers when a user saves the question. Only relevant when isSaveEnabled = true

          -
          targetCollection?: SdkCollectionId

          The collection to save the question to. This will hide the collection picker from the save modal. Only applicable to interactive questions.

          +

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

          +
          targetCollection?: SdkCollectionId

          The collection to save the question to. This will hide the collection picker from the save modal. Only applicable to interactive questions.

          +

          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.

          +
          width?: Width<string | number>

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

          +
          withChartTypeSelector?: boolean

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

          withDownloads?: boolean

          Enables the ability to download results in the interactive question.

          -

          +
    withResetButton?: boolean

    Determines whether a reset button is displayed. Only relevant when using the default layout.

    +

    diff --git a/_docs/master/embedding/sdk/api/EditableDashboard.html b/_docs/master/embedding/sdk/api/EditableDashboard.html index 43f5381000..bd76c55d96 100644 --- a/_docs/master/embedding/sdk/api/EditableDashboard.html +++ b/_docs/master/embedding/sdk/api/EditableDashboard.html @@ -20,7 +20,7 @@
  • the string ID found in the entity_id key of the dashboard object when using the API directly or using the SDK Collection Browser to return data
  • -
  • OptionaldataPickerProps?: Pick<InteractiveQuestionProps, "entityTypes">

    Additional props to pass to the query builder rendered by InteractiveQuestion when creating a new dashboard question.

    +
  • OptionaldataPickerProps?: Pick<SdkQuestionProps, "entityTypes">

    Additional props to pass to the query builder rendered by InteractiveQuestion when creating a new dashboard question.

  • OptionaldrillThroughQuestionHeight?: Height<string | number>

    Height of a question component when drilled from the dashboard to a question level.

  • OptionaldrillThroughQuestionProps?: DrillThroughQuestionProps

    Props of a question component when drilled from the dashboard to a question level.

  • OptionalhiddenParameters?: string[]

    A list of parameters to hide. diff --git a/_docs/master/embedding/sdk/api/EditableDashboardProps.html b/_docs/master/embedding/sdk/api/EditableDashboardProps.html index 624a16cef9..0b4a818e9c 100644 --- a/_docs/master/embedding/sdk/api/EditableDashboardProps.html +++ b/_docs/master/embedding/sdk/api/EditableDashboardProps.html @@ -9,7 +9,7 @@ layout: docs-api --- -EditableDashboardProps | Embedded analytics SDK API{% include docs/embedded-analytics-sdk-metadata.html %}

    Interface EditableDashboardProps

    interface EditableDashboardProps {
        className?: string;
        dashboardId: SdkDashboardId;
        dataPickerProps?: Pick<InteractiveQuestionProps, "entityTypes">;
        drillThroughQuestionHeight?: Height<string | number>;
        drillThroughQuestionProps?: DrillThroughQuestionProps;
        hiddenParameters?: string[];
        initialParameters?: ParameterValues;
        onLoad?: (dashboard: null | MetabaseDashboard) => void;
        onLoadWithoutCards?: (dashboard: null | MetabaseDashboard) => void;
        plugins?: MetabasePluginsConfig;
        renderDrillThroughQuestion?: () => ReactNode;
        style?: CSSProperties;
        withCardTitle?: boolean;
        withDownloads?: boolean;
        withTitle?: boolean;
    }
    Index

    Properties

    className? +EditableDashboardProps | Embedded analytics SDK API{% include docs/embedded-analytics-sdk-metadata.html %}

    Interface EditableDashboardProps

    interface EditableDashboardProps {
        className?: string;
        dashboardId: SdkDashboardId;
        dataPickerProps?: Pick<SdkQuestionProps, "entityTypes">;
        drillThroughQuestionHeight?: Height<string | number>;
        drillThroughQuestionProps?: DrillThroughQuestionProps;
        hiddenParameters?: string[];
        initialParameters?: ParameterValues;
        onLoad?: (dashboard: null | MetabaseDashboard) => void;
        onLoadWithoutCards?: (dashboard: null | MetabaseDashboard) => void;
        plugins?: MetabasePluginsConfig;
        renderDrillThroughQuestion?: () => ReactNode;
        style?: CSSProperties;
        withCardTitle?: boolean;
        withDownloads?: boolean;
        withTitle?: boolean;
    }
    Index
  • the string ID found in the entity_id key of the dashboard object when using the API directly or using the SDK Collection Browser to return data
  • -
    dataPickerProps?: Pick<InteractiveQuestionProps, "entityTypes">

    Additional props to pass to the query builder rendered by InteractiveQuestion when creating a new dashboard question.

    +
    dataPickerProps?: Pick<SdkQuestionProps, "entityTypes">

    Additional props to pass to the query builder rendered by InteractiveQuestion when creating a new dashboard question.

    drillThroughQuestionHeight?: Height<string | number>

    Height of a question component when drilled from the dashboard to a question level.

    drillThroughQuestionProps?: DrillThroughQuestionProps

    Props of a question component when drilled from the dashboard to a question level.

    Type declaration

    Props for the drill-through question

    diff --git a/_docs/master/embedding/sdk/api/IconName.html b/_docs/master/embedding/sdk/api/IconName.html index 79e2c3249b..dc5d728476 100644 --- a/_docs/master/embedding/sdk/api/IconName.html +++ b/_docs/master/embedding/sdk/api/IconName.html @@ -9,4 +9,4 @@ layout: docs-api --- -IconName | Embedded analytics SDK API{% include docs/embedded-analytics-sdk-metadata.html %}

    Type Alias IconName

    IconName:
        | "string"
        | "number"
        | "function"
        | "model"
        | "table"
        | "question"
        | "collection"
        | "dashboard"
        | "add"
        | "add_column"
        | "add_data"
        | "add_folder"
        | "add_row"
        | "add_to_dash"
        | "ai"
        | "alert"
        | "alert_filled"
        | "alert_confirm"
        | "archive"
        | "area"
        | "attachment"
        | "arrow_up"
        | "arrow_down"
        | "arrow_left"
        | "arrow_left_to_line"
        | "arrow_right"
        | "arrow_split"
        | "audit"
        | "badge"
        | "bar"
        | "bell"
        | "birthday"
        | "bookmark"
        | "bookmark_filled"
        | "bolt"
        | "bolt_filled"
        | "breakout"
        | "bubble"
        | "burger"
        | "calendar"
        | "check"
        | "check_filled"
        | "chevrondown"
        | "chevronleft"
        | "chevronright"
        | "chevronup"
        | "click"
        | "clipboard"
        | "clock"
        | "clone"
        | "close"
        | "cloud"
        | "cloud_filled"
        | "compare"
        | "combine"
        | "connections"
        | "contract"
        | "copy"
        | "curved"
        | "database"
        | "dash"
        | "curve"
        | "document"
        | "download"
        | "dyno"
        | "edit_document"
        | "ellipsis"
        | "embed"
        | "empty"
        | "enter_or_return"
        | "expand"
        | "expand_arrow"
        | "extract"
        | "eye"
        | "eye_crossed_out"
        | "eye_outline"
        | "field"
        | "fields"
        | "filter"
        | "filter_plus"
        | "bug"
        | "format_code"
        | "formula"
        | "funnel"
        | "funnel_outline"
        | "folder"
        | "folder_filled"
        | "gauge"
        | "gear"
        | "gear_settings_filled"
        | "gem"
        | "globe"
        | "grabber"
        | "grid"
        | "group"
        | "google"
        | "google_drive"
        | "google_sheet"
        | "history"
        | "home"
        | "horizontal_bar"
        | "hourglass"
        | "info"
        | "info_filled"
        | "info_outline"
        | "insight"
        | "int"
        | "io"
        | "join_full_outer"
        | "join_inner"
        | "join_left_outer"
        | "join_right_outer"
        | "index"
        | "key"
        | "label"
        | "ldap"
        | "learn"
        | "lightbulb"
        | "link"
        | "line"
        | "lines"
        | "lineandbar"
        | "line_style_dashed"
        | "line_style_dotted"
        | "line_style_solid"
        | "list"
        | "location"
        | "lock"
        | "lock_filled"
        | "mail"
        | "mail_filled"
        | "metabot"
        | "metabot_sad"
        | "metric"
        | "model_with_badge"
        | "moon"
        | "move"
        | "move_card"
        | "new_folder"
        | "notebook"
        | "palette"
        | "pause"
        | "pencil"
        | "pencil_lines"
        | "permissions_limited"
        | "person"
        | "pie"
        | "pin"
        | "pinmap"
        | "pivot_table"
        | "play"
        | "play_outlined"
        | "popover"
        | "popular"
        | "progress"
        | "pulse"
        | "recents"
        | "revert"
        | "sankey"
        | "share"
        | "split"
        | "sql"
        | "subscription"
        | "straight"
        | "stepped"
        | "sort"
        | "sort_arrows"
        | "sum"
        | "sync"
        | "redo"
        | "return"
        | "reference"
        | "refresh"
        | "refresh_downstream"
        | "rocket"
        | "ruler"
        | "schema"
        | "search"
        | "section"
        | "segment"
        | "shield"
        | "sidebar_closed"
        | "sidebar_open"
        | "slack"
        | "slack_colorized"
        | "smartscalar"
        | "snail"
        | "snippet"
        | "sparkles"
        | "star_filled"
        | "star"
        | "stop"
        | "store"
        | "sun"
        | "t-shirt"
        | "tab"
        | "table2"
        | "time_history"
        | "trash"
        | "trash_filled"
        | "triangle_left"
        | "triangle_right"
        | "unarchive"
        | "undo"
        | "unknown"
        | "unpin"
        | "unsubscribe"
        | "upload"
        | "variable"
        | "verified"
        | "official_collection"
        | "verified_filled"
        | "view_archive"
        | "warning"
        | "warning_round_filled"
        | "warning_triangle_filled"
        | "waterfall"
        | "webhook"
        | "10k"
        | "1m"
        | "zoom_in"
        | "zoom_out"
        | "scalar"
        | "cake"
        | "external"
        | "table_spaced"
        | "beaker"
        | "eye_filled"

    +IconName | Embedded analytics SDK API{% include docs/embedded-analytics-sdk-metadata.html %}

    Type Alias IconName

    IconName:
        | "string"
        | "number"
        | "function"
        | "model"
        | "table"
        | "question"
        | "collection"
        | "dashboard"
        | "revert"
        | "add"
        | "add_column"
        | "add_data"
        | "add_folder"
        | "add_row"
        | "add_to_dash"
        | "ai"
        | "alert"
        | "alert_filled"
        | "alert_confirm"
        | "archive"
        | "area"
        | "attachment"
        | "arrow_up"
        | "arrow_down"
        | "arrow_left"
        | "arrow_left_to_line"
        | "arrow_right"
        | "arrow_split"
        | "audit"
        | "badge"
        | "bar"
        | "bell"
        | "birthday"
        | "bookmark"
        | "bookmark_filled"
        | "bolt"
        | "bolt_filled"
        | "breakout"
        | "bubble"
        | "burger"
        | "calendar"
        | "check"
        | "check_filled"
        | "chevrondown"
        | "chevronleft"
        | "chevronright"
        | "chevronup"
        | "click"
        | "clipboard"
        | "clock"
        | "clone"
        | "close"
        | "cloud"
        | "cloud_filled"
        | "compare"
        | "combine"
        | "connections"
        | "contract"
        | "copy"
        | "curved"
        | "database"
        | "dash"
        | "curve"
        | "document"
        | "download"
        | "dyno"
        | "edit_document"
        | "ellipsis"
        | "embed"
        | "empty"
        | "enter_or_return"
        | "expand"
        | "expand_arrow"
        | "extract"
        | "eye"
        | "eye_crossed_out"
        | "eye_outline"
        | "field"
        | "fields"
        | "filter"
        | "filter_plus"
        | "bug"
        | "format_code"
        | "formula"
        | "funnel"
        | "funnel_outline"
        | "folder"
        | "folder_filled"
        | "gauge"
        | "gear"
        | "gear_settings_filled"
        | "gem"
        | "globe"
        | "grabber"
        | "grid"
        | "group"
        | "google"
        | "google_drive"
        | "google_sheet"
        | "history"
        | "home"
        | "horizontal_bar"
        | "hourglass"
        | "info"
        | "info_filled"
        | "info_outline"
        | "insight"
        | "int"
        | "io"
        | "join_full_outer"
        | "join_inner"
        | "join_left_outer"
        | "join_right_outer"
        | "index"
        | "key"
        | "label"
        | "ldap"
        | "learn"
        | "lightbulb"
        | "link"
        | "line"
        | "lines"
        | "lineandbar"
        | "line_style_dashed"
        | "line_style_dotted"
        | "line_style_solid"
        | "list"
        | "location"
        | "lock"
        | "lock_filled"
        | "mail"
        | "mail_filled"
        | "metabot"
        | "metabot_sad"
        | "metric"
        | "model_with_badge"
        | "moon"
        | "move"
        | "move_card"
        | "new_folder"
        | "notebook"
        | "palette"
        | "pause"
        | "pencil"
        | "pencil_lines"
        | "permissions_limited"
        | "person"
        | "pie"
        | "pin"
        | "pinmap"
        | "pivot_table"
        | "play"
        | "play_outlined"
        | "popover"
        | "popular"
        | "progress"
        | "pulse"
        | "recents"
        | "sankey"
        | "share"
        | "split"
        | "sql"
        | "subscription"
        | "straight"
        | "stepped"
        | "sort"
        | "sort_arrows"
        | "sum"
        | "sync"
        | "redo"
        | "return"
        | "reference"
        | "refresh"
        | "refresh_downstream"
        | "rocket"
        | "ruler"
        | "schema"
        | "search"
        | "section"
        | "segment"
        | "shield"
        | "sidebar_closed"
        | "sidebar_open"
        | "slack"
        | "slack_colorized"
        | "smartscalar"
        | "snail"
        | "snippet"
        | "sparkles"
        | "star_filled"
        | "star"
        | "stop"
        | "store"
        | "sun"
        | "t-shirt"
        | "tab"
        | "table2"
        | "time_history"
        | "trash"
        | "trash_filled"
        | "triangle_left"
        | "triangle_right"
        | "unarchive"
        | "undo"
        | "unknown"
        | "unpin"
        | "unsubscribe"
        | "upload"
        | "variable"
        | "verified"
        | "official_collection"
        | "verified_filled"
        | "view_archive"
        | "warning"
        | "warning_round_filled"
        | "warning_triangle_filled"
        | "waterfall"
        | "webhook"
        | "10k"
        | "1m"
        | "zoom_in"
        | "zoom_out"
        | "scalar"
        | "cake"
        | "external"
        | "table_spaced"
        | "beaker"
        | "eye_filled"

    diff --git a/_docs/master/embedding/sdk/api/InteractiveDashboard.html b/_docs/master/embedding/sdk/api/InteractiveDashboard.html index 41e5061096..fe6812fef0 100644 --- a/_docs/master/embedding/sdk/api/InteractiveDashboard.html +++ b/_docs/master/embedding/sdk/api/InteractiveDashboard.html @@ -9,8 +9,8 @@ layout: docs-api --- -InteractiveDashboard | Embedded analytics SDK API{% include docs/embedded-analytics-sdk-metadata.html %}

    Function InteractiveDashboard

    dataPickerProps?: Pick<InteractiveQuestionProps, "entityTypes">

    Additional props to pass to the query builder rendered by InteractiveQuestion when creating a new dashboard question.

    +
    dataPickerProps?: Pick<SdkQuestionProps, "entityTypes">

    Additional props to pass to the query builder rendered by InteractiveQuestion when creating a new dashboard question.

    drillThroughQuestionHeight?: Height<string | number>

    Height of a question component when drilled from the dashboard to a question level.

    drillThroughQuestionProps?: DrillThroughQuestionProps

    Props of a question component when drilled from the dashboard to a question level.

    Type declaration

    Props for the drill-through question

    diff --git a/_docs/master/embedding/sdk/api/InteractiveQuestion.html b/_docs/master/embedding/sdk/api/InteractiveQuestion.html deleted file mode 100644 index dc7989bff8..0000000000 --- a/_docs/master/embedding/sdk/api/InteractiveQuestion.html +++ /dev/null @@ -1,131 +0,0 @@ ---- -version: master -has_magic_breadcrumbs: true -show_category_breadcrumb: true -show_title_breadcrumb: true -category: Embedding -title: InteractiveQuestion -source_url: 'https://github.com/metabase/metabase/blob/master/docs/embedding/sdk/api/InteractiveQuestion.html' -layout: docs-api ---- - -InteractiveQuestion | Embedded analytics SDK API{% include docs/embedded-analytics-sdk-metadata.html %}

    Function InteractiveQuestion

    • A component that renders an interactive question.

      -

      Parameters

      • props: InteractiveQuestionProps
        • Optionalchildren?: ReactNode

          The children of the MetabaseProvider component.s

          -
        • OptionalclassName?: string

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

          -
        • OptionalentityTypes?: EmbeddingEntityType[]

          An array that specifies which entity types are available in the data picker

          -
        • 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.

          -
        • OptionalisSaveEnabled?: boolean

          Whether to show the save button.

          -
        • OptionalonBeforeSave?: (
              question: undefined | MetabaseQuestion,
              context: { isNewQuestion: boolean },
          ) => Promise<void>

          A callback function that triggers before saving. Only relevant when isSaveEnabled = true

          -
        • OptionalonRun?: (question: undefined | MetabaseQuestion) => void

          A callback function that triggers when a question is updated, including when a user clicks the Visualize button in the question editor

          -
        • OptionalonSave?: (
              question: MetabaseQuestion,
              context: { dashboardTabId?: number; isNewQuestion: boolean },
          ) => void

          A callback function that triggers when a user saves the question. Only relevant when isSaveEnabled = true

          -
        • Optionalplugins?: MetabasePluginsConfig
        • questionId: null | SdkQuestionId

          The ID of the question. -
          -This is either: -

          -
            -
          • The numerical ID when accessing a question link, e.g., http://localhost:3000/question/1-my-question where the ID is 1 -
          • -
          • The entity_id key of the question object. You can find a question's Entity ID in the info panel when viewing a question -
          • -
          • new to show the notebook editor for creating new questions. isSaveEnabled must be true to allow saving the question
          • -
          -
        • Optionalstyle?: CSSProperties

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

          -
        • OptionaltargetCollection?: SdkCollectionId

          The collection to save the question to. This will hide the collection picker from the save modal. Only applicable to interactive questions.

          -
        • 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.

          -
        • OptionalwithResetButton?: boolean

          Determines whether a reset button is displayed. Only relevant when using the default layout.

          -

      Returns null | Element

    Index

    InteractiveQuestion

    BackButton: (props: InteractiveQuestionBackButtonProps) => null | Element

    Type declaration

    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

    Editor: (props: InteractiveQuestionEditorProps) => undefined | Element

    Type declaration

      • (props: InteractiveQuestionEditorProps): undefined | Element
      • Function

        Advanced query editor that provides full access to question configuration. -Includes filtering, aggregation, custom expressions, and joins.

        -

        Parameters

        • props: InteractiveQuestionEditorProps
          • OptionalhasVisualizeButton?: boolean
          • OptionalonApply?: () => void

            Callback function executed when changes are applied

            -

        Returns undefined | Element

    EditorButton: (
        props: InteractiveQuestionEditorButtonProps,
    ) => undefined | false | Element

    Type declaration

    Type declaration

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

    Type declaration

    Notebook: (props: InteractiveQuestionEditorProps) => undefined | Element

    Type declaration

      • (props: InteractiveQuestionEditorProps): undefined | Element
      • Function

        Advanced query editor that provides full access to question configuration. -Includes filtering, aggregation, custom expressions, and joins.

        -

        Parameters

        • props: InteractiveQuestionEditorProps
          • OptionalhasVisualizeButton?: boolean
          • OptionalonApply?: () => void

            Callback function executed when changes are applied

            -

        Returns undefined | Element

    Use InteractiveQuestion.Editor instead

    -
    NotebookButton: (
        props: InteractiveQuestionEditorButtonProps,
    ) => undefined | false | Element

    Type declaration

    Use InteractiveQuestion.EditorButton instead

    -
    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

      Type declaration

      SaveQuestionForm: (
          props: InteractiveQuestionSaveQuestionFormProps,
      ) => null | Element

      Type declaration

      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)
          • -
          • "New question" as fallback or for new/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

      other

      VisualizationButton: () => null | Element

      diff --git a/_docs/master/embedding/sdk/api/InteractiveQuestionProps.html b/_docs/master/embedding/sdk/api/InteractiveQuestionProps.html index ab3d118292..a1ccc4f197 100644 --- a/_docs/master/embedding/sdk/api/InteractiveQuestionProps.html +++ b/_docs/master/embedding/sdk/api/InteractiveQuestionProps.html @@ -9,13 +9,14 @@ layout: docs-api --- -InteractiveQuestionProps | Embedded analytics SDK API{% include docs/embedded-analytics-sdk-metadata.html %}

      Interface InteractiveQuestionProps

      interface InteractiveQuestionProps {
          children?: ReactNode;
          className?: string;
          entityTypes?: EmbeddingEntityType[];
          height?: Height<string | number>;
          initialSqlParameters?: SqlParameterValues;
          isSaveEnabled?: boolean;
          onBeforeSave?: (
              question: undefined | MetabaseQuestion,
              context: { isNewQuestion: boolean },
          ) => Promise<void>;
          onRun?: (question: undefined | MetabaseQuestion) => void;
          onSave?: (
              question: MetabaseQuestion,
              context: { dashboardTabId?: number; isNewQuestion: boolean },
          ) => void;
          plugins?: MetabasePluginsConfig;
          questionId: null | SdkQuestionId;
          style?: CSSProperties;
          targetCollection?: SdkCollectionId;
          title?: SdkQuestionTitleProps;
          width?: Width<string | number>;
          withChartTypeSelector?: boolean;
          withDownloads?: boolean;
          withResetButton?: boolean;
      }
      Index

      Properties

      children? -className? +InteractiveQuestionProps | Embedded analytics SDK API{% include docs/embedded-analytics-sdk-metadata.html %}

      Interface InteractiveQuestionProps

      interface InteractiveQuestionProps {
          className?: string;
          componentPlugins?: MetabasePluginsConfig;
          entityTypes?: EmbeddingEntityType[];
          height?: Height<string | number>;
          initialSqlParameters?: SqlParameterValues;
          isSaveEnabled?: boolean;
          onBeforeSave?: (
              question: undefined | MetabaseQuestion,
              context: { isNewQuestion: boolean },
          ) => Promise<void>;
          onNavigateBack?: () => void;
          onRun?: (question: undefined | MetabaseQuestion) => void;
          onSave?: (
              question: MetabaseQuestion,
              context: { dashboardTabId?: number; isNewQuestion: boolean },
          ) => void;
          plugins?: MetabasePluginsConfig;
          questionId: null | SdkQuestionId;
          style?: CSSProperties;
          targetCollection?: SdkCollectionId;
          title?: SdkQuestionTitleProps;
          width?: Width<string | number>;
          withChartTypeSelector?: boolean;
          withDownloads?: boolean;
          withResetButton?: boolean;
      }
      Index

      Properties

      children?: ReactNode

      The children of the MetabaseProvider component.s

      -
      className?: string

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

      +

      Properties

      className?: string

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

      +
      componentPlugins?: MetabasePluginsConfig

      Additional mapper function to override or add drill-down menu

      entityTypes?: EmbeddingEntityType[]

      An array that specifies which entity types are available in the data picker

      height?: Height<string | number>

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

      initialSqlParameters?: SqlParameterValues

      Initial values for the SQL parameters.

      isSaveEnabled?: boolean

      Whether to show the save button.

      onBeforeSave?: (
          question: undefined | MetabaseQuestion,
          context: { isNewQuestion: boolean },
      ) => Promise<void>

      A callback function that triggers before saving. Only relevant when isSaveEnabled = true

      +
      onNavigateBack?: () => void

      A callback function that triggers when a user clicks the back button.

      onRun?: (question: undefined | MetabaseQuestion) => void

      A callback function that triggers when a question is updated, including when a user clicks the Visualize button in the question editor

      onSave?: (
          question: MetabaseQuestion,
          context: { dashboardTabId?: number; isNewQuestion: boolean },
      ) => void

      A callback function that triggers when a user saves the question. Only relevant when isSaveEnabled = true

      -
      questionId: null | SdkQuestionId

      The ID of the question. -
      -This is either: -

      -
        -
      • The numerical ID when accessing a question link, e.g., http://localhost:3000/question/1-my-question where the ID is 1 -
      • -
      • The entity_id key of the question object. You can find a question's Entity ID in the info panel when viewing a question -
      • -
      • new to show the notebook editor for creating new questions. isSaveEnabled must be true to allow saving the question
      • -
      -

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

      +
      questionId: null | SdkQuestionId

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

      targetCollection?: SdkCollectionId

      The collection to save the question to. This will hide the collection picker from the save modal. Only applicable to interactive questions.

      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.

      width?: Width<string | number>

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

      withChartTypeSelector?: boolean

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

      withDownloads?: boolean

      Enables the ability to download results in the interactive question.

      withResetButton?: boolean

      Determines whether a reset button is displayed. Only relevant when using the default layout.

      -

      +
      diff --git a/_docs/master/embedding/sdk/api/SdkQuestionProps.html b/_docs/master/embedding/sdk/api/SdkQuestionProps.html new file mode 100644 index 0000000000..80d8e43f09 --- /dev/null +++ b/_docs/master/embedding/sdk/api/SdkQuestionProps.html @@ -0,0 +1,48 @@ +--- +version: master +has_magic_breadcrumbs: true +show_category_breadcrumb: true +show_title_breadcrumb: true +category: Embedding +title: SdkQuestionProps +source_url: 'https://github.com/metabase/metabase/blob/master/docs/embedding/sdk/api/SdkQuestionProps.html' +layout: docs-api +--- + +SdkQuestionProps | Embedded analytics SDK API{% include docs/embedded-analytics-sdk-metadata.html %}
      Embedded analytics SDK API
        Preparing search index...

        Interface SdkQuestionProps

        interface SdkQuestionProps {
            className?: string;
            componentPlugins?: MetabasePluginsConfig;
            entityTypes?: EmbeddingEntityType[];
            height?: Height<string | number>;
            initialSqlParameters?: SqlParameterValues;
            isSaveEnabled?: boolean;
            onBeforeSave?: (
                question: undefined | MetabaseQuestion,
                context: { isNewQuestion: boolean },
            ) => Promise<void>;
            onNavigateBack?: () => void;
            onRun?: (question: undefined | MetabaseQuestion) => void;
            onSave?: (
                question: MetabaseQuestion,
                context: { dashboardTabId?: number; isNewQuestion: boolean },
            ) => void;
            plugins?: MetabasePluginsConfig;
            questionId: null | SdkQuestionId;
            style?: CSSProperties;
            targetCollection?: SdkCollectionId;
            title?: SdkQuestionTitleProps;
            width?: Width<string | number>;
            withChartTypeSelector?: boolean;
            withDownloads?: boolean;
            withResetButton?: boolean;
        }
        Index

        Properties

        className?: string

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

        +
        componentPlugins?: MetabasePluginsConfig

        Additional mapper function to override or add drill-down menu

        +
        entityTypes?: EmbeddingEntityType[]

        An array that specifies which entity types are available in the data picker

        +
        height?: Height<string | number>

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

        +
        initialSqlParameters?: SqlParameterValues

        Initial values for the SQL parameters.

        +
        isSaveEnabled?: boolean

        Whether to show the save button.

        +
        onBeforeSave?: (
            question: undefined | MetabaseQuestion,
            context: { isNewQuestion: boolean },
        ) => Promise<void>

        A callback function that triggers before saving. Only relevant when isSaveEnabled = true

        +
        onNavigateBack?: () => void

        A callback function that triggers when a user clicks the back button.

        +
        onRun?: (question: undefined | MetabaseQuestion) => void

        A callback function that triggers when a question is updated, including when a user clicks the Visualize button in the question editor

        +
        onSave?: (
            question: MetabaseQuestion,
            context: { dashboardTabId?: number; isNewQuestion: boolean },
        ) => void

        A callback function that triggers when a user saves the question. Only relevant when isSaveEnabled = true

        +
        questionId: null | SdkQuestionId

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

        +
        targetCollection?: SdkCollectionId

        The collection to save the question to. This will hide the collection picker from the save modal. Only applicable to interactive questions.

        +

        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.

        +
        width?: Width<string | number>

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

        +
        withChartTypeSelector?: boolean

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

        +
        withDownloads?: boolean

        Enables the ability to download results in the interactive question.

        +
        withResetButton?: boolean

        Determines whether a reset button is displayed. Only relevant when using the default layout.

        +
        diff --git a/_docs/master/embedding/sdk/api/StaticDashboard.html b/_docs/master/embedding/sdk/api/StaticDashboard.html index 137b9f13ef..2345fa0fb4 100644 --- a/_docs/master/embedding/sdk/api/StaticDashboard.html +++ b/_docs/master/embedding/sdk/api/StaticDashboard.html @@ -9,8 +9,8 @@ layout: docs-api --- -StaticDashboard | Embedded analytics SDK API{% include docs/embedded-analytics-sdk-metadata.html %}
        Embedded analytics SDK API
          Preparing search index...

          Function StaticDashboard

          dataPickerProps?: Pick<InteractiveQuestionProps, "entityTypes">

          Additional props to pass to the query builder rendered by InteractiveQuestion when creating a new dashboard question.

          +
          dataPickerProps?: Pick<SdkQuestionProps, "entityTypes">

          Additional props to pass to the query builder rendered by InteractiveQuestion when creating a new dashboard question.

          drillThroughQuestionHeight?: Height<string | number>

          Height of a question component when drilled from the dashboard to a question level.

          drillThroughQuestionProps?: DrillThroughQuestionProps

          Props of a question component when drilled from the dashboard to a question level.