CFXSeriesAttributes Class Reference

Inherits from
CFXPointAttributes
Conforms to
NSObject (NSObject)
Framework
/ChartFX.framework
Availability
Available in iOS 5.0 and later.
Companion guide
Programming Guide
Declared in
ChartFX.h

Overview

The chart series are represented by groups of data points. For example if you want to plot yearly sales for two different products. Product A and Product B are called the series of the chart. For example, if you create a bar chart, two groups of bars will appear, a group of bars will represent each product and each bar will represent actual sales for a particular month.

The series object allows you to set everything related to the series of the chart, including data, legends and visual attributes like colors, chart types and border styles among others.

What's important about the series object is that you can use properties available in this object to set specific settings to individual series in the chart without affecting the other ones. For example, if you want to create a combination (multitype) chart, where Product A is plotted as line with data labels and Product B is displayed as bars with no borders, you can access each series properties using the series object.

Properties

alternateColor

Gets or sets the alternate color for a selected item when using gradient FillMode.

@property(nonatomic) UIColor alternateColor
Discussion

This property is used in conjunction with fillMode property. You need to set the FillMode to gradient in order to use AlternateColor property.

To create a gradient for an item, you first need to set an initial color using the color property. Then you can assign a AlternateColor to complete the gradient assignment.

For more information regarding the Color type, please refer to the Xcode and Objective-C Documentation.

Declared In
ChartFX.h

axisX

Gets or sets a value indicating the AxisX the series is connected to.

@property(nonatomic) CFXAxisX axisX
Discussion

You may only assign a series to an AxisX object if the series contains XY data. The X property of the DataValues class allows you to assign XValues in a chart.

The axesX property is used to access the AxisXCollection for a chart. The AxisX property is used to assign a data series to one of the existing AxisX items in the AxisXCollection.

The axisY property gets or sets a value indicating the AxisY the series is connected to.

Declared In
ChartFX.h

axisY

Gets or sets a value indicating the AxisY the series is connected to.

@property(nonatomic) CFXAxisY axisY
Discussion

The axesY property is used to access the AxisYCollection for a chart. The AxisY property is used to assign a data series to one of the existing AxisY items in the AxisYCollection.

The axisX property gets or sets a value indicating the AxisX the series is connected to.

Declared In
ChartFX.h

barShape

Gets or sets the Shape for the Bars.

@property(nonatomic) CFXBarShape barShape
Discussion

This property applies when the chart Gallery is set to Bar.

Declared In
ChartFX.h

border

Provides access to the border attributes object.

@property(nonatomic) CFXBorderAttributes border
Discussion

The members of the BorderAttributes class allow customization of the border for CFXPoints and CFXSeries.

Color, Effect, Style, Width, etc, are some of the configurable attributes for Borders.

Declared In
ChartFX.h

color

Gets or sets a Color for the selected series.

@property(nonatomic) UIColor color
Discussion

If no colors are specified, The default color is automatically selected by Chart FX for iOS when you create the chart, and chosen according to the current palette and its position in the series array.

For more information regarding the Color type, please refer to the Xcode and Objective-C Documentation.

Declared In
ChartFX.h

fillMode

Gets or sets a value indicating how Chart FX for iOS should fill the area representing the point.

@property(nonatomic) CFXFillMode fillMode
Discussion

The default value is Solid.

The difference between colored patterns and black & white patterns, also known as hatched paterns, is that hatched patterns are defined by windows and they can be resized when printing the charts. However, there are limited hatched patterns available.

When creating gradients on point or series markers, the FillMode must be set to CFXFillModeGradient. The color and alternateColor properties can be set to create the desired gradient colors.

Declared In
ChartFX.h

gallery

Gets or sets a gallery type for a particular series. All chart types are available in both 2D and 3D modes.

@property(nonatomic) CFXGallery gallery
Discussion

Applying this property to a specific series will create a MultiType chart, where different Chart Types can be combined in the same chart.

You must be careful of the chart types you select to combine as not all of them will produce desirable results. For example, combining a chart that does not have numerical axis (e.g. Pie Chart) with a chart that has a numerical axis (e.g. Line Chart) will produce a chart that can't be read by the end user.

A rule of thumb is that you can combine axis charts with similar types and non-axis charts with similar types, as follows:

Axis Charts:

Lines, Bar, Curve, Scatter, Area, Step, HiLowClose, Cube, Bubble, CandleStick, CurveArea, OpenHiLowClose, Pareto.

