iOS & macOS Charting Documentation - SciChart iOS & macOS Charts SDK v4.x

SCIAnimations

@interface SCIAnimations : NSObject

Defines the class which contains methods to help create different animations/transformations for ISCIRenderableSeries.

See

ISCIRenderPassDataTransformation.

See

SCIBaseRenderPassDataTransformation.

See

SCIScaleTransformationBase.

See

SCISweepXyTransformation.

See

SCITranslateXTransformation.

See

SCITranslateXyTransformationBase.

See

SCIWaveTransformationBase.

Methods to create Animator


                        
                        
                        +createScaleAnimatorForSeries:

Creates SCIValueAnimator which can be used to animate associated ISCIRenderableSeries with scale transformation.

Declaration

Objective-C

+ (nonnull SCIValueAnimator *)createScaleAnimatorForSeries:
    (nonnull id<ISCIRenderableSeries>)series;

Swift

class func createScaleAnimator(for series: any ISCIRenderableSeries) -> SCIValueAnimator

Parameters


                                    series

The associated ISCIRenderableSeries which is going to be animated.

Return Value

SCIValueAnimator insance which can be used to animate associated ISCIRenderableSeries.


                        
                        
                        +createScaleAnimatorForSeries:withZeroLine:

Creates SCIValueAnimator which can be used to animate associated ISCIRenderableSeries with scale transformation.

Declaration

Objective-C

+ (nonnull SCIValueAnimator *)createScaleAnimatorForSeries:
                                  (nonnull id<ISCIRenderableSeries>)series
                                              withZeroLine:(double)zeroLine;

Swift

class func createScaleAnimator(for series: any ISCIRenderableSeries, withZeroLine zeroLine: Double) -> SCIValueAnimator

Parameters

`series`	The associated `ISCIRenderableSeries` which is going to be animated.
`zeroLine`	Data value which determines the zero line in `Y-direction`, from which scaling will be performed.

Return Value

SCIValueAnimator insance which can be used to animate associated ISCIRenderableSeries.


                        
                        
                        +createSweepAnimatorForSeries:

Creates SCIValueAnimator which can be used to animate associated ISCIRenderableSeries with sweep transformation.

Declaration

Objective-C

+ (nonnull SCIValueAnimator *)createSweepAnimatorForSeries:
    (nonnull id<ISCIRenderableSeries>)series;

Swift

class func createSweepAnimator(for series: any ISCIRenderableSeries) -> SCIValueAnimator

Parameters


                                    series

The associated ISCIRenderableSeries which is going to be animated.

Return Value

SCIValueAnimator insance which can be used to animate associated ISCIRenderableSeries.


                        
                        
                        +createWaveAnimatorForSeries:

Creates SCIValueAnimator which can be used to animate associated ISCIRenderableSeries with wave transformation.

Declaration

Objective-C

+ (nonnull SCIValueAnimator *)createWaveAnimatorForSeries:
    (nonnull id<ISCIRenderableSeries>)series;

Swift

class func createWaveAnimator(for series: any ISCIRenderableSeries) -> SCIValueAnimator

Parameters


                                    series

The associated ISCIRenderableSeries which is going to be animated.

Return Value

SCIValueAnimator insance which can be used to animate associated ISCIRenderableSeries.


                        
                        
                        +createWaveAnimatorForSeries:withZeroLine:

Creates SCIValueAnimator which can be used to animate associated ISCIRenderableSeries with wave transformation.

Declaration

Objective-C

+ (nonnull SCIValueAnimator *)createWaveAnimatorForSeries:
                                  (nonnull id<ISCIRenderableSeries>)series
                                             withZeroLine:(double)zeroLine;

Swift

class func createWaveAnimator(for series: any ISCIRenderableSeries, withZeroLine zeroLine: Double) -> SCIValueAnimator

Parameters

`series`	The associated `ISCIRenderableSeries` which is going to be animated.
`zeroLine`	Data value which determines the zero line in `Y-direction`, from which scaling will be performed.

Return Value

SCIValueAnimator insance which can be used to animate associated ISCIRenderableSeries.


                        
                        
                        +createWaveAnimatorForSeries:withZeroLine:andDurationOfStep:

Creates SCIValueAnimator which can be used to animate associated ISCIRenderableSeries with wave transformation.

