iOS Charting Documentation - SciChart iOS Charts SDK v3.x

ISCIPieRenderableSeries

@protocol ISCIPieRenderableSeries <NSObject, ISCIInvalidatableElement>

@extends ISCIInvalidatableElement

  • Parent surface of renderable series. Set internally during adding renderable series to surface.

    Declaration

    Objective-C

    @property (nonatomic, weak, readwrite, nullable)
        SCIPieChartSurface *parentSurface;

    Swift

    weak var parentSurface: SCIPieChartSurface? { get set }
  • Collection of segments of renderable series.

    Declaration

    Objective-C

    @property (nonatomic, strong, readwrite, nonnull)
        SCIPieSegmentCollection *segments;

    Swift

    var segments: SCIPieSegmentCollection { get set }
  • Defines a value indicating is this series has segmengs.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL hasSegments;

    Swift

    var hasSegments: Bool { get }
  • Renderable series name.

    Declaration

    Objective-C

    @property (nonatomic, strong, readwrite, nonnull) NSString *seriesName;

    Swift

    var seriesName: String { get set }
  • Gets or sets series visibility

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite) BOOL isVisible;

    Swift

    var isVisible: Bool { get set }
  • Return true if series has selected sectors

    Declaration

    Objective-C

    - (BOOL)isSelected;

    Swift

    func isSelected() -> Bool
  • Total combined value of all segments

    Declaration

    Objective-C

    - (double)totalSegmentValue;

    Swift

    func totalSegmentValue() -> Double
  • Data used for drawing. Contains information like frame, center and radius Changes internally during charts layout process

    See

    SCIPieRenderPassData

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite, nonnull)
        SCIPieRenderPassData *renderData;

    Swift

    var renderData: SCIPieRenderPassData { get set }
  • Height of renderable series. Not used for drawing. Radius of series is calculated internally from this property in combination with heightSizingMode

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite) double height;

    Swift

    var height: Double { get set }
  • Mode for charts height

    See

    SCIPieSeriesSizingMode

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
        SCIPieSeriesSizingMode heightSizingMode;

    Swift

    var heightSizingMode: SCIPieSeriesSizingMode { get set }
  • Starting angle offset for series in radinas. Default is zero (start at right) and increases clockwise

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite) double startAngle;

    Swift

    var startAngle: Double { get set }
  • Scaleof circle series. Value is fraction of circle where 0 is empty circle and 1 is full circle

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite) double scale;

    Swift

    var scale: Double { get set }
  • Sets renderData based on calculated layout data Called internally during autolayout process

    See

    SCIPieRenderPassData

    See

    SCIPieLayoutPassData

    Declaration

    Objective-C

    - (void)setLayout:(SCIPieLayoutPassData *_Nonnull)data;

    Swift

    func setLayout(_ data: SCIPieLayoutPassData)
  • Start appear animation with duration in seconds

    Declaration

    Objective-C

    - (void)animate:(double)duration;

    Swift

    func animate(_ duration: Double)
  • Entry point for drawing

    Declaration

    Objective-C

    - (void)draw;

    Swift

    func draw()
  • Set isSelected to false for all segments

    Declaration

    Objective-C

    - (void)deselectSegments;

    Swift

    func deselectSegments()
  • Set isSelected to true for segment by index

    Declaration

    Objective-C

    - (void)selectSegmentAtIndex:(int)index;

    Swift

    func selectSegment(at index: Int32)
  • Changes isSelected state for segment by index

    Declaration

    Objective-C

    - (void)setSegmentSelected:(BOOL)selected atIndex:(int)index;

    Swift

    func setSegmentSelected(_ selected: Bool, at index: Int32)
  • Performs hit test at point and return segment index if hit, or -1 if miss

    Declaration

    Objective-C

    - (int)getSegmentIndexAtPoint:(CGPoint)point;

    Swift

    func getSegmentIndex(at point: CGPoint) -> Int32
  • Formats text for segment. By default its’ “Title: value (percent_of_total%)”

    Declaration

    Objective-C

    - (NSString *_Nonnull)getSegmentTextAtIndex:(int)index;

    Swift

    func getSegmentText(at index: Int32) -> String
  • Returns tools for hit test

    See

    SCIPieHitTestProvider

    Declaration

    Objective-C

    - (SCIPieHitTestProvider *_Nullable)hitTestProvider;

    Swift

    func hitTestProvider() -> SCIPieHitTestProvider?
  • Gets or sets offset from center in points for selected segments

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
        double selectedSegmentOffset;

    Swift

    var selectedSegmentOffset: Double { get set }
  • Gets or sets fill style for segments. Used only if fill style is nil on segment.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite, nullable)
        SCIBrushStyle *segmentFillStyle;

    Swift

    var segmentFillStyle: SCIBrushStyle? { get set }
  • Gets or sets selected fill style for segments. Used only if selected fill style is nil on segment.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite, nullable)
        SCIBrushStyle *selectedSegmentFillStyle;

    Swift

    var selectedSegmentFillStyle: SCIBrushStyle? { get set }
  • Gets or sets stroke style for segments. Used only if stroke style is nil on segment.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite, nullable)
        SCIPenStyle *segmentStrokeStyle;

    Swift

    var segmentStrokeStyle: SCIPenStyle? { get set }
  • Gets or sets selected stroke style for segments. Used only if selected stroke style is nil on segment.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite, nullable)
        SCIPenStyle *selectedSegmentStrokeStyle;

    Swift

    var selectedSegmentStrokeStyle: SCIPenStyle? { get set }
  • Gets or sets title style for segments. Used only if title style is nil on segment.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite, nullable)
        SCIFontStyle *segmentTitleStyle;

    Swift

    var segmentTitleStyle: SCIFontStyle? { get set }
  • Gets or sets selected title style for segments. Used only if selected title style is nil on segment.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite, nullable)
        SCIFontStyle *selectedSegmentTitleStyle;

    Swift

    var selectedSegmentTitleStyle: SCIFontStyle? { get set }
  • Return fill style for segment based on style priorities (segment style first, series style second) and selected state

    Declaration

    Objective-C

    - (SCIBrushStyle *_Nullable)getFillStyleForSegment:
        (SCIPieSegment *_Nonnull)segment;

    Swift

    func getFillStyle(for segment: SCIPieSegment) -> SCIBrushStyle?
  • Return stroke style for segment based on style priorities (segment style first, series style second) and selected state

    Declaration

    Objective-C

    - (SCIPenStyle *_Nullable)getStrokeStyleForSegment:
        (SCIPieSegment *_Nonnull)segment;

    Swift

    func getStrokeStyle(for segment: SCIPieSegment) -> SCIPenStyle?
  • Return text style for segment based on style priorities (segment style first, series style second) and selected state

    Declaration

    Objective-C

    - (SCIFontStyle *_Nullable)getTextStyleForSegment:
        (SCIPieSegment *_Nonnull)segment;

    Swift

    func getTextStyle(for segment: SCIPieSegment) -> SCIFontStyle?