# Class: Figure
plotting.Figure
Top-level element for plotting. An instance of Figure typically contains one or more Plot instances which have data plotted on them.
This is analogous to the Figure (opens new window) class in matplotlib.
By default, a single plot is created on the new instance with the options passed through the plot property of the options object.
# Hierarchy
-
↳
Figure
# Table of contents
# Constructors
# Properties
# Methods
# Constructors
# constructor
• new Figure(options?)
# Parameters
| Name | Type | Description |
|---|---|---|
options | Partial<{ plot: PlotOptions }> | Options for the figure. |
# Overrides
# Defined in
plotting/Figure.ts:17 (opens new window)
# Properties
# containers
• containers: CanvasContainer[] = []
List of the child CanvasContainer | CanvasContainer instances of the object.
# Inherited from
# Defined in
core/PulsarObject.ts:13 (opens new window)
# Methods
# show
▸ show(): void
Sets the display style to "grid".
# Returns
void
# Inherited from
# Defined in
core/PulsarObject.ts:25 (opens new window)
# hide
▸ hide(): void
Sets the display style to "none".
# Returns
void