Embedded analytics SDK API
    Preparing search index...

    Interface StaticQuestionProps

    interface StaticQuestionProps {
        className?: string;
        height?: Height<string | number>;
        initialSqlParameters?: SqlParameterValues;
        questionId: null | SdkQuestionId;
        style?: CSSProperties;
        width?: Width<string | number>;
        withChartTypeSelector?: boolean;
    }
    Index

    Properties

    className? height? initialSqlParameters? questionId style? width? withChartTypeSelector?

    Properties

    className?: string

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

    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.

    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
    style?: CSSProperties

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

    width?: Width<string | number>

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

    withChartTypeSelector?: boolean

    Settings

    On This Page

    Properties