Non-axis charts:

Pie, Radar, Doughnut, Pyramid

Note: Gantt, Surface and Contour can't be combined with other chart types

Another important issue to keep in mind when creating MultiType charts is the number of series each chart type requires to properly plot the data. For example, an Open-Hi-Lo-Close chart requires 4 consecutive series to properly plot the data, so if you want to combine this chart type with a line chart, the series containing the data for the line chart must be either the first or the last series in the data set.

Pocket Chart FX for .NET Compact Framework supports a subset of the gallery types supported by the full version of Chart FX.

Declared In
ChartFX.h

galleryAttributes

Used to create a gallery object to assign additional attributes for a particular series.

@property(nonatomic) NSObject galleryAttributes
Discussion

This property returns an object which allows assignment of special properties to be set for the selected gallery. Note that not all gallery types support additional properties.

Declared In
ChartFX.h

line

Gets the LineAttributes object for the particular point.

@property(nonatomic) CFXLineAttributes line
Discussion

The CFXLineAttributes members allows customization of the lines at the CFXGlobalAttributes, CFXSeriesAttributes and CFXPointAttributes level.

LineAttributes will produce a different effect to each Gallery type.  For a example, setting the Line.Width in a Bar chart will set width the line that goes around the bar, while in a Line chart, it will set the width of the line that connects the points.

Declared In
ChartFX.h

markerFont

Gets or sets a wingding font for use as marker shapes.

@property(nonatomic) UIFont markerFont
Discussion

This property is used in conjunction with the markerShape property. You can extend the point types available by setting the markerShape to an integer representing the negative ASCII code from any font. By default, Chart FX uses the Wingdings font table to handle additional point types. This property allows you to select a different Wingdings font.

Declared In
ChartFX.h

markerShape

Gets or sets the the type used to paint markers for the selected item.

@property(nonatomic) CFXMarkerShape markerShape
Discussion

Point markers will not be shown in 3D line charts.

This property applies only to: LINES, CURVE, SCATTER, PARETO, STEP and RADAR charts.

Availability
  • Available in iOS 5.0 and later.
See Also
Declared In
ChartFX.h

markerSize

Gets or sets a value controlling the size of the markers for the selected item.

@property(nonatomic) short int markerSize
Discussion

This property sets the radius of the marker in physical units (pixels). You must make sure the markerShape Property is set to a valid point type for this property to take effect.

Point markers will not be shown in 3D line charts.

Availability
  • Available in iOS 5.0 and later.
See Also
Declared In
ChartFX.h

markerStep

Controls how frequently point markers are shown in the selected series.

@property(nonatomic) short int markerStep
Discussion

This property is very useful when the chart contains a large number of points and the point markers disturb the chart's readability. For example, if you are showing 100 points in a line chart, the physical separation (pixels) of them is very small and probably the point markers will make the chart unreadable to the end user. In this case, you can set this property to force Chart FX for iOS to show point markers every 20 points.

Point markers will not be shown in 3D line charts.

Availability
  • Available in iOS 5.0 and later.
See Also
Declared In
ChartFX.h

markerStyle

Gets or sets the the style used to paint markers for the selected item.

@property(nonatomic) CFXMarkerStyle markerStyle
Discussion

Point markers will not be shown in 3D line charts.

This property applies only to: LINES, CURVE, SCATTER, PARETO, STEP and RADAR charts.

Declared In
ChartFX.h

originalPosition

Returns the original position of the item in the SeriesAttributes Collection.

@property(nonatomic) int originalPosition
Discussion

By utilizing the bringToFront and sendToBack members, developers may control the order of SeriesAttributes in the chart. This property may be used to determine the original starting position for a selected SeriesAttributes object in the SeriesAttributesCollection.

The user interface controls enable end users to order series. This property is useful to determine the original position of a SeriesAttributes object when this has occured.

Availability
  • Available in iOS 5.0 and later.
See Also
Declared In
ChartFX.h

pane

Gets or sets the CFXPane which the series belongs to.

@property(nonatomic) CFXPane pane
Discussion

Once a series is assigned to a CFXPane, this CFXPane will be visible.

Declared In
ChartFX.h

picture

Gets or sets a value specifying the picture associated to the selected item.

@property(nonatomic) UIImage picture
Discussion

