linkDataGraph

Module Contents

Classes

class HowToPlotGraph(attribute_x, attribute_y, kwargs_graph=None, check_if_plot_elem=None, meta=None)[source]
__str__()[source]

Return str(self).

class LinkDataGraph[source]
add_collection(theCollection, kwargs=None)[source]

Add a collection (that will be a future trace)

Parameters:
  • theCollection –
  • kwargs – kwargs associated with the collection (e.g., color, symbol style, etc.)
Returns:

unique id associated with the collection
remove_collection(collectionId)[source]

Remove collection from the graphs

Parameters:collectionId – ID of the collection
Returns:
set_shadow_collection(master_collectionId, shadow_collection)[source]

Link a collection to an other

Parameters:
  • master_collectionId – ID of the collection that is displayed in the graph
  • shadow_collection – collection to link to the master.
Returns:
get_graphs()[source]
get_howToPlotGraph(idGraph)[source]
add_graph(howToPlotGraph)[source]

Add new graph to be plotted.

Parameters:howToPlotGraph – HowToPlotGraph
Returns:
get_idCollections()[source]

Get all ids of the plotted collections

get_idGraphs()[source]

Get all ids of the graphs

get_idTraces(idGraph)[source]

Get all ids of the traces of graph $idGraph

get_idCollection_from_graph(idGraph, idTrace)[source]

Get id of collection plotted in graph $idGraph and trace $idTrace

get_collection(idCollection, getShadow=True)[source]
get_kwargs_collection(idCollection)[source]
update_graphs()[source]

Update the graphs: update graphs, traces, and X-Y data

get_collection_from_graph(idGraph, idTrace, getShadow=True) → optimeed.core.ListDataStruct_Interface[source]

From indices in the graph, get corresponding collection

get_clicked_item(idGraph, idTrace, idPoint, getShadow=True)[source]

Get the data hidden behind the clicked point

Parameters:
  • idGraph – ID of the graph
  • idTrace – ID of the trace
  • idPoint – ID of the point
  • getShadow – If true, will return the data from the collection linked to the collection that is plotted
Returns:

Object in collection
get_clicked_items(idGraph, idTrace, idPoint_list, getShadow=True)[source]

Same as get_clicked_item, but using a list of points

delete_clicked_item(idGraph, idTrace, idPoint)[source]

Remove item from the collection

delete_clicked_items(idGraph, idTrace, idPoints)[source]

Same, but for a list of points

get_graph_and_trace_from_idCollection(idCollection)[source]

Reverse search: from a collection, get all associated graphs

get_idcollection_from_collection(theCollection)[source]

Reverse search: from a collection, find its id

get_idPoints_from_indices_in_collection(idGraph, idTrace, indices_in_collection)[source]

From indices in a collection, find the associated idPoints of the graph

get_collections()[source]
set_meta_from_shadow()[source]

Use this method if ‘howToPlot’ must use shadow collection