CWKConfiguration Class Reference

Inherits from	NSObject
Conforms to	NSXMLParserDelegate
Declared in	CWKConfiguration.h

Overview

This class is used to configure the theming of the CWKView.

There is a default theme set on initialization.

If you want to override certain properties, this can be done directly by setting the properties in code or by using an XML configuration file. See loadCustomConfigurationFromXML.

Warning: For any theme or configuration change to take effect you need to define your theme using this class before creating your CWKView and once the CWKView is created changing any of these properties will likely have no impact.

BOOL Yes / No

Declared In

CWKConfiguration.h

`– loadCustomConfigurationFromXML:`

Overwrites default CWKConfiguration color, string, and some bool values based on values from a configuration XML file. This allows for sharing common values between Android and iOS code bases. Configuration settings XML documents must start and end with Please see the example XML files in the Documentation\XML folder.

- (void)loadCustomConfigurationFromXML:(NSString *)xmlFileName

Return Value

void

Declared In

CWKConfiguration.h

`– loadCustomConfigurationFromData:`

Overwrites default CWKConfiguration color, string, and some bool values based on values from the NSData representation of a configuration XML file. An example use of this would be hosting a configuration XML file on a web service and passing the NSData representation of that in to update configuration settings to deployed apps.

- (void)loadCustomConfigurationFromData:(NSData *)configurationData

Return Value

void

Declared In

CWKConfiguration.h

Behaviors

`hideLowerChartWhenNoLowerIndicatorIsActive`

When enabled, the lower portion of the chart is hidden when there is no lower indicator requested. Default is YES

@property (nonatomic, assign) BOOL hideLowerChartWhenNoLowerIndicatorIsActive

Declared In

CWKConfiguration.h

`enableAutomaticYScalingLower`

Tells the chart to automatic change the range of the Y-Axis on the lower chart when panning or zooming. Default is YES

@property (nonatomic, assign) BOOL enableAutomaticYScalingLower

Declared In

CWKConfiguration.h

`indicatorPlusButtonShown`

Tells the chart to show/hide “+Indicator” buttons

When CWKUpperIndicatorPrice is an active indicator, the legend typically shows the nameShortPrice string. Setting this to YES will replace the button text with the base symbol displayString Default is NO

@property (nonatomic, assign) BOOL showDisplaySymbolInLegendInsteadOfNameShortPrice DEPRECATED_MSG_ATTRIBUTE ( "This is now on by default" )

Declared In

CWKConfiguration.h

`enableCrossHairTooltip`

Specifies if the SDK’s crosshair tooltip should be enabled. Set to NO to use a custom tooltip.

@property (nonatomic, assign) BOOL enableCrossHairTooltip

Discussion

Default is YES

If using a custom tooltip: - Set this property to NO - Implement CWKViewDelegate crosshairUpdatedWithData: and crosshairDidHide:

Declared In

CWKConfiguration.h

`crossHairFollowStyle`

Tells the chart how to display the view following algorithm when a cross hair is enabled (tap and hold on an indicator) * CWKCrossHairFollowStyle is set to CWKCrossHairFollowStyleViewTop by default
CWKCrossHairFollowStyleRight CWKCrossHairFollowStyleLeft CWKCrossHairFollowStyleTop CWKCrossHairFollowStyleCenter

@property (nonatomic, assign) CWKCrossHairFollowStyle crossHairFollowStyle

Declared In

CWKConfiguration.h

`crossHairPopupPosition`

@property (nonatomic, assign) BOOL disableAddOverlayButton

Declared In

CWKConfiguration.h

`eventsTappable`

Tells the chart to show Popover when Dividends, Splits, or Earnings are tapped

@property (nonatomic, assign) BOOL eventsTappable

Declared In

CWKConfiguration.h

`chartsDebug`

@property (nonatomic, assign) BOOL allowTimeZoneOffset

Declared In

CWKConfiguration.h

`shouldNormalizeComparisonTimeZone`

