Class ZoomPanModifier
The ZoomPanModifier provides a touch move to pan the X and Y Axes. Add to the SciChartSurface and set ZoomPanModifier#getIsEnabled() to True to enable this behaviour.
Inheritance
Inherited Members
Namespace:
Assembly: .dll
Syntax
public class ZoomPanModifier extends GestureModifierBaseConstructors
ZoomPanModifier()
Declaration
public ZoomPanModifier()Methods
attachTo(IServiceContainer services)
Declaration
public void attachTo(IServiceContainer services)Parameters
| Type | Name | Description |
|---|---|---|
| IServiceContainer | services |
Overrides
detach()
Declaration
public void detach()Overrides
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. |
getClipModeTargetX()
Gets which target is used as limit by ClipModeX when you reach the edge of the X-Axis extents
Declaration
public final ClipModeTarget getClipModeTargetX()Returns
| Type | Description |
|---|---|
| ClipModeTarget | The target range which is used as limit by ClipModeX |
getClipModeTargetY()
Gets which target is used as limit by ClipModeY when you reach the edge of the Y-Axis extents
Declaration
public final ClipModeTarget getClipModeTargetY()Returns
| Type | Description |
|---|---|
| ClipModeTarget | The target range which is used as limit by ClipModeY |
getClipModeX()
Gets how panning behaves when you reach the edge of the X-Axis extents. e.g. ClipMode#ClipAtExtents prevents panning outside of the X-Axis, ClipMode.None allows panning outside.
Declaration
public final ClipMode getClipModeX()Returns
| Type | Description |
|---|---|
| ClipMode | The ClipMode, which determines behavior when you reach the edge of the X-Axis extents by panning. |
getClipModeY()
Gets how panning behaves when you reach the edge of the Y-Axis extents. e.g. ClipMode#ClipAtExtents prevents panning outside of the Y-Axis, ClipMode.None allows panning outside.
Declaration
public final ClipMode getClipModeY()Returns
| Type | Description |
|---|---|
| ClipMode | The ClipMode, which determines behavior when you reach the edge of the Y-Axis extents by panning. |
getDirection()
Gets the Direction2D to restrict zoom interactivity to.
Declaration
public final Direction2D getDirection()Returns
| Type | Description |
|---|---|
| Direction2D | The Direction2D to restrict zoom interactivity to. |
getZoomExtentsY()
Gets whether the ZoomPanModifier should perform zoom to extents on the Y-Axis on the each zoom operation when panning in X-Direction only. If true, zoom to extents on the Y-Axis on the each zoom operation when panning in X-Direction only. Use in conjunction withZoomPanModifier#direction to achieve different zooming effects.
Declaration
public final boolean getZoomExtentsY()Returns
| Type | Description |
|---|---|
| boolean | True - zoom to extents on the Y-Axis on the each zoom operation. Otherwise - false. |
onDown(MotionEvent e)
Declaration
public boolean onDown(MotionEvent e)Parameters
| Type | Name | Description |
|---|---|---|
| android.view.MotionEvent | e |
Returns
| Type | Description |
|---|---|
| boolean |
Overrides
onFling(MotionEvent e1, MotionEvent e2, float velocityX, float velocityY)
Declaration
public boolean onFling(MotionEvent e1, MotionEvent e2, float velocityX, float velocityY)Parameters
| Type | Name | Description |
|---|---|---|
| android.view.MotionEvent | e1 | |
| android.view.MotionEvent | e2 | |
| float | velocityX | |
| float | velocityY |
Returns
| Type | Description |
|---|---|
| boolean |
Overrides
onRenderSurfaceRendered(RenderedMessage message)
Called when parent SciChartSurface#getRenderSurface() rendered
Declaration
public void onRenderSurfaceRendered(RenderedMessage message)Parameters
| Type | Name | Description |
|---|---|---|
| RenderedMessage | message |
Overrides
onScroll(MotionEvent e1, MotionEvent e2, float xDelta, float yDelta)
Declaration
public boolean onScroll(MotionEvent e1, MotionEvent e2, float xDelta, float yDelta)Parameters
| Type | Name | Description |
|---|---|---|
| android.view.MotionEvent | e1 | |
| android.view.MotionEvent | e2 | |
| float | xDelta | |
| float | yDelta |
Returns
| Type | Description |
|---|---|
| boolean |
Overrides
scroll(float xDelta, float yDelta)
Performs scroll on charts using specified X and Y delta values in pixels
Declaration
protected void scroll(float xDelta, float yDelta)Parameters
| Type | Name | Description |
|---|---|---|
| float | xDelta | The xDelta value to use for scrolling |
| float | yDelta | The yDelta value to use for scrolling |
setClipModeTargetX(ClipModeTarget clipModeTargetX)
Sets which target is used as limit by ClipModeX when you reach the edge of the X-Axis extents
Declaration
public final void setClipModeTargetX(ClipModeTarget clipModeTargetX)Parameters
| Type | Name | Description |
|---|---|---|
| ClipModeTarget | clipModeTargetX | The target range which is used as limit by ClipModeX |
setClipModeTargetY(ClipModeTarget clipModeTargetY)
Sets which target is used as limit by ClipModeY when you reach the edge of the Y-Axis extents
Declaration
public final void setClipModeTargetY(ClipModeTarget clipModeTargetY)Parameters
| Type | Name | Description |
|---|---|---|
| ClipModeTarget | clipModeTargetY | The target range which is used as limit by ClipModeY |
setClipModeX(ClipMode clipModeX)
Sets how panning behaves when you reach the edge of the X-Axis extents. e.g. ClipMode#ClipAtExtents prevents panning outside of the X-Axis, ClipMode.None allows panning outside
Declaration
public final void setClipModeX(ClipMode clipModeX)Parameters
| Type | Name | Description |
|---|---|---|
| ClipMode | clipModeX | The new ClipMode, which determines behavior when you reach the edge of the X-Axis extents by panning. |
setClipModeY(ClipMode clipModeY)
Sets how panning behaves when you reach the edge of the Y-Axis extents. e.g. ClipMode#ClipAtExtents prevents panning outside of the Y-Axis, ClipMode.None allows panning outside
Declaration
public final void setClipModeY(ClipMode clipModeY)Parameters
| Type | Name | Description |
|---|---|---|
| ClipMode | clipModeY | The new ClipMode, which determines behavior when you reach the edge of the Y-Axis extents by panning. |
setDirection(Direction2D direction)
Sets the Direction2D to restrict zoom interactivity to.
Declaration
public final void setDirection(Direction2D direction)Parameters
| Type | Name | Description |
|---|---|---|
| Direction2D | direction | The new Direction2D to restrict zoom interactivity to. |
setZoomExtentsY(boolean zoomExtentsY)
Sets whether the ZoomPanModifier should perform zoom to extents on the Y-Axis on the each zoom operation when panning in X-Direction only. If true, zoom to extents on the Y-Axis on the each zoom operation when panning in X-Direction only. Use in conjunction withZoomPanModifier#direction to achieve different zooming effects.
Declaration
public final void setZoomExtentsY(boolean zoomExtentsY)Parameters
| Type | Name | Description |
|---|---|---|
| boolean | zoomExtentsY | If true - zoom to extents on the Y-Axis on the each zoom operation. |