iOS & macOS Charting Documentation - SciChart iOS & macOS Charts SDK v4.x
Other Classes
The following classes are available globally.
-
Undocumented
See moreDeclaration
Objective-C
@interface SCIAnnotationCreationArgs : NSObject /// The annotation that was created @property (nonatomic, strong, readonly) SCIAnnotationBase *createdAnnotation; /// Creates a new instance of AnnotationCreationArgs /// @param annotation The annotation that was created - (instancetype)initWithAnnotation:(SCIAnnotationBase *)annotation; @endSwift
class SCIAnnotationCreationArgs : NSObject -
Provides a class whicih can draw
See moreNSAttributedStringontoCGContextRef.Declaration
Objective-C
@interface SCIAnnotationDrawableText : NSObject <ISCIInvalidatableElement, ISCICleanable>Swift
class SCIAnnotationDrawableText : NSObject, ISCIInvalidatableElement, ISCICleanable -
Defines a class with style for axis border rendered by
See moreSCIAxisBase.Declaration
Objective-C
@interface SCIAxisBorderStyle : NSObjectSwift
class SCIAxisBorderStyle : NSObject -
Defines an entity which renders an Axis Cube in the 3D scene.
See moreDeclaration
Objective-C
@interface SCIAxisCubeEntity : SCIBaseSceneEntitySwift
class SCIAxisCubeEntity : SCIBaseSceneEntity -
The X Axis DragModifier provides a drag to scale the
X-Axis. This behaviour scales the axis in a different direction depending on which half of the axis the user starts the operation in.Note
Add to aSCIChartSurfaceand setISCIChartModifierCore.IsEnabledto true to enable this behaviour.See moreSee
SCIYAxisDragModifier,Declaration
Objective-C
@interface SCIAxisDragModifier : SCIAxisDragModifierBaseSwift
class SCIAxisDragModifier : SCIAxisDragModifierBase -
Provides abstract base class for axis providers.
See moreWarning
Designed to be an abstract class, hence should be used for inheritance only. No direct initializations.Declaration
Objective-C
@interface SCIAxisProviderBase<T : id <ISCIAxisCore>> : NSObject <ISCIAxisProviderBase>Swift
class SCIAxisProviderBase<T> : NSObject, ISCIAxisProviderBase where T : ISCIAxisCore -
An abstract base class for band series.
See moreWarning
Designed to be an abstract class, hence should be used for inheritance only. No direct initializations.Declaration
Objective-C
@interface SCIBaseBandRenderableSeries : SCIXyyRenderableSeriesBaseSwift
class SCIBaseBandRenderableSeries : SCIXyyRenderableSeriesBase -
Defines a label formatter for
See moreISCIDateAxiswhich allows to useNSCalendarUnitbased formattingDeclaration
Objective-C
@interface SCICalendarDateLabelFormatter<T : SCIDateAxis *> : SCILabelFormatterBaseSwift
class SCICalendarDateLabelFormatter<T> : SCILabelFormatterBase<any ISCIAxisCore> where T : SCIDateAxis -
Defines a default date formatter which is used by
See moreSCITradeChartAxisLabelFormatterDeclaration
Objective-C
@interface SCICalendarUnitDateFormatter : NSObject <ISCICalendarUnitDateFormatter>Swift
class SCICalendarUnitDateFormatter : NSObject, ISCICalendarUnitDateFormatter -
Undocumented
See moreDeclaration
Objective-C
@interface SCICaptureEventsGesture : SCIGestureRecognizer #if TARGET_OS_OSX <ISCITrackingAreaResponder> /// Redeclare the default property to address modifier movement issues when using a mouse. Ticket #45619, #45614, #45612 /// On macOS, `NSGestureRecognizer` restricts direct state mutation — setting state to `Began` /// during `mouseDown:` breaks Apple's internal event tracking session, preventing `mouseUp:` /// from ever being delivered. To work around this, we introduce `internalState` as a separate /// property to track gesture state independently, without interfering with `NSGestureRecognizer`'s /// state machine. This ensures both hover/rollover modifier and mouse click events work correctly. (trading /// annotation edit mode) @property (nonatomic) NSGestureRecognizerState internalState; #endif /** * Returns the mask which defines the buttons which was pressed during gesture recognition. */ @property (nonatomic, readonly) SCIButtonMask recognizedButtonMask; @property(nonatomic, weak) id <SCICaptureEventsGestureDelegate> _Nullable captureEventDelegate; @endSwift
class SCICaptureEventsGesture : UIGestureRecognizer -
Undocumented
See moreDeclaration
Objective-C
@interface SCIComparablePoint : NSObject <NSCopying, NSSecureCoding> @property (nonatomic, strong) id<ISCIComparable> x; @property (nonatomic, strong) id<ISCIComparable> y; - (instancetype)initWithX:(id<ISCIComparable>)x y:(id<ISCIComparable>)y; @endSwift
class SCIComparablePoint : NSObject, NSCopying, NSSecureCoding -
Defines a Custom (flat texture) Point-marker for used with 3D RenderableSeries.
See
SCICubePointMarker3D.See moreSee
SCIQuadPointMarker3D.Declaration
Objective-C
@interface SCICustomPointMarker3D : SCIBaseTexturePointMarker3DSwift
class SCICustomPointMarker3D : SCIBaseTexturePointMarker3D -
Default implementation of
See moreISCIAnnotationSelectionDrawablewhich draws selection overlay with stroke.Declaration
Objective-C
@interface SCIDefaultAnnotationSelectionDrawable : NSObject <ISCIAnnotationSelectionDrawable>Swift
class SCIDefaultAnnotationSelectionDrawable : NSObject, ISCIAnnotationSelectionDrawable -
Default implementation of
See moreISCIIndexCalculatorDeclaration
Objective-C
@interface SCIDefaultIndexCalculator : NSObject <ISCIIndexCalculator>Swift
class SCIDefaultIndexCalculator : NSObject, ISCIIndexCalculator -
Defines
ISCIIndexDataProviderwhich doesn’t have any index data to use.Declaration
Objective-C
@interface SCIDefaultIndexDataProvider : SCIIndexProviderBaseSwift
class SCIDefaultIndexDataProvider : SCIIndexProviderBase -
Defines a default series info provider for
SCIPieDonutRenderableSeriesBase.Declaration
Objective-C
@interface SCIDefaultPieChartSeriesInfoProvider : SCIPieSeriesInfoProviderBase <SCIPieDonutRenderableSeriesBase *, SCIPieSeriesInfo *>Swift
class SCIDefaultPieChartSeriesInfoProvider : SCIPieSeriesInfoProviderBase<SCIPieDonutRenderableSeriesBase, SCIPieSeriesInfo> -
Default implementation of
ISCIPieSegmentLabelFormatterused bySCIPieRenderableSeriesandSCIDonutRenderableSeries.Declaration
Objective-C
@interface SCIDefaultPieSegmentLabelFormatter : SCIPieSegmentLabelFormatterBase <ISCIPieSegmentLabelFormatter>Swift
class SCIDefaultPieSegmentLabelFormatter : SCIPieSegmentLabelFormatterBase, ISCIPieSegmentLabelFormatter -
Provides a class whicih can draw
See moreNSAttributedStringontoCGContextRef.Declaration
Objective-C
@interface SCIDrawableView : NSObject <ISCIInvalidatableElement, ISCICleanable>Swift
class SCIDrawableView : NSObject, ISCIInvalidatableElement, ISCICleanable -
Defines
See moreISCIIndexCalculatorfor case when there is not enough index data to perform proper calculation. In this case we reinterpret value as index and vice versa.Declaration
Objective-C
@interface SCIEmptyIndexCalculator : NSObject <ISCIIndexCalculator>Swift
class SCIEmptyIndexCalculator : NSObject, ISCIIndexCalculator
-
Defines the factory which allows to create a high-performance array-backed fifo buffers.
See moreDeclaration
Objective-C
@interface SCIFifoBufferFactory : NSObjectSwift
class SCIFifoBufferFactory : NSObject -
Defines an entity to display the
FPS counterin the bottom left of the screen.Declaration
Objective-C
@interface SCIFpsPresenter : SCIBaseSceneEntitySwift
class SCIFpsPresenter : SCIBaseSceneEntity -
Defines a gesture event args, used by various classes within SciChart to process events produced by gesture recognizers.
See moreDeclaration
Objective-C
@interface SCIGestureModifierEventArgs : SCIModifierEventArgsSwift
class SCIGestureModifierEventArgs : SCIModifierEventArgs -
Defines a base class for
See moreISCIIndexAxisimplementations.Declaration
Objective-C
@interface SCIIndexAxisBase : SCIAxisBase <ISCIIndexAxis>Swift
class SCIIndexAxisBase : SCIAxisBase<any ISCIComparable>, ISCIIndexAxis -
Defines a range calculation helper used by
SCIIndexDateAxisDeclaration
Objective-C
@interface SCIIndexDateRangeCalculationHelper : SCIDateRangeCalculationHelperSwift
class SCIIndexDateRangeCalculationHelper : SCIDateRangeCalculationHelper -
Defines
See moreISCITickProviderused bySCIIndexDateAxisDeclaration
Objective-C
@interface SCIIndexDateTickProvider : SCIDeltaTickProviderSwift
class SCIIndexDateTickProvider : SCIDeltaTickProvider -
An abstract base class to define an
IndexProviderimplementations.See moreWarning
Designed to be an abstract class, hence should be used for inheritance only. No direct initializations.Declaration
Objective-C
@interface SCIIndexProviderBase : NSObject <ISCIIndexDataProvider>Swift
class SCIIndexProviderBase : NSObject, ISCIIndexDataProvider -
Defines the
ISCIAnimatorListenerforSCIIndexDateAxiswhich is used inSCIVisibleRangeAnimator.Note
Used as a hack, to fix(break) retain cycle betweenSCIVisibleRangeAnimatorandSCIValueAnimator.Declaration
Objective-C
@interface SCIIndexVisibleRangeAnimatorListener : SCIVisibleRangeAnimatorListenerSwift
class SCIIndexVisibleRangeAnimatorListener : SCIVisibleRangeAnimatorListener -
An abstract base class to define a
LabelFormatterwhich is used bySCIFormatterLabelProviderBase.Declaration
Objective-C
@interface SCILabelFormatterBase<T : id <ISCIAxisCore>> : NSObject <ISCILabelFormatter>Swift
class SCILabelFormatterBase<T> : NSObject, ISCILabelFormatter where T : ISCIAxisCore -
Defines the factory which allows to create a high-performance array-backed fifo buffers.
See moreDeclaration
Objective-C
@interface SCIListFactory : NSObjectSwift
class SCIListFactory : NSObject -
Helper class for work with internal items arrays of ISCIList.
See moreDeclaration
Objective-C
@interface SCIListUtil : NSObjectSwift
class SCIListUtil : NSObject -
Defines
SCIObservableCollectionwithSCIReadWriteLockto ensure thread safety.See moreNote
TType of items.Declaration
Objective-C
@interface SCILockableObservableCollection<__covariant T> : SCIObservableCollection <T>Swift
class SCILockableObservableCollection<T> : SCIObservableCollection<T> where T : AnyObject -
Defines the
ISCIAnimatorListenerwhich is used inSCIVisibleRangeAnimator.Note
Used as a hack, to fix(break) retain cycle betweenSCIVisibleRangeAnimatorandSCIValueAnimator.Declaration
Objective-C
@interface SCILogarithmicVisibleRangeAnimatorListener : SCIVisibleRangeAnimatorListenerSwift
class SCILogarithmicVisibleRangeAnimatorListener : SCIVisibleRangeAnimatorListener -
Defines a base class for trading drawing tools which are defined by a fixed number of base points and rendered as a group of child annotations.
This class implements the interaction plumbing shared by all such tools - one resizing grip per base point, grip dragging, whole-annotation dragging, hit-testing and culling - so that concrete tools only need to describe their geometry.
Note
Line thickness and dash pattern come from the inheritedstrokeSCIPenStyle. Concrete tools add their ownSCIPenStyleandSCIBrushStyleproperties for the parts they draw.Subclasses must override
See moreplacementPointCountandonBasePointsChanged.Declaration
Objective-C
@interface SCIMultiPointAnnotationBase : SCITradingAnnotationBase <ISCITradingAnnotation>Swift
class SCIMultiPointAnnotationBase : SCITradingAnnotationBase, ISCITradingAnnotation -
Base gesture modifier for interactive placement of two-point trading drawing tools.
Interaction: touch down → places the first anchor point drag → moves the second anchor point live touch up → commits the annotation, which then becomes editable and selected
See moreNote
This class provides the placement engine only. Use one of its concrete subclasses -SCIFibonacciRetracementCreationModifier,SCIMeasureCreationModifierorSCIStopLossTakeProfitCreationModifier- which create and style their own annotation type.Declaration
Objective-C
@interface SCIMultiPointAnnotationPlacementModifier : SCIAnnotationCreationModifierBaseSwift
class SCIMultiPointAnnotationPlacementModifier : SCIAnnotationCreationModifierBase -
Defines a label drawn by a multi-point trading annotation.
See moreNote
textis the complete label string. For text which has to change as the annotation is edited, use the annotation’sformatLabelblock instead - it takes precedence overtext.Declaration
Objective-C
@interface SCIMultiPointLabel : NSObjectSwift
class SCIMultiPointLabel : NSObject -
Provides the context passed to a
See moreSCIMultiPointLabelFormatterwhen a label’s text is resolved.Declaration
Objective-C
@interface SCIMultiPointLabelFormatParams : NSObjectSwift
class SCIMultiPointLabelFormatParams : NSObject -
Defines a smart property class which can hold
See moreanyinstance and send notifications whenever it’s value changes.Declaration
Objective-C
@interface SCINotifiableSmartProperty : SCISmartPropertySwift
class SCINotifiableSmartProperty : SCISmartProperty -
Defines a smart property class which can hold
See morebooleanvalue and send notifications whenever it’s value changes.Declaration
Objective-C
@interface SCINotifiableSmartPropertyBool : SCISmartPropertyBoolSwift
class SCINotifiableSmartPropertyBool : SCISmartPropertyBool -
Defines a smart property class which can hold
See moredoublevalue and send notifications whenever it’s value changes.Declaration
Objective-C
@interface SCINotifiableSmartPropertyDouble : SCISmartPropertyDoubleSwift
class SCINotifiableSmartPropertyDouble : SCISmartPropertyDouble -
Defines a smart property class which can hold
See morefloatvalue and send notifications whenever it’s value changes.Declaration
Objective-C
@interface SCINotifiableSmartPropertyFloat : SCISmartPropertyFloatSwift
class SCINotifiableSmartPropertyFloat : SCISmartPropertyFloat -
Defines a smart property class which can hold
See moreintvalue and send notifications whenever it’s value changes.Declaration
Objective-C
@interface SCINotifiableSmartPropertyInt : SCISmartPropertyIntSwift
class SCINotifiableSmartPropertyInt : SCISmartPropertyInt -
Defines a smart property class which can hold
See morelongvalue and send notifications whenever it’s value changes.Declaration
Objective-C
@interface SCINotifiableSmartPropertyLong : SCISmartPropertyLongSwift
class SCINotifiableSmartPropertyLong : SCISmartPropertyLong -
Defines a smart property class which can hold any
See moreidinstances and observe it’s value changes.Declaration
Objective-C
@interface SCIObservableSmartProperty : SCISmartPropertySwift
class SCIObservableSmartProperty : SCISmartProperty -
Undocumented
See moreDeclaration
Objective-C
@interface SCIOverviewOptions : NSObject // Properties @property (nonatomic, strong, nullable) NSString *xAxisId; @property (nonatomic, strong, nullable) NSString *yAxisId; @property (nonatomic, strong, nullable) NSMutableArray *renderableSeries; // Initializer to set the properties - (instancetype)initWithXAxisId:(NSString *)xAxisId yAxisId:(NSString *)yAxisId renderableSeries:(NSMutableArray *)renderableSeries; @endSwift
class SCIOverviewOptions : NSObject -
Defines a base class for
ISCIPieChartHitProviderimplementations.See moreWarning
Designed to be an abstract class, hence should be used for inheritance only. No direct initializations.Declaration
Objective-C
@interface SCIPieChartHitProviderBase<T : id <ISCIPieDonutRenderPassData>> : NSObject <ISCIPieChartHitProvider>Swift
class SCIPieChartHitProviderBase<T> : NSObject, ISCIPieChartHitProvider where T : ISCIPieDonutRenderPassData -
Provides a base class for Linked Pie Chart Modifiers. Classes that inherit this allow touch events and interaction to occur across Pie Charts.
Declaration
Objective-C
@interface SCIPieChartMasterSlaveTouchModifierBase : SCIPieChartGestureModifierBaseSwift
class SCIPieChartMasterSlaveTouchModifierBase : SCIPieChartGestureModifierBase -
Defines the base class to a PieChart Modifier, which can be used to extend the interactivity or rendering of the
See moreSCIPieChartSurface.Declaration
Objective-C
@interface SCIPieChartModifierBase : SCIChartModifierCore <ISCIPieChartModifier>Swift
class SCIPieChartModifierBase : SCIChartModifierCore, ISCIPieChartModifier -
Contains a collection of
See moreISCIPieChartModifier.Declaration
Objective-C
@interface SCIPieChartModifierCollection : SCIChartModifierCollectionBase <id <ISCIPieChartModifier>>Swift
class SCIPieChartModifierCollection : SCIChartModifierCollectionBase<any ISCIPieChartModifier> -
Published by
See moreSCIPieChartRenderSurfaceimmediately before the end of a render pass.Declaration
Objective-C
@interface SCIPieChartRenderedMessage : SCILoggedMessageSwift
class SCIPieChartRenderedMessage : SCILoggedMessage -
The
SCIPieChartTooltipModifierBaseis part of the ChartModifier API, which factors out handling of Chart Label templates, and provides a touch-over templated tooltip, provided by the output of the Hit-Test operation on aISCIPieRenderableSeries.See moreNote
Abstract base class for tooltip modifiers inSCIPieChartSurface.Declaration
Objective-C
@interface SCIPieChartTooltipModifierBase : SCIPieChartMasterSlaveTouchModifierBaseSwift
class SCIPieChartTooltipModifierBase : SCIPieChartMasterSlaveTouchModifierBase -
Defines a base class for
ISCIPieSeriesInfoProviderimplementors.Declaration
Objective-C
@interface SCIPieSeriesInfoProviderBase< TRenderableSeries : id <ISCIPieRenderableSeries>, TSeriesInfo : SCIPieSeriesInfo *> : NSObject <ISCIPieSeriesInfoProvider>Swift
class SCIPieSeriesInfoProviderBase<TRenderableSeries, TSeriesInfo> : NSObject, ISCIPieSeriesInfoProvider where TRenderableSeries : ISCIPieRenderableSeries, TSeriesInfo : SCIPieSeriesInfo -
A base class for
ISCIPieSeriesTooltipimplementors.See moreWarning
Designed to be an abstract class, hence should be used for inheritance only. No direct initializations.Declaration
Objective-C
@interface SCIPieSeriesTooltipBase<T : SCIPieSeriesInfo *> : SCITooltipBase <ISCIPieSeriesTooltip>Swift
class SCIPieSeriesTooltipBase<T> : SCITooltipBase, ISCIPieSeriesTooltip where T : SCIPieSeriesInfo -
Defines a rectangle, which may be placed on the chart at specific
See moreX1, Y1, X2, Y2coordinates.Declaration
Objective-C
@interface SCIRangeSelectorAnnotation : SCIAnnotationBaseSwift
class SCIRangeSelectorAnnotation : SCIAnnotationBase -
The
See moreSCIRubberBandXyZoomModifierprovides a touch move to zoom into a rectangular region, or horizontal section of the chart.Declaration
Objective-C
@interface SCIRubberBandXyZoomModifier : SCIGestureModifierBaseSwift
class SCIRubberBandXyZoomModifier : SCIGestureModifierBase -
Defines a color palette with single color which can be used with
See moreSCSurfaceMeshRenderableSeries3DandSCIFreeSurfaceRenderableSeries3De.g. to give a height-map at runtime.Declaration
Objective-C
@interface SCISolidColorBrushPalette : SCIBrushColorPaletteSwift
class SCISolidColorBrushPalette : SCIBrushColorPalette -
A raster RenderableSeries type which displays two lines and shaded bands between them, where band-colors depend on whether one line is greater than the other.
See moreDeclaration
Objective-C
@interface SCISplineBandRenderableSeries : SCIBaseBandRenderableSeriesSwift
class SCISplineBandRenderableSeries : SCIBaseBandRenderableSeries -
Defines the
ISCISeriesRenderPassData, the data used in a single render pass bySCISplineLineRenderableSeries.Declaration
Objective-C
@interface SCISplineLineRenderPassData : SCISplineXyRenderPassDataSwift
class SCISplineLineRenderPassData : SCISplineXyRenderPassData -
Defines a Spline Line renderable series, supporting solid, stroked (thickness 1+) lines, dashed lines and optional Point-markers
See moreISCIRenderableSeries.pointMarker.Declaration
Objective-C
@interface SCISplineLineRenderableSeries : SCIXyRenderableSeriesBaseSwift
class SCISplineLineRenderableSeries : SCIXyRenderableSeriesBase -
Provides Spline Mountain (Area) series rendering, however makes the assumption that all
See moreX-Datais evenly spacedDeclaration
Objective-C
@interface SCISplineMountainRenderableSeries : SCIBaseMountainRenderableSeriesSwift
class SCISplineMountainRenderableSeries : SCIBaseMountainRenderableSeries -
Defines the
See moreISCISeriesRenderPassData, the data used in a single render pass by Spline Renderable Series, that extendsSCIXyRenderableSeriesBase.Declaration
Objective-C
@interface SCISplineXyRenderPassData : SCIXyRenderPassDataSwift
class SCISplineXyRenderPassData : SCIXyRenderPassData -
Defines a base class for a
ViewportManager, which may be used to control visible range and ranging and to perform zoom operations on aSCIChartSurface.Declaration
Objective-C
@interface SCIViewportManagerBase2D<TParentSurface : id <ISCIChartSurface>> : SCIViewportManagerBase <TParentSurface>Swift
class SCIViewportManagerBase2D<TParentSurface> : SCIViewportManagerBase<TParentSurface> where TParentSurface : ISCIChartSurface -
Defines a class with methods for animating Axes VisibleRange.
See moreDeclaration
Objective-C
@interface SCIVisibleRangeAnimator : NSObject <ISCIVisibleRangeAnimator>Swift
class SCIVisibleRangeAnimator : NSObject, ISCIVisibleRangeAnimator -
Defines the
See moreISCIAnimatorListenerwhich is used inSCIVisibleRangeAnimator.Declaration
Objective-C
@interface SCIVisibleRangeAnimatorListener : NSObject <ISCIAnimatorListener>Swift
class SCIVisibleRangeAnimatorListener : NSObject, ISCIAnimatorListener -
Defines an entity to display the
XYZ Axis gizmoin the bottom left of the screen.Declaration
Objective-C
@interface SCIXyzGizmo : SCIBaseSceneEntitySwift
class SCIXyzGizmo : SCIBaseSceneEntity
View on GitHub