ChartModifiers

Data Structures

class  SCIAxisDragModifierBase
 The SCIAxisDragModifierBase class. More...
 
class  SCIAxisPinchZoomModifier
 The SCIAxisPinchZoomModifier class. More...
 
class  SCIXAxisDragModifier
 The SCIXAxisDragModifier class. More...
 
class  SCIYAxisDragModifier
 The SCIYAxisDragModifier class. More...
 
class  SCIPieSelectionModifier
 Selection modifier for SCIPieRenderableSeries and SCIDonutRednerableSeries. More...
 
class  SCIPieTooltipModifier
 The SCITooltipModifier class. More...
 
class  SCIChartModifierBase
 
class  SCIChartModifierCollection
 
category  SCIChartModifierCollection(Indexing)
 
protocol  <SCIChartModifierProtocol>
 
class  SCICollectionViewLeftAlignedLayout
 
protocol  <UICollectionViewDelegateLeftAlignedLayoutProtocol>
 Just a convenience protocol to keep things consistent. More...
 
class  SCIGestureController
 
class  SCIGestureModifier
 
protocol  <SCILegendCellProtocol>
 
class  SCILegendCell
 The class is used in SCILegendCollectionModifier to visualize SCILegendItem. More...
 
class  SCILegendModifier
 Defines a custom chart modifier which shows a Legend on the SCIChartSurface and also can provide a data-source via SCILegendModifier::sourceMode property. More...
 
class  SCIMultiSurfaceModifier
 
class  SCIPieLegendModifier
 Defines a custom chart modifier which shows a Legend on the SCIPieChartSurface and also can provide a data-source via SCILegendModifier::sourceMode property. More...
 
class  SCISeriesSelectionModifier
 
class  SCIPinchZoomModifier
 
class  SCIRelativeZoomModifierBase
 
class  SCIZoomExtentsModifier
 
class  SCIZoomPanModifier
 
class  SCIZoomPanModifierBase
 
class  SCICursorModifier
 The SCICursorModifier class. More...
 
class  SCIRolloverModifier
 The SCIRolloverModifier class. More...
 
class  SCITooltipDataView
 
class  SCITooltipModifier
 The SCITooltipModifier class. More...
 
class  SCITooltipView
 

Typedefs

typedef void(^ SCILegendCheckAction) (SCILegendItem *legendItem, BOOL checked)
 
typedef void(^ SCILegendCheckAction) (SCILegendItem *_Nonnull legendItem, BOOL checked)
 

Enumerations

enum  SCIPieSelectionModifierSelectionMode : NSUInteger { SCIPieSelectionModifierSelectionMode_SingleSelectDeselectOnMiss, SCIPieSelectionModifierSelectionMode_SingleSelectDeselectOnDoubleTap, SCIPieSelectionModifierSelectionMode_MultiSelectDeselectOnMiss, SCIPieSelectionModifierSelectionMode_MultiSelectDeselectOnDoubleTap }
 Enum of SCIPieSelectionModifier selection modes. More...
 
enum  SCISelectionModifierSelectionMode : NSUInteger { SCISelectionModifierSelectionMode_SingleSelectDeselectOnMiss, SCISelectionModifierSelectionMode_SingleSelectDeselectOnDoubleTap, SCISelectionModifierSelectionMode_MultiSelectDeselectOnMiss, SCISelectionModifierSelectionMode_MultiSelectDeselectOnDoubleTap }
 
enum  SCICursorModifierBehaviourEnum : NSUInteger { SCICursorModifierBehaviour_Default, SCICursorModifierBehaviour_ShowOnTouch }
 Enum defines options for SCICursorModifier reactions on gestures and touches. More...
 
enum  SCIRolloverModifierBehaviourEnum : NSUInteger { SCIRolloverModifierBehaviour_Default, SCIRolloverModifierBehaviour_ShowOnTouch }
 Enum defines options for SCIRolloverModifier reactions on gestures and touches. More...
 
