def validate(self, caller=True):
"""Recursively check the validity of the entries in a PlotlyList.
PlotlyList may only contain suclasses of PlotlyDict, or dictionary-like
objects that can be re-instantiated as subclasses of PlotlyDict.
The validation process first requires that all nested collections be
converted to the appropriate subclass of PlotlyDict/PlotlyList. Then,
each of these objects call `validate` and so on, recursively,
until the entire list has been validated.
"""
if caller: # change everything to PlotlyList/Dict objects
try:
self.to_graph_objs()
except exceptions.PlotlyGraphObjectError as err:
err.prepare()
raise
for index, entry in enumerate(self):
if isinstance(entry, PlotlyDict):
try:
entry.validate(caller=False)
except exceptions.PlotlyGraphObjectError as err:
err.add_to_error_path(index)
err.prepare()
raise
else:
raise exceptions.PlotlyGraphObjectError( # TODO!!!
message=("uh-oh, this error shouldn't have happenend."),
plain_message=(
"uh-oh, this error shouldn't have happenend."),
path=[index],
)
def iplot_mpl(fig,
resize=True,
strip_style=False,
update=None,
**plot_options):
"""Replot a matplotlib figure with plotly in IPython.
This function:
1. converts the mpl figure into JSON (run help(plolty.tools.mpl_to_plotly))
2. makes a request to Plotly to save this figure in your account
3. displays the image in your IPython output cell
Positional agruments:
fig -- a figure object from matplotlib
Keyword arguments:
resize (default=True) -- allow plotly to choose the figure size
strip_style (default=False) -- allow plotly to choose style options
update (default=None) -- update the resulting figure with an 'update'
dictionary-like object resembling a plotly 'Figure' object
Additional keyword arguments:
plot_options -- run help(plotly.plotly.iplot)
"""
fig = tools.mpl_to_plotly(fig, resize=resize, strip_style=strip_style)
if update and isinstance(update, dict):
try:
fig.update(update)
fig.validate()
except exceptions.PlotlyGraphObjectError as err:
err.add_note(
"Your updated figure could not be properly validated.")
err.prepare()
raise
elif update is not None:
raise exceptions.PlotlyGraphObjectError(
"'update' must be dictionary-like and a valid plotly Figure "
"object. Run 'help(plotly.graph_objs.Figure)' for more info.")
return iplot(fig, **plot_options)