Struct Configuration

pub struct Configuration { /* private fields */ }

Implementations

impl Configuration

pub fn new() -> Configuration

Create a new default Configuration object. Options can be configured using the provided setter methods.

pub fn static_plot(self, static_plot: bool) -> Configuration

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

pub fn typeset_math(self, typeset_math: bool) -> Configuration

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

pub fn plotly_server_url(self, plotly_server_url: &str) -> Configuration

When set it determines base URL for the “Edit in Chart Studio” show_edit_in_chart_studio/show_send_to_cloud mode bar button and the show_link/send_data on-graph link. To enable sending your data to Chart Studio Cloud, you need to set both plotly_server_url to “https://chart-studio.plotly.com” and also set showSendToCloud to true.

pub fn editable(self, editable: bool) -> Configuration

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

pub fn autosizable(self, autosizable: bool) -> Configuration

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

pub fn responsive(self, responsive: bool) -> Configuration

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

pub fn fill_frame(self, fill_frame: bool) -> Configuration

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

pub fn frame_margins(self, frame_margins: f64) -> Configuration

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

pub fn scroll_zoom(self, scroll_zoom: bool) -> Configuration

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

pub fn double_click(self, double_click: DoubleClick) -> Configuration

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.

pub fn double_click_delay(self, double_click_delay: usize) -> Configuration

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 and mapbox) and on-legend double clicks.

pub fn show_axis_drag_handles( self, show_axis_drag_handles: bool, ) -> Configuration

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

pub fn show_axis_range_entry_boxes( self, show_axis_range_entry_boxes: bool, ) -> Configuration

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

pub fn show_tips(self, show_tips: bool) -> Configuration

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

pub fn show_link(self, show_link: bool) -> Configuration

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

pub fn link_text(self, link_text: &str) -> Configuration

Sets the text appearing in the showLink link.

pub fn send_data(self, send_data: bool) -> Configuration

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

pub fn display_mode_bar(self, display_mode_bar: DisplayModeBar) -> Configuration

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.

pub fn show_send_to_cloud(self, show_send_to_cloud: bool) -> Configuration

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 plotly_server_url 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 plotly_server_url 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”.

pub fn show_edit_in_chart_studio( self, show_edit_in_chart_studio: bool, ) -> Configuration

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

pub fn mode_bar_buttons_to_remove( self, mode_bar_buttons_to_remove: Vec<ModeBarButtonName>, ) -> Configuration

Remove mode bar buttons by name.

pub fn to_image_button_options( self, to_image_button_options: ToImageButtonOptions, ) -> Configuration

Statically override options for toImage modebar button.

pub fn display_logo(self, display_logo: bool) -> Configuration

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

pub fn watermark(self, watermark: bool) -> Configuration

Watermark the images with the company’s logo.

pub fn plot_gl_pixel_ratio( self, plot_gl_pixel_ratio: PlotGLPixelRatio, ) -> Configuration

Set the pixel ratio during WebGL image export.

pub fn topojson_url(self, topojson_url: &str) -> Configuration

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.

pub fn mapbox_access_token(self, mapbox_access_token: &str) -> Configuration

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.

pub fn queue_length(self, queue_length: usize) -> Configuration

Sets the length of the undo/redo queue.

pub fn locale(self, locale: &str) -> Configuration

Sets which localization to use. When using this setting, make sure that the appropriate locale is present in the HTML file. For example, to use the “fr” locale, must be present.

Trait Implementations

impl Clone for Configuration

fn clone(&self) -> Configuration

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Configuration

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for Configuration

fn default() -> Configuration

Returns the “default value” for a type.

impl Serialize for Configuration

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.