Tells the chart to align series to the same timezone, as if something in the London stock exchange was trading in
the same timezone as the New York. In effect, The chart will move the London symbol data several hours later so
London 8 AM shows on the chart as New York 8 AM. Setting this to ‘no’ means that everything will be plotted at the technically correct
time.
Note that this will only affect charts with intraday data.
Default = NO

@property (nonatomic, assign) BOOL shouldNormalizeComparisonTimeZone

Declared In

CWKConfiguration.h

`shouldMakeAllTradingDaysEqualLength`

Tells the chart to use the longest trading day as the prototype for all days of the week - ensuring each day takes up the same amount of space on the X-Axis. Note that this will only affect charts with intraday data. Default = NO;

@property (nonatomic, assign) BOOL shouldMakeAllTradingDaysEqualLength

Declared In

CWKConfiguration.h

`shouldShowGapsWhenMarketIsClosed`

By default, the chart will show gaps in line series to indicate when the market is closed.
If you would not like to see the these gaps, set this property to NO.
Note that this will only affect charts with intraday data.
Default = YES;

`extendedHours`

The extended hours configuration object with options related to extended hours.

@property (nonatomic, strong) CWKExtendedHoursConfiguration *extendedHours

Declared In

CWKConfiguration.h

CWKConfiguration.h

Resizing Gripper

`resizeGripperImage`

To enable a user to resize the upper and lower chart by simply moving their finger up and down, Set an a gripper image. The chart view will position the gripper image centered vertically between the upper and lower chart. Default = nil (no resizing gripper)

Busy screen that appears while network activity is ongoing. You may want to set a UIColor with opacity to a number less than 1.

`formatLocale`

@property (nonatomic, assign) BOOL showFirstLabelOfYearAsYear

Declared In

CWKConfiguration.h

X-Axis Tick Mark Settings

`xAxisTickLabelAlignment`

tickLabelAlignment - Customize the alignment of the tick labels relative to tick mark lines. Defaults to NSTextAlignmentCenter
NSTextAlignmentLeft NSTextAlignmentRight

@property (nonatomic, assign) NSTextAlignment xAxisTickLabelAlignment

Declared In

CWKConfiguration.h

`xAxisTickLabelOffset`

tickLabelOffset - Moves the tick label relative to the tick mark on the xAxis. Defaults to 0.

@property (nonatomic, assign) CGFloat xAxisTickLabelOffset

Declared In

CWKConfiguration.h

General Annotation Settings

`annotationEditImage`

The image used inside the button circle for the annotation’s Edit action, such as the text of a text annotation. Displayed when certain annotations are in edit mode.

@property (nonatomic, strong) UIImage *annotationEditImage

Declared In

CWKConfiguration.h

`annotationDeleteImage`

The image used inside the button circle for the annotation’s Delete action. Displayed when annotations are in edit mode.

@property (nonatomic, strong) UIImage *annotationDeleteImage

Declared In

CWKConfiguration.h

CWKConfiguration.h

`trendlineColorBasedOnSlope`

If YES, the color will be determined based on the slope of the trendline. Default is YES.

@property (nonatomic, assign) BOOL trendlineColorBasedOnSlope

Declared In

CWKConfiguration.h

`widthTrendline`

The width of the trendline. Default is 2.

The width of the line. Default is 2.

CWKConfiguration.h

Returns Calculator Settings

`returnsGestureMinimumPressDuration`

The time, in seconds, the gesture recognizer will wait before recognizing the touch event to display the Returns Calculator.

@property (nonatomic, assign) NSTimeInterval returnsGestureMinimumPressDuration

Declared In

CWKConfiguration.h

`disableReturnsGesture`

Disable the returns calculator (2 finger long press popup) with this flag

`showTrendLineOnFibonacciRetracement`

If YES, a trendline will be drawn to the corners of the Fibonacci retracement area.
The trendline will derive all of it’s properties from the normal trendline settings.
Default is YES

@property (nonatomic, assign) BOOL showTrendLineOnFibonacciRetracement

