Core API Reference Reference


                        
                        
                        ISCIComparable

Provides a protocol that can be compared. The ISCIComparable is used for types that have inherent orter, such as NSNumber and NSDate.

Declaration

Objective-C

@protocol ISCIComparable <NSObject>

Swift

protocol ISCIComparable : NSObjectProtocol


                        
                        
                        SCIDataType

Enumeration of SciChart supported types.

Declaration

Objective-C

enum SCIDataType : NSUInteger {}

Swift

enum SCIDataType : UInt, @unchecked Sendable


                        
                        
                        ISCIAttachable

Defines interface with methods which allows to attach/detach this instance to ISCIServiceContainer.

Declaration

Objective-C

@protocol ISCIAttachable <NSObject>

Swift

protocol ISCIAttachable : NSObjectProtocol


                        
                        
                        ISCICleanable

Defines a methods which allow to clean current state of object.

Declaration

Objective-C

@protocol ISCICleanable <NSObject>

Swift

protocol ISCICleanable : NSObjectProtocol


                        
                        
                        ISCIDisposable

Classes which comforms to ISCIDisposable protocol can be disposed.

Declaration

Objective-C

@protocol ISCIDisposable <NSObject>

Swift

protocol ISCIDisposable : NSObjectProtocol


                        
                        
                        SCIDisposableBase

Defines base class for the disposable object.

Declaration

Objective-C

@interface SCIDisposableBase : NSObject <ISCIDisposable>

Swift

class SCIDisposableBase : NSObject, ISCIDisposable


                        
                        
                        ISCIHitTestable

Defines the base interface for a type which can be hit-tested.

Declaration

Objective-C

@protocol ISCIHitTestable <NSObject>

Swift

protocol ISCIHitTestable : NSObjectProtocol


                        
                        
                        ISCIInvalidatableElement

Classes which implement ISCIInvalidatableElement can be invalidated (redrawn).

Declaration

Objective-C

@protocol ISCIInvalidatableElement <NSObject>

Swift

protocol ISCIInvalidatableElement : NSObjectProtocol


                        
                        
                        ISCISuspendable

Classes which implement ISCISuspendable can have updates suspended/resumed.

Note

Useful for batch operations.

Declaration

Objective-C

@protocol ISCISuspendable <NSObject>

Swift

protocol ISCISuspendable : NSObjectProtocol


                        
                        
                        ISCIUpdateSuspender

Defines the interface to an SCIUpdateSuspender, a disposable class which allows nested suspend/resume operations on an ISCISuspendable instance.

Declaration

Objective-C

@protocol ISCIUpdateSuspender <ISCIDisposable>

Swift

protocol ISCIUpdateSuspender : ISCIDisposable


                        
                        
                        SCIUpdateSuspender

A disposable class which allows nested suspend/resume operations on an ISCISuspendable target.

Declaration

Objective-C

@interface SCIUpdateSuspender : SCIDisposableBase <ISCIUpdateSuspender>

Swift

class SCIUpdateSuspender : SCIDisposableBase, ISCIUpdateSuspender


                        
                        
                        ISCIView

Defines protocol which allows to get access to some of the UIView members.

Declaration

Objective-C

@protocol ISCIView <ISCIHitTestable>

Swift

protocol ISCIView : ISCIHitTestable


                        
                        
                        ISCIViewContainer

Defines interface with methods which allows to add/remove views from this container.

Declaration

Objective-C

@protocol ISCIViewContainer <ISCIView, ISCICleanable>

Swift

protocol ISCIViewContainer : ISCICleanable, ISCIView


                        
                        
                        ISCIServiceProvider

Classes which conforms to ISCIServiceProvider can get access to services provided by SciChart.

Declaration

Objective-C

@protocol ISCIServiceProvider <NSObject>

Swift

protocol ISCIServiceProvider : NSObjectProtocol


                        
                        
                        ISCIServiceContainer

Defines the interface to a ServiceContainer used throughout SciChart.

Declaration

Objective-C

@protocol ISCIServiceContainer <NSObject>

Swift

protocol ISCIServiceContainer : NSObjectProtocol


                        
                        
                        SCIServiceContainer

Provides a container with access to shared services through SciChart components.

Declaration

Objective-C

@interface SCIServiceContainer : NSObject <ISCIServiceContainer>

Swift