Declaration

Objective-C

+ (nonnull SCIValueAnimator *)createWaveAnimatorForSeries:
                                  (nonnull id<ISCIRenderableSeries>)series
                                             withZeroLine:(double)zeroLine
                                        andDurationOfStep:(float)durationOfStep;

Swift

class func createWaveAnimator(for series: any ISCIRenderableSeries, withZeroLine zeroLine: Double, andDurationOfStep durationOfStep: Float) -> SCIValueAnimator

Parameters

`series`	The associated `ISCIRenderableSeries` which is going to be animated.
`zeroLine`	Data value which determines the zero line in `Y-direction`, from which scaling will be performed.
`durationOfStep`	Wave duration before next point is started to animate. Default is `0.5`.

Return Value

SCIValueAnimator insance which can be used to animate associated ISCIRenderableSeries.


                        
                        
                        +createTranslateXAnimatorForSeries:withOffset:

Creates SCIValueAnimator which can be used to animate associated ISCIRenderableSeries with translate transformation in X-Direction.

Declaration

Objective-C

+ (nonnull SCIValueAnimator *)createTranslateXAnimatorForSeries:
                                  (nonnull id<ISCIRenderableSeries>)series
                                                     withOffset:(float)offset;

Swift

class func createTranslateXAnimator(for series: any ISCIRenderableSeries, withOffset offset: Float) -> SCIValueAnimator

Parameters

`series`	The associated `ISCIRenderableSeries` which is going to be animated.
`offset`	The translation offset value.

Return Value

SCIValueAnimator insance which can be used to animate associated ISCIRenderableSeries.


                        
                        
                        +createTranslateYAnimatorForSeries:withOffset:

Creates SCIValueAnimator which can be used to animate associated ISCIRenderableSeries with translate transformation in Y-Direction.

Declaration

Objective-C

+ (nonnull SCIValueAnimator *)createTranslateYAnimatorForSeries:
                                  (nonnull id<ISCIRenderableSeries>)series
                                                     withOffset:(float)offset;

Swift

class func createTranslateYAnimator(for series: any ISCIRenderableSeries, withOffset offset: Float) -> SCIValueAnimator

Parameters

`series`	The associated `ISCIRenderableSeries` which is going to be animated.
`offset`	The translation offset value.

Return Value

SCIValueAnimator insance which can be used to animate associated ISCIRenderableSeries.


                        
                        
                        +createAnimatorForSeries:withTransformation:

Creates SCIValueAnimator which can be used to animate associated ISCIRenderableSeries with one of the provided ISCIRenderPassDataTransformations.

Declaration

Objective-C

+ (nonnull SCIValueAnimator *)
    createAnimatorForSeries:(nonnull id<ISCIRenderableSeries>)series
         withTransformation:
             (nonnull id<ISCIRenderPassDataTransformation>)transformation;

Swift

class func createAnimator(for series: any ISCIRenderableSeries, with transformation: any ISCIRenderPassDataTransformation) -> SCIValueAnimator

Parameters

`series`	The associated `ISCIRenderableSeries` which is going to be animated.
`transformation`	The `ISCIRenderPassDataTransformation` which is going to be applied onto associated `series`.

Return Value

SCIValueAnimator insance which can be used to animate associated ISCIRenderableSeries.

Fade Animations


                        
                        
                        +fadeSeries:duration:andEasingFunction:

Fade-in animates passed in ISCIRenderableSeries with scale transformation.

Declaration

Objective-C

+ (void)fadeSeries:(nonnull id<ISCIRenderableSeries>)series
             duration:(NSTimeInterval)duration
    andEasingFunction:(nullable id<ISCIEasingFunction>)easingFunction;

Swift

class func fade(_ series: any ISCIRenderableSeries, duration: TimeInterval, andEasingFunction easingFunction: (any ISCIEasingFunction)?)

Parameters

`series`	The series to `fade-in`.
`duration`	The length of the animation.
`easingFunction`	The `ISCIEasingFunction` used in calculating the elapsed fraction of the animation.


                        
                        
                        +fadeSeries:duration:delay:andEasingFunction:

Fade-in animates passed in ISCIRenderableSeries with scale transformation.

Declaration

Objective-C

