CFXTitleDockable Class Reference

Inherits from	CFXTitle
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 TitleDockable class provides the developer with a means of controlling positioning and alignment for configured titles in a chart as well as visual attributes.

Using the supported members, you can adjust title strings to be center, near and fear as well as dock them in the right, left, top, or bottom of the chart.

To dock a title or use line alignment attributes, chart title objects must be created as a TitleDockable rather than a general CFXTitle object.

Properties

alignment

Allows you to set the alignment of the specified title.

@property(nonatomic) CFXStringAlignment alignment

Discussion

The Alignment property may also be used for Axis title by utilizing the CFXAxis class.

The lineAlignment property can be used to position the top title vertically in the title area.

Declared In


ChartFX.h

dock

Sets or Gets the Dock property, which sets the position where the title will be docked.

@property(nonatomic) CFXDockArea dock

Discussion

This property allows you to dock the chart title at the top, bottom, left or right of the chart.

Declared In


ChartFX.h

indentation

Specifies the space in pixels to the front and back of the selected title when read from top to bottom.

@property(nonatomic) int indentation

Declared In


ChartFX.h

lineAlignment

Gets or sets the vertical alignment for the lines of the chart title.

@property(nonatomic) CFXStringAlignment lineAlignment

Discussion

By changing the LineAlignment value, you can control the distance from the title to the chart.

The alignment property allows you set the title left, center or right justified in the chart.

Declared In


ChartFX.h

plotAreaOnly

Gets or sets a value indicating whether the title may use the entire length of the chart, or only above the plot area.

@property(nonatomic) BOOL plotAreaOnly

Discussion

When set to YES, the title header is the same width as the chart's plot area. When set to NO, title may be drawn across the entire chart including margins.

When using the alignment property, the PlotAreaOnly property will affect the position of the text when configured to Near or Far.

Declared In


ChartFX.h

separation

Specifies the space in pixels above and below the selected title text when read from right to left.

@property(nonatomic) int separation

Discussion

The indentation property may be used to add space in pixels to the front and back of the title string when read from right to left.

Declared In


ChartFX.h

text

Gets or sets the text for the selected title.

@property(nonatomic) NSString *text

Discussion

The textColor property allows you to change the color of the specified title text.

Declared In


ChartFX.h

Constants

CFXDockArea

Define how to set the docked selected tool position.

typedef enum {
   CFXLeft,
   CFXTop,
   CFXRight,
   CFXBottom
} CFXDockArea;

Constants

CFXLeft: Docks the object to the left margin.
CFXTop: Docks the object to the top margin.
CFXRight: Docks the object to the right margin.
CFXBottom: Docks the object to the bottom margin.

Declared In


			  chartfx.h

CFXStringAlignment

The StringAlignment type specifies how a string is aligned in reference to the bounding rectangle. A bounding rectangle is used to define the area in which the text displays.

typedef enum {

} CFXStringAlignment;

Constants

CFX: Specifies that alignment is towards the origin of the bounding rectangle. May be used for alignment of characters along the line or for alignment of lines within the rectangle. For a right to left bounding rectangle, the origin is at the upper right.
CFX: Specifies that alignment is centered between origin and extent (width) of the formatting rectangle.
CFX: Specifies that alignment is to the far extent (right side) of the formatting rectangle.

Declared In


			  chartfx.h