iOS & macOS Charting Documentation - SciChart iOS & macOS Charts SDK v4.x
ISCIPieRenderableSeries
@protocol ISCIPieRenderableSeries <
ISCIRenderableSeriesCore, ISCIPieChartSurfaceProvider,
ISCIInvalidatableElement, ISCIAttachable, ISCIThemeable>
Defines the interface for renderable series which are used within ISCIPieChartSurface
.
-
Gets or sets a flag indicating whether to draw labels over segments, or not.
Declaration
Objective-C
@property (nonatomic) BOOL drawLabels;
Swift
var drawLabels: Bool { get set }
-
Gets or sets the start angle value from which this series will be drawn.
Declaration
Objective-C
@property (nonatomic) float startAngle;
Swift
var startAngle: Float { get set }
-
Gets or sets the value which specifies the offset from center, which will be used for selected
ISCIPieSegment
s.Declaration
Objective-C
@property (nonatomic) float selectedSegmentOffset;
Swift
var selectedSegmentOffset: Float { get set }
-
Gets or sets the
ISCIPieRenderableSeries
height consideringheightSizingMode
.Declaration
Objective-C
@property (nonatomic) float height;
Swift
var height: Float { get set }
-
Gets or sets the
SCISizingMode
to use for computation of this series height. E.g. the default of Absolute requires that the spacing value is in pixels. The value of Relative requires relative spacing value.Declaration
Objective-C
@property (nonatomic) SCISizingMode heightSizingMode;
Swift
var heightSizingMode: SCISizingMode { get set }
-
Gets or sets the value indicating spacing between segments of current
ISCIPieRenderableSeries
.Declaration
Objective-C
@property (nonatomic) float segmentSpacing;
Swift
var segmentSpacing: Float { get set }
-
Gets or sets the value determines which percentage of the circumference is occupied by the series.
Declaration
Objective-C
@property (nonatomic) float scale;
Swift
var scale: Float { get set }
-
Gets or sets the name of this series.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nonnull seriesName;
Swift
var seriesName: String { get set }
-
Gets the collection of
ISCIPieSegment
that thisISCIPieRenderableSeries
draws.Declaration
Objective-C
@property (nonatomic, strong, readonly) SCIPieSegmentCollection *_Nonnull segmentsCollection;
Swift
var segmentsCollection: SCIPieSegmentCollection { get }
-
Gets the collection of
ISCIPieSegment
that are selected.Declaration
Objective-C
@property (nonatomic, strong, readonly) SCIPieSegmentCollection *_Nonnull selectedSegmentsCollection;
Swift
var selectedSegmentsCollection: SCIPieSegmentCollection { get }
-
Checks if this
ISCIPieRenderableSeries
has segments in it’sSCIPieSegmentCollection
.Declaration
Objective-C
@property (nonatomic, readonly) BOOL hasSegments;
Swift
var hasSegments: Bool { get }
Return Value
true if this
ISCIPieRenderableSeries
has at least one segment. Otherwise - false. -
Returns the current
ISCIPieDonutRenderPassData
instance which is used for render pass.Declaration
Objective-C
@property (nonatomic, strong, readonly) id<ISCIPieDonutRenderPassData> _Nonnull currentRenderPassData;
Swift
var currentRenderPassData: ISCIPieDonutRenderPassData { get }
-
Performs a hit-test at the specific point
[x, y]
coordinate on the parentSCIPieChartSurface
.Declaration
Objective-C
- (void)hitTest:(nonnull SCIPieHitTestInfo *)hitTestResult at:(CGPoint)point;
Swift
func hitTest(_ hitTestResult: SCIPieHitTestInfo, at point: CGPoint)
Parameters
hitTestResult
The SCIPieHitTestInfo instance where result of hit-test should be stored.
point
point The x-y coordinates in pixels relative to parent SCIPieChartSurface.
-
Gets or sets the
ISCIPieSeriesInfoProvider
instance associated with this series.Declaration
Objective-C
@property (nonatomic, strong) id<ISCIPieSeriesInfoProvider> _Nonnull seriesInfoProvider;
Swift
var seriesInfoProvider: ISCIPieSeriesInfoProvider { get set }
-
Gets or sets label formatter for
ISCIPieSegment
collection use by this series.Declaration
Objective-C
@property (nonatomic, strong, nullable) id<ISCIPieSegmentLabelFormatter> pieSegmentLabelFormatter;
Swift
var pieSegmentLabelFormatter: ISCIPieSegmentLabelFormatter? { get set }
-
Asynchronously requests layout for the parent
ISCIPieChartSurface
instance.Declaration
Objective-C
- (void)invalidateLayout;
Swift
func invalidateLayout()
-
Called during layout pass and updates current layout pass data.
Declaration
Objective-C
- (void)updateLayoutPassDataWithState: (nonnull SCIPieChartLayoutState *)pieChartLayoutState;
Swift
func updateLayoutPassData(with pieChartLayoutState: SCIPieChartLayoutState)
-
Draws this ISCIPieRenderableSeries instance.
Declaration
Objective-C
- (void)onDrawOnCGContext:(nonnull CGContextRef)context;
Swift
func onDraw(on context: CGContext)
Parameters
context
The
CGContext
to draw on. -
Animates this series with specified duration.
Declaration
Objective-C
- (void)animateWithDuration:(NSTimeInterval)duration;
Swift
func animate(withDuration duration: TimeInterval)
Parameters
duration
The duration of animation in milliseconds.