5.20193.637
PlotArea Wijmo API Class

PlotArea Class

Represents a plot area on the chart.

The chart can have multiple plot areas with multiple axes. To assign axis to plot area use Axis.plotArea property. For example:

 // create a plot area
 var pa = new PlotArea();
 pa.row = 1;
 chart.plotAreas.push(pa);
 // create auxiliary y-axis
 var ay2 = new Axis(Position.Left);
 ay2.plotArea = pa; // attach axis to the plot area
 chart.axes.push(ay2);
 // plot first series along y-axis
 chart.series[0].axisY = ay2;

Heirarchy

Constructors

Properties

Constructors

constructor

  • Initializes a new instance of the PlotArea class.

    Parameters

    • Optional options: any

      Initialization options for the plot area.

    Returns PlotArea

Properties

column

column: number

Gets or sets the column index of plot area. This determines the horizontal position of the plot area on the chart.

height

height: any

Gets or sets the height of the plot area.

The height can be specified as a number (in pixels) or as a string in the format '{number}*' (star sizing).

name

name: string

Gets or sets the plot area name.

row

row: number

Gets or sets the row index of plot area. This determines the vertical position of the plot area on the chart.

style

style: any

Gets or sets the style of the plot area.

Using style property, you can set appearance of the plot area. For example:

  pa.style = { fill: 'rgba(0,255,0,0.1)' };

width

width: any

Gets or sets width of the plot area.

The width can be specified as a number (in pixels) or as a string in the format '{number}*' (star sizing).