Class: PlotlyExtensions

vef.plot.core.PlotlyExtensions(graphDiv, dataopt, layoutopt, configopt)

Class that extend the default plotly functionality *after* creating the plot.

Constructor

new PlotlyExtensions(graphDiv, dataopt, layoutopt, configopt)

Create a plotly extension object.
Parameters:
Name Type Attributes Default Description
graphDiv HTMLElement Plotly graphDiv configuration.
data Array <optional>
 [] Plotly data configuration.
layout Object <optional>
 {} Plotly layout configuration.
config Object <optional>
 {} Plotly config configuration.
Source:

Methods

apply(settings)

Activate custom plotly extensions based on the configuration.
Parameters:
Name Type Description
settings Object Dictionary containing configuration parameters.
Properties
Name Type Attributes Default Description
styleResetButton Boolean <optional>
 true Enable extending the default reset button styling.
setAutoRangeLimits Boolean <optional>
 true Enable range limitation of the plot.
redirectNotification Boolean | Object <optional>
 false Configure a custom notification function.
Properties
Name Type Attributes Description
callback messageCallback <optional>
 Callback for handling plotly's notification message, i.e., appending it to the DOM.
infoSelect2dButton Boolean <optional>
 true Enable hint on how to use the select button for first time usage.
Source: