CFXCondition Class Reference

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

Overview

The supported members of the Condition class allow you to customize the conditions for a CFXConditionalAttributes. This includes the range for a data value to meet the requirements for the ConditionalAttribute, if the ConditionalAttribute will be active, etc.

In order to use this functionality you must include jchartfx.advanced.js in your project.

Properties

active

A boolean property indicating whether the specified ConditionalAttribute is enabled or disabled.

@property(nonatomic) BOOL active
Availability
  • Available in iOS 5.0 and later.
See Also
Declared In
ChartFX.h

dataElement

Gets or sets the data value that the specified ConditionalAttribute will evaluate.

@property(nonatomic) CFXDataElement dataElement
Discussion

By default, the YValue for the chart is evaluated for a condition. You can use this property to select to evaluate the IniValue or XValue for each point contained in the chart.

Use the active property to specify if a selected ConditionalAttributes object may be applied to a chart.

The to property is used to specify the ending value of the conditional range for a selected CFXConditionalAttributes object. The toOpen property indicates whether or not to include the configured to value in the range.

The from property is used to specify the beginning value of the conditional range for a selected CFXConditionalAttributes object. The fromOpen property indicates whether or not to include the configured from value in the range.

Use the inverse property to reverse the configured to and from attributes and create the opposite condition configured.

Declared In
ChartFX.h

from

Represents a value indicating the beginning value of the conditional range for a CFXConditionalAttributes object.

@property(nonatomic) double from
Discussion

By default, the From value is not included. To include it, set the fromOpen property to texttextYES.

Declared In
ChartFX.h

fromOpen

A boolean indicating whether or not to include the configured from value in the range.

@property(nonatomic) BOOL fromOpen
Discussion

The default value is false.

Declared In
ChartFX.h

inverse

Represents a value indicating whether to reverse the configured to and from attributes for a selected ConditionalAttributes object.

@property(nonatomic) BOOL inverse
Discussion

The to property gets or sets a value indicating the ending value of the conditional range for a selected CFXConditionalAttributes object. The ToOpen property is a boolean indicating whether or not to include the configured to value in the range.

The from property gets or sets a value indicating the beginning value of the conditional range for a selected CFXConditionalAttributes object. The fromOpen property is a boolean indicating whether or not to include the configured from value in the range.

Declared In
ChartFX.h

to

Represents a value indicating the ending value of the conditional range for a selected CFXConditionalAttributes object.

@property(nonatomic) double to
Discussion

By default, the To value is not included. To include it, set the toOpen property to true.

Declared In
ChartFX.h

toOpen

A boolean value indicating whether or not to include the configured to value in the range.

@property(nonatomic) BOOL toOpen
Discussion

The default value is false.

Declared In
ChartFX.h

Instance Methods

evaluateForValue:

Returns a boolean indicating whether or not the configured condition is met for a specified value.

- (BOOL)evaluateForValue:(double *)value
Parameters
value
Value to Evaluate.
Availability
  • Available in iOS 5.0 and later.
Declared In
ChartFX.h

Constants

CFXDataElement

Define how the chart should treat the different fields available in the result set.

typedef enum {
   CFXYValue,
   CFXXValue,
   CFXIniValue
} CFXDataElement;
Constants
CFXYValue
Instructs the chart to treat the selected field as a number. Therefore an additional data series.
CFXXValue
Instructs the chart to treat the selected field as a number to be used as the X axis coordinate. Use this option if you are creating XY Plots.
CFXIniValue
Instructs the chart to treat the selected field as a number to be used to set initial values for data points to achieve floating bars and area charts.
Declared In
chartfx.h