Declared In

CWKConfiguration.h

`showBoundingBoxOnFibonacciRetracement`

If YES, a border will be shown around the Fibonacci retracement area.
Default is NO

If YES, the Fibonacci retracement lines will display a label with their current values.
Default is YES

@property (nonatomic, assign) BOOL showPercentagesOnFibonacciRetracement

Declared In

CWKConfiguration.h

`showEndPercentagesOnFibonacciRetracement`

If YES, the Fibonacci retracement lines will display a label for 0% and 100% (start and end).
Default is YES

@property (nonatomic, assign) BOOL showEndPercentagesOnFibonacciRetracement

Declared In

CWKConfiguration.h

`showPercentagesAsDecimalsOnFibonacciRetracement`

If YES, the Fibonacci retracement labels will be shown as decimals instead of percentages (ex: 0.618 instead of 61.8%).
Default is NO

@property (nonatomic, assign) BOOL showPercentagesAsDecimalsOnFibonacciRetracement

Declared In

CWKConfiguration.h

`showYAxisValuesOnFibonacciRetracement`

If YES, the Y-Axis values will be shown on the Fibonacci retracement labels
Default is YES

@property (nonatomic, assign) BOOL showYAxisValuesOnFibonacciRetracement

Declared In

CWKConfiguration.h

`fibonacciRetracementInfiniteLength`

If YES, the Fibonacci Retracement will extend outward infinitely from the start point.
Default is YES

`showTrendLineOnFibonacciArc`

If YES, a trendline will be drawn to the corners of the Fibonacci Arc/Circle area.
The trendline will derive all of it’s properties from the normal trendline settings.
Default is YES

@property (nonatomic, assign) BOOL showTrendLineOnFibonacciArc

Declared In

CWKConfiguration.h

`showPercentagesOnFibonacciArc`

If YES, the Fibonacci Arc/Circle lines will display a label with their current values.
Default is YES

@property (nonatomic, assign) BOOL showPercentagesOnFibonacciArc

Declared In

CWKConfiguration.h

`showPercentagesAsDecimalsOnFibonacciArc`

If YES, the Fibonacci Arc/Circle labels will be shown as decimals instead of percentages (ex: 0.618 instead of 61.8%).
Default is NO

`colorEllipseLine`

The color of the ellipse line. Default is #FEA428

@property (nonatomic, strong) UIColor *colorEllipseLine

Declared In

CWKConfiguration.h

`widthEllipseLine`

The width of the ellipse line. Default is 2

@property (nonatomic, strong) NSNumber *widthEllipseLine

Declared In

CWKConfiguration.h

CWKConfiguration.h

Upper Chart Axes

`showUpperXAxis`

When enabled, the upper X axis area is shown. Defaults to YES

@property (nonatomic, assign) BOOL showUpperXAxis

Declared In

CWKConfiguration.h

`showUpperYAxis`

@property (nonatomic, assign) BOOL showXAxisMajorGridLinesUpper

Declared In

CWKConfiguration.h

`showYAxisMajorGridLinesUpper`

Show major gridlines on the upper chart’s Y-Axis. Defaults to YES.

@property (nonatomic, assign) BOOL showYAxisMajorGridLinesUpper

Declared In

CWKConfiguration.h

`majorGridLinesDashedUpper`

Major gridlines on upper chart use dashed style.

@property (nonatomic, assign) BOOL majorGridLinesDashedUpper

Declared In

CWKConfiguration.h

`widthMajorGridLinesDashedUpper`

The width of the dashes and spaces in the gridline when using dashed style. Default is 3
Width of 9 Width of 1

@property (nonatomic, strong) NSNumber *widthMajorGridLinesDashedUpper

Declared In

CWKConfiguration.h

`enableUpperXAxisMinorTicks`

For setting the location of the Y axis. If YES, it is on the right (the default)

@property (nonatomic, assign) BOOL positionUpperYAxisOnRight

Declared In