class SCIServiceContainer : NSObject, ISCIServiceContainer


                        
                        
                        SCIAttachableServiceContainer

Provides an attachable container with access to shared services through SciChart components.

Declaration

Objective-C

@interface SCIAttachableServiceContainer : SCIServiceContainer <ISCIAttachable>

Swift

class SCIAttachableServiceContainer : SCIServiceContainer, ISCIAttachable


                        
                        
                        ISCIPublishEvents

Defines the protocol to a class which publishes motion events.

Declaration

Objective-C

@protocol ISCIPublishEvents <NSObject>

Swift

protocol ISCIPublishEvents : NSObjectProtocol


                        
                        
                        ISCIReceiveEvents

Defines the interface to a type which receives unified events.

Declaration

Objective-C

@protocol ISCIReceiveEvents <NSObject>

Swift

protocol ISCIReceiveEvents : NSObjectProtocol


                        
                        
                        SCIModifierEventArgs

Defines an event args, used by various classes within SciChart to process motion events.

Declaration

Objective-C

@interface SCIModifierEventArgs : NSObject <ISCICleanable>

Swift

class SCIModifierEventArgs : NSObject, ISCICleanable


                        
                        
                        ISCIEventManager

Defines the protocol to the SCIEventManager, a helper class to propagate events.

Declaration

Objective-C

@protocol ISCIEventManager

Swift

protocol ISCIEventManager


                        
                        
                        ISCIChartDebugLoggerFacade

Defines the protocol to a logger facade. If you wish to receive debug log messages from SciChart, then set a logger instance via -[SCIChartDebugLogger setLoggerFacade:].

Warning

Please note, that logging will dramatically decrease performance, especially in a real-time scenario.

Declaration

Objective-C

@protocol ISCIChartDebugLoggerFacade <NSObject>

Swift

protocol ISCIChartDebugLoggerFacade : NSObjectProtocol


                        
                        
                        SCIChartDebugLogger

Provides a debug logger which can be used to pipe debug messages from SciChart to your own code, by setting the ISCIChartDebugLoggerFacade via -[SCIChartDebugLogger setLoggerFacade:].

Declaration

Objective-C

@interface SCIChartDebugLogger : NSObject

Swift

class SCIChartDebugLogger : NSObject


                        
                        
                        ISCIEventAggregator

Defines the interface to a lightweight Event Aggregator used within SciChart for inter-component communication.

Declaration

Objective-C

@protocol ISCIEventAggregator <NSObject>

Swift

protocol ISCIEventAggregator : NSObjectProtocol


                        
                        
                        ISCIMessage

A message to be published/delivered by ISCIEventAggregator.

Declaration

Objective-C

@protocol ISCIMessage <NSObject>

Swift

protocol ISCIMessage : NSObjectProtocol


                        
                        
                        SCIMessageBase

Base class for messages published/delivered by ISCIEventAggregator.

Declaration

Objective-C

@interface SCIMessageBase : NSObject <ISCIMessage>

Swift

class SCIMessageBase : NSObject, ISCIMessage


                        
                        
                        SCILoggedMessage

Base class for automatically logged Event Aggregator messages.

Declaration

Objective-C

@interface SCILoggedMessage : SCIMessageBase

Swift

class SCILoggedMessage : SCIMessageBase


                        
                        
                        ISCIMessageSubscription

Represents a message subscription.

Declaration

Objective-C

@protocol ISCIMessageSubscription <NSObject>

Swift

protocol ISCIMessageSubscription : NSObjectProtocol


                        
                        
                        SCIMessageSubscriptionToken

Represents an active subscription to a message.

Declaration

Objective-C

@interface SCIMessageSubscriptionToken : SCIDisposableBase

Swift

class SCIMessageSubscriptionToken : SCIDisposableBase


                        
                        
                        SCICollectionChangedEventArgs

Defines a class which contains changes of SCIObservableCollection.

Note

E - is the type of elements in the changed SCIObservableCollection.

Declaration

Objective-C

@interface SCICollectionChangedEventArgs<T> : NSObject <ISCICleanable> {
  NSMutableArray<T> *_newItems;
  NSMutableArray<T> *_oldItems;
}

Swift

class SCICollectionChangedEventArgs<T> : NSObject, ISCICleanable where T : AnyObject


                        
                        
                        SCICollectionObserver

