PlotElement

class gdt.core.plot.plot.PlotElement(color=None, alpha=None)[source]

Bases: object

A base class representing a plot element. A plot element can be a complex collection of more primitive matplotlib plot elements, but are treated as a single element.

Note

This class is not intended to be instantiated directly by the user, rather it is inherited by child plot element objects.

Parameters:
  • alpha (float) – The alpha opacity value, between 0 and 1.

  • color (str) – The color of the plot element

Attributes Summary

alpha

The alpha opacity value, between 0 and 1.

artists

The object references to the individual matplotlib elements

color

The color of the plot element

visible

True if the element is shown on the plot, False otherwise

zorder

The plot element zorder

Methods Summary

hide()

Hide the plot element

remove()

Remove the plot element

show()

Show the plot element

toggle()

Toggle the visibility of the plot element

Attributes Documentation

alpha

The alpha opacity value, between 0 and 1.

Type:

(float)

artists

The object references to the individual matplotlib elements

Type:

(list)

color

The color of the plot element

Type:

(str)

visible

True if the element is shown on the plot, False otherwise

Type:

(bool)

zorder

The plot element zorder

Type:

(int)

Methods Documentation

hide()[source]

Hide the plot element

remove()[source]

Remove the plot element

show()[source]

Show the plot element

toggle()[source]

Toggle the visibility of the plot element