Interface ISciPieChartSurface
Defines the interface to the SciPieChartSurface, which contains a single PieChartRenderSurface viewport for rendering multiple IPieRenderableSeries which may have a IPieSegment in the appropriate PieSegmentCollection as a source.
The SciPieChartSurface may have zero or many IPieChartModifier to enable interaction with the chart. See Also: IPieRenderableSeries, SciPieChartSurface, IPieSegment, IPieChartModifier
Namespace:
Assembly: .dll
Syntax
public interface ISciPieChartSurface extends ISciChartSurfaceBase, IPublishMotionEvents, IViewContainer, IThemeable
Methods
getChartModifiers()
Gets the collection of IPieChartModifier that this SciPieChartSurface uses
Declaration
public abstract PieChartModifierCollection getChartModifiers()
Returns
| Type | Description |
|---|---|
| PieChartModifierCollection | The chart modifier collection |
getHoleRadius()
Gets the value indicating radius of the hole, which is used only for DonutRenderableSeries
Declaration
public abstract float getHoleRadius()
Returns
| Type | Description |
|---|---|
| float | The current hole radius value. |
getHoleRadiusSizingMode()
Gets the SizingMode to use for computation of radius of the hole, which is used only for DonutRenderableSeries E.g. the default of Absolute requires that the spacing value is in pixels. The value of Relative requires relative spacing value
Declaration
public abstract SizingMode getHoleRadiusSizingMode()
Returns
| Type | Description |
|---|---|
| SizingMode | The current SizingMode instance. |
getRenderableSeries()
Gets the collection of IPieRenderableSeries that this SciPieChartSurface draws
Declaration
public abstract PieRenderableSeriesCollection getRenderableSeries()
Returns
| Type | Description |
|---|---|
| PieRenderableSeriesCollection | The RenderableSeries collection |
getSelectedRenderableSeries()
Gets the collection of IPieRenderableSeries that are selected
Declaration
public abstract PieRenderableSeriesCollection getSelectedRenderableSeries()
Returns
| Type | Description |
|---|---|
| PieRenderableSeriesCollection | The selected renderable series |
getSeriesSpacing()
Gets the value indicating spacing between IPieRenderableSeries instances.
Declaration
public abstract float getSeriesSpacing()
Returns
| Type | Description |
|---|---|
| float | The value which indicates spacing between series. |
getSeriesSpacingMode()
Gets the SizingMode to use for computation of spacing. E.g. the default of Absolute requires that the spacing value is in pixels. The value of Relative requires that the spacing value is a double value from 0.0 to 1.0.
Declaration
public abstract SizingMode getSeriesSpacingMode()
Returns
| Type | Description |
|---|---|
| SizingMode | The current SizingMode instance. |
getTheme()
Gets the current theme applied to this ISciPieChartSurface
Declaration
public abstract int getTheme()
Returns
| Type | Description |
|---|---|
| int | The theme id. |
invalidateLayout()
Asynchronously requests layout for this ISciPieChartSurface instance.
Declaration
public abstract void invalidateLayout()
onSciChartRendered(PieChartRenderedMessage renderedMessage)
Processes PieChartRenderedMessage which is raised at at the end of render pass
Declaration
public abstract void onSciChartRendered(PieChartRenderedMessage renderedMessage)
Parameters
| Type | Name | Description |
|---|---|---|
| PieChartRenderedMessage | renderedMessage | The PieChartRenderedMessage instance |
setHoleRadius(float holeRadius)
Sets the value indicating radius of the hole, which is used only for DonutRenderableSeries
Declaration
public abstract void setHoleRadius(float holeRadius)
Parameters
| Type | Name | Description |
|---|---|---|
| float | holeRadius | New value for hole radius. |
setHoleRadiusSizingMode(SizingMode sizingMode)
Sets the SizingMode to use for computation of radius of the hole, which is used only for DonutRenderableSeries E.g. the default of Absolute requires that the spacing value is in pixels. The value of Relative requires relative spacing value
Declaration
public abstract void setHoleRadiusSizingMode(SizingMode sizingMode)
Parameters
| Type | Name | Description |
|---|---|---|
| SizingMode | sizingMode | The new SizingMode instance. |
setRenderedListener(ISciPieChartSurfaceRenderedListener listener)
Sets the ISciPieChartSurfaceRenderedListener instance for this surface
Declaration
public abstract void setRenderedListener(ISciPieChartSurfaceRenderedListener listener)
Parameters
| Type | Name | Description |
|---|---|---|
| ISciPieChartSurfaceRenderedListener | listener | The listener to set |
setSeriesSpacing(float seriesSpacing)
Sets the value indicating spacing between IPieRenderableSeries instances.
Declaration
public abstract void setSeriesSpacing(float seriesSpacing)
Parameters
| Type | Name | Description |
|---|---|---|
| float | seriesSpacing | New spacing between series. |
setSeriesSpacingMode(SizingMode sizingMode)
Gets the SizingMode to use for computation of spacing. E.g. the default of Absolute requires that the spacing value is in pixels. The value of Relative requires that the spacing value is a double value from 0.0 to 1.0.
Declaration
public abstract void setSeriesSpacingMode(SizingMode sizingMode)
Parameters
| Type | Name | Description |
|---|---|---|
| SizingMode | sizingMode | The new SizingMode instance. |