CWKConfiguration.h

`upperXAxisLeftDataInsetPercent`

Insets the leftmost data by a percentage of the data width. Defaults to .005 (.5%)

@property (nonatomic, assign) double upperXAxisLeftDataInsetPercent

Declared In

CWKConfiguration.h

`upperXAxisRightDataInsetPercent`

Insets the rightmost data by a percentage of the data width. Defaults to .005 (.5%)

@property (nonatomic, assign) double upperXAxisRightDataInsetPercent

Declared In

CWKConfiguration.h

`upperXAxisTickClippingEnabled`

When enabled, partial tick marks are omitted. Defaults to YES
tickClippingEnabled-YES tickClippingEnabled-NO

`colorYAxisLowerBackground`

Lower chart Y-Axis background color

@property (nonatomic, strong) UIColor *colorYAxisLowerBackground

Declared In

CWKConfiguration.h

`heightXAxisLower`

@property (nonatomic, strong) UIFont *fontLowerXAxisLabel

Declared In

CWKConfiguration.h

`fontLowerYAxisLabel`

Font of the lower chart Y-Axis

@property (nonatomic, strong) UIFont *fontLowerYAxisLabel

Declared In

CWKConfiguration.h

`widthXAxisLowerLine`

Width of the line separating the lower chart’s X-Axis from the chart area. Set to zero to hide the line.

@property (nonatomic, strong) NSNumber *widthXAxisLowerLine

Declared In

CWKConfiguration.h

`widthYAxisLowerLine`

Width of the line separating the lower chart’s Y-Axis from the chart area. Set to zero to hide the line.

Major gridlines on lower chart use dashed style.

Enable minor ticks on lower chart Y-Axis.

@property (nonatomic, assign) BOOL enableLowerYAxisMinorTicks

Declared In

CWKConfiguration.h

`lowerYAxisTickLabelAlignment`

Customize the alignment of the tick labels for the lower Y axis. Defaults to NSTextAlignmentLeft.
NSTextAlignmentCenter NSTextAlignmentRight

CWKConfiguration.h

Stock Price Colors and Sizing

`colorStyleCandlestickRising`

The color of rising candlesticks.

@property (nonatomic, strong) UIColor *colorStyleCandlestickRising

Declared In

CWKConfiguration.h

`colorStyleCandlestickFalling`

The color of falling candlesticks.

@property (nonatomic, strong) UIColor *colorStyleCandlestickFalling

Declared In

CWKConfiguration.h

`colorStyleCandlestickNoChange`

`upperIndicatorButtonStyle`

The indicator button style. The default is CWKIndicatorButtonStyleColorLeft
CWKIndicatorButtonStyleColorTop

The indicator button style. The default is CWKIndicatorButtonStyleColorLeft
CWKIndicatorButtonStyleColorTop

if YES lower indicators buttons will display indicator parameters. Default is YES.
YES

@property (nonatomic, assign) BOOL showLowerIndicatorParametersOnButton

Declared In

CWKConfiguration.h

`showUpperIndicatorParametersOnButton`

if YES upper indicators buttons will display indicator parameters Default is YES.
YES

@property (nonatomic, assign) BOOL showUpperIndicatorParametersOnButton

Declared In

CWKConfiguration.h

CWKConfiguration.h

CWKConfiguration.h

CWKConfiguration.h

`colorEventPopover`

The color of the text used in an event popover

@property (nonatomic, strong) UIColor *colorEventPopover

Declared In

CWKConfiguration.h

`fontEventPopover`

The font used in an even popover

@property (nonatomic, strong) UIFont *fontEventPopover

Declared In

CWKConfiguration.h

`widthCustomAnnouncementPopover`

widthCustomAnnouncementPopover

@property (nonatomic, assign) CGFloat widthCustomAnnouncementPopover

Declared In

CWKConfiguration.h

`textAlignCustomAnnouncementPopover`

textAlignCustomAnnouncementPopover

CWKConfiguration.h

CWKConfiguration.h