SCIBubbleRenderableSeries Class Reference

The SCIBubbleRenderableSeries class. More...

#import <SCIBubbleRenderableSeries.h>

Inheritance diagram for SCIBubbleRenderableSeries:
SCIRenderableSeriesBase <SCIRenderableSeriesProtocol> <SCIThemeableProtocol> <SCIDrawableProtocol>

Instance Methods

(void) - addAnimation:
 Make the series animatable. More...
 
- 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...
 

Properties

SCIBubbleSeriesStyle * style
 Get or set style for visual customization. More...
 
SCIBubbleSeriesStyle * selectedStyle
 Gets or sets selected series style @discussion If set to nil selected style is default series style. More...
 
double zScaleFactor
 Get or set bubble scale @discussion If autoZrange is NO, Z value multiplied by zScale is bubble radius in pixels. More...
 
BOOL autoZRange
 Get or Set auto range for Z. More...
 
SCIBrushStylebubbleBrushStyle
 

Additional Inherited Members

- Protected Attributes inherited from SCIRenderableSeriesBase
id< SCIPointSeriesProtocol_previousPointSeries
 
SCIAnimationsController_animationsController
 
SCIDataSeriesObserver_dataSeriesObserver
 

Detailed Description

The SCIBubbleRenderableSeries class.

@discussion Every data point in this renderable series has XYZ data and displayed as buble with position at XY and radius defined by Z value

Remarks
Designed to work with SCIXyzDataSeriesProtocol as data container
For styling provide or customize SCIBubbleSeriesStyle
See also
SCIRenderableSeriesProtocol
SCIRenderableSeriesBase
SCIXyzDataSeriesProtocol
SCIBubbleSeriesStyle

Method Documentation

◆ addAnimation:()

- (void) addAnimation: (id< SCIBubbleRenderableSeriesAnimationProtocol >)  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 SCIBubbleRenderableSeriesAnimationProtocol.

Property Documentation

◆ autoZRange

- (BOOL) autoZRange
readwritenonatomicassign

Get or Set auto range for Z.

Default is NO. If value is YES Max Z value uses max_bubble_size_in_pixel for defining size of radius.

◆ bubbleBrushStyle

- (SCIBrushStyle*) bubbleBrushStyle
readwritenonatomicassign

◆ selectedStyle

- (SCIBubbleSeriesStyle*) selectedStyle
readwritenonatomiccopy

Gets or sets selected series style @discussion If set to nil selected style is default series style.

◆ style

- (SCIBubbleSeriesStyle*) style
readwritenonatomiccopy

Get or set style for visual customization.

See also
SCIBubbleSeriesStyle

◆ zScaleFactor

- (double) zScaleFactor
readwritenonatomicassign

Get or set bubble scale @discussion If autoZrange is NO, Z value multiplied by zScale is bubble radius in pixels.


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