enum  SCITooltipModifierBehaviourEnum : NSUInteger { SCITooltipModifierBehaviour_Default, SCITooltipModifierBehaviour_ShowOnTouch }
 Enum defines options for SCITooltipModifier reactions on gestures and touches. More...
 

Variables

void setCustomStyleForCell
 The method are used in SCILegendCollectionModifier for setting style of cell. More...
 
_Nonnull instancetype initWithRenderebleSeries
 An instance of SCILegendItem should be created by the initializer. More...
 
nullable SCILegendCheckAction checkActionHandler
 
void setCheckActionHandler
 
void setupWithItem
 Configurate view with model of renderable series. More...
 
nullable NSString * nibName
 Name of nib for creating instance of the class from xib file with all needed constraints. More...
 
void setCustomStyleForCell
 Configurate view with custom style. More...
 
instancetype initWithPosition
 @abstract Call the init for setting default position and orientation of the LegendView. More...
 
void layoutPositionOfHolderView
 Call the method when need to define new location for the holderLegendView on the chart surface. More...
 
void generateDataSourceAndSetDataSource
 

Properties

__deprecated_msg("Please use custom SCIDefaultLegendItemBase or it's inheritors instead.") @interface SCILegendItemView IBOutlet UIView * markerView
 The class is used in SCILegendCollectionModifier to visualize SCILegendItem. More...
 
IBOutlet UILabel * seriesNameLabel
 Font and text color can be changed in seriesNameLabel. More...
 
__deprecated_msg("This is no longer used as a model of data for SCIPieLegendModifier.") @interface SCIPieLegendItem SCIPieSegmentsegment
 SCIPieLegendItem model of data which will be shown in pie legend modifier. More...
 
__deprecated_msg("Please use custom ctor of SCILegendDataSource which takes legendItemXibName as a parameter which will be used as fully customized legend item.") @interface SCILegendCellStyle UIColor * seriesNameTextColor
 The class allows editng style of default cell. More...
 
UIImage * checkedBoxImage
 The image is used for checkBoxButton of SCILegendCell instance for UIControlStateSelected. More...
 
UIImage * uncheckedBoxImage
 The image is used for checkBoxButton of SCILegendCell instance for UIControlStateNormal. More...
 
CGFloat borderWidthMarkerView
 Border width of markerView of SCILegendCell instance. More...
 
UIColor * borderColorMarkerView
 Border color of markerView of SCILegendCell instance. More...
 
CGFloat cornerRadiusMarkerView
 Corner radius of markerView of SCILegendCell instance. More...
 
CGSize sizeMarkerView
 Size of markerView of SCILegendCell instance. More...
 
__deprecated_msg("This is no longer used as a model of data for SCILegendModifier") @interface SCILegendItem BOOL isVisible
 SCILegendItem model of data which will be shown in legend modifier. More...
 
BOOL isSelected
 If dataSeries is selected on chartSurface the property will be YES. More...
 
BOOL showMarker
 It is used in SCILegendCell for showing markerView or not. More...
 
BOOL showCheckBoxes
 It is used in SCILegendCell for showing checkBoxButton or not. More...
 
NSString * seriesName
 It is used in SCILegendCell for showing series name. More...
 
id< SCIRenderableSeriesProtocolrenderebleSeries
 Renderable series which is used for generating data upper. More...
 
__deprecated_msg("This is no longer used as a base class for SCILegendModifier") @interface SCILegendModifierBase SCIOrientation orientation
 Class SCILegendModifier - defines base functionality of legend modifier. More...
 
SCISourceMode sourceMode
 Filtering of which data series legend must be shown on the legend. More...
 
BOOL showCheckBoxes
 Show check boxes. More...
 
BOOL showSeriesMarkers
 Show series marker. More...
 
NSArray< SCILegendItem * > * dataSource
 Array of SCILegendItem which will be displayed on the legend. More...
 
UIView * holderLegendView
 The root view of legend. More...
 
CGSize preferredMaxSize
 Preferred max size of holder view for legend. More...
 