Defines the listener for SCIObservableCollection. Called when SCIObservableCollection changes.

Declaration

Objective-C

typedef void (^SCICollectionObserver)(SCIObservableCollection *_Nonnull,
                                      SCICollectionChangedEventArgs *_Nonnull)

Parameters

`collection`	The collection which changed.
`args`	The `SCICollectionChangedEventArgs` instance with changes in collection.


                        
                        
                        SCIObservableCollection

Defines a collection implementation which allows to get notification about adding, removing objects from it.

Note

T is the type of underlying objects.

Declaration

Objective-C

@interface SCIObservableCollection<__covariant T> : NSObject <NSFastEnumeration>

Swift

class SCIObservableCollection<T> : NSObject, NSFastEnumeration where T : AnyObject


                        
                        
                        SCIProjectionCollection

Defines special read-only collection which projects items of one collection into another collection according to specified transform function.

Note

T - is the type of items to project to.

Note

TSource - is the type of source items which need to be projected.

Declaration

Objective-C

@interface SCIProjectionCollection<__covariant T, __covariant TSource>
    : SCIObservableCollection <T>

Swift

class SCIProjectionCollection<T, TSource> : SCIObservableCollection<T> where T : AnyObject, TSource : AnyObject


                        
                        
                        SCIObservableSmartPropertyBool

Defines a smart property class which can hold boolean value and provides listener with old and new value.

Declaration

Objective-C

@interface SCIObservableSmartPropertyBool : SCISmartPropertyBool

Swift

class SCIObservableSmartPropertyBool : SCISmartPropertyBool


                        
                        
                        SCIObservableSmartPropertyDouble

Defines a smart property class which can hold double value and provides listener with old and new value.

Declaration

Objective-C

@interface SCIObservableSmartPropertyDouble : SCISmartPropertyDouble

Swift

class SCIObservableSmartPropertyDouble : SCISmartPropertyDouble


                        
                        
                        SCIObservableSmartPropertyFloat

Defines a smart property class which can hold float value and provides listener with old and new value.

Declaration

Objective-C

@interface SCIObservableSmartPropertyFloat : SCISmartPropertyFloat

Swift

class SCIObservableSmartPropertyFloat : SCISmartPropertyFloat


                        
                        
                        SCIObservableSmartPropertyInt

Defines a smart property class which can hold int value and provides listener with old and new value.

Declaration

Objective-C

@interface SCIObservableSmartPropertyInt : SCISmartPropertyInt

Swift

class SCIObservableSmartPropertyInt : SCISmartPropertyInt


                        
                        
                        SCIObservableSmartPropertyLong

Defines a smart property class which can hold long value and provides listener with old and new value.

Declaration

Objective-C

@interface SCIObservableSmartPropertyLong : SCISmartPropertyLong

Swift

class SCIObservableSmartPropertyLong : SCISmartPropertyLong


                        
                        
                        SCIObjectPool

Defines a simple object pool implementation which allows to reuse object instances.

Declaration

Objective-C

@interface SCIObjectPool<T> : NSObject <ISCICleanable>

Swift

class SCIObjectPool<T> : NSObject, ISCICleanable where T : AnyObject


                        
                        
                        UIColor(Util)

Helper category with some color constants and helper methods to work with Color.

Declaration

Objective-C

@interface UIColor (Util)


                        
                        
                        SCIComparableUtil

Defines helper class for works with ISCIComparable.

Declaration

Objective-C

@interface SCIComparableUtil : NSObject

Swift

class SCIComparableUtil : NSObject


                        
                        
                        SCIDateUtil

Helper class for work with NSDate values

Declaration

Objective-C

@interface SCIDateUtil : NSObject

Swift

class SCIDateUtil : NSObject


                        
                        
                        SCIDateIntervalUtil

Helper class for work with date intervals, which are measured in seconds in Cocoa.

Declaration

Objective-C

@interface SCIDateIntervalUtil : NSObject

Swift

class SCIDateIntervalUtil : NSObject


                        
                        
                        SCISmartProperty

Defines a smart property class which can hold any NSObject instances.

Declaration

Objective-C

@interface SCISmartProperty : NSObject

Swift

class SCISmartProperty : NSObject


                        
                        
                        SCISmartPropertyBool

Defines a smart property class which can hold boolean value.

Declaration

Objective-C

@interface SCISmartPropertyBool : NSObject

