Class LegendModifier3D

Inheritance
java.lang.Object
ReceiveMotionEventsBase
ChartModifierCore
ChartModifierBase3D
LegendModifier3D
Inherited Members
Namespace:
Assembly: .dll
Syntax
public class LegendModifier3D extends ChartModifierBase3D

Constructors

LegendModifier3D(Context context)

Creates a new instance of LegendModifier class

Declaration
public LegendModifier3D(Context context)
Parameters
Type Name Description
android.content.Context context

The context of the application

LegendModifier3D(SciChartLegend legend)

Creates a new instance of LegendModifier class

Declaration
public LegendModifier3D(SciChartLegend legend)
Parameters
Type Name Description
SciChartLegend legend

The SciChartLegend instance which should be used by this modifier

LegendModifier3D(SciChartLegend legend, boolean useAutoPlacement)

Creates a new instance of LegendModifier3D class

Declaration
public LegendModifier3D(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

LegendModifier3D(SciChartLegend legend, LegendItemsAdapter3D legendAdapter, boolean useAutoPlacement)

Creates a new instance of LegendModifier3D class

Declaration
public LegendModifier3D(SciChartLegend legend, LegendItemsAdapter3D legendAdapter, boolean useAutoPlacement)
Parameters
Type Name Description
SciChartLegend legend

The SciChartLegend instance which should be used by this modifier
LegendItemsAdapter3D legendAdapter

The LegendItemsAdapter3D 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)

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.IRenderableSeries3D series)

When overridden in derived classes, indicates whether the series should be inspected in order to get SeriesInfo

Declaration
protected boolean isSeriesValid(renderableSeries.IRenderableSeries3D series)
Parameters
Type Name Description
renderableSeries.IRenderableSeries3D series

The renderable series to check
Returns
Type Description
boolean

True if renderable series is valid

onRenderableSeriesCollectionChanged(CollectionChangedEventArgs<? extends renderableSeries.IRenderableSeriesCore> args)

Declaration
public void onRenderableSeriesCollectionChanged(CollectionChangedEventArgs<? extends renderableSeries.IRenderableSeriesCore> args)
Parameters
Type Name Description
CollectionChangedEventArgs<? extends com.scichart.charting.visuals.renderableSeries.IRenderableSeriesCore> args
Overrides

onRenderableSeriesDrasticallyChanged()

Declaration
public void onRenderableSeriesDrasticallyChanged()
Overrides

onSelectedSeriesCollectionChanged(CollectionChangedEventArgs<? extends renderableSeries.IRenderableSeriesCore> args)

Declaration
public void onSelectedSeriesCollectionChanged(CollectionChangedEventArgs<? extends renderableSeries.IRenderableSeriesCore> args)
Parameters
Type Name Description
CollectionChangedEventArgs<? extends com.scichart.charting.visuals.renderableSeries.IRenderableSeriesCore> args
Overrides

setLegendPosition(int gravity, int margin)

Sets the position of the current LegendModifier3D instance.

Declaration
public void setLegendPosition(int gravity, int margin)
Parameters
Type Name Description
int gravity

The LegendModifier3D#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 LegendModifier3D instance.

Declaration
public void setLegendPosition(int gravity, int leftMargin, int topMargin, int rightMargin, int bottomMargin)
Parameters
Type Name Description
int gravity

The LegendModifier3D#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

setSourceMode(SourceMode sourceMode)

Sets the SourceMode value for legend

Declaration
public final void setSourceMode(SourceMode sourceMode)
Parameters
Type Name Description
SourceMode sourceMode

The new SourceMode value

updateLegend()

Refreshes content of the legend with up-to-date values

Declaration
public void updateLegend()