Class ChartModifierBase

Defines the base class to a Chart Modifier, which can be used to extend the interactivity or rendering of the SciChartSurface

Inheritance

java.lang.Object

ReceiveMotionEventsBase

ChartModifierCore

ChartModifierBase

Implements

IChartModifier

Inherited Members

ChartModifierCore.applyThemeProvider(IThemeProvider)

ChartModifierCore.attachTo(IServiceContainer)

ChartModifierCore.checkPointerCounter(MotionEvent,int)

ChartModifierCore.detach()

ChartModifierCore.getEventsGroupTag()

ChartModifierCore.getIsEnabled()

ChartModifierCore.getReceiveHandledEvents()

ChartModifierCore.getServices()

ChartModifierCore.isAttached()

ChartModifierCore.onGenericMotion(ModifierTouchEventArgs)

ChartModifierCore.onIsEnabledChanged(boolean)

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

ChartModifierCore.onRenderableSeriesDrasticallyChanged()

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

ChartModifierCore.onTouch(ModifierTouchEventArgs)

ChartModifierCore.setEventsGroupTag(String)

ChartModifierCore.setIsEnabled(boolean)

ChartModifierCore.setReceiveHandledEvents(boolean)

ReceiveMotionEventsBase.getName()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Namespace:

Assembly: .dll

Syntax

public abstract class ChartModifierBase extends ChartModifierCore implements IChartModifier

Constructors

ChartModifierBase()

Declaration

public ChartModifierBase()

Methods

<T>getMasterModifier(T modifier, IReceiveMotionEvents target)

Declaration

protected static T <T>getMasterModifier(T modifier, IReceiveMotionEvents target)

Parameters

Type	Name	Description
T	modifier
IReceiveMotionEvents	target

Returns

Type	Description
T

attachTo(IServiceContainer services)

Declaration

public void attachTo(IServiceContainer services)

Parameters

Type	Name	Description
IServiceContainer	services

Overrides

ChartModifierCore.attachTo(IServiceContainer services)

detach()

Declaration

public void detach()

Overrides

ChartModifierCore.detach()

getAllXAxes()

Gets ALL X axes from the parent surface without filtering. Use this when you need the complete list regardless of inclusion settings.

Declaration

public final List<IAxis> getAllXAxes()

Returns

Type	Description
List<IAxis>	All X axes from the parent surface

getAllYAxes()

Gets ALL Y axes from the parent surface without filtering. Use this when you need the complete list regardless of inclusion settings.

Declaration

public final List<IAxis> getAllYAxes()

Returns

Type	Description
List<IAxis>	All Y axes from the parent surface

getContext()

Declaration

public final Context getContext()

Returns

Type	Description
android.content.Context

getModifierSurface()

Gets the parent SciChartSurface#getModifierSurface()

Declaration

public final IChartModifierSurface getModifierSurface()

Returns

Type	Description
IChartModifierSurface

getParentSurface()

Gets the parent surface that this instance is associated with

Declaration

public final ISciChartSurface getParentSurface()

Returns

Type	Description
ISciChartSurface

getPointRelativeTo(PointF point, IHitTestable relativeTo)

Transforms point with coordinates relative to parent surface and transforms it relative to specified IHitTestable instance

Declaration

public final boolean getPointRelativeTo(PointF point, IHitTestable relativeTo)

Parameters

Type	Name	Description
android.graphics.PointF	point	The point to translate
IHitTestable	relativeTo	The target IHitTestable instance

Returns

Type	Description
boolean	True if translate was successful

getRenderableSeries()

Gets the parent SciChartSurface#getRenderableSeries() collection

Declaration

public final List<renderableSeries.IRenderableSeries> getRenderableSeries()

Returns

Type	Description
List<IRenderableSeries>

getRenderableSeriesArea()

Gets the parent SciChartSurface#getRenderableSeriesArea()

Declaration

protected final IRenderableSeriesArea getRenderableSeriesArea()

Returns

Type	Description
IRenderableSeriesArea	The renderable series area

getXAxes()

Gets the parent SciChartSurface#getXAxes() collection

Returns the filtered list of X axes based on includeAxis settings.

If no axes are explicitly included or excluded, returns all X axes.

Declaration

public final List<IAxis> getXAxes()

Returns

Type	Description
List<IAxis>

getXAxis()

Gets the primary XAxis, this is the first axis in the XAxes collection

Declaration

public IAxis getXAxis()

Returns

Type	Description
IAxis

