Interface PlotlyConfig

The plot config.

See https://github.com/plotly/angular-plotly.js#basic-props for added properties to Plotly config.

interface PlotlyConfig {
    autosizable?: boolean;
    className?: string | string[];
    debug?: boolean;
    displaylogo?: boolean;
    displayModeBar?: boolean | "hover";
    doubleClick?: false | "reset" | "autosize" | "reset+autosize";
    doubleClickDelay?: number;
    editable?: boolean;
    edits?: Partial<Edits>;
    editSelection?: boolean;
    fillFrame?: boolean;
    frameMargins?: number;
    linkText?: string;
    locale?: string;
    locales?: Record<
        string,
        { dictionary?: Record<string, string>; format?: Record<string, any> },
    >;
    logging?: 0 | 2 | 1;
    mapboxAccessToken?: string | null;
    modeBarButtons?: false | ModeBarButtonAny[][];
    modeBarButtonsToAdd?: ModeBarButtonAny[];
    modeBarButtonsToRemove?: ModeBarDefaultButtons[];
    notifyOnLogging?: 0 | 2 | 1;
    plotGlPixelRatio?: number;
    plotlyServerURL?: string;
    queueLength?: number;
    responsive?: boolean;
    revision?: number;
    scrollZoom?: string | boolean;
    sendData?: boolean;
    setBackground?:
        | "transparent"
        | "opaque"
        | ((gd: PlotlyHTMLElement, bgColor: string) => void);
    showAxisDragHandles?: boolean;
    showAxisRangeEntryBoxes?: boolean;
    showEditInChartStudio?: boolean;
    showLink?: boolean;
    showSendToCloud?: boolean;
    showSources?: false | ((gd: PlotlyHTMLElement) => void | Promise<void>);
    showTips?: boolean;
    staticPlot?: boolean;
    style?: { [key: string]: string };
    toImageButtonOptions?: Partial<
        {
            filename: string;
            format: "svg"
            | "jpeg"
            | "png"
            | "webp";
            height: number;
            scale: number;
            width: number;
        },
    >;
    topojsonURL?: string;
    typesetMath?: boolean;
    updateOnDataChange?: boolean;
    updateOnLayoutChange?: boolean;
    updateOnlyWithRevision?: boolean;
    useResizeHandler?: boolean;
    watermark?: boolean;
}

Hierarchy

Partial<Config>
- PlotlyConfig

Properties

`Optional`autosizable

autosizable?: boolean

Determines whether the graphs are plotted with respect to layout.autosize:true and infer its container size.

Default

false

`Optional`className

className?: string | string[]

`Optional`debug

debug?: boolean

`Optional`displaylogo

displaylogo?: boolean

Determines whether or not the plotly logo is displayed on the end of the mode bar.

Default

true

`Optional`displayModeBar

displayModeBar?: boolean | "hover"

Determines the mode bar display mode. If true, the mode bar is always visible. If false, the mode bar is always hidden. If hover, the mode bar is visible while the mouse cursor is on the graph container.

Default

"hover"

`Optional`doubleClick

doubleClick?: false | "reset" | "autosize" | "reset+autosize"

Sets the double click interaction mode. Has an effect only in cartesian plots. If false, double click is disable. If reset, double click resets the axis ranges to their initial values. If autosize, double click set the axis ranges to their autorange values. If reset+autosize, the odd double clicks resets the axis ranges to their initial values and even double clicks set the axis ranges to their autorange values.

Default

'reset+autosize'

`Optional`doubleClickDelay

doubleClickDelay?: number

Sets the delay for registering a double-click in ms. This is the time interval (in ms) between first mousedown and 2nd mouseup to constitute a double-click. This setting propagates to all on-subplot double clicks (except for geo, mapbox and map) and on-legend double clicks.

Default

`Optional`editable

editable?: boolean

Determines whether the graph is editable or not. Sets all pieces of edits unless a separate edits config item overrides individual parts.

Default

false

`Optional`edits

edits?: Partial<Edits>

Configuration for editable features.

`Optional`editSelection

editSelection?: boolean

Enables moving selections.

Default

true

`Optional`fillFrame

fillFrame?: boolean

When layout.autosize is turned on, determines whether the graph fills the container (the default) or the screen (if set to true).

Default

false

`Optional`frameMargins

frameMargins?: number

When layout.autosize is turned on, set the frame margins in fraction of the graph size.

Default

`Optional`linkText

linkText?: string

Sets the text appearing in the showLink link.

Default

'Edit chart'

`Optional`locale

locale?: string

Which localization should we use? Should be a string like 'en' or 'en-US'.

Default

'en-US'

`Optional`locales

locales?: Record<
string,
{ dictionary?: Record<string, string>; format?: Record<string, any> },
>

