vega-embed
    Preparing search index...

    Interface EmbedOptions<S, R>

    interface EmbedOptions<S = string, R = Renderers> {
        actions?: boolean | Actions;
        ast?: boolean;
        bind?: string | HTMLElement;
        config?: Config | S;
        defaultStyle?: string | boolean;
        downloadFileName?: string;
        editorUrl?: string;
        expr?: typeof expressionInterpreter;
        expressionFunctions?: ExpressionFunction;
        forceActionsMenu?: boolean;
        formatLocale?: Record<string, unknown>;
        height?: number;
        hover?: boolean | Hover;
        i18n?: Partial<
            {
                CLICK_TO_VIEW_ACTIONS: string;
                COMPILED_ACTION: string;
                EDITOR_ACTION: string;
                PNG_ACTION: string;
                SOURCE_ACTION: string;
                SVG_ACTION: string;
            },
        >;
        loader?: Loader
        | LoaderOptions;
        logLevel?: number;
        mode?: Mode;
        padding?:
            | number
            | { bottom?: number; left?: number; right?: number; top?: number };
        patch?: S | PatchFunc | Operation[];
        renderer?: R;
        scaleFactor?: number | { png?: number; svg?: number };
        sourceFooter?: string;
        sourceHeader?: string;
        theme?:
            | "dark"
            | "excel"
            | "fivethirtyeight"
            | "ggplot2"
            | "latimes"
            | "quartz"
            | "vox"
            | "urbaninstitute"
            | "googlecharts"
            | "powerbi"
            | "carbonwhite"
            | "carbong10"
            | "carbong90"
            | "carbong100";
        timeFormatLocale?: Record<string, unknown>;
        tooltip?: boolean | TooltipHandler | Options;
        viewClass?: typeof View;
        width?: number;
    }

    Type Parameters

    • S = string
    • R = Renderers
    Index

    Properties

    actions?: boolean | Actions
    ast?: boolean
    bind?: string | HTMLElement
    config?: Config | S
    defaultStyle?: string | boolean
    downloadFileName?: string
    editorUrl?: string
    expr?: typeof expressionInterpreter
    expressionFunctions?: ExpressionFunction
    forceActionsMenu?: boolean
    formatLocale?: Record<string, unknown>
    height?: number
    hover?: boolean | Hover
    i18n?: Partial<
        {
            CLICK_TO_VIEW_ACTIONS: string;
            COMPILED_ACTION: string;
            EDITOR_ACTION: string;
            PNG_ACTION: string;
            SOURCE_ACTION: string;
            SVG_ACTION: string;
        },
    >
    loader?: Loader | LoaderOptions
    logLevel?: number
    mode?: Mode
    padding?:
        | number
        | { bottom?: number; left?: number; right?: number; top?: number }
    patch?: S | PatchFunc | Operation[]
    renderer?: R
    scaleFactor?: number | { png?: number; svg?: number }
    sourceFooter?: string
    sourceHeader?: string
    theme?:
        | "dark"
        | "excel"
        | "fivethirtyeight"
        | "ggplot2"
        | "latimes"
        | "quartz"
        | "vox"
        | "urbaninstitute"
        | "googlecharts"
        | "powerbi"
        | "carbonwhite"
        | "carbong10"
        | "carbong90"
        | "carbong100"
    timeFormatLocale?: Record<string, unknown>
    tooltip?: boolean | TooltipHandler | Options
    viewClass?: typeof View
    width?: number