CFXPane Class Reference

Inherits from
Conforms to
Framework
Availability
Available in iOS 5.0 and later.
Companion guide
Declared in
ChartFX.h

Overview

The Panes feature of Chart FX for iOS 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 simplifying the display of a chart.

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

The first indexed pane of the collection is referred to the main pane of the chart. It can be accessed by the mainPane property of the Chart class.

Properties

axes

Provides access to the Y Axis Collection for the selected Pane.

@property(nonatomic) AxisYCollection axes
Parameters
index
A zero based index indicating the Y Axis index.
Discussion

Use this property to mamipulate the Y Axes of the Pane.

The axisY property provides direct access to the Pane's main Y axis.

Declared In
ChartFX.h

axisY

Provides access to the members of the main Y Axis for the selected Pane.

@property(nonatomic) CFXAxisY axisY
Discussion

This property is a shortcut to the Pane's main CFXAxisY.

To access any other Pane's Y axes, i.e. Secondary Y axis, use the axes property.

Declared In
ChartFX.h

background

Gets or sets an ImageBackground or GradientBackground object for a pane.

@property(nonatomic) IAdornment background
Discussion

Each pane present in a chart may have a unique ImageBackground or GradientBackground object configured as the background.

Please see the ImageBackground and GradientBackground objects for information regarding supported members.

Declared In
ChartFX.h

proportion

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

@property(nonatomic) double proportion
Discussion

This property accepts an integer that specifies the "proportional" size of a selected pane. For Example, If you set this property to a value of 2, that pane's height would be twice the size of any default pane's height. 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.

Declared In
ChartFX.h

separation

Gets or sets a value indicating the space between panes.

@property(nonatomic) int separation
Discussion

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

Declared In
ChartFX.h

title

Gets the Title object for a selected pane.

@property(nonatomic) CFXTitle title
Discussion

This property returns a Title object. By 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 separation 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.

Declared In
ChartFX.h

visible

Gets or sets a value indicating if the Pane object should be shown or not.

@property(nonatomic) BOOL visible
Discussion

Hiding a Pane object will hide all the series associated with that pane, not only from the chart area but also from the Legend and the DataGrid. The hidden series objects will remain accessible but invisible.

Hiding a Pane object does not destroy or lose previous settings assigned by other properties.

Declared In
ChartFX.h