Plotly's Python API User Guide¶

Figure(
    data=Data([
        Bar(
            x=[u'2001', u'2002', u'2003', u'2004', u'2005', u'2006', u'2..', ],
            y=[u'1.1', u'1.5', u'2.1', u'2.8', u'3.4', u'4.1', u'5.0', '..'  ],
            name=u'China',
            marker=Marker(
                color=u'rgb(222, 113, 88)'
            )
        ),
        Bar(
            x=[u'2001', u'2002', u'2003', u'2004', u'2005', u'2006', u'2..', ],
            y=[u'1.3', u'1.2', u'1.3', u'1.4', u'1.5', u'1.5', u'1.5', '..'  ],
            name=u'U.S.',
            marker=Marker(
                color=u'rgb(84, 172, 234)'
            )
        )
    ]),
    layout=Layout(
        title=u'<br> #OF UNIVERSITY GRADUATES IN CHINA VS. U.S. (MILLIONS)',
        titlefont=Font(
            family=u'',
            size=0,
            color=u''
        ),
        font=Font(
            family=u"'Open sans', verdana, arial, sans-serif",
            size=12,
            color=u'rgb(33, 33, 33)'
        ),
        showlegend=True,
        autosize=False,
        width=700,
        height=400,
        xaxis=XAxis(
            title=u"<i>Data: Solidiance's Analysis</i>",
            titlefont=Font(
                family=u'',
                size=0,
                color=u''
            ),
            range=[2000.5, 2014.1492895382241],
            domain=[0, 1],
            type=u'linear',
            rangemode=u'normal',
            autorange=True,
            showgrid=False,
            zeroline=False,
            showline=True,
            autotick=True,
            nticks=17,
            ticks=u'',
            showticklabels=True,
            tick0=2001,
            dtick=1,
            ticklen=5,
            tickwidth=1,
            tickcolor=u'#000',
            tickangle=u'auto',
            tickfont=Font(
                family=u'',
                size=0,
                color=u''
            ),
            exponentformat=u'e',
            showexponent=u'all',
            mirror=False,
            gridcolor=u'#ddd',
            gridwidth=1,
            zerolinecolor=u'#000',
            zerolinewidth=1,
            linecolor=u'#000',
            linewidth=1,
            anchor=u'y',
            overlaying=False,
            position=0
        ),
        yaxis=YAxis(
            title=u'',
            titlefont=Font(
                family=u'',
                size=0,
                color=u''
            ),
            range=[0, 8.1],
            domain=[0, 1],
            type=u'linear',
            rangemode=u'nonnegative',
            autorange=False,
            showgrid=True,
            zeroline=False,
            showline=True,
            autotick=True,
            nticks=0,
            ticks=u'',
            showticklabels=True,
            tick0=0,
            dtick=2,
            ticklen=5,
            tickwidth=1,
            tickcolor=u'#000',
            tickangle=u'auto',
            tickfont=Font(
                family=u'',
                size=0,
                color=u''
            ),
            exponentformat=u'e',
            showexponent=u'all',
            mirror=False,
            gridcolor=u'#ddd',
            gridwidth=1,
            zerolinecolor=u'#000',
            zerolinewidth=1,
            linecolor=u'#000',
            linewidth=1,
            anchor=u'x',
            overlaying=False,
            position=0
        ),
        legend=Legend(
            x=0.001851851851851852,
            y=0.9863636363636363,
            traceorder=u'normal',
            font=Font(
                family=u'',
                size=0,
                color=u''
            ),
            bgcolor=u'rgba(255, 255, 255, 0)',
            bordercolor=u'rgba(0, 0, 0, 0)',
            borderwidth=1,
            xanchor=u'auto',
            yanchor=u'auto'
        ),
        annotations=Annotations([
            Annotation(
                x=2001.7,
                y=2.4299999999999997,
                xref=u'x',
                yref=u'y',
                text=u'Source: <a href="http://qz.com/187350/six-charts-tha..',
                showarrow=True,
                font=Font(
                    family=u'',
                    size=0,
                    color=u''
                ),
                xanchor=u'auto',
                yanchor=u'auto',
                align=u'center',
                arrowhead=1,
                arrowsize=1,
                arrowwidth=0,
                arrowcolor=u'rgba(0, 0, 0, 0)',
                ax=446,
                ay=114.98332977294922,
                textangle=0,
                bordercolor=u'',
                borderwidth=1,
                borderpad=1,
                bgcolor=u'rgba(0,0,0,0)',
                opacity=1
            )
        ]),
        margin=Margin(
            l=80,
            r=80,
            b=80,
            t=100,
            pad=0,
            autoexpand=True
        ),
        paper_bgcolor=u'#fff',
        plot_bgcolor=u'#fff',
        hovermode=u'x',
        dragmode=u'zoom',
        separators=u'.,',
        barmode=u'group',
        bargap=0.1,
        bargroupgap=0.15,
        boxmode=u'overlay',
        boxgap=0.3,
        boxgroupgap=0.3,
        hidesources=False
    )
)

