Embedded analytics SDK API
    Preparing search index...

    Interface StaticQuestionProps

    interface StaticQuestionProps {
        className?: string;
        height?: Height<string | number>;
        hiddenParameters?: string[];
        initialSqlParameters?: SqlParameterValues;
        questionId?: null | SdkQuestionId;
        style?: CSSProperties;
        title?: SdkQuestionTitleProps;
        token?: null | string;
        width?: Width<string | number>;
        withChartTypeSelector?: boolean;
        withDownloads?: boolean;
    }
    Index

    Properties

    className? height? hiddenParameters? initialSqlParameters? questionId? style? title? token? width? withChartTypeSelector? withDownloads?

    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

    hiddenParameters?: string[]

    A list of parameters to hide.

    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, i.e. http://localhost:3000/question/1-my-question where the ID is 1
    • the string ID found in the entity_id key of the question object when using the API directly or using the SDK Collection Browser to return data
    style?: CSSProperties

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

    title?: 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.

    token?: null | string

    A valid JWT token for the guest embed.

    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.

    Settings

    On This Page

    Properties