Class PieDonutRenderableSeriesBase

Defines the Base class for for renderable series which are used within ISciPieChartSurface.

Inheritance
java.lang.Object
renderableSeries.RenderableSeriesCore
PieDonutRenderableSeriesBase
Inherited Members
Namespace:
Assembly: .dll
Syntax
public abstract class PieDonutRenderableSeriesBase extends renderableSeries.RenderableSeriesCore implements renderableSeries.IPieRenderableSeries

Constructors

PieDonutRenderableSeriesBase(renderableSeriesIPieDonutRenderPassData currentRenderPassData, renderableSeries.hitTest.IPieChartHitProvider hitProvider)

Abstract constructor for PieDonutRenderableSeriesBase

Declaration
protected PieDonutRenderableSeriesBase(renderableSeriesIPieDonutRenderPassData currentRenderPassData, renderableSeries.hitTest.IPieChartHitProvider hitProvider)
Parameters
Type Name Description
renderableSeriesIPieDonutRenderPassData currentRenderPassData

The render pass data instance.
renderableSeries.hitTest.IPieChartHitProvider hitProvider

The hit provider instance.

Fields

DEGREE_IN_CIRCLE

Declaration
public static final int DEGREE_IN_CIRCLE
Field Value
Type Description
int

center

Declaration
protected final PointF center
Field Value
Type Description
android.graphics.PointF

drawLabelsProperty

Declaration
protected final SmartPropertyBoolean drawLabelsProperty
Field Value
Type Description
SmartPropertyBoolean

heightProperty

Declaration
protected final SmartPropertyFloat heightProperty
Field Value
Type Description
SmartPropertyFloat

heightSizingModeProperty

Declaration
protected final SmartProperty<SizingMode> heightSizingModeProperty
Field Value
Type Description
SmartProperty<SizingMode>

invalidateElementListener

Declaration
protected final InvalidatableElementCallback invalidateElementListener
Field Value
Type Description
InvalidatableElementCallback

invalidateLayoutListener

Declaration
protected final renderableSeries.InvalidatePieRenderableSeriesLayoutListener invalidateLayoutListener
Field Value
Type Description
com.scichart.charting.visuals.renderableSeries.InvalidatePieRenderableSeriesLayoutListener

outerRadius

Declaration
protected float outerRadius
Field Value
Type Description
float

scaleProperty

Declaration
protected final SmartPropertyFloat scaleProperty
Field Value
Type Description
SmartPropertyFloat

segmentSpacingProperty

Declaration
protected final SmartPropertyFloat segmentSpacingProperty
Field Value
Type Description
SmartPropertyFloat

selectedSegmentOffsetProperty

Declaration
protected final SmartPropertyFloat selectedSegmentOffsetProperty
Field Value
Type Description
SmartPropertyFloat

seriesNameProperty

Declaration
protected final SmartProperty<String> seriesNameProperty
Field Value
Type Description
SmartProperty<String>

startAngleProperty

Declaration
protected final SmartPropertyFloat startAngleProperty
Field Value
Type Description
SmartPropertyFloat

Methods

animate(long duration)

Animates this series with specified duration.

Declaration
public void animate(long duration)
Parameters
Type Name Description
long duration

animate(long duration, TimeInterpolator interpolator)

Animates associated series with specified duration.

Declaration
public void animate(long duration, TimeInterpolator interpolator)
Parameters
Type Name Description
long duration
android.animation.TimeInterpolator interpolator

applyThemeProvider(IThemeProvider themeProvider)

Applies specified theme to current instance

Declaration
public void applyThemeProvider(IThemeProvider themeProvider)
Parameters
Type Name Description
IThemeProvider themeProvider

attachTo(IServiceContainer services)

Declaration
public void attachTo(IServiceContainer services)
Parameters
Type Name Description
IServiceContainer services
Overrides

detach()

Declaration
public void detach()
Overrides

disposeCachedData()

This method is called when series should dispose any cached data

Declaration
protected void disposeCachedData()

getContext()

Declaration
public final Context getContext()
Returns
Type Description
android.content.Context

getCurrentRenderPassData()

Returns the current IPieDonutRenderPassData instance which is used for render pass.

Declaration
public final renderableSeriesIPieDonutRenderPassData getCurrentRenderPassData()
Returns
Type Description
renderableSeriesIPieDonutRenderPassData

getDrawLabels()