Help on class Scatter in module plotly.graph_objs.graph_objs:

class Scatter(PlotlyDict)
 |  Valid attributes for 'scatter' at path [] under parents ():
 |  
 |      ['textposition', 'uid', 'stream', 'ysrc', 'hoverinfo', 'xsrc',
 |      'visible', 'marker', 'y0', 'tsrc', 'line', 'fill', 'showlegend',
 |      'error_x', 'error_y', 'rsrc', 'xaxis', 'text', 'type', 't', 'opacity',
 |      'textfont', 'legendgroup', 'textpositionsrc', 'textsrc', 'dx', 'dy',
 |      'x0', 'name', 'yaxis', 'connectgaps', 'r', 'mode', 'y', 'x',
 |      'fillcolor']
 |  
 |  Run `<scatter-object>.help('attribute')` on any of the above.
 |  '<scatter-object>' is the object at []
 |  
 |  Method resolution order:
 |      Scatter
 |      PlotlyDict
 |      __builtin__.dict
 |      PlotlyBase
 |      __builtin__.object
 |  
 |  Methods inherited from PlotlyDict:
 |  
 |  __copy__(self)
 |  
 |  __deepcopy__(self, memodict={})
 |  
 |  __dir__(self)
 |      Dynamically return the existing and possible attributes.
 |  
 |  __getattr__(self, key)
 |      Python only calls this when key is missing!
 |  
 |  __getitem__(self, key)
 |      Calls __missing__ when key is not found. May mutate object.
 |  
 |  __init__(self, *args, **kwargs)
 |  
 |  __missing__(self, key)
 |      Mimics defaultdict. This is called from __getitem__ when key DNE.
 |  
 |  __setattr__(self, key, value)
 |      Maps __setattr__ onto __setitem__
 |  
 |  __setitem__(self, key, value, _raise=True)
 |      Validates/Converts values which should be Graph Objects.
 |  
 |  force_clean(self, **kwargs)
 |      Recursively remove empty/None values.
 |  
 |  get_data(self, flatten=False)
 |      Returns the JSON for the plot with non-data elements stripped.
 |  
 |  get_ordered(self, **kwargs)
 |      Return a predictable, OrderedDict version of self.
 |  
 |  help(self, attribute=None, return_help=False)
 |      Print help string for this object or an attribute of this object.
 |      
 |      :param (str) attribute: A valid attribute string for this object.
 |      :param (bool) return_help: Return help_string instead of printing it?
 |      :return: (None|str)
 |  
 |  strip_style(self)
 |      Recursively strip style from the current representation.
 |      
 |      All PlotlyDicts and PlotlyLists are guaranteed to survive the
 |      stripping process, though they made be left empty. This is allowable.
 |      
 |      Keys that will be stripped in this process are tagged with
 |      `'type': 'style'` in graph_objs_meta.json. Note that a key tagged as
 |      style, but with an array as a value may still be considered data.
 |  
 |  to_string(self, level=0, indent=4, eol='\n', pretty=True, max_chars=80)
 |      Returns a formatted string showing graph_obj constructors.
 |      
 |      :param (int) level: The number of indentations to start with.
 |      :param (int) indent: The indentation amount.
 |      :param (str) eol: The end of line character(s).
 |      :param (bool) pretty: Curtail long list output with a '..' ?
 |      :param (int) max_chars: The max characters per line.
 |      
 |      Example:
 |      
 |          print(obj.to_string())
 |  
 |  update(self, dict1=None, **dict2)
 |      Update current dict with dict1 and then dict2.
 |      
 |      This recursively updates the structure of the original dictionary-like
 |      object with the new entries in the second and third objects. This
 |      allows users to update with large, nested structures.
 |      
 |      Note, because the dict2 packs up all the keyword arguments, you can
 |      specify the changes as a list of keyword agruments.
 |      
 |      Examples:
 |      # update with dict
 |      obj = Layout(title='my title', xaxis=XAxis(range=[0,1], domain=[0,1]))
 |      update_dict = dict(title='new title', xaxis=dict(domain=[0,.8]))
 |      obj.update(update_dict)
 |      obj
 |      {'title': 'new title', 'xaxis': {'range': [0,1], 'domain': [0,.8]}}
 |      
 |      # update with list of keyword arguments
 |      obj = Layout(title='my title', xaxis=XAxis(range=[0,1], domain=[0,1]))
 |      obj.update(title='new title', xaxis=dict(domain=[0,.8]))
 |      obj
 |      {'title': 'new title', 'xaxis': {'range': [0,1], 'domain': [0,.8]}}
 |      
 |      This 'fully' supports duck-typing in that the call signature is
 |      identical, however this differs slightly from the normal update
 |      method provided by Python's dictionaries.
 |  
 |  ----------------------------------------------------------------------
 |  Data descriptors inherited from PlotlyDict:
 |  
 |  __dict__
 |      dictionary for instance variables (if defined)
 |  
 |  __weakref__
 |      list of weak references to the object (if defined)
 |  
 |  ----------------------------------------------------------------------
 |  Methods inherited from __builtin__.dict:
 |  
 |  __cmp__(...)
 |      x.__cmp__(y) <==> cmp(x,y)
 |  
 |  __contains__(...)
 |      D.__contains__(k) -> True if D has a key k, else False
 |  
 |  __delitem__(...)
 |      x.__delitem__(y) <==> del x[y]
 |  
 |  __eq__(...)
 |      x.__eq__(y) <==> x==y
 |  
 |  __ge__(...)
 |      x.__ge__(y) <==> x>=y
 |  
 |  __getattribute__(...)
 |      x.__getattribute__('name') <==> x.name
 |  
 |  __gt__(...)
 |      x.__gt__(y) <==> x>y
 |  
 |  __iter__(...)
 |      x.__iter__() <==> iter(x)
 |  
 |  __le__(...)
 |      x.__le__(y) <==> x<=y
 |  
 |  __len__(...)
 |      x.__len__() <==> len(x)
 |  
 |  __lt__(...)
 |      x.__lt__(y) <==> x<y
 |  
 |  __ne__(...)
 |      x.__ne__(y) <==> x!=y
 |  
 |  __repr__(...)
 |      x.__repr__() <==> repr(x)
 |  
 |  __sizeof__(...)
 |      D.__sizeof__() -> size of D in memory, in bytes
 |  
 |  clear(...)
 |      D.clear() -> None.  Remove all items from D.
 |  
 |  copy(...)
 |      D.copy() -> a shallow copy of D
 |  
 |  fromkeys(...)
 |      dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v.
 |      v defaults to None.
 |  
 |  get(...)
 |      D.get(k[,d]) -> D[k] if k in D, else d.  d defaults to None.
 |  
 |  has_key(...)
 |      D.has_key(k) -> True if D has a key k, else False
 |  
 |  items(...)
 |      D.items() -> list of D's (key, value) pairs, as 2-tuples
 |  
 |  iteritems(...)
 |      D.iteritems() -> an iterator over the (key, value) items of D
 |  
 |  iterkeys(...)
 |      D.iterkeys() -> an iterator over the keys of D
 |  
 |  itervalues(...)
 |      D.itervalues() -> an iterator over the values of D
 |  
 |  keys(...)
 |      D.keys() -> list of D's keys
 |  
 |  pop(...)
 |      D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
 |      If key is not found, d is returned if given, otherwise KeyError is raised
 |  
 |  popitem(...)
 |      D.popitem() -> (k, v), remove and return some (key, value) pair as a
 |      2-tuple; but raise KeyError if D is empty.
 |  
 |  setdefault(...)
 |      D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D
 |  
 |  values(...)
 |      D.values() -> list of D's values
 |  
 |  viewitems(...)
 |      D.viewitems() -> a set-like object providing a view on D's items
 |  
 |  viewkeys(...)
 |      D.viewkeys() -> a set-like object providing a view on D's keys
 |  
 |  viewvalues(...)
 |      D.viewvalues() -> an object providing a view on D's values
 |  
 |  ----------------------------------------------------------------------
 |  Data and other attributes inherited from __builtin__.dict:
 |  
 |  __hash__ = None
 |  
 |  __new__ = <built-in method __new__ of type object>
 |      T.__new__(S, ...) -> a new object with type S, a subtype of T
 |  
 |  ----------------------------------------------------------------------
 |  Methods inherited from PlotlyBase:
 |  
 |  to_graph_objs(self, **kwargs)
 |      Everything is cast into graph_objs. Here for backwards compat.
 |  
 |  validate(self)
 |      Everything is *always* validated now. keep for backwards compat.