+ (void)fadeSeries:(nonnull id<ISCIRenderableSeries>)series
             duration:(NSTimeInterval)duration
                delay:(NSTimeInterval)delay
    andEasingFunction:(nullable id<ISCIEasingFunction>)easingFunction;

Swift

class func fade(_ series: any ISCIRenderableSeries, duration: TimeInterval, delay: TimeInterval, andEasingFunction easingFunction: (any ISCIEasingFunction)?)

Parameters

`series`	The series to `fade-in`.
`duration`	The length of the animation.
`delay`	The `delay` before start of the animation.
`easingFunction`	The `ISCIEasingFunction` used in calculating the elapsed fraction of the animation.

Scale Animations


                        
                        
                        +scaleSeries:duration:andEasingFunction:

Animate passed in ISCIRenderableSeries with scale transformation.

Declaration

Objective-C

+ (void)scaleSeries:(nonnull id<ISCIRenderableSeries>)series
             duration:(NSTimeInterval)duration
    andEasingFunction:(nullable id<ISCIEasingFunction>)easingFunction;

Swift

class func scale(_ series: any ISCIRenderableSeries, duration: TimeInterval, andEasingFunction easingFunction: (any ISCIEasingFunction)?)

Parameters

`series`	The series to animate.
`duration`	The length of the animation.
`easingFunction`	The `ISCIEasingFunction` used in calculating the elapsed fraction of the animation.


                        
                        
                        +scaleSeries:duration:delay:andEasingFunction:

Animate passed in ISCIRenderableSeries with scale transformation.

Declaration

Objective-C

+ (void)scaleSeries:(nonnull id<ISCIRenderableSeries>)series
             duration:(NSTimeInterval)duration
                delay:(NSTimeInterval)delay
    andEasingFunction:(nullable id<ISCIEasingFunction>)easingFunction;

Swift

class func scale(_ series: any ISCIRenderableSeries, duration: TimeInterval, delay: TimeInterval, andEasingFunction easingFunction: (any ISCIEasingFunction)?)

Parameters

`series`	The series to animate.
`duration`	The length of the animation.
`delay`	The `delay` before start of the animation.
`easingFunction`	The `ISCIEasingFunction` used in calculating the elapsed fraction of the animation.


                        
                        
                        +scaleSeries:withZeroLine:duration:andEasingFunction:

Animate passed in ISCIRenderableSeries with scale transformation.

Declaration

Objective-C

+ (void)scaleSeries:(nonnull id<ISCIRenderableSeries>)series
         withZeroLine:(double)zeroLine
             duration:(NSTimeInterval)duration
    andEasingFunction:(nullable id<ISCIEasingFunction>)easingFunction;

Swift

class func scale(_ series: any ISCIRenderableSeries, withZeroLine zeroLine: Double, duration: TimeInterval, andEasingFunction easingFunction: (any ISCIEasingFunction)?)

Parameters

`series`	The series to animate.
`zeroLine`	Data value which determines the zero line in `Y-direction`, from which scaling will be performed.
`duration`	The length of the animation.
`easingFunction`	The `ISCIEasingFunction` used in calculating the elapsed fraction of the animation.


                        
                        
                        +scaleSeries:withZeroLine:duration:delay:andEasingFunction:

Animate passed in ISCIRenderableSeries with scale transformation.

Declaration

Objective-C

+ (void)scaleSeries:(nonnull id<ISCIRenderableSeries>)series
         withZeroLine:(double)zeroLine
             duration:(NSTimeInterval)duration
                delay:(NSTimeInterval)delay
    andEasingFunction:(nullable id<ISCIEasingFunction>)easingFunction;

Swift

class func scale(_ series: any ISCIRenderableSeries, withZeroLine zeroLine: Double, duration: TimeInterval, delay: TimeInterval, andEasingFunction easingFunction: (any ISCIEasingFunction)?)

Parameters

`series`	The series to animate.
`zeroLine`	Data value which determines the zero line in `Y-direction`, from which scaling will be performed.
`duration`	The length of the animation.
`delay`	The `delay` before start of the animation.
`easingFunction`	The `ISCIEasingFunction` used in calculating the elapsed fraction of the animation.

Sweep Animations


                        
                        
                        +sweepSeries:duration:andEasingFunction:

Animate passed in ISCIRenderableSeries with sweep transformation.

Declaration