Gets a flag indicating whether to draw labels over segments, or not.

Declaration
public final boolean getDrawLabels()
Returns
Type Description
boolean

getHeight()

Gets the IPieRenderableSeries height considering IPieRenderableSeries#getHeightSizingMode()

Declaration
public final float getHeight()
Returns
Type Description
float

getHeightSizingMode()

Gets the SizingMode 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
public final SizingMode getHeightSizingMode()
Returns
Type Description
SizingMode

getParentSurface()

Gets the parent surface that this instance is associated with

Declaration
public final ISciPieChartSurface getParentSurface()
Returns
Type Description
ISciPieChartSurface

getPieSegmentLabelFormatter()

Gets label formatter for IPieSegment collection use by this series

Declaration
public final renderableSeries.IPieSegmentLabelFormatter getPieSegmentLabelFormatter()
Returns
Type Description
renderableSeries.IPieSegmentLabelFormatter

getScale()

Gets the value determines which percentage of the circumference is occupied by the series.

Declaration
public final float getScale()
Returns
Type Description
float

getSegmentSpacing()

Gets the value indicating spacing between segments of current IPieRenderableSeries.

Declaration
public final float getSegmentSpacing()
Returns
Type Description
float

getSegmentsCollection()

Gets the collection of IPieSegment that this IPieRenderableSeries draws.

Declaration
public final PieSegmentCollection getSegmentsCollection()
Returns
Type Description
PieSegmentCollection

getSelectedSegmentOffset()

Gets the value which specifies the offset from center, which will be used for selected IPieSegments.

Declaration
public final float getSelectedSegmentOffset()
Returns
Type Description
float

getSelectedSegmentsCollection()

Gets the collection of IPieSegment that are selected

Declaration
public final PieSegmentCollection getSelectedSegmentsCollection()
Returns
Type Description
PieSegmentCollection

getSeriesAnimator()

Gets a ISeriesAnimator instance used to animate this series.

Declaration
protected final renderableSeries.seriesAnimators.ISeriesAnimator getSeriesAnimator()
Returns
Type Description
renderableSeries.seriesAnimators.ISeriesAnimator

The ISeriesAnimator instance.

getSeriesInfoProvider()

Gets the IPieSeriesInfoProvider instance associated with this series.

Declaration
public final renderableSeries.hitTest.IPieSeriesInfoProvider getSeriesInfoProvider()
Returns
Type Description
renderableSeries.hitTest.IPieSeriesInfoProvider

getSeriesName()

Gets the name of this series.

Declaration
public final String getSeriesName()
Returns
Type Description
String

getStartAngle()

Gets the start angle value from which this series will be drawn.

Declaration
public final float getStartAngle()
Returns
Type Description
float

hasSegments()

Checks if this IPieRenderableSeries has segments in it's PieSegmentCollection.

Declaration
public final boolean hasSegments()
Returns
Type Description
boolean

hitTest(renderableSeries.hitTest.PieHitTestInfo hitTestResult, float x, float y)