Scatter(
    x=[u'2001', u'2002', u'2003', u'2004', u'2005', u'2006', u'2007', u'..', ],
    y=[u'1.1', u'1.5', u'2.1', u'2.8', u'3.4', u'4.1', u'5.0', u'5.6', '..'  ],
    mode='markers+lines',
    name=u'China'
)

Scatter(
    x=[u'2001', u'2002', u'2003', u'2004', u'2005', u'2006', u'2007', u'..', ],
    y=[u'1.3', u'1.2', u'1.3', u'1.4', u'1.5', u'1.5', u'1.5', u'1.6', '..'  ],
    mode='markers',
    name=u'U.S.',
    marker=Marker(
        symbol='square'
    )
)

Help on class image in module plotly.plotly.plotly:

class image
 |  Helper functions wrapped around plotly's static image generation api.
 |  
 |  Class methods defined here:
 |  
 |  ishow(cls, figure_or_data, format='png', width=None, height=None) from __builtin__.classobj
 |      Display a static image of the plot described by `figure`
 |      in an IPython Notebook.
 |  
 |  save_as(cls, figure_or_data, filename, format=None, width=None, height=None) from __builtin__.classobj
 |      Save a static image of the plot described by `figure` locally as `filename`.
 |      Valid image formats are 'png', 'svg', 'jpeg', and 'pdf'.
 |      The format is taken as the extension of the filename or as the supplied format.
 |  
 |  ----------------------------------------------------------------------
 |  Static methods defined here:
 |  
 |  get(figure_or_data, format='png', width=None, height=None)
 |      Return a static image of the plot described by `figure`.
 |      
 |      Valid formats: 'png', 'svg', 'jpeg', 'pdf'