Localization definitions Locales can be provided either here (specific to one chart) or globally by registering them as modules. Should be an object of objects {locale: {dictionary: {...}, format: {...}}} { da: { dictionary: {'Reset axes': 'Nulstil aksler', ...}, format: {months: [...], shortMonths: [...]} }, ... } All parts are optional. When looking for translation or format fields, we look first for an exact match in a config locale, then in a registered module. If those fail, we strip off any regionalization ('en-US' -> 'en') and try each (config, registry) again. The final fallback for translation is untranslated (which is US English) and for formats is the base English (the only consequence being the last fallback date format %x is DD/MM/YYYY instead of MM/DD/YYYY). Currently grouping and currency are ignored for our automatic number formatting, but can be used in custom formats.

Default

{}

`Optional`logging

logging?: 0 | 2 | 1

Turn all console logging on or off (errors will be thrown). This should ONLY be set via Plotly.setPlotConfig. Available levels: 0: no logs 1: warnings and errors, but not informational messages 2: verbose logs

Default

`Optional`mapboxAccessToken

mapboxAccessToken?: string | null

Mapbox access token (required to plot mapbox trace types). If using an Mapbox Atlas server, set this option to '' so that plotly.js won't attempt to authenticate to the public Mapbox server.

Default

null

`Optional`modeBarButtons

modeBarButtons?: false | ModeBarButtonAny[][]

Define fully custom mode bar buttons as nested array, where the outer arrays represents button groups, and the inner arrays have buttons config objects or names of default buttons. See ./components/modebar/buttons.js for more info.

Default

false

`Optional`modeBarButtonsToAdd

modeBarButtonsToAdd?: ModeBarButtonAny[]

Add mode bar button using config objects. See ./components/modebar/buttons.js for list of arguments. To enable predefined modebar buttons e.g. shape drawing, hover and spikelines, simply provide their string name(s). This could include: v1hovermode, hoverclosest, hovercompare, togglehover, togglespikelines, drawline, drawopenpath, drawclosedpath, drawcircle, drawrect and eraseshape. Please note that these predefined buttons will only be shown if they are compatible with all trace types used in a graph.

Default

[]

`Optional`modeBarButtonsToRemove

modeBarButtonsToRemove?: ModeBarDefaultButtons[]

Remove mode bar buttons by name. See ./components/modebar/buttons.js for the list of names.

Default

[]

`Optional`notifyOnLogging

notifyOnLogging?: 0 | 2 | 1

Set on-graph logging (notifier) level. This should ONLY be set via Plotly.setPlotConfig. Available levels: 0: no on-graph logs 1: warnings and errors, but not informational messages 2: verbose logs

Default

`Optional`plotGlPixelRatio

plotGlPixelRatio?: number

Set the pixel ratio during WebGL image export.

Default

`Optional`plotlyServerURL

plotlyServerURL?: string

When set it determines base URL for the 'Edit in Chart Studio' showEditInChartStudio/showSendToCloud mode bar button and the showLink/sendData on-graph link. To enable sending your data to Chart Studio Cloud, you need to set both plotlyServerURL to 'https://chart-studio.plotly.com' and also set showSendToCloud to true.

Default

''

`Optional`queueLength

queueLength?: number

Sets the length of the undo/redo queue.

Default

`Optional`responsive

responsive?: boolean

Determines whether to change the layout size when window is resized. In v3, this option will be removed and will always be true.

Default

false

`Optional`revision

revision?: number

`Optional`scrollZoom

scrollZoom?: string | boolean

Determines whether mouse wheel or two-finger scroll zooms is enable. Turned on by default for gl3d, geo, mapbox and map subplots (as these subplot types do not have zoombox via pan), but turned off by default for cartesian subplots. Set scrollZoom to false to disable scrolling for all subplots.

Default

'gl3d+geo+map'

`Optional`sendData

sendData?: boolean

If showLink is true, does it contain data just link to a Chart Studio Cloud file?

Default

true

`Optional`setBackground

setBackground?:
    | "transparent"
    | "opaque"
    | ((gd: PlotlyHTMLElement, bgColor: string) => void)

Set function to add the background color (i.e. layout.paper_color) to a different container. This function take the graph div as first argument and the current background color as second argument. Alternatively, set to string opaque to ensure there is white behind it.

Default

"transparent"

`Optional`showAxisDragHandles

showAxisDragHandles?: boolean

Set to false to omit cartesian axis pan/zoom drag handles.

Default

true

`Optional`showAxisRangeEntryBoxes

showAxisRangeEntryBoxes?: boolean

Set to false to omit direct range entry at the pan/zoom drag points, note that showAxisDragHandles must be enabled to have an effect.

Default

true

`Optional`showEditInChartStudio

showEditInChartStudio?: boolean

Same as showSendToCloud, but use a pencil icon instead of a floppy-disk. Note that if both showSendToCloud and showEditInChartStudio are turned, only showEditInChartStudio will be honored.

Default

false

`Optional`showLink

showLink?: boolean

Determines whether a link to Chart Studio Cloud is displayed at the bottom right corner of resulting graphs. Use with sendData and linkText.

Default

false

`Optional`showSendToCloud

showSendToCloud?: boolean

