Class TooltipModifier3D
The TooltipModifier3D provides a touch-over tooltip to a chart, outputting a singleSeriesInfo3D object to bind to which updates as the touch moves over data-points
Inheritance
Inherited Members
Namespace:
Assembly: .dll
Syntax
public class TooltipModifier3D extends TooltipModifierBase3D
Constructors
TooltipModifier3D()
Creates a new instance of the TooltipModifier3D class.
Declaration
public TooltipModifier3D()
TooltipModifier3D(CrossDrawableBehavior<?> crossDrawableBehavior)
Creates a new instance of the TooltipModifier3D class with the CrossDrawableBehavior instance.
Declaration
public TooltipModifier3D(CrossDrawableBehavior<?> crossDrawableBehavior)
Parameters
Type | Name | Description |
---|---|---|
CrossDrawableBehavior<?> | crossDrawableBehavior | The CrossDrawableBehavior instance which will be use to show marker which will identify what point will be Hit-tested. |
TooltipModifier3D(CrossDrawableBehavior<?> crossDrawableBehavior, int tooltipContainerLayoutResId)
Creates a new instance of the TooltipModifier3D class.
Declaration
public TooltipModifier3D(CrossDrawableBehavior<?> crossDrawableBehavior, int tooltipContainerLayoutResId)
Parameters
Type | Name | Description |
---|---|---|
CrossDrawableBehavior<?> | crossDrawableBehavior | The CrossDrawableBehavior instance which will be use to show marker which will identify what point will be Hit-tested. |
int | tooltipContainerLayoutResId | The layout resource id which will be used to inflate tooltip container. |
TooltipModifier3D(TooltipBehaviorWithCrosshairBehavior3D tooltipBehavior, CrossDrawableBehavior<?> crossDrawableBehavior)
Creates a new instance of the TooltipModifier3D class.
Declaration
public TooltipModifier3D(TooltipBehaviorWithCrosshairBehavior3D tooltipBehavior, CrossDrawableBehavior<?> crossDrawableBehavior)
Parameters
Type | Name | Description |
---|---|---|
TooltipBehaviorWithCrosshairBehavior3D | tooltipBehavior | The TooltipBehaviorWithCrosshairBehavior3D which will be associated with this modifier. |
CrossDrawableBehavior<?> | crossDrawableBehavior | The CrossDrawableBehavior instance which will be use to show marker which will identify what point will be Hit-tested. |
Methods
applyThemeProvider(IThemeProvider themeProvider)
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
clearAll()
When overridden in a derived class, this method should clear all markers and tooltips from the SciChartSurface3D#getModifierSurface().
Declaration
protected void clearAll()
Overrides
detach()
Declaration
public void detach()
Overrides
getCrosshairMode()
Gets the mode of the Crosshairs
Declaration
public final CrosshairMode getCrosshairMode()
Returns
Type | Description |
---|---|
CrosshairMode | The current crosshair mode |
getCrosshairPlanesFill()
Gets color to draw Crosshair plains with
Declaration
public final int getCrosshairPlanesFill()
Returns
Type | Description |
---|---|
int | The current crosshair planes fill color |
getCrosshairStrokeStyle()
Gets the style to draw stroke of Crosshairs
Declaration
public final SolidPenStyle getCrosshairStrokeStyle()
Returns
Type | Description |
---|---|
SolidPenStyle | The current crosshair stroke style |
getCustomPointOffset()
Gets the PointF value which will replace #getOffset() and will be used to shift tooltip and the marker in custom x and y directions.
Declaration
public PointF getCustomPointOffset()
Returns
Type | Description |
---|---|
android.graphics.PointF | The custom PointF offset to shift tooltip. |
getLineProjectionMode()
Gets the projection mode used to draw Crosshair lines
Declaration
public final int getLineProjectionMode()
Returns
Type | Description |
---|---|
int | The current line projection mode |
getMarkerPlacement()
Gets the Placement mode, to determine where to place tooltip and the marker relatively to the Hit-test point.
Declaration
public Placement getMarkerPlacement()
Returns
Type | Description |
---|---|
Placement | The one of the Placement modes, to place tooltip properly. |
getOffset()
Gets the offset on which tooltip and the marker will be shifted in x and y directions.
Declaration
public float getOffset()
Returns
Type | Description |
---|---|
float | The offset on which tooltip and the marker will be shifted in x and y directions. |
getProjectionMode()
Gets the projection mode used to draw Crosshairs
Declaration
public final ProjectionMode getProjectionMode()
Returns
Type | Description |
---|---|
ProjectionMode | The current projection mode |
getShowAxisLabels()
Sets the projection mode used to draw Crosshair lines
Declaration
public final boolean getShowAxisLabels()
Returns
Type | Description |
---|---|
boolean | The current line projection mode |
handleMasterTouchDownEvent(PointF point)
When overridden in a derived class, called to handle the Master ChartModifierBase MotionEvent#ACTION_DOWN
Declaration
protected void handleMasterTouchDownEvent(PointF point)
Parameters
Type | Name | Description |
---|---|---|
android.graphics.PointF | point |
Overrides
handleMasterTouchMoveEvent(PointF point)
When overridden in a derived class, called to handle the Master ChartModifierBase MotionEvent#ACTION_MOVE
Declaration
protected void handleMasterTouchMoveEvent(PointF point)
Parameters
Type | Name | Description |
---|---|---|
android.graphics.PointF | point |
Overrides
handleMasterTouchUpEvent(PointF point)
When overridden in a derived class, called to handle the Master ChartModifierBase MotionEvent#ACTION_UP
Declaration
protected void handleMasterTouchUpEvent(PointF point)
Parameters
Type | Name | Description |
---|---|---|
android.graphics.PointF | point |
Overrides
setCrosshairMode(CrosshairMode crosshairMode)
Sets the mode of the Crosshairs
Declaration
public final void setCrosshairMode(CrosshairMode crosshairMode)
Parameters
Type | Name | Description |
---|---|---|
CrosshairMode | crosshairMode | The crosshair mode |
setCrosshairPlanesFill(int crosshairPlanesFill)
Sets color to draw Crosshair plains with
Declaration
public final void setCrosshairPlanesFill(int crosshairPlanesFill)
Parameters
Type | Name | Description |
---|---|---|
int | crosshairPlanesFill | The new crosshair planes fill color |
setCrosshairStrokeStyle(SolidPenStyle crosshairStrokeStyle)
Sets the style to draw stroke of Crosshairs
Declaration
public final void setCrosshairStrokeStyle(SolidPenStyle crosshairStrokeStyle)
Parameters
Type | Name | Description |
---|---|---|
SolidPenStyle | crosshairStrokeStyle | The new crosshair stroke style |
setCustomPointOffset(PointF customPointOffset)
Sets the PointF value which will replace #getOffset() and will be used to shift tooltip and the marker in custom x and y directions.
Declaration
public void setCustomPointOffset(PointF customPointOffset)
Parameters
Type | Name | Description |
---|---|---|
android.graphics.PointF | customPointOffset | The new PointF value which will replace #getOffset() and will be used to shift tooltip and the marker in custom x and y directions. |
setLineProjectionMode(int lineProjectionMode)
Sets the projection mode used to draw Crosshair lines
Declaration
public final void setLineProjectionMode(int lineProjectionMode)
Parameters
Type | Name | Description |
---|---|---|
int | lineProjectionMode | The new line projection mode |
setMarkerPlacement(Placement markerPlacement)
Sets the Placement mode, to determine where to place tooltip and the marker relatively to the Hit-test point.
Declaration
public void setMarkerPlacement(Placement markerPlacement)
Parameters
Type | Name | Description |
---|---|---|
Placement | markerPlacement | The new Placement mode, to determine where to place tooltip and the marker relatively to the Hit-test point. |
setOffset(float offset)
Sets the offset on which tooltip and the marker will be shifted in x and y directions.
Declaration
public void setOffset(float offset)
Parameters
Type | Name | Description |
---|---|---|
float | offset | Value which indicates the offset on which tooltip and the marker will be shifted in x and y directions. |
setProjectionMode(ProjectionMode projectionMode)
Sets the projection mode used to draw Crosshairs
Declaration
public final void setProjectionMode(ProjectionMode projectionMode)
Parameters
Type | Name | Description |
---|---|---|
ProjectionMode | projectionMode | The new projection mode |
setShowAxisLabels(boolean showAxisLabels)
Sets whether modifier should show axis label
Declaration
public final void setShowAxisLabels(boolean showAxisLabels)
Parameters
Type | Name | Description |
---|---|---|
boolean | showAxisLabels | The new show axis labels value |
updateCurrentPoint(PointF currentPoint, ModifierTouchEventArgs args)
Updates the passed in current point when one of the following methods was called: MasterSlaveTouchModifierBase3D#onTouchDown(ModifierTouchEventArgs), MasterSlaveTouchModifierBase3D#onTouchMove(ModifierTouchEventArgs), MasterSlaveTouchModifierBase3D#onTouchUp(ModifierTouchEventArgs).
Declaration
protected boolean updateCurrentPoint(PointF currentPoint, ModifierTouchEventArgs args)
Parameters
Type | Name | Description |
---|---|---|
android.graphics.PointF | currentPoint | |
ModifierTouchEventArgs | args |
Returns
Type | Description |
---|---|
boolean |