pyvista.Chart2D

class Chart2D(size=(1, 1), loc=(0, 0), x_label='x', y_label='y', grid=True)

2D chart class similar to a matplotlib figure.

Parameters
sizelist or tuple, optional

Size of the chart in normalized coordinates. A size of (0, 0) is invisible, a size of (1, 1) occupies the whole renderer’s width and height.

loclist or tuple, optional

Location of the chart (its bottom left corner) in normalized coordinates. A location of (0, 0) corresponds to the renderer’s bottom left corner, a location of (1, 1) corresponds to the renderer’s top right corner.

x_labelstr, optional

Label along the x-axis. Defaults to 'x'.

y_labelstr, optional

Label along the y-axis. Defaults to 'y'.

gridbool, optional

Show the background grid in the plot. Default True.

Examples

Plot a simple sine wave as a scatter and line plot.

>>> import pyvista
>>> import numpy as np
>>> x = np.linspace(0, 2*np.pi, 20)
>>> y = np.sin(x)
>>> chart = pyvista.Chart2D()
>>> _ = chart.scatter(x, y)
>>> _ = chart.line(x, y, 'r')
>>> chart.show()
../../../../_images/pyvista-Chart2D-1_00_00.png

Combine multiple types of plots in the same chart.

>>> rng = np.random.default_rng(1)
>>> x = np.arange(1, 8)
>>> y = rng.integers(5, 15, 7)
>>> e = np.abs(rng.normal(scale=2, size=7))
>>> z = rng.integers(0, 5, 7)
>>> chart = pyvista.Chart2D()
>>> _ = chart.area(x, y-e, y+e, color=(0.12, 0.46, 0.71, 0.2))
>>> _ = chart.line(x, y, color="tab:blue", style="--", label="Scores")
>>> _ = chart.scatter(x, y, color="tab:blue", style="d")
>>> _ = chart.bar(x, z, color="tab:orange", label="Violations")
>>> chart.x_axis.tick_locations = x
>>> chart.x_axis.tick_labels = ["Mon", "Tue", "Wed", "Thu", "Fri",
...                             "Sat", "Sun"]
>>> chart.x_label = "Day of week"
>>> chart.show()
../../../../_images/pyvista-Chart2D-1_01_00.png

Methods

Chart2D.area(x, y1[, y2, color, label])

Add an area plot to this chart.

Chart2D.bar(x, y[, color, orientation, label])

Add a bar plot to this chart.

Chart2D.clear([plot_type])

Remove all plots of the specified type from this chart.

Chart2D.hide_axes()

Hide the x- and y-axis of this chart.

Chart2D.line(x, y[, color, width, style, label])

Add a line plot to this chart.

Chart2D.plot(x[, y, fmt])

Matplotlib like plot method.

Chart2D.plots([plot_type])

Return all plots of the specified type in this chart.

Chart2D.remove_plot(plot)

Remove the given plot from this chart.

Chart2D.scatter(x, y[, color, size, style, ...])

Add a scatter plot to this chart.

Chart2D.show([off_screen, full_screen, ...])

Show this chart in a self contained plotter.

Chart2D.stack(x, ys[, colors, labels])

Add a stack plot to this chart.

Chart2D.toggle()

Toggle the chart's visibility.

Attributes

Chart2D.background_color

Return or set the chart's background color.

Chart2D.background_texture

Return or set the chart's background texture.

Chart2D.border_color

Return or set the chart's border color.

Chart2D.border_style

Return or set the chart's border style.

Chart2D.border_width

Return or set the chart's border width.

Chart2D.grid

Enable or disable the chart grid.

Chart2D.legend_visible

Return or set the visibility of the chart's legend.

Chart2D.loc

Return or set the chart position in normalized coordinates.

Chart2D.size

Return or set the chart size in normalized coordinates.

Chart2D.title

Return or set the chart's title.

Chart2D.visible

Return or set the chart's visibility.

Chart2D.x_axis

Return this chart's horizontal (x) Axis.

Chart2D.x_label

Return or set the label of this chart's x axis.

Chart2D.x_range

Return or set the range of this chart's x axis.

Chart2D.y_axis

Return this chart's vertical (y) Axis.

Chart2D.y_label

Return or set the label of this chart's y axis.

Chart2D.y_range

Return or set the range of this chart's y axis.