Swift

class SCISmartPropertyBool : NSObject


                        
                        
                        SCISmartPropertyDouble

Defines a smart property class which can hold double value.

Declaration

Objective-C

@interface SCISmartPropertyDouble : NSObject

Swift

class SCISmartPropertyDouble : NSObject


                        
                        
                        SCISmartPropertyFloat

Defines a smart property class which can hold float value.

Declaration

Objective-C

@interface SCISmartPropertyFloat : NSObject

Swift

class SCISmartPropertyFloat : NSObject


                        
                        
                        SCISmartPropertyInt

Defines a smart property class which can hold int value.

Declaration

Objective-C

@interface SCISmartPropertyInt : NSObject

Swift

class SCISmartPropertyInt : NSObject


                        
                        
                        SCISmartPropertyLong

Defines a smart property class which can hold long value.

Declaration

Objective-C

@interface SCISmartPropertyLong : NSObject

Swift

class SCISmartPropertyLong : NSObject


                        
                        
                        ISCIValues

Defines the base protocol for values.

Declaration

Objective-C

@protocol ISCIValues <ISCICleanable>

Swift

protocol ISCIValues : ISCICleanable


                        
                        
                        SCIBoolValues

Defines a byte values collection.

Declaration

Objective-C

@interface SCIBoolValues : SCIDisposableBase <ISCIValues>

Swift

class SCIBoolValues : SCIDisposableBase, ISCIValues


                        
                        
                        SCIByteValues

Defines a byte values collection.

Declaration

Objective-C

@interface SCIByteValues : SCIDisposableBase <ISCIValues>

Swift

class SCIByteValues : SCIDisposableBase, ISCIValues


                        
                        
                        SCIDateValues

Defines a NSDate values collection.

Declaration

Objective-C

@interface SCIDateValues : SCIDisposableBase <ISCIValues>

Swift

class SCIDateValues : SCIDisposableBase, ISCIValues


                        
                        
                        SCIDoubleValues

Defines a double values collection

Declaration

Objective-C

@interface SCIDoubleValues : SCIDisposableBase <ISCIValues>

Swift

class SCIDoubleValues : SCIDisposableBase, ISCIValues


                        
                        
                        SCIFloatValues

Defines a float values collection.

Declaration

Objective-C

@interface SCIFloatValues : SCIDisposableBase <ISCIValues>

Swift

class SCIFloatValues : SCIDisposableBase, ISCIValues


                        
                        
                        SCIIntegerValues

Defines an int values collection.

Declaration

Objective-C

@interface SCIIntegerValues : SCIDisposableBase <ISCIValues>

Swift

class SCIIntegerValues : SCIDisposableBase, ISCIValues


                        
                        
                        SCILongValues

Defines a long long values collection.

Declaration

Objective-C

@interface SCILongValues : SCIDisposableBase <ISCIValues>

Swift

class SCILongValues : SCIDisposableBase, ISCIValues


                        
                        
                        SCIShortValues

Defines a short values collection.

Declaration

Objective-C

@interface SCIShortValues : SCIDisposableBase <ISCIValues>

Swift

class SCIShortValues : SCIDisposableBase, ISCIValues


                        
                        
                        SCIUnsignedByteValues

Defines a byte values collection

Declaration

Objective-C

@interface SCIUnsignedByteValues : SCIDisposableBase <ISCIValues>

Swift

class SCIUnsignedByteValues : SCIDisposableBase, ISCIValues


                        
                        
                        SCIUnsignedIntegerValues

Defines an unsigned int values collection.

Declaration

Objective-C

@interface SCIUnsignedIntegerValues : SCIDisposableBase <ISCIValues>

Swift

class SCIUnsignedIntegerValues : SCIDisposableBase, ISCIValues


                        
                        
                        SCIUnsignedLongValues

Defines a unsigned long long values collection.

Declaration

Objective-C

@interface SCIUnsignedLongValues : SCIDisposableBase <ISCIValues>

Swift

class SCIUnsignedLongValues : SCIDisposableBase, ISCIValues


                        
                        
                        SCIUnsignedShortValues

Defines a unsigned short values collection.

Declaration

Objective-C

@interface SCIUnsignedShortValues : SCIDisposableBase <ISCIValues>

Swift

class SCIUnsignedShortValues : SCIDisposableBase, ISCIValues