Objective-C

+ (void)sweepSeries:(nonnull id<ISCIRenderableSeries>)series
             duration:(NSTimeInterval)duration
    andEasingFunction:(nullable id<ISCIEasingFunction>)easingFunction;

Swift

class func sweep(_ series: any ISCIRenderableSeries, duration: TimeInterval, easingFunction: (any ISCIEasingFunction)?)

Parameters

`series`	The series to animate.
`duration`	The length of the animation.
`easingFunction`	The `ISCIEasingFunction` used in calculating the elapsed fraction of the animation.


                        
                        
                        +sweepSeries:duration:delay:andEasingFunction:

Animate passed in ISCIRenderableSeries with sweep transformation.

Declaration

Objective-C

+ (void)sweepSeries:(nonnull id<ISCIRenderableSeries>)series
             duration:(NSTimeInterval)duration
                delay:(NSTimeInterval)delay
    andEasingFunction:(nullable id<ISCIEasingFunction>)easingFunction;

Swift

class func sweep(_ series: any ISCIRenderableSeries, duration: TimeInterval, delay: TimeInterval, easingFunction: (any ISCIEasingFunction)?)

Parameters

`series`	The series to animate.
`duration`	The length of the animation.
`delay`	The `delay` before start of the animation.
`easingFunction`	The `ISCIEasingFunction` used in calculating the elapsed fraction of the animation.

Wave Animations


                        
                        
                        +waveSeries:duration:andEasingFunction:

Animate passed in ISCIRenderableSeries with wave transformation.

Declaration

Objective-C

+ (void)waveSeries:(nonnull id<ISCIRenderableSeries>)series
             duration:(NSTimeInterval)duration
    andEasingFunction:(nullable id<ISCIEasingFunction>)easingFunction;

Swift

class func wave(_ series: any ISCIRenderableSeries, duration: TimeInterval, andEasingFunction easingFunction: (any ISCIEasingFunction)?)

Parameters

`series`	The series to animate.
`duration`	The length of the animation.
`easingFunction`	The `ISCIEasingFunction` used in calculating the elapsed fraction of the animation.


                        
                        
                        +waveSeries:duration:delay:andEasingFunction:

Animate passed in ISCIRenderableSeries with wave transformation.

Declaration

Objective-C

+ (void)waveSeries:(nonnull id<ISCIRenderableSeries>)series
             duration:(NSTimeInterval)duration
                delay:(NSTimeInterval)delay
    andEasingFunction:(nullable id<ISCIEasingFunction>)easingFunction;

Swift

class func wave(_ series: any ISCIRenderableSeries, duration: TimeInterval, delay: TimeInterval, andEasingFunction easingFunction: (any ISCIEasingFunction)?)

Parameters

`series`	The series to animate.
`duration`	The length of the animation.
`delay`	The `delay` before start of the animation.
`easingFunction`	The `ISCIEasingFunction` used in calculating the elapsed fraction of the animation.


                        
                        
                        +waveSeries:withZeroLine:duration:andEasingFunction:

Animate passed in ISCIRenderableSeries with wave transformation.

Declaration

Objective-C

+ (void)waveSeries:(nonnull id<ISCIRenderableSeries>)series
         withZeroLine:(double)zeroLine
             duration:(NSTimeInterval)duration
    andEasingFunction:(nullable id<ISCIEasingFunction>)easingFunction;

Swift

class func wave(_ series: any ISCIRenderableSeries, withZeroLine zeroLine: Double, duration: TimeInterval, andEasingFunction easingFunction: (any ISCIEasingFunction)?)

Parameters

`series`	The series to animate.
`zeroLine`	Data value which determines the zero line in `Y-direction`, from which scaling will be performed.
`duration`	The length of the animation.
`easingFunction`	The `ISCIEasingFunction` used in calculating the elapsed fraction of the animation.


                        
                        
                        +waveSeries:withZeroLine:duration:delay:andEasingFunction:

Animate passed in ISCIRenderableSeries with wave transformation.

Declaration

Objective-C

+ (void)waveSeries:(nonnull id<ISCIRenderableSeries>)series
         withZeroLine:(double)zeroLine
             duration:(NSTimeInterval)duration
                delay:(NSTimeInterval)delay
    andEasingFunction:(nullable id<ISCIEasingFunction>)easingFunction;