Should we include a ModeBar button, labeled "Edit in Chart Studio", that sends this chart to chart-studio.plotly.com (formerly plot.ly) or another plotly server as specified by plotlyServerURL for editing, export, etc? Prior to version 1.43.0 this button was included by default, now it is opt-in using this flag. Note that this button can (depending on plotlyServerURL being set) send your data to an external server. However that server does not persist your data until you arrive at the Chart Studio and explicitly click "Save".

Default

false

`Optional`showSources

showSources?: false | ((gd: PlotlyHTMLElement) => void | Promise<void>)

Adds a source-displaying function to show sources on the resulting graphs.

Default

false

`Optional`showTips

showTips?: boolean

Determines whether or not tips are shown while interacting with the resulting graphs.

Default

true

`Optional`staticPlot

staticPlot?: boolean

Determines whether the graphs are interactive or not. If false, no interactivity, for export or image generation.

Default

false

`Optional`style

style?: { [key: string]: string }

`Optional`toImageButtonOptions

toImageButtonOptions?: Partial<
    {
        filename: string;
        format: "svg"
        | "jpeg"
        | "png"
        | "webp";
        height: number;
        scale: number;
        width: number;
    },
>

Statically override options for toImage modebar button allowed keys are format, filename, width, height, scale

Default

{}

`Optional`topojsonURL

topojsonURL?: string

Set the URL to topojson used in geo charts. By default, the topojson files are fetched from cdn.plot.ly. For example, set this option to: <path-to-plotly.js>/dist/topojson/ to render geographical feature using the topojson files that ship with the plotly.js module.

Default

'https://cdn.plot.ly/'

`Optional`typesetMath

typesetMath?: boolean

Determines whether math should be typeset or not, when MathJax (either v2 or v3) is present on the page.

Default

true

`Optional`updateOnDataChange

updateOnDataChange?: boolean

`Optional`updateOnLayoutChange

updateOnLayoutChange?: boolean

`Optional`updateOnlyWithRevision

updateOnlyWithRevision?: boolean

`Optional`useResizeHandler

useResizeHandler?: boolean

`Optional`watermark

watermark?: boolean

Watermark the images with the company's logo.

Default

false

Interface PlotlyConfig

Hierarchy

Index

Properties

Properties

Optionalautosizable

Default

OptionalclassName

Optionaldebug

Optionaldisplaylogo

Default

OptionaldisplayModeBar

Default

OptionaldoubleClick

Default

OptionaldoubleClickDelay

Default

Optionaleditable

Default

Optionaledits

OptionaleditSelection

Default

OptionalfillFrame

Default

OptionalframeMargins

Default

OptionallinkText

Default

Optionallocale

Default

Optionallocales

Default

Optionallogging

Default

OptionalmapboxAccessToken

Default

OptionalmodeBarButtons

Default

OptionalmodeBarButtonsToAdd

Default

OptionalmodeBarButtonsToRemove

Default

OptionalnotifyOnLogging

Default

OptionalplotGlPixelRatio

Default

OptionalplotlyServerURL

Default

OptionalqueueLength

Default

Optionalresponsive

Default

Optionalrevision

OptionalscrollZoom

Default

OptionalsendData

Default

OptionalsetBackground

Default

OptionalshowAxisDragHandles

Default

OptionalshowAxisRangeEntryBoxes

Default

OptionalshowEditInChartStudio

Default

OptionalshowLink

Default

OptionalshowSendToCloud

Default

OptionalshowSources

Default

OptionalshowTips

Default

OptionalstaticPlot

Default

Optionalstyle

OptionaltoImageButtonOptions

Default

OptionaltopojsonURL

Default

`Optional`autosizable

`Optional`className

`Optional`debug

`Optional`displaylogo

`Optional`displayModeBar

`Optional`doubleClick

`Optional`doubleClickDelay

`Optional`editable

`Optional`edits

`Optional`editSelection

`Optional`fillFrame

`Optional`frameMargins

`Optional`linkText

`Optional`locale

`Optional`locales

`Optional`logging

`Optional`mapboxAccessToken

`Optional`modeBarButtons

`Optional`modeBarButtonsToAdd

`Optional`modeBarButtonsToRemove

`Optional`notifyOnLogging

`Optional`plotGlPixelRatio

`Optional`plotlyServerURL

`Optional`queueLength

`Optional`responsive

`Optional`revision

`Optional`scrollZoom

`Optional`sendData

`Optional`setBackground

`Optional`showAxisDragHandles

`Optional`showAxisRangeEntryBoxes

`Optional`showEditInChartStudio

`Optional`showLink

`Optional`showSendToCloud

`Optional`showSources

`Optional`showTips

`Optional`staticPlot

`Optional`style

`Optional`toImageButtonOptions

`Optional`topojsonURL

`Optional`typesetMath

`Optional`updateOnDataChange

`Optional`updateOnLayoutChange

`Optional`updateOnlyWithRevision

`Optional`useResizeHandler

`Optional`watermark