Class PieChartLegendModifier
Defines a custom chart modifier which shows a Legend on the SciPieChartSurface and also can provide a data-source via PieChartLegendModifier#setSourceSeries(IPieRenderableSeries) method.
Inheritance
Inherited Members
Namespace:
Assembly: .dll
Syntax
public class PieChartLegendModifier extends PieChartModifierBase
Constructors
PieChartLegendModifier(Context context)
Creates a new instance of PieChartLegendModifier class
Declaration
public PieChartLegendModifier(Context context)
Parameters
| Type | Name | Description |
|---|---|---|
| android.content.Context | context | The context of the application |
PieChartLegendModifier(SciChartLegend legend)
Creates a new instance of PieChartLegendModifier class
Declaration
public PieChartLegendModifier(SciChartLegend legend)
Parameters
| Type | Name | Description |
|---|---|---|
| SciChartLegend | legend | The SciChartLegend instance which should be used by this modifier |
PieChartLegendModifier(SciChartLegend legend, boolean useAutoPlacement)
Creates a new instance of PieChartLegendModifier class
Declaration
public PieChartLegendModifier(SciChartLegend legend, boolean useAutoPlacement)
Parameters
| Type | Name | Description |
|---|---|---|
| SciChartLegend | legend | The SciChartLegend instance which should be used by this modifier |
| boolean | useAutoPlacement | If true modifier will try to place legend inside chart, otherwise legend is already placed somewhere and shouldn't be moved |
PieChartLegendModifier(SciChartLegend legend, PieSegmentsLegendAdapter legendAdapter, boolean useAutoPlacement)
Creates a new instance of PieChartLegendModifier class
Declaration
public PieChartLegendModifier(SciChartLegend legend, PieSegmentsLegendAdapter legendAdapter, boolean useAutoPlacement)
Parameters
| Type | Name | Description |
|---|---|---|
| SciChartLegend | legend | The SciChartLegend instance which should be used by this modifier |
| PieSegmentsLegendAdapter | legendAdapter | The PieSegmentsLegendAdapter instance which should be used by legend |
| boolean | useAutoPlacement | If true modifier will try to place legend inside chart, otherwise legend is already placed somewhere and shouldn't be moved |
Methods
applyThemeProvider(IThemeProvider themeProvider)
Applies specified theme to current instance
Declaration
public void applyThemeProvider(IThemeProvider themeProvider)
Parameters
| Type | Name | Description |
|---|---|---|
| IThemeProvider | themeProvider |
Overrides
attachTo(IServiceContainer serviceContainer)
Declaration
public void attachTo(IServiceContainer serviceContainer)
Parameters
| Type | Name | Description |
|---|---|---|
| IServiceContainer | serviceContainer |
Overrides
detach()
Declaration
public void detach()
Overrides
isSeriesValid(renderableSeries.IPieRenderableSeries series)
When overridden in derived classes, indicates whether the series should be inspected in order to get SeriesInfo
Declaration
protected boolean isSeriesValid(renderableSeries.IPieRenderableSeries series)
Parameters
| Type | Name | Description |
|---|---|---|
| renderableSeries.IPieRenderableSeries | series | The renderable series to check |
Returns
| Type | Description |
|---|---|
| boolean | True if renderable series is valid |
onSegmentCollectionDrasticallyChanged()
Called when segments collection drastically changed.
Declaration
public void onSegmentCollectionDrasticallyChanged()
Overrides
onSegmentsCollectionChanged(CollectionChangedEventArgs<renderableSeries.IPieSegment> args)
Called when segments collection changes.
Declaration
public void onSegmentsCollectionChanged(CollectionChangedEventArgs<renderableSeries.IPieSegment> args)
Parameters
| Type | Name | Description |
|---|---|---|
| CollectionChangedEventArgs<IPieSegment> | args |
Overrides
onSelectedSegmentsCollectionChanged(CollectionChangedEventArgs<renderableSeries.IPieSegment> args)
Called when selected segments collection changes.
Declaration
public void onSelectedSegmentsCollectionChanged(CollectionChangedEventArgs<renderableSeries.IPieSegment> args)
Parameters
| Type | Name | Description |
|---|---|---|
| CollectionChangedEventArgs<IPieSegment> | args |
Overrides
setLegendPosition(int gravity, int margin)
Sets the position of the current PieChartLegendModifier instance.
Declaration
public void setLegendPosition(int gravity, int margin)
Parameters
| Type | Name | Description |
|---|---|---|
| int | gravity | The PieChartLegendModifier#sciChartLegend gravity for this modifier. |
| int | margin | The margin size for all sides (left, top, right, bottom). |
setLegendPosition(int gravity, int leftMargin, int topMargin, int rightMargin, int bottomMargin)
Sets the position of the current PieChartLegendModifier instance.
Declaration
public void setLegendPosition(int gravity, int leftMargin, int topMargin, int rightMargin, int bottomMargin)
Parameters
| Type | Name | Description |
|---|---|---|
| int | gravity | The PieChartLegendModifier#sciChartLegend gravity for this modifier. |
| int | leftMargin | The left margin size. |
| int | topMargin | The top margin size. |
| int | rightMargin | The right margin size. |
| int | bottomMargin | The bottom margin size. |
setOrientation(int orientation)
Sets the orientation of the legend
Declaration
public final void setOrientation(int orientation)
Parameters
| Type | Name | Description |
|---|---|---|
| int | orientation | The orientation of legend |
setShowCheckboxes(boolean showCheckboxes)
Sets whether the legend should display checkboxes
Declaration
public final void setShowCheckboxes(boolean showCheckboxes)
Parameters
| Type | Name | Description |
|---|---|---|
| boolean | showCheckboxes | The new showCheckboxes value |
setShowLegend(boolean showLegend)
Sets whether the legend should be displayed
Declaration
public final void setShowLegend(boolean showLegend)
Parameters
| Type | Name | Description |
|---|---|---|
| boolean | showLegend | The new showLegend value |
setShowSeriesMarkers(boolean showSeriesMarkers)
Sets whether the legend should display series markers
Declaration
public final void setShowSeriesMarkers(boolean showSeriesMarkers)
Parameters
| Type | Name | Description |
|---|---|---|
| boolean | showSeriesMarkers | The new showSeriesMarkers value |
setSourceSeries(renderableSeries.IPieRenderableSeries sourceSeries)
Sets the SourceMode value for legend
Declaration
public final void setSourceSeries(renderableSeries.IPieRenderableSeries sourceSeries)
Parameters
| Type | Name | Description |
|---|---|---|
| renderableSeries.IPieRenderableSeries | sourceSeries | The new SourceMode value |
updateLegend()
Refreshes content of the legend with up-to-date values
Declaration
public void updateLegend()