Detailed Description

Typedef Documentation

◆ SCILegendCheckAction [1/2]

typedef void(^ SCILegendCheckAction) (SCILegendItem *legendItem, BOOL checked)

◆ SCILegendCheckAction [2/2]

typedef void(^ SCILegendCheckAction) (SCILegendItem *_Nonnull legendItem, BOOL checked)

Enumeration Type Documentation

◆ SCICursorModifierBehaviourEnum

Enum defines options for SCICursorModifier reactions on gestures and touches.

See also
SCICursorModifier
Enumerator
SCICursorModifierBehaviour_Default 

modifier will show on pan gesture and disappear on release

SCICursorModifierBehaviour_ShowOnTouch 

annotation will show on touch, move on pan and disappear on release

◆ SCIPieSelectionModifierSelectionMode

Enum of SCIPieSelectionModifier selection modes.

Enumerator
SCIPieSelectionModifierSelectionMode_SingleSelectDeselectOnMiss 

Can be selected only one sector at time.

Sector will be deselected on miss

SCIPieSelectionModifierSelectionMode_SingleSelectDeselectOnDoubleTap 

Can be selected only one sector at time.

Sector will be deselected on double tap

SCIPieSelectionModifierSelectionMode_MultiSelectDeselectOnMiss 

Can be selected multiple sectors.

Sectors will be deselected on miss

SCIPieSelectionModifierSelectionMode_MultiSelectDeselectOnDoubleTap 

Can be selected multiple sectors.

Sectors will be deselected on double tap

◆ SCIRolloverModifierBehaviourEnum

Enum defines options for SCIRolloverModifier reactions on gestures and touches.

See also
SCIRolloverModifier
Enumerator
SCIRolloverModifierBehaviour_Default 

modifier will show on pan gesture and disappear on release

SCIRolloverModifierBehaviour_ShowOnTouch 

annotation will show on touch, move on pan and disappear on release

◆ SCISelectionModifierSelectionMode

Enumerator
SCISelectionModifierSelectionMode_SingleSelectDeselectOnMiss 
SCISelectionModifierSelectionMode_SingleSelectDeselectOnDoubleTap 
SCISelectionModifierSelectionMode_MultiSelectDeselectOnMiss 
SCISelectionModifierSelectionMode_MultiSelectDeselectOnDoubleTap 

◆ SCITooltipModifierBehaviourEnum

Enum defines options for SCITooltipModifier reactions on gestures and touches.

See also
SCITooltipModifier
Enumerator
SCITooltipModifierBehaviour_Default 

modifier will show on pan gesture and disappear on release

SCITooltipModifierBehaviour_ShowOnTouch 

annotation will show on touch, move on pan and disappear on release

Variable Documentation

◆ checkActionHandler

nullable SCILegendCheckAction checkActionHandler

◆ generateDataSourceAndSetDataSource

void generateDataSourceAndSetDataSource

◆ initWithPosition

instancetype initWithPosition

@abstract Call the init for setting default position and orientation of the LegendView.

Parameters
position- defines a position of legend on chart surface, if it is set in SCILegendPositionNone, the legend will not be placed on chart surface.
orientation- defines orientation of content on the legend.

◆ initWithRenderebleSeries

_Nonnull instancetype initWithRenderebleSeries

An instance of SCILegendItem should be created by the initializer.

Parameters
seriesis renderebleSeries which sets renderebleSeries property, markerColor, seriesName, isVisible.
See also
SCILegendCell

◆ layoutPositionOfHolderView

void layoutPositionOfHolderView

Call the method when need to define new location for the holderLegendView on the chart surface.

It can be helpfull when you change size of the holderLegendView.

◆ nibName

nullable NSString* nibName

Name of nib for creating instance of the class from xib file with all needed constraints.

Return nil if the class does not have xib.

Returns
nib name.

◆ setCheckActionHandler

void setCheckActionHandler

◆ setCustomStyleForCell [1/2]

void setCustomStyleForCell
optional