XAxis(
    title=u'<b>Distance</b> \xa0[Mpc]',
    titlefont=Font(
        family=u'',
        size=0,
        color=u''
    ),
    range=[0, 23.39607843137255],
    domain=[0, 1],
    type=u'linear',
    rangemode=u'tozero',
    autorange=True,
    showgrid=True,
    zeroline=False,
    showline=False,
    autotick=False,
    nticks=0,
    ticks=u'outside',
    showticklabels=True,
    tick0=0,
    dtick=2,
    ticklen=8,
    tickwidth=1.5,
    tickcolor=u'#444',
    tickangle=u'auto',
    tickfont=Font(
        family=u'',
        size=0,
        color=u''
    ),
    exponentformat=u'B',
    showexponent=u'all',
    mirror=False,
    gridcolor=u'rgb(255, 255, 255)',
    gridwidth=1.5,
    zerolinecolor=u'#444',
    zerolinewidth=1,
    linecolor=u'#444',
    linewidth=1,
    anchor=u'y',
    overlaying=False,
    position=0
)

YAxis(
    title=u'<b>Radial velocity</b> \xa0[km/s]',
    titlefont=Font(
        family=u'',
        size=0,
        color=u''
    ),
    range=[-221.13855421686748, 2148.1385542168673],
    domain=[0, 1],
    type=u'linear',
    rangemode=u'tozero',
    autorange=True,
    showgrid=True,
    zeroline=False,
    showline=False,
    autotick=True,
    nticks=0,
    ticks=u'outside',
    showticklabels=True,
    tick0=0,
    dtick=500,
    ticklen=8,
    tickwidth=1.5,
    tickcolor=u'#444',
    tickangle=u'auto',
    tickfont=Font(
        family=u'',
        size=0,
        color=u''
    ),
    exponentformat=u'B',
    showexponent=u'all',
    mirror=False,
    gridcolor=u'rgb(255, 255, 255)',
    gridwidth=1.5,
    zerolinecolor=u'#444',
    zerolinewidth=1,
    linecolor=u'#444',
    linewidth=1,
    anchor=u'x',
    overlaying=False,
    position=0
)

Legend(
    x=0.010260457774269928,
    y=0.9551820728291316,
    traceorder=u'normal',
    font=Font(
        family=u'',
        size=0,
        color=u''
    ),
    bgcolor=u'rgba(0, 0, 0, 0)',
    bordercolor=u'#444',
    borderwidth=0,
    xanchor=u'left',
    yanchor=u'top'
)