Class RubberBandXyZoomModifier

The RubberBandXyZoomModifier provides a touch move to zoom into a rectangular region, or horizontal section of the chart. Add to a SciChartSurface and set RubberBandXyZoomModifier#getIsEnabled() to True to enable this behaviour.

Inheritance

java.lang.Object

ReceiveMotionEventsBase

ChartModifierCore

ChartModifierBase

TouchModifierBase

RubberBandXyZoomModifier

Inherited Members

ChartModifierBase.<T>getMasterModifier(T,IReceiveMotionEvents)

ChartModifierBase.attachTo(IServiceContainer)

ChartModifierBase.detach()

ChartModifierBase.getAllXAxes()

ChartModifierBase.getAllYAxes()

ChartModifierBase.getContext()

ChartModifierBase.getModifierSurface()

ChartModifierBase.getParentSurface()

ChartModifierBase.getPointRelativeTo(PointF,IHitTestable)

ChartModifierBase.getRenderableSeries()

ChartModifierBase.getRenderableSeriesArea()

ChartModifierBase.getXAxes()

ChartModifierBase.getXAxis()

ChartModifierBase.getXAxis(String)

ChartModifierBase.getYAxes()

ChartModifierBase.getYAxis()

ChartModifierBase.getYAxis(String)

ChartModifierBase.includeAllAxes()

ChartModifierBase.includeXAxis(IAxis,boolean)

ChartModifierBase.includeYAxis(IAxis,boolean)

ChartModifierBase.isWithinSourceBounds(float,float,boolean,IReceiveMotionEvents)

ChartModifierBase.onAnnotationsCollectionChanged(CollectionChangedEventArgs<IAnnotation>)

ChartModifierBase.onAnnotationsDrasticallyChanged()

ChartModifierBase.onParentSurfaceResized(ResizedMessage)

ChartModifierBase.onRenderSurfaceRendered(RenderedMessage)

ChartModifierBase.onXAxesCollectionChanged(CollectionChangedEventArgs<IAxis>)

ChartModifierBase.onXAxesDrasticallyChanged()

ChartModifierBase.onYAxesCollectionChanged(CollectionChangedEventArgs<IAxis>)

ChartModifierBase.onYAxesDrasticallyChanged()

ChartModifierCore.applyThemeProvider(IThemeProvider)

ChartModifierCore.checkPointerCounter(MotionEvent,int)

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.setEventsGroupTag(String)

ChartModifierCore.setIsEnabled(boolean)

ChartModifierCore.setReceiveHandledEvents(boolean)

TouchModifierBase.onTouch(ModifierTouchEventArgs)

TouchModifierBase.onTouchCancel(ModifierTouchEventArgs)

TouchModifierBase.onTouchDown(ModifierTouchEventArgs)

TouchModifierBase.onTouchMove(ModifierTouchEventArgs)

TouchModifierBase.onTouchUp(ModifierTouchEventArgs)

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 class RubberBandXyZoomModifier extends TouchModifierBase

Constructors

RubberBandXyZoomModifier()

Declaration

public RubberBandXyZoomModifier()

Methods

applyThemeProvider(IThemeProvider themeProvider)

Applies specified theme to current instance

Declaration

public void applyThemeProvider(IThemeProvider themeProvider)

Parameters

Type	Name	Description
IThemeProvider	themeProvider

Overrides

ChartModifierCore.applyThemeProvider(IThemeProvider themeProvider)

attachTo(IServiceContainer services)

Declaration

public void attachTo(IServiceContainer services)

Parameters

Type	Name	Description
IServiceContainer	services

Overrides

ChartModifierBase.attachTo(IServiceContainer services)

detach()

Declaration

public void detach()

Overrides

ChartModifierBase.detach()

getApplicableXAxes()

Gets the Iterable collection of the XAxes to which this modifier may be applicable on.

Declaration

protected Iterable<IAxis> getApplicableXAxes()

Returns

Type	Description
Iterable<IAxis>	The collection of the XAxes which this modifier may be applicable on.

getApplicableYAxes()

Gets the Iterable collection of the YAxes to which this modifier may be applicable on.

Declaration

protected Iterable<IAxis> getApplicableYAxes()

Returns

Type	Description
Iterable<IAxis>	The collection of the YAxes which this modifier may be applicable on.

getIsAnimated()

Gets whether zoom operations should be animated.

Declaration

public final boolean getIsAnimated()

Returns

Type	Description
boolean	True is zoom is animated, else - false.

getIsXAxisOnly()

Gets whether the RubberBand should zoom the X-Axis only. If true, then the effect will be instead of a rectangle drawn under the touch move gesture, an horizontal section of the entire chart will be selected.

Declaration

public final boolean getIsXAxisOnly()

Returns

Type	Description
boolean	True is modifier should zoom X-Axis only, else - false.

getMinDragSensitivity()

Gets the drag sensitivity - rectangles dragged smaller than this size in the diagonal will be ignored when zooming. Default is 10 pixels.

Declaration

public final double getMinDragSensitivity()

Returns

Type	Description
double	Minimal drag sensitivity in pixels.

getRubberBandFillStyle()

Gets the BrushStyle of the reticule drawn on the screen as the user zooms.

Declaration