Performs a hit-test at the specific point (x,y coordinate on the parent SciPieChartSurface.

Declaration
public final void hitTest(renderableSeries.hitTest.PieHitTestInfo hitTestResult, float x, float y)
Parameters
Type Name Description
renderableSeries.hitTest.PieHitTestInfo hitTestResult
float x
float y

internalDraw(Canvas canvas, renderableSeriesIPieDonutRenderPassData renderPassData)

Draws the series using the Canvas and the IPieDonutRenderPassData passed i.

Declaration
protected abstract void internalDraw(Canvas canvas, renderableSeriesIPieDonutRenderPassData renderPassData)
Parameters
Type Name Description
android.graphics.Canvas canvas

The canvas instance to draw on.
renderableSeriesIPieDonutRenderPassData renderPassData

The render pass data which contain a pre-calculated data to draw this IPieRenderableSeries instance.

internalUpdateRenderPassData(renderableSeriesIPieDonutRenderPassData renderPassDataToUpdate)

Updates the current render pass data.

Declaration
protected void internalUpdateRenderPassData(renderableSeriesIPieDonutRenderPassData renderPassDataToUpdate)
Parameters
Type Name Description
renderableSeriesIPieDonutRenderPassData renderPassDataToUpdate

The render pass data to update

invalidateElement()

Declaration
public void invalidateElement()

invalidateLayout()

Asynchronously requests layout for the parent ISciPieChartSurface instance.

Declaration
public void invalidateLayout()

isUpdateOfRenderPassDataRequired()

Checks whether this pie renderable series need to update its render pass data.

Declaration
protected boolean isUpdateOfRenderPassDataRequired()
Returns
Type Description
boolean

If true update is required and PieDonutRenderableSeriesBase#internalUpdateRenderPassData(IPieDonutRenderPassData) should be called.

isValidForDrawing()

Checks whether this series is valid for drawing

Declaration
public boolean isValidForDrawing()
Returns
Type Description
boolean

isValidForUpdate()

Checks whether this series is valid for update

Declaration
public boolean isValidForUpdate()
Returns
Type Description
boolean

onDraw(Canvas canvas)

Draws this IPieRenderableSeries instance.

Declaration
public final void onDraw(Canvas canvas)
Parameters
Type Name Description
android.graphics.Canvas canvas

setDrawLabels(boolean drawLabels)

Sets a flag indicating whether to draw labels over segments, or not.

Declaration
public final void setDrawLabels(boolean drawLabels)
Parameters
Type Name Description
boolean drawLabels

setHeight(float height)

Sets the IPieRenderableSeries height.

Declaration
public final void setHeight(float height)
Parameters
Type Name Description
float height

setHeightSizingMode(SizingMode heightSizingMode)

Sets the SizingMode 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
public final void setHeightSizingMode(SizingMode heightSizingMode)
Parameters
Type Name Description
SizingMode heightSizingMode

setPieSegmentLabelFormatter(renderableSeries.IPieSegmentLabelFormatter labelFormatter)

Sets label formatter for IPieSegment collection use by this series

Declaration
public void setPieSegmentLabelFormatter(renderableSeries.IPieSegmentLabelFormatter labelFormatter)
Parameters
Type Name Description
renderableSeries.IPieSegmentLabelFormatter labelFormatter

setScale(float scale)

Sets the value determines which percentage of the circumference is occupied by the series.

Declaration
public final void setScale(float scale)
Parameters
Type Name Description
float scale

setSegmentSpacing(float segmentSpacing)

Sets the value indicating spacing between segments of current IPieRenderableSeries.

Declaration
public final void setSegmentSpacing(float segmentSpacing)
Parameters
Type Name Description
float segmentSpacing

setSegmentsCollection(PieSegmentCollection segmentsCollection)

Sets the collection of IPieSegment that this PieDonutRenderableSeriesBase draws.

Declaration
public final void setSegmentsCollection(PieSegmentCollection segmentsCollection)
Parameters
Type Name Description
PieSegmentCollection segmentsCollection

The segments collection.

setSelectedSegmentOffset(float offset)

Sets the value which specifies the offset from center, which will be used for selected IPieSegments.

Declaration
public final void setSelectedSegmentOffset(float offset)
Parameters
Type Name Description
float offset

setSeriesAnimator(renderableSeries.seriesAnimators.ISeriesAnimator seriesAnimator)

Sets a ISeriesAnimator instance used to animate this series.

Declaration
protected final void setSeriesAnimator(renderableSeries.seriesAnimators.ISeriesAnimator seriesAnimator)
Parameters
Type Name Description
renderableSeries.seriesAnimators.ISeriesAnimator seriesAnimator

a new ISeriesAnimator instance.

setSeriesInfoProvider(renderableSeries.hitTest.IPieSeriesInfoProvider seriesInfoProvider)

Sets the IPieSeriesInfoProvider instance associated with this series.

Declaration
public final void setSeriesInfoProvider(renderableSeries.hitTest.IPieSeriesInfoProvider seriesInfoProvider)
Parameters
Type Name Description
renderableSeries.hitTest.IPieSeriesInfoProvider seriesInfoProvider

setSeriesName(String seriesName)

Sets the name of this series.

Declaration
public final void setSeriesName(String seriesName)
Parameters
Type Name Description
String seriesName

setStartAngle(float startAngle)

Sets the start angle value from which this series will be drawn.

Declaration
public final void setStartAngle(float startAngle)
Parameters
Type Name Description
float startAngle

updateLayoutPassData(PieChartLayoutState pieChartLayoutState)

Called during layout pass and updates current layout pass data.

Declaration
public void updateLayoutPassData(PieChartLayoutState pieChartLayoutState)
Parameters
Type Name Description
PieChartLayoutState pieChartLayoutState

Implements