CFXGlobalAttributes Class Reference
Inherits from | |
Conforms to | |
Framework | |
Availability |
Available in iOS 5.0 and later.
|
Companion guide | |
Declared in |
ChartFX.h
|
Overview
The GlobalAttributes class allows customization of visual attributes that apply to all the CFXSeries and CFXPoints in a Chart.
Using the GlobalAttributes members, you can set Gallery type, Colors, Marker shapes, Borders, etc.
GlobalAttibuttes are accessed through the allSeries property of the CFXChart class.
Properties
axisX
Assigns properties specifically to the primary X axis.
Discussion
The AxisX property allows developers to assign attributes directly to the X axis object, use the axisY property for the primary Y axis.
The CFXAxis property is used to reference axes other than the primary X and Y.
Using the major and minor properties, you can customize grid line attributes using the CFXLine class members.
Declared In
ChartFX.h
axisY
Assigns properties specifically to the Y axis.
Discussion
The AxisY property allows developers to assign attributes directly to the Y axis object, use the axisX property for the primary X axis.
The CFXAxis property is used to reference axes other than the primary X and Y.
Using the major and minor properties, you can customize grid line attributes using the CFXLine class members.
Declared In
ChartFX.h
barShape
Gets or sets the Shape for the Bars.
Discussion
This property applies when the chart Gallery is set to Bar.
Declared In
ChartFX.h
border
Provides access to the border attributes object.
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
fillMode
Gets or sets a value indicating how Chart FX for iOS should fill the area representing the point.
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 and sets the chart type for all Series.
Discussion
When you set the gallery with this property it applies to all the series in the chart. If you want to create a Multitype (or combination chart) please refer to the Series object gallery property.
When selecting a Gallery for charts, keep in mind the number of data series which will be included in the chart. Pie, Pyramid and Doughnut chart types can only display one series per chart. If you have multiple data series, you may want to select a Gallery type that supports one that one series.
Creating a gallery object using the galleryAttributes property allows you to assign additional attributes to selected gallery types.
This property applies to all series. You can then override this value by setting the same property for a specific series.
Declared In
ChartFX.h
galleryAttributes
Used to create a gallery object to assign additional attributes for a particular series.
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
horizontal
Gets or sets a value specifying to transpose X and Y axes in a chart.
Discussion
When Horizontal is True, X and Y axis objects are transposed in the chart.
By transposing the X and Y axes, the orientation of series in the chart is inverted. Therefore, vertical bars in a bar gallery chart are now horizontal, like in a Gantt gallery chart.
The allSeries property is used to access the GlobalAttributes object of a chart.
Declared In
ChartFX.h
line
Gets the LineAttributes object for the particular point.
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.
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.
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.
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.
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.
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
multipleColors
Gets and sets the Multiple colors to allow for independently colored data points.
Discussion
When set to YES all data points on a series will have a unique color. When set to NO all the data points in the series will assume the same color.
When MultipleColors is set to YES and the legendBox has been set to Visible, the Legend will show the Axis X labels.
This property applies to all series. You can then override this value by setting the same property for a specific series.
You can assign specific colors to specific points by utilizing the color property of the CFXPointAttributes class.
Declared In
ChartFX.h
originalPosition
Returns the original position of the item in the SeriesAttributes Collection.
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 Pane which will be used by the series by default.
Declared In
ChartFX.h
pattern
Gets or sets the Pattern for all the series in a chart.
Discussion
To use this property, you must make sure the fillMode is set to either Monochrome or Pattern.
If the FillMode is set to Pattern you can set both the background and foreground color of the pattern with the color and alternateColor properties, respectively.
For more information regarding the HatchStyle type, please refer to the Xcode and Objective-C Documentation.
This property applies to all series. You can then override this value by setting the same property for a specific series.
Declared In
ChartFX.h
picture
Gets or sets a value specifying the picture associated to the selected item.
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.
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.
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 the Stacked style in the chart.
Discussion
This property applies to BAR or AREA charts only.
This property applies the stacked style to all series in the chart. Chart FX for iOS also support multistacked charts where you can stack series by pairs. For more information, please refer to the stacked property in the series object.
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.
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.
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
visible
Shows or hides all the Series.
Discussion
Hiding the all Series does not destroy or lose previous settings assigned by other properties.
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.
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
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
CFXHatchStyle
Specifies the different hatch patterns available.
typedef enum { CFXBackwardDiagonal, CFXCross, CFXDarkDownwardDiagonal, CFXDarkHorizontal, CFXDarkUpwardDiagonal, CFXDarkVertical, CFXDashedDownwardDiagonal, CFXDashedHorizontal, CFXDashedUpwardDiagonal, CFXDashedVertical, CFXDiagonalBrick, CFXDiagonalCross, CFXDivot, CFXDottedDiamond, CFXDottedGrid, CFXForwardDiagonal, CFXHorizontal, CFXHorizontalBrick, CFXLargeCheckerBoard, CFXLargeConfetti, CFXLargeGrid, CFXLightDownwardDiagonal, CFXLightHorizontal, CFXLightUpwardDiagonal, CFXLightVertical, CFXMax, CFXMin, CFXNarrowHorizontal, CFXNarrowVertical, CFXOutlinedDiamond, CFXPercent05, CFXPercent10, CFXPercent20, CFXPercent25, CFXPercent30, CFXPercent40, CFXPercent50, CFXPercent60, CFXPercent70, CFXPercent75, CFXPercent80, CFXPercent90, CFXPlaid, CFXShingle, CFXSmallCheckerBoard, CFXSmallConfetti, CFXSmallGrid, CFXSolidDiamond, CFXSphere, CFXTrellis, CFXVertical, CFXWave, CFXWeave, CFXWideDownwardDiagonal, CFXWideUpwardDiagonal, CFXZigZag } CFXHatchStyle;
Constants
CFXBackwardDiagonal
- A pattern of lines on a diagonal from upper right to lower left.
CFXCross
- Specifies horizontal and vertical lines that cross.
CFXDarkDownwardDiagonal
- Specifies diagonal lines that slant to the right from top points to bottom points, are spaced 50 percent closer together than, and are twice the width of ForwardDiagonal. This hatch pattern is not antialiased.
CFXDarkHorizontal
- Specifies horizontal lines that are spaced 50 percent closer together than Horizontal and are twice the width of HatchStyleHorizontal.
CFXDarkUpwardDiagonal
- Specifies diagonal lines that slant to the left from top points to bottom points, are spaced 50 percent closer together than BackwardDiagonal, and are twice its width, but the lines are not antialiased.
CFXDarkVertical
- Specifies vertical lines that are spaced 50 percent closer together than Vertical and are twice its width.
CFXDashedDownwardDiagonal
- Specifies dashed diagonal lines, that slant to the right from top points to bottom points.
CFXDashedHorizontal
- Specifies dashed horizontal lines.
CFXDashedUpwardDiagonal
- Specifies dashed diagonal lines, that slant to the left from top points to bottom points.
CFXDashedVertical
- Specifies dashed vertical lines.
CFXDiagonalBrick
- Specifies a hatch that has the appearance of layered bricks that slant to the left from top points to bottom points.
CFXDiagonalCross
- Specifies forward diagonal and backward diagonal lines that cross. The lines are antialiased.
CFXDivot
- Specifies a hatch that has the appearance of divots.
CFXDottedDiamond
- Specifies forward diagonal and backward diagonal lines, each of which is composed of dots, that cross.
CFXDottedGrid
- Specifies horizontal and vertical lines, each of which is composed of dots, that cross.
CFXForwardDiagonal
- A pattern of lines on a diagonal from upper left to lower right.
CFXHorizontal
- A pattern of horizontal lines.
CFXHorizontalBrick
- Specifies a hatch that has the appearance of horizontally layered bricks.
CFXLargeCheckerBoard
- Specifies a hatch that has the appearance of a checkerboard with squares that are twice the size of SmallCheckerBoard.
CFXLargeConfetti
- Specifies a hatch that has the appearance of confetti, and is composed of larger pieces than SmallConfetti.
CFXLargeGrid
- Specifies the hatch style Cross.
CFXLightDownwardDiagonal
- Specifies diagonal lines that slant to the right from top points to bottom points and are spaced 50 percent closer together than DownwardDiagonal, but they are not antialiased.
CFXLightHorizontal
- Specifies horizontal lines that are spaced 50 percent closer together than Horizontal.
CFXLightUpwardDiagonal
- Specifies diagonal lines that slant to the left from top points to bottom points and are spaced 50 percent closer together than BackwardDiagonal, but they are not antialiased.
CFXLightVertical
- Specifies vertical lines that are spaced 50 percent closer together than Vertical.
CFXMax
- Specifies hatch style SolidDiamond.
CFXMin
- Specifies hatch style Horizonal.
CFXNarrowHorizontal
- Specifies horizontal lines that are spaced 75 percent closer together than hatch style Horizontal (or 25 percent closer together than LightHorizontal).
CFXNarrowVertical
- Specifies vertical lines that are spaced 75 percent closer together than hatch style Vertical (or 25 percent closer together than LightVertical).
CFXOutlinedDiamond
- Specifies forward diagonal and backward diagonal lines that cross but are not antialiased.
CFXPercent05
- Specifies a 5-percent hatch. The ratio of foreground color to background color is 5:100.
CFXPercent10
- Specifies a 10-percent hatch. The ratio of foreground color to background color is 10:100.
CFXPercent20
- Specifies a 20-percent hatch. The ratio of foreground color to background color is 20:100.
CFXPercent25
- Specifies a 25-percent hatch. The ratio of foreground color to background color is 25:100.
CFXPercent30
- Specifies a 30-percent hatch. The ratio of foreground color to background color is 30:100.
CFXPercent40
- Specifies a 40-percent hatch. The ratio of foreground color to background color is 40:100.
CFXPercent50
- Specifies a 50-percent hatch. The ratio of foreground color to background color is 50:100.
CFXPercent60
- Specifies a 60-percent hatch. The ratio of foreground color to background color is 60:100.
CFXPercent70
- Specifies a 70-percent hatch. The ratio of foreground color to background color is 70:100.
CFXPercent75
- Specifies a 75-percent hatch. The ratio of foreground color to background color is 75:100.
CFXPercent80
- Specifies a 80-percent hatch. The ratio of foreground color to background color is 80:100.
CFXPercent90
- Specifies a 90-percent hatch. The ratio of foreground color to background color is 90:100.
CFXPlaid
- Specifies a hatch that has the appearance of a plaid material.
CFXShingle
- Specifies a hatch that has the appearance of diagonally-layered shingles that slant to the right from top points to bottom points.
CFXSmallCheckerBoard
- Specifies a hatch that has the appearance of a checkerboard.
CFXSmallConfetti
- Specifies a hatch that has the appearance of confetti.
CFXSmallGrid
- Specifies horizontal and vertical lines that cross and are spaced 50 percent closer together than hatch style Cross.
CFXSolidDiamond
- Specifies a hatch that has the appearance of a checkerboard placed diagonally.
CFXSphere
- Specifies a hatch that has the appearance of spheres laid adjacent to one another.
CFXTrellis
- Specifies a hatch that has the appearance of a trellis.
CFXVertical
- A pattern of vertical lines.
CFXWave
- Specifies horizontal lines that are composed of tildes.
CFXWeave
- Specifies a hatch that has the appearance of a woven material.
CFXWideDownwardDiagonal
- Specifies diagonal lines that slant to the right from top points to bottom points, have the same spacing as hatch style ForwardDiagonal, and are triple its width, but are not antialiased.
CFXWideUpwardDiagonal
- Specifies diagonal lines that slant to the left from top points to bottom points, have the same spacing as hatch style BackwardDiagonal, and are triple its width, but are not antialiased.
CFXZigZag
- Specifies horizontal lines that are composed of zigzags.
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
Declared In
chartfx.h
CFXStacked
Defines the stacked style in the chart.
typedef enum { CFXNo, CFXNormal, CFXStacked100 } CFXStacked;
Constants
Declared In
chartfx.h