The Picture property may be used in two different ways depending on the chart's gallery and FillMode:

1. If the chart gallery is one that uses point markers, meaning you can set the shape of the marker using the MarkerShape property, then the configured image will be used as a point marker as long as the markerShape for that point is set to MarkerShape.Picture.

2. If the chart gallery is one that uses bars, area markers or pie slices (Bar, Area or Pie type charts), then the image will be tiled in the selected series or point. However, in order for the tiled effect to be applied you must set the fillMode to FillMode.Pattern.

The Legends and DataEditor will also show the picture but with an appropriated size. Notice that if you do not set the fillMode to FillMode.Pattern, the configured picture will only be used with charts that have point markers.

When this property is set to a 3D chart, the sides of the markers (3D perspective) are painted with the configured series color.

For more information regarding the Image type, please refer to the Xcode and Objective-C Documentation.

Declared In
ChartFX.h

pointLabels

Provides access to PointLabelAttributes allowing for the manipulation of attributes pertaining to the point label.

@property(nonatomic) CFXPointLabelAttributes pointLabels
Discussion

The CFXPointAttributes members allows customization of the Point labels at the CFXGlobalAttributes, CFXSeriesAttributes and CFXPointAttributes level.

Declared In
ChartFX.h

separateSlice

Gets or sets a value allowing you to separate a slice of a Pie or Doughnut chart for a selected item.

@property(nonatomic) short int separateSlice
Discussion

Setting this property to 100 will make the vertex of the slice to be on the edge of the pie.

Chart FX for iOS does not provide administrative properties, such as the biggest slice in a PIE chart, so if you want to separate a particular slice based on a certain condition, you must first determine the slice to be separated based on the data contained in the chart.

Declared In
ChartFX.h

stacked

Gets or sets a value allowing you to stack the selected series with the previous series to achieve multi-stacked charts.

@property(nonatomic) BOOL stacked
Discussion

Stacked options apply only to Bar and Area charts. So before applying this property, you must make sure the previous series and the selected series are of the same type (Bar or Area).

Declared In
ChartFX.h

tag

Gets or sets and object for the specific item.

@property(nonatomic) NSObject tag
Discussion

The Tag allows the developer to assign and external object to a Point, Series, or the Chart itself, to be retrieved later.

This feature is very useful for drill-down. For example, a data collection which contains the all the data for a particular series can be stored in the Tag, and accessed later, when the user clicks on that series.

Declared In
ChartFX.h

text

Gets or sets a value for labeling the point or series attribute.

@property(nonatomic) NSString *text
Discussion

For Points, Text will be used to asign a string to the point, which can be used as a pointLabels, in a tooltip, etc.

For CFXSeriesAttibutes and CFXConditionalAttributes, Text will be used to asign a string for the legend.

Declared In
ChartFX.h

visible

Gets or sets a value allowing you to show or hide the series.

@property(nonatomic) BOOL visible
Discussion

Hiding a Series will:

- not recalculate any of the scale values for the axis.

- not remove the data associated with it.

- hide the legend associated with it from the Series Legend.

- hide all the data points in the dataGrid

If you hide a Series and want Chart FX for iOS to recalculate the axis scale values, you must invoke the recalculateScale method when you show and/or hide the selected Series.

You can also display hidden series in the DataEditor using the showHiddenSeries of the DataGrid class

Availability
  • Available in iOS 5.0 and later.
See Also
Declared In
ChartFX.h

volume

Gets or sets a value indicating a volume for a data point markers in supported galleries. By adjusting the volume, you can modify the amount of space you want between the items.

@property(nonatomic) short int volume
Discussion

The larger the value, the lesser the distance between the selected point and its neighbors.

This property has a dual functionality depending on the clustered status of the chart, as follows:

If the chart is clustered, this property is used to specify the amount of space between the selected point and its neighbors in the z-axis (a.k.a. Gap Depth). When used in this context, this property is used for any chart type that supports clustered options (Including Multi-Type charts)

When the chart is not clustered, this property controls the amount of space between the selected point and its neighbors in the x-axis (a.k.a. Gap Width). When used in this context, this property applies to any chart type that allows side to side positioning of the series (BAR, BUBBLE, CANDLESTICK, HI-LO-CLOSE, OPEN-HI-LOW-CLOSE and CUBES).

If you want to control the Volume property for all the series in the chart (i.e. apply the same volume setting to all of them) you can use the chart class AllSeries property.