public final BrushStyle getRubberBandFillStyle()

Returns

Type	Description
BrushStyle	The BrushStyle instance, to fill reticule.

getRubberBandStrokeStyle()

Gets the PenStyle of the reticule drawn on the screen as the user zooms.

Declaration

public final PenStyle getRubberBandStrokeStyle()

Returns

Type	Description
PenStyle	The PenStyle instance, to draw reticule.

getZoomExtentsY()

Gets whether the RubberBand should perform zoom to extents on the Y-Axis on the each zoom operation. If true, zooms to extents on the Y-Axis on each zoom operation. Use in conjunction withRubberBandXyZoomModifier#isXAxisOnly to achieve different zooming effects.

Declaration

public final boolean getZoomExtentsY()

Returns

Type	Description
boolean	Value which indicates whether the RubberBand should zoom to extents on the Y-Axis on the each zoom operation.

includeAllAxes()

Includes all X and Y axes

Declaration

public void includeAllAxes()

Overrides

ChartModifierBase.includeAllAxes()

includeXAxis(IAxis axis, boolean isIncluded)

Includes or excludes X axis

Declaration

public void includeXAxis(IAxis axis, boolean isIncluded)

Parameters

Type	Name	Description
IAxis	axis
boolean	isIncluded

Overrides

ChartModifierBase.includeXAxis(IAxis axis, boolean isIncluded)

includeYAxis(IAxis axis, boolean isIncluded)

Includes or excludes Y axis

Declaration

public void includeYAxis(IAxis axis, boolean isIncluded)

Parameters

Type	Name	Description
IAxis	axis
boolean	isIncluded

Overrides

ChartModifierBase.includeYAxis(IAxis axis, boolean isIncluded)

onTouchDown(ModifierTouchEventArgs args)

Called when MotionEvent#ACTION_DOWN event occurs

Declaration

protected boolean onTouchDown(ModifierTouchEventArgs args)

Parameters

Type	Name	Description
ModifierTouchEventArgs	args

Returns

Type	Description
boolean

Overrides

TouchModifierBase.onTouchDown(ModifierTouchEventArgs args)

onTouchMove(ModifierTouchEventArgs args)

Called when MotionEvent#ACTION_MOVE event occurs

Declaration

protected boolean onTouchMove(ModifierTouchEventArgs args)

Parameters

Type	Name	Description
ModifierTouchEventArgs	args

Returns

Type	Description
boolean

Overrides

TouchModifierBase.onTouchMove(ModifierTouchEventArgs args)

onTouchUp(ModifierTouchEventArgs args)

Called when MotionEvent#ACTION_UP event occurs

Declaration

protected boolean onTouchUp(ModifierTouchEventArgs args)

Parameters

Type	Name	Description
ModifierTouchEventArgs	args

Returns

Type	Description
boolean

Overrides

TouchModifierBase.onTouchUp(ModifierTouchEventArgs args)

setIsAnimated(boolean isAnimated)

Sets whether zoom operations should be animated.

Declaration

public final void setIsAnimated(boolean isAnimated)

Parameters

Type	Name	Description
boolean	isAnimated	Value which indicates whether zoom operations should be animated.

setIsXAxisOnly(boolean isXAxisOnly)

Sets whether the RubberBand should zoom the X-Axis only. If true, then the effect will be instead of a rectangle drawn under the touch move gesture, an horizontal section of the entire chart will be selected.

Declaration

public final void setIsXAxisOnly(boolean isXAxisOnly)

Parameters

Type	Name	Description
boolean	isXAxisOnly	Value which indicates whether RubberBand should zoom the X-Axis only.

setMinDragSensitivity(double minDragSensitivity)

Sets the drag sensitivity - rectangles dragged smaller than this size in the diagonal will be ignored when zooming. Default is 10 pixels.

Declaration

public final void setMinDragSensitivity(double minDragSensitivity)

Parameters

Type	Name	Description
double	minDragSensitivity	Minimal drag sensitivity in pixels.

setRubberBandFillStyle(BrushStyle rubberBandFill)

Sets the BrushStyle of the reticule drawn on the screen as the user zooms.

Declaration

public final void setRubberBandFillStyle(BrushStyle rubberBandFill)

Parameters

Type	Name	Description
BrushStyle	rubberBandFill	The BrushStyle instance, to fill reticule.

setRubberBandStrokeStyle(PenStyle rubberBandStrokeStyle)

Sets the PenStyle of the reticule drawn on the screen as the user zooms.

Declaration

public final void setRubberBandStrokeStyle(PenStyle rubberBandStrokeStyle)

Parameters

Type	Name	Description
PenStyle	rubberBandStrokeStyle	The PenStyle instance, to draw reticule.

setZoomExtentsY(boolean zoomExtentsY)

Sets whether the RubberBand should perform zoom to extents on the Y-Axis on the each zoom operation. If true, zooms to extents on the Y-Axis on each zoom operation. Use in conjunction withRubberBandXyZoomModifier#isXAxisOnly to achieve different zooming effects.

Declaration

public final void setZoomExtentsY(boolean zoomExtentsY)

Parameters

Type	Name	Description
boolean	zoomExtentsY	Value which indicates whether the RubberBand should zoom to extents on the Y-Axis on the each zoom operation.