getXAxis(String axisId)

Gets XAxis specified by id if it exists, otherwise returns null

Declaration

protected final IAxis getXAxis(String axisId)

Parameters

Type	Name	Description
String	axisId	The XAxis id

Returns

Type	Description
IAxis	The XAxis instance

getYAxes()

Gets the parent SciChartSurface#getYAxes() collection

Returns the filtered list of Y axes based on includeAxis settings.

If no axes are explicitly included or excluded, returns all Y axes.

Declaration

public final List<IAxis> getYAxes()

Returns

Type	Description
List<IAxis>

getYAxis()

Gets the primary YAxis, this is the first axis in the YAxes collection

Declaration

public IAxis getYAxis()

Returns

Type	Description
IAxis

getYAxis(String axisId)

Gets YAxis specified by id if it exists, otherwise returns null

Declaration

protected final IAxis getYAxis(String axisId)

Parameters

Type	Name	Description
String	axisId	The YAxis id

Returns

Type	Description
IAxis	The YAxis instance

includeAllAxes()

Includes all X and Y axes

Declaration

protected void includeAllAxes()

includeXAxis(IAxis axis, boolean isIncluded)

Includes or excludes X axis

Declaration

protected void includeXAxis(IAxis axis, boolean isIncluded)

Parameters

Type	Name	Description
IAxis	axis	The axis to include or exclude
boolean	isIncluded	True to include, false to exclude

includeYAxis(IAxis axis, boolean isIncluded)

Includes or excludes Y axis

Declaration

protected void includeYAxis(IAxis axis, boolean isIncluded)

Parameters

Type	Name	Description
IAxis	axis	The axis to include or exclude
boolean	isIncluded	True to include, false to exclude

isWithinSourceBounds(float x, float y, boolean isMaster, IReceiveMotionEvents source)

Performs a check whether the point is inside the boundaries of the initial IChartModifierSurface.

Declaration

protected boolean isWithinSourceBounds(float x, float y, boolean isMaster, IReceiveMotionEvents source)

Parameters

Type	Name	Description
float	x	The x-coordinate of the point to check.
float	y	The y-coordinate of the point to check.
boolean	isMaster	Indicates whether this check is performed on the master IChartModifierSurface instance.
IReceiveMotionEvents	source	The IReceiveMotionEvents instance.

Returns

Type	Description
boolean	True if the point is inside the boundaries of the initial IChartModifierSurface.

onAnnotationsCollectionChanged(CollectionChangedEventArgs<IAnnotation> args)

Called when parent SciChartSurface#getAnnotations() collection changes

Declaration

public void onAnnotationsCollectionChanged(CollectionChangedEventArgs<IAnnotation> args)

Parameters

Type	Name	Description
CollectionChangedEventArgs<IAnnotation>	args

onAnnotationsDrasticallyChanged()

Called when parent SciChartSurface#getAnnotations() collection drastically changed

Declaration

public void onAnnotationsDrasticallyChanged()

onParentSurfaceResized(ResizedMessage message)

Called when chart resized.

Declaration

public void onParentSurfaceResized(ResizedMessage message)

Parameters

Type	Name	Description
ResizedMessage	message

onRenderSurfaceRendered(RenderedMessage message)

Called when parent SciChartSurface#getRenderSurface() rendered

Declaration

public void onRenderSurfaceRendered(RenderedMessage message)

Parameters

Type	Name	Description
RenderedMessage	message

onXAxesCollectionChanged(CollectionChangedEventArgs<IAxis> args)

Called when parent SciChartSurface#getXAxes() collection changes

Declaration

public void onXAxesCollectionChanged(CollectionChangedEventArgs<IAxis> args)

Parameters

Type	Name	Description
CollectionChangedEventArgs<IAxis>	args

onXAxesDrasticallyChanged()

Called when parent SciChartSurface#getXAxes() collection drastically changed

Declaration

public void onXAxesDrasticallyChanged()

onYAxesCollectionChanged(CollectionChangedEventArgs<IAxis> args)

Called when parent SciChartSurface#getYAxes() collection changes

Declaration

public void onYAxesCollectionChanged(CollectionChangedEventArgs<IAxis> args)

Parameters

Type	Name	Description
CollectionChangedEventArgs<IAxis>	args

onYAxesDrasticallyChanged()

Called when parent SciChartSurface#getYAxes() collection drastically changed

Declaration

public void onYAxesDrasticallyChanged()

Implements

IChartModifier