public class TooltipModifier3D extends TooltipModifierBase3D
TooltipModifier3D
provides a touch-over tooltip to a chart, outputting a singleSeriesInfo3D
object to bind to which updates as the touch moves over data-pointsshowTooltipProperty, sourceModeProperty, tooltipBehavior
Constructor and Description |
---|
TooltipModifier3D()
Creates a new instance of the
TooltipModifier3D class. |
TooltipModifier3D(com.scichart.charting.modifiers.behaviors.CrossDrawableBehavior<?> crossDrawableBehavior)
Creates a new instance of the
TooltipModifier3D class with the CrossDrawableBehavior instance. |
TooltipModifier3D(com.scichart.charting.modifiers.behaviors.CrossDrawableBehavior<?> crossDrawableBehavior,
int tooltipContainerLayoutResId)
Creates a new instance of the
TooltipModifier3D class. |
TooltipModifier3D(TooltipBehaviorWithCrosshairBehavior3D tooltipBehavior,
com.scichart.charting.modifiers.behaviors.CrossDrawableBehavior<?> crossDrawableBehavior)
Creates a new instance of the
TooltipModifier3D class. |
Modifier and Type | Method and Description |
---|---|
void |
applyThemeProvider(com.scichart.charting.themes.IThemeProvider themeProvider) |
void |
attachTo(com.scichart.core.IServiceContainer services) |
protected void |
clearAll()
When overridden in a derived class, this method should clear all markers and tooltips from the
SciChartSurface3D.getModifierSurface() . |
void |
detach() |
CrosshairMode |
getCrosshairMode()
Gets the mode of the Crosshairs
|
int |
getCrosshairPlanesFill()
Gets color to draw Crosshair plains with
|
com.scichart.drawing.common.SolidPenStyle |
getCrosshairStrokeStyle()
Gets the style to draw stroke of Crosshairs
|
android.graphics.PointF |
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. |
int |
getLineProjectionMode()
Gets the projection mode used to draw Crosshair lines
|
com.scichart.charting.modifiers.Placement |
getMarkerPlacement()
Gets the
Placement mode, to determine where to place tooltip and the marker relatively to the Hit-test point. |
float |
getOffset()
Gets the offset on which tooltip and the marker will be shifted in x and y directions.
|
ProjectionMode |
getProjectionMode()
Gets the projection mode used to draw Crosshairs
|
boolean |
getShowAxisLabels()
Sets the projection mode used to draw Crosshair lines
|
protected void |
handleMasterTouchDownEvent(android.graphics.PointF point)
When overridden in a derived class, called to handle the Master
ChartModifierBase MotionEvent.ACTION_DOWN |
protected void |
handleMasterTouchMoveEvent(android.graphics.PointF point)
When overridden in a derived class, called to handle the Master
ChartModifierBase MotionEvent.ACTION_MOVE |
protected void |
handleMasterTouchUpEvent(android.graphics.PointF point)
When overridden in a derived class, called to handle the Master
ChartModifierBase MotionEvent.ACTION_UP |
void |
setCrosshairMode(CrosshairMode crosshairMode)
Sets the mode of the Crosshairs
|
void |
setCrosshairPlanesFill(int crosshairPlanesFill)
Sets color to draw Crosshair plains with
|
void |
setCrosshairStrokeStyle(com.scichart.drawing.common.SolidPenStyle crosshairStrokeStyle)
Sets the style to draw stroke of Crosshairs
|
void |
setCustomPointOffset(android.graphics.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. |
void |
setLineProjectionMode(int lineProjectionMode)
Sets the projection mode used to draw Crosshair lines
|
void |
setMarkerPlacement(com.scichart.charting.modifiers.Placement markerPlacement)
Sets the
Placement mode, to determine where to place tooltip and the marker relatively to the Hit-test point. |
void |
setOffset(float offset)
Sets the offset on which tooltip and the marker will be shifted in x and y directions.
|
void |
setProjectionMode(ProjectionMode projectionMode)
Sets the projection mode used to draw Crosshairs
|
void |
setShowAxisLabels(boolean showAxisLabels)
Sets whether modifier should show axis label
|
protected void |
updateCurrentPoint(android.graphics.PointF currentPoint,
com.scichart.core.utility.touch.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) . |
getObservableSeries, getShowTooltip, getSourceMode, handleSlaveTouchDownEvent, handleSlaveTouchMoveEvent, handleSlaveTouchUpEvent, onRenderableSeriesDrasticallyChanged, setShowTooltip, setSourceMode
getExecuteOnPointerCount, isEnabledAt, onIsEnabledChanged, onTouchDown, onTouchMove, onTouchUp, setExecuteOnPointerCount
onTouch, onTouchCancel
getCamera, getContext, getModifierSurface, getParentSurface, getPointRelativeTo, getXAxis, getYAxis, getZAxis, onChartRendered, onXAxisChanged, onYAxisChanged, onZAxisChanged
checkPointerCounter, getEventsGroupTag, getIsEnabled, getReceiveHandledEvents, getServices, isAttached, onGenericMotion, onRenderableSeriesCollectionChanged, onSelectedSeriesCollectionChanged, setEventsGroupTag, setIsEnabled, setReceiveHandledEvents
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getEventsGroupTag, getIsEnabled, setIsEnabled
public TooltipModifier3D()
TooltipModifier3D
class.public TooltipModifier3D(com.scichart.charting.modifiers.behaviors.CrossDrawableBehavior<?> crossDrawableBehavior)
TooltipModifier3D
class with the CrossDrawableBehavior
instance.crossDrawableBehavior
- The CrossDrawableBehavior
instance which will be use to show marker which will identify what point will be Hit-tested.public TooltipModifier3D(com.scichart.charting.modifiers.behaviors.CrossDrawableBehavior<?> crossDrawableBehavior, int tooltipContainerLayoutResId)
TooltipModifier3D
class.crossDrawableBehavior
- The CrossDrawableBehavior
instance which will be use to show marker which will identify what point will be Hit-tested.tooltipContainerLayoutResId
- The layout resource id which will be used to inflate tooltip container.public TooltipModifier3D(TooltipBehaviorWithCrosshairBehavior3D tooltipBehavior, com.scichart.charting.modifiers.behaviors.CrossDrawableBehavior<?> crossDrawableBehavior)
TooltipModifier3D
class.tooltipBehavior
- The TooltipBehaviorWithCrosshairBehavior3D
which will be associated with this modifier.crossDrawableBehavior
- The CrossDrawableBehavior
instance which will be use to show marker which will identify what point will be Hit-tested.public float getOffset()
public void setOffset(float offset)
offset
- Value which indicates the offset on which tooltip and the marker will be shifted in x and y directions.public android.graphics.PointF getCustomPointOffset()
PointF
value which will replace getOffset()
and will be used to shift tooltip and the marker in custom x and y directions.PointF
offset to shift tooltip.public void setCustomPointOffset(android.graphics.PointF customPointOffset)
PointF
value which will replace getOffset()
and will be used to shift tooltip and the marker in custom x and y directions.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.public com.scichart.charting.modifiers.Placement getMarkerPlacement()
Placement
mode, to determine where to place tooltip and the marker relatively to the Hit-test point.Placement
modes, to place tooltip properly.public void setMarkerPlacement(com.scichart.charting.modifiers.Placement markerPlacement)
Placement
mode, to determine where to place tooltip and the marker relatively to the Hit-test point.markerPlacement
- The new Placement
mode, to determine where to place tooltip and the marker relatively to the Hit-test point.public final void setCrosshairMode(CrosshairMode crosshairMode)
crosshairMode
- The crosshair modepublic final CrosshairMode getCrosshairMode()
public final void setProjectionMode(ProjectionMode projectionMode)
projectionMode
- The new projection modepublic final ProjectionMode getProjectionMode()
public final void setCrosshairStrokeStyle(com.scichart.drawing.common.SolidPenStyle crosshairStrokeStyle)
crosshairStrokeStyle
- The new crosshair stroke stylepublic final com.scichart.drawing.common.SolidPenStyle getCrosshairStrokeStyle()
public final void setLineProjectionMode(int lineProjectionMode)
lineProjectionMode
- The new line projection modepublic final int getLineProjectionMode()
public final void setShowAxisLabels(boolean showAxisLabels)
showAxisLabels
- The new show axis labels valuepublic final boolean getShowAxisLabels()
public final void setCrosshairPlanesFill(int crosshairPlanesFill)
crosshairPlanesFill
- The new crosshair planes fill colorpublic final int getCrosshairPlanesFill()
public void applyThemeProvider(com.scichart.charting.themes.IThemeProvider themeProvider)
applyThemeProvider
in interface com.scichart.charting.themes.IThemeable
applyThemeProvider
in class TooltipModifierBase3D
public void attachTo(com.scichart.core.IServiceContainer services)
attachTo
in interface com.scichart.core.framework.IAttachable
attachTo
in class TooltipModifierBase3D
public void detach()
detach
in interface com.scichart.core.framework.IAttachable
detach
in class TooltipModifierBase3D
protected void clearAll()
SciChartSurface3D.getModifierSurface()
.clearAll
in class TooltipModifierBase3D
protected void handleMasterTouchDownEvent(android.graphics.PointF point)
ChartModifierBase
MotionEvent.ACTION_DOWN
handleMasterTouchDownEvent
in class TooltipModifierBase3D
point
- The current touch pointprotected void handleMasterTouchMoveEvent(android.graphics.PointF point)
ChartModifierBase
MotionEvent.ACTION_MOVE
handleMasterTouchMoveEvent
in class TooltipModifierBase3D
point
- The current touch pointprotected void handleMasterTouchUpEvent(android.graphics.PointF point)
ChartModifierBase
MotionEvent.ACTION_UP
handleMasterTouchUpEvent
in class TooltipModifierBase3D
point
- The current touch pointprotected void updateCurrentPoint(android.graphics.PointF currentPoint, com.scichart.core.utility.touch.ModifierTouchEventArgs args)
MasterSlaveTouchModifierBase3D.onTouchDown(ModifierTouchEventArgs)
,
MasterSlaveTouchModifierBase3D.onTouchMove(ModifierTouchEventArgs)
,
MasterSlaveTouchModifierBase3D.onTouchUp(ModifierTouchEventArgs)
.updateCurrentPoint
in class MasterSlaveTouchModifierBase3D
currentPoint
- The point which will be updated.args
- The ModifierTouchEventArgs
which is used to update the passed in currentPoint.