Declared In
ChartFX.h

Instance Methods

bringToFront

Sends a SeriesAttributes to the first position in the SeriesAttributes Collection.

Displays the series to the front of the chart.

- (void) bringToFront
Availability
  • Available in iOS 5.0 and later.
See Also
Declared In
ChartFX.h

sendToBack

Sends a SeriesAttributes to the last position in the SeriesAttributes Collection.

Displays the series to the back of the chart.

- (void) sendToBack
Declared In
ChartFX.h

Constants

CFXBarShape

Sets the shape for the bars in a Bar Chart

typedef enum {
   CFXRectangle,
   CFXCylinder,
   CFXCone,
   CFXPyramid
} CFXBarShape;
Constants
CFXRectangle
Sets the Bar shape to a Rectangle (Default).
CFXCylinder
Sets the Bar shape to a Cylinder.
CFXCone
Sets the Bar shape to a Cone.
CFXPyramid
Sets the Bar shape to a Pyramid.
Declared In
chartfx.h

CFXFillMode

Defines color scheme in the chart.

typedef enum {
   CFXSolid,
   CFXMonochrome,
   CFXPattern,
   CFXGradient
} CFXFillMode;
Constants
CFXSolid
Use solid colors.
CFXMonochrome
Use Black & White patterns.
CFXPattern
Use colored patterns.
CFXGradient
Use Gradient when painting the chart series
Declared In
chartfx.h

CFXGallery

Available chart types

typedef enum {
   CFXNone,
   CFXLines,
   CFXBar,
   CFXArea,
   CFXScatter,
   CFXPie,
   CFXCurve,
   CFXPareto,
   CFXStep,
   CFXHighLowClose,
   CFXSurface,
   CFXRadar,
   CFXPolar,
   CFXCube,
   CFXDoughnut,
   CFXPyramid,
   CFXBubble,
   CFXOpenHighLowClose,
   CFXCandlestick,
   CFXContour,
   CFXCurveArea,
   CFXGantt
} CFXGallery;
Constants
CFXNone
None
CFXLines
Line Chart
CFXBar
Bar Chart
CFXArea
Area Chart
CFXScatter
Scatter Chart
CFXPie
Pie Chart
CFXCurve
Curve Chart
CFXPareto
Pareto Chart
CFXStep
Step Chart
CFXHighLowClose
Hi-Low-Close Chart
CFXSurface
Surface Chart
CFXRadar
Radar Chart
CFXPolar
Polar Chart.
CFXCube
Cube Chart
CFXDoughnut
Doughnut Chart
CFXPyramid
Pyramid Chart
CFXBubble
Bubble Chart
CFXOpenHighLowClose
Open-High-Low-Close Chart
CFXCandlestick
Candlestick Chart
CFXContour
Countour Chart
CFXCurveArea
Curve Area Chart
CFXGantt
Gantt Chart
Declared In
chartfx.h

CFXMarkerShape

Defines different shapes used to paint point markers in the chart. 

typedef enum {
   CFXNone,
   CFXRect,
   CFXCircle,
   CFXTriangle,
   CFXDiamond,
   CFXMarble,
   CFXHorizontalLine,
   CFXVerticalLine,
   CFXCross,
   CFXInvertedTriangle,
   CFXX,
   CFXMany,
   CFXPicture
} CFXMarkerShape;
Constants
CFXNone
Do not display point markers.
CFXRect
Displays a rectangle.
CFXCircle
Displays a circle.
CFXTriangle
Displays a triangle.
CFXDiamond
Displays a diamond.
CFXMarble
Displays a 3D marble.
CFXHorizontalLine
Displays a horizontal line.
CFXVerticalLine
Displays a vertical line.
CFXCross
Displays a cross.
CFXInvertedTriangle
Displays a rotated triangle.
CFXX
Displays an X.
CFXMany
Selects a combination of marker shapes.
CFXPicture
Displays a configured picture.
Declared In
chartfx.h

CFXMarkerStyle

Description goes here

typedef enum {
   CFXDefault,
   CFXAlternate
} CFXMarkerStyle;
Constants
CFXDefault
Description goes here
CFXAlternate
Description goes here
Declared In
chartfx.h

@2013 Software FX, Inc. All Rights Reserved. Chart FX is a registered trademark of Software FX, Inc
All other names are trademarks or registered trademarks of their respective owners.