SCIStackedSeriesCollectionBase Class Reference

The SCIStackedGroupSeries class. More...

#import <SCIStackedSeriesCollectionBase.h>

Inheritance diagram for SCIStackedSeriesCollectionBase:
SCIRenderableSeriesBase <SCIThemeableProtocol> <SCIRenderableSeriesProtocol> <SCIThemeableProtocol> <SCIDrawableProtocol> SCIHorizontallyStackedColumnsCollection SCIVerticallyStackedColumnsCollection

Instance Methods

(void) - add:
 Method adds stacked series to drawing queue. More...
 
(void) - remove:
 Method removes stacked series from drawing queue. More...
 
(void) - removeAll
 Method removes all stacked series from drawing queue. More...
 
(SCIRenderPassData *) - renderDataForSeries:
 Returns updated SCIRenderPassData for particular SCIRenderableSeries. More...
 
(void) - updateRenderData:ForSeries:
 
(void) - addAnimation:
 Make the series animatable. More...
 
(void) - recalculateRenderDataForVerticalPlacement
 
- Instance Methods inherited from SCIRenderableSeriesBase
(BOOL) - isValidForDrawing
 If method returns false renderable series is not valid for drawing. More...
 
(float) - getDatapointWidthFrom:Amount:Calculator:WidthFraction:
 Returns data point width in pixels @discussion For internal use. More...
 
(void) - internalDrawWithContext:WithData:
 Method that implements renderable series drawing. More...
 
(void) - iterationInRenderPassData:withBlock:
 Method that iterates through data points @discussion For internal use @params renderPassData SCIRenderPassData contains all data required for drawing. More...
 
- Instance Methods inherited from <SCIRenderableSeriesProtocol>
(void) - addAnimation:
 The SCIRenderableSeriesProtocol class' property. More...
 
(void) - removeAnimation:
 Remove animation from queue, All animations automatically are removed from queue when they are finished, only repeatable animations are left. More...
 
(BOOL) - isValidForUpdate
 Checks whether this series is valid for update. More...
 
- Instance Methods inherited from <SCIDrawableProtocol>
(void) - onDrawAnimationWithContext:
 
(void) - onDrawWithContext:WithData:
 
(void) - prepareForDrawing
 
- Instance Methods inherited from <SCIThemeableProtocol>
(void) - applyThemeProvider:
 Applies specified theme to current instance. More...
 

Protected Attributes

NSMutableArray< id< SCIStackedRenderableSeriesProtocol > > * _series
 
NSMutableArray< id< SCIRenderPassDataProtocol > > * _renderData
 
BOOL _drawRequest
 
- Protected Attributes inherited from SCIRenderableSeriesBase
id< SCIPointSeriesProtocol_previousPointSeries
 
SCIAnimationsController_animationsController
 
SCIDataSeriesObserver_dataSeriesObserver
 

Properties

BOOL isOneHundredPercentSeries
 Defines mode for stacked series, if value is true data convert into percentage. More...
 
NSArray< id< SCIStackedRenderableSeriesProtocol > > * series
 
SCIDataSeriesObservercollectionDataSeriesObserver
 

Detailed Description

The SCIStackedGroupSeries class.

@discussion That series is not visible, but used for organization of drawing SCIStackedRenderableSeries that were added to it.

Remarks
Do not need any data, and do not have styles. Provide data and styles to attached SCIStackedRenderableSeries.
See also
SCIRenderableSeriesProtocol
SCIRenderableSeriesBase
SCIStackedRenderableSeriesProtocol

Method Documentation

◆ add:()

- (void) add: (id< SCIStackedRenderableSeriesProtocol >)  series

Method adds stacked series to drawing queue.

@discussion Order of adding matters, because usually data of stacked series is modified with data of all previous stacked series @params series SCIStackedRenderableSeriesProtocol to be drawn

◆ addAnimation:()

- (void) addAnimation: (id< SCIStackedSeriesCollectionAnimnationProtocol >)  animation

Make the series animatable.

After adding animation and then change data series of the renderable series make new data appear with animation. It is not thread safe method. It should be called only from main thread.

renderableSeries.addAnimation(SCIScaleRenderableSeriesAnimation(duration: 5, curveAnimation: SCIAnimationCurveEaseOut))
renderableSeries.dataSeries = newDataSeries
Parameters
animationsome base animation object which implements SCIStackedSeriesCollectionAnimnationProtocol.

◆ recalculateRenderDataForVerticalPlacement()

- (void) recalculateRenderDataForVerticalPlacement

◆ remove:()

- (void) remove: (id< SCIStackedRenderableSeriesProtocol >)  series

Method removes stacked series from drawing queue.

@params series SCIStackedRenderableSeriesProtocol to be removed

◆ removeAll()

- (void) removeAll

Method removes all stacked series from drawing queue.

◆ renderDataForSeries:()

- (SCIRenderPassData *) renderDataForSeries: (id< SCIRenderableSeriesProtocol >)  series

Returns updated SCIRenderPassData for particular SCIRenderableSeries.

◆ updateRenderData:ForSeries:()

- (void) updateRenderData: (SCIRenderPassData *)  data
ForSeries: (id< SCIStackedRenderableSeriesProtocol >)  series 

Field Documentation

◆ _drawRequest

- (BOOL) _drawRequest
protected

◆ _renderData

- (NSMutableArray<id <SCIRenderPassDataProtocol> >*) _renderData
protected

◆ _series

- (NSMutableArray<id <SCIStackedRenderableSeriesProtocol> >*) _series
protected

Property Documentation

◆ collectionDataSeriesObserver

- (SCIDataSeriesObserver*) collectionDataSeriesObserver
readwritenonatomicassign

◆ isOneHundredPercentSeries

- (BOOL) isOneHundredPercentSeries
readwriteatomic

Defines mode for stacked series, if value is true data convert into percentage.

◆ series

- (NSArray<id <SCIStackedRenderableSeriesProtocol> >*) series
readnonatomicassign

The documentation for this class was generated from the following file: