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
Inherited Members
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
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. |
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. |
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
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
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
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. |