Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

plot method in GraphWidget #192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Feb 20, 2015
Merged

plot method in GraphWidget #192

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2eef301
move figure_or_data argument logic to tools for use in widgets.py
chriddyp Feb 17, 2015
c5677c8
add `plot` command to widgets
chriddyp Feb 17, 2015
1afa30a
bump version
chriddyp Feb 17, 2015
4d310d0
start a changelog
chriddyp Feb 17, 2015
fc22d6d
rm changelog, use github releases instead (thx @etpinard)
chriddyp Feb 20, 2015
4ed0b85
allow empty Fig, {}, [] as a way to clear a graph (great idea @theeng…
chriddyp Feb 20, 2015
8486779
provide some examples for widget plottin
chriddyp Feb 20, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions 4 changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
### Changelog

- 1.6.7
Added `plot` method to `plotly.widgets.GraphWidget` for easy-to-use client-side graphing
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+ 💯

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any reasons for not using GitHub releases instead ?

29 changes: 2 additions & 27 deletions 29 plotly/plotly/plotly.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,33 +163,8 @@ def plot(figure_or_data, validate=True, **plot_options):
False: do not open plot in the browser, but do return the unique url

"""
if isinstance(figure_or_data, dict):
figure = figure_or_data
elif isinstance(figure_or_data, list):
figure = {'data': figure_or_data}
else:
raise exceptions.PlotlyError("The `figure_or_data` positional argument "
"must be either `dict`-like or "
"`list`-like.")
if validate:
try:
tools.validate(figure, obj_type='Figure')
except exceptions.PlotlyError as err:
raise exceptions.PlotlyError("Invalid 'figure_or_data' argument. "
"Plotly will not be able to properly "
"parse the resulting JSON. If you "
"want to send this 'figure_or_data' "
"to Plotly anyway (not recommended), "
"you can set 'validate=False' as a "
"plot option.\nHere's why you're "
"seeing this error:\n\n{0}"
"".format(err))
if not figure['data']:
raise exceptions.PlotlyEmptyDataError(
"Empty data list found. Make sure that you populated the "
"list of data objects you're sending and try again.\n"
"Questions? support@plot.ly"
)
figure = tools.return_figure_from_figure_or_data(figure_or_data, validate)

for entry in figure['data']:
for key, val in list(entry.items()):
try:
Expand Down
32 changes: 32 additions & 0 deletions 32 plotly/tools.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1230,3 +1230,35 @@ def __init__(self, url, width, height):

def _repr_html_(self):
return self.embed_code


def return_figure_from_figure_or_data(figure_or_data, validate_figure):
if isinstance(figure_or_data, dict):
figure = figure_or_data
elif isinstance(figure_or_data, list):
figure = {'data': figure_or_data}
else:
raise exceptions.PlotlyError("The `figure_or_data` positional "
"argument must be either "
"`dict`-like or `list`-like.")
if validate_figure:
try:
validate(figure, obj_type='Figure')
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that darn tools.validate. if that didn't exist, i woulda placed this function in utils.py since i can't imagine anyone actually needing it.

except exceptions.PlotlyError as err:
raise exceptions.PlotlyError("Invalid 'figure_or_data' argument. "
"Plotly will not be able to properly "
"parse the resulting JSON. If you "
"want to send this 'figure_or_data' "
"to Plotly anyway (not recommended), "
"you can set 'validate=False' as a "
"plot option.\nHere's why you're "
"seeing this error:\n\n{0}"
"".format(err))
if not figure['data']:
raise exceptions.PlotlyEmptyDataError(
"Empty data list found. Make sure that you populated the "
"list of data objects you're sending and try again.\n"
"Questions? support@plot.ly"
)

return figure
2 changes: 1 addition & 1 deletion 2 plotly/version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = '1.6.6'
__version__ = '1.6.7'
15 changes: 13 additions & 2 deletions 15 plotly/widgets/graph_widget.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
from collections import deque
import json
import os
import uuid

# TODO: protected imports?
from IPython.html import widgets
from IPython.utils.traitlets import Unicode
from IPython.display import Javascript, display

from plotly import utils
from plotly import utils, tools
from pkg_resources import resource_string

# Load JS widget code
Expand Down Expand Up @@ -247,6 +246,18 @@ def message_handler(widget, ranges):
"""
self._handle_registration('zoom', callback, remove)

def plot(self, figure_or_data, validate=True):
"""Plot figure_or_data in the Plotly graph.
"""
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mind throwing in a couple extra lines for docs describing the args?

figure = tools.return_figure_from_figure_or_data(figure_or_data, validate)
message = {
'task': 'newPlot',
'data': figure['data'],
'layout': figure.get('layout', {}),
'graphId': self._graphId
}
self._handle_outgoing_message(message)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

clean!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this support refreshing a blank graph? I.e., should this work?

g.plot()

or at least

g.plot({})

Does validation mess with that or something? It seems like it would mirror the g = GraphWidget() initialization well.

def restyle(self, data, indices=None):
"""Update the style of existing traces in the Plotly graph.

Expand Down
Morty Proxy This is a proxified and sanitized view of the page, visit original site.