CFXDockableBar Class Reference

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

Overview

The background color may be modified using the backColor property.

Using the dock property, you can dock the bar in different areas of the CFXChart.

You must make the bar visible in order to see any of the visual attributes configured using the properties of the class.

Properties

autoSize

Allows Chart FX for iOS to calculate the best size according to the tool position.

@property(nonatomic) BOOL autoSize
Discussion

The width and height properties may be used to manually control the size of a DockableBar, however they should only be used when the AutoSize is configured to NO.

The dock property may be used to position a DockableBar object in a chart.

Declared In
ChartFX.h

backColor

Gets or sets a value for the background color of a dockable bar.

@property(nonatomic) UIColor backColor
Discussion

The effect of this property is to change the background behind any dockable bar object such as the LegendBox.

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

Declared In
ChartFX.h

border

Allows the developer to specify the border style.

@property(nonatomic) CFXDockBorder border
Declared In
ChartFX.h

dock

Gets or sets the tool position.

@property(nonatomic) CFXDockArea dock
Availability
  • Available in iOS 5.0 and later.
Declared In
ChartFX.h

height

Gets or sets the height of the dockable bar in pixels.

@property(nonatomic) int height
Discussion

When you modify the height, the autoSize property will be set to NO.

Use the Height property to configure the height for the dockable bar object.

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

visible

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

@property(nonatomic) BOOL visible
Discussion

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

Declared In
ChartFX.h

width

Sets the height in pixels.

@property(nonatomic) int width
Discussion

When you modify the width, the autoSize property will be set to NO.

Declared In
ChartFX.h

zOrder

Gets or sets the z-order for a dockable bar.

@property(nonatomic) int zOrder
Discussion

Using this property, developers can control the order of Dockable bar objects in a chart.

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

CFXDockBorder

Sets the Docking style for Border of the selected object.

typedef enum {
   CFXNone,
   CFXExternal,
   CFXInternal
} CFXDockBorder;
Constants
CFXNone
No border used is used.
CFXExternal
External border used for the selected object.
CFXInternal
Internal border used for the selected object.
Declared In
chartfx.h