Configurate view with custom style.

Called when legend modifier has own style.

◆ setCustomStyleForCell [2/2]

void setCustomStyleForCell

The method are used in SCILegendCollectionModifier for setting style of cell.

See also
SCILegendCollectionModifier

◆ setupWithItem

void setupWithItem

Configurate view with model of renderable series.

Parameters
itemSCILegendItem

Properties

◆ borderColorMarkerView

UIColor* borderColorMarkerView
readwritenonatomicassign

Border color of markerView of SCILegendCell instance.

Default is [UIColor whiteColor]

See also
SCILegendCell

◆ borderWidthMarkerView

CGFloat borderWidthMarkerView
readwritenonatomicassign

Border width of markerView of SCILegendCell instance.

Default is 0.5f

See also
SCILegendCell

◆ checkedBoxImage

UIImage* checkedBoxImage
readwritenonatomicassign

The image is used for checkBoxButton of SCILegendCell instance for UIControlStateSelected.

Default is [UIImage imageNamed:"checked_checkbox"]

See also
SCILegendCell

◆ cornerRadiusMarkerView

CGFloat cornerRadiusMarkerView
readwritenonatomicassign

Corner radius of markerView of SCILegendCell instance.

Default is 5.0f

See also
SCILegendCell

◆ dataSource

NSArray<SCILegendItem *>* dataSource
readwritenonatomicassign

Array of SCILegendItem which will be displayed on the legend.

See also
SCILegendShowSeries

◆ holderLegendView

UIView* holderLegendView
readnonatomicassign

The root view of legend.

◆ isSelected

BOOL isSelected
readwritenonatomicassign

If dataSeries is selected on chartSurface the property will be YES.

It is used in SCILegendCell for checking box.

See also
SCILegendCell

◆ isVisible

__deprecated_msg ("This is no longer used as a model of data for SCILegendModifier") @interface SCILegendItem BOOL isVisible
readwritenonatomicassign

SCILegendItem model of data which will be shown in legend modifier.

And those items are generated in SCILegendModifier.

See also
SCILegendModifierMarkerColor - is color of series. Uses in SCILegendCell for background of markerView property.
SCILegendCellIf dataSeries is visible on chartSurface the property will be YES. It is used in SCILegendCell for checking box.
SCILegendCell

◆ markerView

__deprecated_msg ("Please use custom SCIDefaultLegendItemBase or it's inheritors instead.") @interface SCILegendItemView IBOutlet UIView* markerView
readwritenonatomicweak

The class is used in SCILegendCollectionModifier to visualize SCILegendItem.

See also
SCILegendCollectionModifier
SCILegendItemNew images for states can be set in SCILegendCellStyle which is property of SCILegendCollectionModifier. Also it can be hidden if set property showCheckBoxes = NO.
SCILegendCollectionModifier *legendModifier = [SCILegendCollectionModifier new];
legendModifier.showCheckBoxes = NO;
legendModifier.styleOfItemCell.checkedBoxImage = [UIImage new];
legendModifier.styleOfItemCell.uncheckedBoxImage = [UIImage new];
SCILegendCellStyle
SCILegendCollectionModifier
SCILegenModifierThe size can be set in SCILegendCellStyle which is property of SCILegendCollectionModifier. Also it can be hidden if set property showSeriesMarkers = NO.
SCILegendCollectionModifier *legendModifier = [SCILegendCollectionModifier new];
legendModifier.showSeriesMarkers = NO;
legendModifier.styleOfItemCell.sizeMarkerView = CGSizeMake(320.f, 320.f);
SCILegendCellStyle
SCILegendCollectionModifier
SCILegenModifier

◆ orientation

__deprecated_msg ("This is no longer used as a base class for SCILegendModifier") @interface SCILegendModifierBase SCIOrientation orientation
readwritenonatomicassign

Class SCILegendModifier - defines base functionality of legend modifier.

e.g Defines a position, generates dataSource, orientation.Position on surfaceChart. Default is SCILegendPositionTop|SCILegendPositionLeft.