Swift

class func wave(_ series: any ISCIRenderableSeries, withZeroLine zeroLine: Double, duration: TimeInterval, delay: TimeInterval, andEasingFunction easingFunction: (any ISCIEasingFunction)?)

Parameters

`series`	The series to animate.
`zeroLine`	Data value which determines the zero line in `Y-direction`, from which scaling will be performed.
`duration`	The length of the animation.
`delay`	The `delay` before start of the animation.
`easingFunction`	The `ISCIEasingFunction` used in calculating the elapsed fraction of the animation.


                        
                        
                        +waveSeries:withZeroLine:andDurationOfStep:duration:andEasingFunction:

Animate passed in ISCIRenderableSeries with wave transformation.

Declaration

Objective-C

+ (void)waveSeries:(nonnull id<ISCIRenderableSeries>)series
         withZeroLine:(double)zeroLine
    andDurationOfStep:(float)durationOfStep
             duration:(NSTimeInterval)duration
    andEasingFunction:(nullable id<ISCIEasingFunction>)easingFunction;

Swift

class func wave(_ series: any ISCIRenderableSeries, withZeroLine zeroLine: Double, andDurationOfStep durationOfStep: Float, duration: TimeInterval, andEasingFunction easingFunction: (any ISCIEasingFunction)?)

Parameters

`series`	The series to animate.
`zeroLine`	Data value which determines the zero line in `Y-direction`, from which scaling will be performed.
`durationOfStep`	Wave duration before next point is started to animate. Default is `0.5`.
`duration`	The length of the animation.
`easingFunction`	The `ISCIEasingFunction` used in calculating the elapsed fraction of the animation.


                        
                        
                        +waveSeries:withZeroLine:andDurationOfStep:duration:delay:andEasingFunction:

Animate passed in ISCIRenderableSeries with wave transformation.

Declaration

Objective-C

+ (void)waveSeries:(nonnull id<ISCIRenderableSeries>)series
         withZeroLine:(double)zeroLine
    andDurationOfStep:(float)durationOfStep
             duration:(NSTimeInterval)duration
                delay:(NSTimeInterval)delay
    andEasingFunction:(nullable id<ISCIEasingFunction>)easingFunction;

Swift

class func wave(_ series: any ISCIRenderableSeries, withZeroLine zeroLine: Double, andDurationOfStep durationOfStep: Float, duration: TimeInterval, delay: TimeInterval, andEasingFunction easingFunction: (any ISCIEasingFunction)?)

Parameters

`series`	The series to animate.
`zeroLine`	Data value which determines the zero line in `Y-direction`, from which scaling will be performed.
`durationOfStep`	Wave duration before next point is started to animate. Default is `0.5`.
`duration`	The length of the animation.
`delay`	The `delay` before start of the animation.
`easingFunction`	The `ISCIEasingFunction` used in calculating the elapsed fraction of the animation.

Translate Animations


                        
                        
                        +translateXSeries:withOffset:duration:andEasingFunction:

Animate passed in ISCIRenderableSeries with translate transformation in X-Direction.

Declaration

Objective-C

+ (void)translateXSeries:(nonnull id<ISCIRenderableSeries>)series
              withOffset:(float)offset
                duration:(NSTimeInterval)duration
       andEasingFunction:(nullable id<ISCIEasingFunction>)easingFunction;

Swift

class func translateX(_ series: any ISCIRenderableSeries, offset: Float, duration: TimeInterval, easingFunction: (any ISCIEasingFunction)?)

Parameters

`series`	The series to animate.
`offset`	The translation offset value.
`duration`	The length of the animation.
`easingFunction`	The `ISCIEasingFunction` used in calculating the elapsed fraction of the animation.


                        
                        
                        +translateXSeries:withOffset:duration:delay:andEasingFunction:

Animate passed in ISCIRenderableSeries with translate transformation in X-Direction.

Declaration

Objective-C

+ (void)translateXSeries:(nonnull id<ISCIRenderableSeries>)series
              withOffset:(float)offset
                duration:(NSTimeInterval)duration
                   delay:(NSTimeInterval)delay
       andEasingFunction:(nullable id<ISCIEasingFunction>)easingFunction;

Swift

