Help on class Data in module plotly.graph_objs.graph_objs: class Data(PlotlyList) | A list of traces to be shown on a plot/graph. | | Any operation that can be done with a standard list may be used with Data. | Instantiation requires an iterable (just like list does), for example: | | Data([Scatter(), Heatmap(), Box()]) | | Valid entry types: (dict or any subclass of Trace, i.e., Scatter, Box, etc.) | | | Quick method reference: | | Data.update(changes) | Data.strip_style() | Data.get_data() | Data.to_graph_objs() | Data.validate() | Data.to_string() | Data.force_clean() | | Method resolution order: | Data | PlotlyList | __builtin__.list | __builtin__.object | | Methods defined here: | | to_graph_objs(self, caller=True) | Change any nested collections to subclasses of PlotlyDict/List. | | Procedure: | 1. Attempt to convert all entries to a subclass of PlotlyTrace. | 2. Call `to_graph_objects` on each of these entries. | | ---------------------------------------------------------------------- | Methods inherited from PlotlyList: | | __init__(self, *args) | | force_clean(self, caller=True) | Attempts to convert to graph_objs and calls force_clean() on entries. | | Calling force_clean() on a PlotlyList will ensure that the object is | valid and may be sent to plotly. This process will remove any entries | that end up with a length == 0. It will also remove itself from | enclosing trivial structures if it is enclosed by a collection with | length 1, meaning the data is the ONLY object in the collection. | | Careful! This will delete any invalid entries *silently*. | | get_data(self) | Returns the JSON for the plot with non-data elements stripped. | | get_ordered(self, caller=True) | | strip_style(self) | 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 the INFO dictionary listed in graph_objs_meta.py. | | This process first attempts to convert nested collections from dicts | or lists to subclasses of PlotlyList/PlotlyDict. This process forces | a validation, which may throw exceptions. | | Then, each of these objects call `strip_style` on themselves and so | on, recursively until the entire structure has been validated and | stripped. | | to_string(self, level=0, indent=4, eol='

', pretty=True, max_chars=80) | Returns a formatted string showing graph_obj constructors. | | Example: | | print obj.to_string() | | Keyword arguments: | level (default = 0) -- set number of indentations to start with | indent (default = 4) -- set indentation amount | eol (default = ' | ') -- set end of line character(s) | pretty (default = True) -- curtail long list output with a '...' | max_chars (default = 80) -- set max characters per line | | update(self, changes) | Update current list with changed_list, which must be iterable. | The 'changes' should be a list of dictionaries, however, | it is permitted to be a single dict object. | | 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. | | ---------------------------------------------------------------------- | Data descriptors inherited from PlotlyList: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) | | ---------------------------------------------------------------------- | Data and other attributes inherited from PlotlyList: | | __metaclass__ = <class 'plotly.graph_objs.graph_objs.ListMeta'> | A meta class for PlotlyList class creation. | | The sole purpose of this meta class is to properly create the __doc__ | attribute so that running help(Obj), where Obj is a subclass of PlotlyList, | will return useful information for that object. | | ---------------------------------------------------------------------- | Methods inherited from __builtin__.list: | | __add__(...) | x.__add__(y) <==> x+y | | __contains__(...) | x.__contains__(y) <==> y in x | | __delitem__(...) | x.__delitem__(y) <==> del x[y] | | __delslice__(...) | x.__delslice__(i, j) <==> del x[i:j] | | Use of negative indices is not supported. | | __eq__(...) | x.__eq__(y) <==> x==y | | __ge__(...) | x.__ge__(y) <==> x>=y | | __getattribute__(...) | x.__getattribute__('name') <==> x.name | | __getitem__(...) | x.__getitem__(y) <==> x[y] | | __getslice__(...) | x.__getslice__(i, j) <==> x[i:j] | | Use of negative indices is not supported. | | __gt__(...) | x.__gt__(y) <==> x>y | | __iadd__(...) | x.__iadd__(y) <==> x+=y | | __imul__(...) | x.__imul__(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 | | __mul__(...) | x.__mul__(n) <==> x*n | | __ne__(...) | x.__ne__(y) <==> x!=y | | __repr__(...) | x.__repr__() <==> repr(x) | | __reversed__(...) | L.__reversed__() -- return a reverse iterator over the list | | __rmul__(...) | x.__rmul__(n) <==> n*x | | __setitem__(...) | x.__setitem__(i, y) <==> x[i]=y | | __setslice__(...) | x.__setslice__(i, j, y) <==> x[i:j]=y | | Use of negative indices is not supported. | | __sizeof__(...) | L.__sizeof__() -- size of L in memory, in bytes | | append(...) | L.append(object) -- append object to end | | count(...) | L.count(value) -> integer -- return number of occurrences of value | | extend(...) | L.extend(iterable) -- extend list by appending elements from the iterable | | index(...) | L.index(value, [start, [stop]]) -> integer -- return first index of value. | Raises ValueError if the value is not present. | | insert(...) | L.insert(index, object) -- insert object before index | | pop(...) | L.pop([index]) -> item -- remove and return item at index (default last). | Raises IndexError if list is empty or index is out of range. | | remove(...) | L.remove(value) -- remove first occurrence of value. | Raises ValueError if the value is not present. | | reverse(...) | L.reverse() -- reverse *IN PLACE* | | sort(...) | L.sort(cmp=None, key=None, reverse=False) -- stable sort *IN PLACE*; | cmp(x, y) -> -1, 0, 1 | | ---------------------------------------------------------------------- | Data and other attributes inherited from __builtin__.list: | | __hash__ = None | | __new__ = <built-in method __new__ of type object> | T.__new__(S, ...) -> a new object with type S, a subtype of T