SoftwareFX.ChartFX
Class Pane

java.lang.Object
  SoftwareFX.ChartFX.Pane

public final class Pane
extends java.lang.Object

Provides access to the Pane object.

The Panes feature of Chart FX allows the developer to display multiple panes of data in a single chart window. This data analysis feature allows developers to separate or combine several series allowing for improved analysis experience. This could be used for many applications, the most obvious being to improve readability by simplifing the display of a chart.

In the chart above, three series are each assigned to in individual pane. As you can see, each pane as several attributes unique per pane instance, such as the InsideBackObject, InsideColor, Proportion, Separation and Title. Also observe how each of the panes has an independent axis.

Constructor Summary

Pane()

Method Summary

java.awt.Rectangle	getBounds() Returns a rectangle object that contains attributes for the selected pane.
IAdornment	getInsideBackObject() Gets the InsideBackObject.
java.awt.Color	getInsideColor() Gets the InsideColor.
int	getProportion() Gets the Proportion.
int	getSeparation() Gets the Separation.
Title	getTitle() Gets the Title.
void	setInsideBackObject(IAdornment value) Allows you to assign a gradient to the inside area of a chart.
void	setInsideColor(java.awt.Color value) Gets or sets the inside color for the selected pane.
void	setProportion(int value) Gets or sets a value indicating the proportional size of the selected pane.
void	setSeparation(int value) Gets or sets a value indicating the space in between panes.
void	setTitle(Title value) Gets the Title object for a selected chart pane.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Pane

public Pane()

Method Detail

getBounds

public java.awt.Rectangle getBounds()

Returns a rectangle object that contains attributes for the selected pane.

Remarks:

By reading the attributes of the Rectangle object returned by this property, you can determine the size and location of a selected pane object.

See Also:

setInsideBackObject(SoftwareFX.ChartFX.IAdornment), setInsideColor(java.awt.Color), setProportion(int), setSeparation(int), setTitle(SoftwareFX.ChartFX.Title)

getInsideBackObject

public IAdornment getInsideBackObject()

Gets the InsideBackObject. For more detail see setInsideBackObject(SoftwareFX.ChartFX.IAdornment).

getInsideColor

public java.awt.Color getInsideColor()

Gets the InsideColor. For more detail see setInsideColor(java.awt.Color).

getProportion

public int getProportion()

Gets the Proportion. For more detail see setProportion(int).

getSeparation

public int getSeparation()

Gets the Separation. For more detail see setSeparation(int).

getTitle

public Title getTitle()

Gets the Title. For more detail see setTitle(SoftwareFX.ChartFX.Title).

setInsideBackObject

public void setInsideBackObject(IAdornment value)

Allows you to assign a gradient to the inside area of a chart.

Remarks:

In order to set a gradient, you must set the ChartCore.setScheme(int) to Scheme.Gradient for the chart.

Once you have created a gradient using the GradientBackground.setAngle(float), GradientBackground.getColor(int), GradientBackground.getFactor(int) and GradientBackground.getPosition(int) properties, you will need to assign the gradient object to the InsideBackObject.

You can use the chart's ChartCore.setBackObject(SoftwareFX.ChartFX.IAdornment) to assign a gradient to the chart background area.

Gradients applied to the InsideBackObject of a chart will only be applied to 2D charts. Gradients applied to the InsideBackObject of 3D charts will be ignored.

See Also:

setInsideColor(java.awt.Color), setProportion(int), setSeparation(int), setTitle(SoftwareFX.ChartFX.Title), ChartCore.setScheme(int), GradientBackground

setInsideColor

public void setInsideColor(java.awt.Color value)

Gets or sets the inside color for the selected pane.

Remarks:

The InsideBackObject may be used to configure a GradientBackground object to the selected chart pane.

For more information regarding the Color type, please refer to your Java API documentation.

See Also:

setInsideBackObject(SoftwareFX.ChartFX.IAdornment), setProportion(int), setSeparation(int), setTitle(SoftwareFX.ChartFX.Title)

setProportion

public void setProportion(int value)

Gets or sets a value indicating the proportional size of the selected pane.

Remarks:

This property accepts an integer that specifies the "proportional" size of a selected pane. For Example, If you set this property to the value of 2 for a selected pane, that pane's height would be twice the size of any default pane's size. The default pane size will depend on the number of panes visible in the chart as well as the dimensions of the chart object itself.

See Also:

setInsideBackObject(SoftwareFX.ChartFX.IAdornment), setInsideColor(java.awt.Color), setSeparation(int), setTitle(SoftwareFX.ChartFX.Title)

setSeparation

public void setSeparation(int value)

Gets or sets a value indicating the space in between panes.

Remarks:

This property is useful when multiple panes are configured and you need to create space for readability.

See Also:

setInsideBackObject(SoftwareFX.ChartFX.IAdornment), setInsideColor(java.awt.Color), setProportion(int), setTitle(SoftwareFX.ChartFX.Title)

setTitle

public void setTitle(Title value)

Gets the Title object for a selected chart pane.

Remarks:

This property returns a Title object. Accessing the title class members you will be able to control attributes such as: Alignment, Color, Font,Text, etc.

Each pane may only have one title.

The setSeparation(int) property may be used to control the space between panes. This may be useful to developers trying a change the font for a pane's title.

See Also:

setInsideBackObject(SoftwareFX.ChartFX.IAdornment), setInsideColor(java.awt.Color), setProportion(int), setSeparation(int), Title, TitleDockable