ipygee.plotting#

The extensive plotting function for bokhe binding.

Functions#

plot_data(type, data, label_name[, colors, figure, ax])

Plotting mechanism used in all the plotting functions.

Module Contents#

ipygee.plotting.plot_data(type, data, label_name, colors=None, figure=None, ax=None, **kwargs)[source]#

Plotting mechanism used in all the plotting functions.

It binds the bokeh capabilities with the data aggregated by different axes. the shape of the data should as follows:

{
    "label1": {"properties1": value1, "properties2": value2, ...}
    "label2": {"properties1": value1, "properties2": value2, ...},
    ...
}
Parameters:

  • type (str) – The type of plot to use. can be any type of plot from the python lib matplotlib.pyplot. If the one you need is missing open an issue!

  • data (dict) – the data to use as inputs of the graph. Please follow the format specified in the documentation.

  • label_name (str) – The name of the property that was used to generate the labels

  • property_names – The list of names that was used to name the values. They will be used to order the keys of the data dictionary.

  • colors (list[str] | None) – A list of colors to use for the plot. If not provided, the default colors from the matplotlib library will be used.

  • figure (bokeh.plotting.figure | None) – The bokeh figure to use. If not provided, the plot will be sent to a new figure.

  • ax (matplotlib.pyplot.Axes | None) – The matplotlib axis to use. If not provided, the plot will be sent to a new axis.

  • kwargs – Additional arguments from the figure chart type selected.

Returns:

The bokeh figure or the column of figure for time series.

Return type:

bokeh.plotting.figure | bokeh.models.layouts.Column