Embedded analytics SDK API
    Preparing search index...

    Function ModifyQuestion

    • Parameters

      • props: BaseInteractiveQuestionProps
        • Optionalchildren?: ReactNode

          The children of the MetabaseProvider component.s

        • OptionalentityTypeFilter?: EntityTypeFilterKeys[]

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

        • 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

        • OptionalonSave?: (
              question: undefined | MetabaseQuestion,
              context: { 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
        • OptionaltargetCollection?: SdkCollectionId

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

        • OptionalwithDownloads?: boolean

          Enables the ability to download results in the interactive question.

      Returns Element

      Use InteractiveQuestion with isSaveEnabled={true} instead.