class func translateX(_ series: any ISCIRenderableSeries, offset: Float, duration: TimeInterval, delay: TimeInterval, easingFunction: (any ISCIEasingFunction)?)

Parameters

`series`	The series to animate.
`offset`	The translation offset value.
`duration`	The length of the animation.
`delay`	The `delay` before start of the animation.
`easingFunction`	The `ISCIEasingFunction` used in calculating the elapsed fraction of the animation.


                        
                        
                        +translateYSeries:withOffset:duration:andEasingFunction:

Animate passed in ISCIRenderableSeries with translate transformation in Y-Direction.

Declaration

Objective-C

+ (void)translateYSeries:(nonnull id<ISCIRenderableSeries>)series
              withOffset:(float)offset
                duration:(NSTimeInterval)duration
       andEasingFunction:(nullable id<ISCIEasingFunction>)easingFunction;

Swift

class func translateY(_ series: any ISCIRenderableSeries, offset: Float, duration: TimeInterval, easingFunction: (any ISCIEasingFunction)?)

Parameters

`series`	The series to animate.
`offset`	The translation offset value.
`duration`	The length of the animation.
`easingFunction`	The `ISCIEasingFunction` used in calculating the elapsed fraction of the animation.


                        
                        
                        +translateYSeries:withOffset:duration:delay:andEasingFunction:

Animate passed in ISCIRenderableSeries with translate transformation in Y-Direction.

Declaration

Objective-C

+ (void)translateYSeries:(nonnull id<ISCIRenderableSeries>)series
              withOffset:(float)offset
                duration:(NSTimeInterval)duration
                   delay:(NSTimeInterval)delay
       andEasingFunction:(nullable id<ISCIEasingFunction>)easingFunction;

Swift

class func translateY(_ series: any ISCIRenderableSeries, offset: Float, duration: TimeInterval, delay: TimeInterval, easingFunction: (any ISCIEasingFunction)?)

Parameters

`series`	The series to animate.
`offset`	The translation offset value.
`duration`	The length of the animation.
`delay`	The `delay` before start of the animation.
`easingFunction`	The `ISCIEasingFunction` used in calculating the elapsed fraction of the animation.

Animate with Transformation


                        
                        
                        +animateSeries:withTransformation:duration:andEasingFunction:

Animates passed in ISCIRenderableSeries with defined ISCIRenderPassDataTransformation and other params.

Declaration

Objective-C

+ (void)animateSeries:(nonnull id<ISCIRenderableSeries>)series
    withTransformation:
        (nonnull id<ISCIRenderPassDataTransformation>)transformation
              duration:(NSTimeInterval)duration
     andEasingFunction:(nullable id<ISCIEasingFunction>)easingFunction;

Swift

class func animate(_ series: any ISCIRenderableSeries, with transformation: any ISCIRenderPassDataTransformation, duration: TimeInterval, andEasingFunction easingFunction: (any ISCIEasingFunction)?)

Parameters

`series`	The series to animate.
`transformation`	The `ISCIRenderPassDataTransformation` which will be used during animation.
`duration`	The length of the animation.
`easingFunction`	The `ISCIEasingFunction` used in calculating the elapsed fraction of the animation.


                        
                        
                        +animateSeries:withTransformation:duration:startDelay:andEasingFunction:

Animates passed in ISCIRenderableSeries with defined ISCIRenderPassDataTransformation and other params.

Declaration

Objective-C

+ (void)animateSeries:(nonnull id<ISCIRenderableSeries>)series
    withTransformation:
        (nonnull id<ISCIRenderPassDataTransformation>)transformation
              duration:(NSTimeInterval)duration
            startDelay:(NSTimeInterval)delay
     andEasingFunction:(nullable id<ISCIEasingFunction>)easingFunction;

Swift

class func animate(_ series: any ISCIRenderableSeries, with transformation: any ISCIRenderPassDataTransformation, duration: TimeInterval, startDelay delay: TimeInterval, andEasingFunction easingFunction: (any ISCIEasingFunction)?)

Parameters

`series`	The series to animate.
`transformation`	The `ISCIRenderPassDataTransformation` which will be used during animation.
`duration`	The length of the animation.
`delay`	The `delay` before start of the animation.
`easingFunction`	The `ISCIEasingFunction` used in calculating the elapsed fraction of the animation.