See also
SCILegendPositionOrientation of content on the legend. Default is SCIOrientationVertical
SCIOrientation

◆ preferredMaxSize

CGSize preferredMaxSize
readwritenonatomicassign

Preferred max size of holder view for legend.

You can limit size of frame for legend view by setting this property. Default CGSize(.0f, .0f) - means holder view will have max size equal to chartsurface view size.

◆ renderebleSeries

id<SCIRenderableSeriesProtocol> renderebleSeries
readassign

Renderable series which is used for generating data upper.

Also the renderable series is used for changing visibility of renderebleSeries on chartSurface.

See also
SCILegendCell

◆ segment

__deprecated_msg ("This is no longer used as a model of data for SCIPieLegendModifier.") @interface SCIPieLegendItem SCIPieSegment* segment
readwritenonatomicweak

SCIPieLegendItem model of data which will be shown in pie legend modifier.

And those items are generated in SCILegendModifier.

See also
SCIPieLegendModifierAn instance of SCIPieLegendItem should be created by the initializer.
Parameters
segmentis SCIPieSegment which sets segment property
See also
SCILegendCellPie segment which is used for generating data
SCIPieSegment

◆ seriesName

NSString* seriesName
readwritenonatomicassign

It is used in SCILegendCell for showing series name.

See also
SCILegendCell

◆ seriesNameLabel

IBOutlet UILabel* seriesNameLabel
readwritenonatomicweak

Font and text color can be changed in seriesNameLabel.

SCILegendCollectionModifier *legendModifier = [SCILegendCollectionModifier new];
legendModifier.styleOfItemCell.seriesNameFont = [UIFont fontWithName:@"Helvetica" size:16.f];
legendModifier.styleOfItemCell.seriesNameTextColor = [UIColor grayColor];
See also
SCILegendCellStyle
SCILegendCollectionModifier
SCILegenModifier

◆ seriesNameTextColor

__deprecated_msg ("Please use custom ctor of SCILegendDataSource which takes legendItemXibName as a parameter which will be used as fully customized legend item.") @interface SCILegendCellStyle UIColor* seriesNameTextColor
readwritenonatomicassign

The class allows editng style of default cell.

New instance of SCILegendCellStyle should be set into property styleOfItemCell of SCILegendCollectionModifier instance.

See also
SCILegendCollectionModifierFont name for seriesNameLabel on SCILegendCell. Default is [UIFont fontWithName:"Helvetica" size:18.f]
SCILegendCellText color for seriesNameLabel on SCILegendCell. Default is [UIColor darkTextColor]
SCILegendCell

◆ showCheckBoxes [1/2]

BOOL showCheckBoxes
readwritenonatomicassign

Show check boxes.

Default is YES.

◆ showCheckBoxes [2/2]

BOOL showCheckBoxes
readwritenonatomicassign

It is used in SCILegendCell for showing checkBoxButton or not.

See also
SCILegendCell

◆ showMarker

BOOL showMarker
readwritenonatomicassign

It is used in SCILegendCell for showing markerView or not.

See also
SCILegendCell

◆ showSeriesMarkers

BOOL showSeriesMarkers
readwritenonatomicassign

Show series marker.

Default is YES.

◆ sizeMarkerView

CGSize sizeMarkerView
readwritenonatomicassign

Size of markerView of SCILegendCell instance.

Default is CGSizeMake(15.0f, 15.0f)

See also
SCILegendCell

◆ sourceMode

SCISourceMode sourceMode
readwritenonatomicassign

Filtering of which data series legend must be shown on the legend.

Default is SCILegendShowSeriesAll.

See also
SCILegendShowSeries

◆ uncheckedBoxImage

UIImage* uncheckedBoxImage
readwritenonatomicassign

The image is used for checkBoxButton of SCILegendCell instance for UIControlStateNormal.

Default is [UIImage imageNamed:"unchecked_checkbox"]

See also
SCILegendCell