Class TooltipBehaviorBase<T>

Defines a base class with tooltip behavior for IChartModifier implementors.

Inheritance

java.lang.Object

ModifierBehavior

TooltipBehaviorBase<T>

Implements

com.scichart.core.common.Func1<com.scichart.charting.visuals.renderableSeries.IRenderableSeries,com.scichart.charting.visuals.renderableSeries.tooltips.ISeriesTooltip>

Inherited Members

ModifierBehavior.applyThemeProvider(IThemeProvider)

ModifierBehavior.attachTo(ModifierBehavior,IChartModifierCore,boolean)

ModifierBehavior.attachTo(IServiceContainer)

ModifierBehavior.clear()

ModifierBehavior.detach()

ModifierBehavior.getIsEnabled()

ModifierBehavior.isAttached()

ModifierBehavior.isLastPointValid()

ModifierBehavior.onBeginUpdate(PointF,boolean)

ModifierBehavior.onEndUpdate(PointF,boolean)

ModifierBehavior.onIsEnabledChanged(boolean)

ModifierBehavior.onUpdate(PointF,boolean)

ModifierBehavior.resetLastUpdatePoint()

ModifierBehavior.setIsEnabled(boolean)

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 abstract class TooltipBehaviorBase<T> extends ModifierBehavior<T> implements Func1<renderableSeries.IRenderableSeries,renderableSeriesISeriesTooltip>

Type Parameters

Name	Description
T

Constructors

TooltipBehaviorBase(Class<T> modifierType)

Creates a new instance of the TooltipBehaviorBase class

Declaration

protected TooltipBehaviorBase(Class<T> modifierType)

Parameters

Type	Name	Description
Class<T>	modifierType	The type of the associated IChartModifier

Fields

CURSOR_XY_OFFSET

Declaration

public static final float CURSOR_XY_OFFSET

Field Value

Type	Description
float

Methods

func(renderableSeries.IRenderableSeries renderableSeries)

Declaration

public renderableSeriesISeriesTooltip func(renderableSeries.IRenderableSeries renderableSeries)

Parameters

Type	Name	Description
renderableSeries.IRenderableSeries	renderableSeries

Returns

Type	Description
renderableSeriesISeriesTooltip

getObservableSeries()

Gets the ObservableCollection of renderable series which will take part in interaction.

Declaration

public final ObservableCollection<renderableSeries.IRenderableSeries> getObservableSeries()

Returns

Type	Description
ObservableCollection<IRenderableSeries>	The ObservableCollection of renderable series.

getSourceMode()

Gets the SourceMode type of series on which interaction is performed.

Declaration

public final SourceMode getSourceMode()

Returns

Type	Description
SourceMode	The SourceMode type of series on which interaction is performed.

getUseInterpolation()

Gets a value indicating whether to use interpolation during updating tooltip or not.

Declaration

public final boolean getUseInterpolation()

Returns

Type	Description
boolean	True if should use interpolation.

isHitPointValid(renderableSeries.hitTest.HitTestInfo hitTestInfo)

Gets the value indicating whether the HitTestInfo instance is valid.

Declaration

protected boolean isHitPointValid(renderableSeries.hitTest.HitTestInfo hitTestInfo)

Parameters

Type	Name	Description
renderableSeries.hitTest.HitTestInfo	hitTestInfo	The HitTestInfo instance to test.

Returns

Type	Description
boolean	True if hit point is Valid.

isSeriesValid(renderableSeries.IRenderableSeries series)

Gets the value indicating whether the IRenderableSeries instance is valid.

Declaration

protected boolean isSeriesValid(renderableSeries.IRenderableSeries series)

Parameters

Type	Name	Description
renderableSeries.IRenderableSeries	series	The IRenderableSeries instance to check.

Returns

Type	Description
boolean	True if the passed IRenderableSeries instance is valid.

onObservableSeriesDrasticallyChanged()

Called when the TooltipBehaviorBase#observableSeries has drastically changed.

Declaration

protected abstract void onObservableSeriesDrasticallyChanged()

setIncludedRenderableSeries(IncludedItems includedItems)

Declaration

public final void setIncludedRenderableSeries(IncludedItems includedItems)

Parameters

Type	Name	Description
IncludedItems	includedItems

setObservableSeries(ObservableCollection<renderableSeries.IRenderableSeries> observableSeries)

Sets the ObservableCollection of renderable series which will take part in interaction.

Declaration

public final void setObservableSeries(ObservableCollection<renderableSeries.IRenderableSeries> observableSeries)

Parameters

Type	Name	Description
ObservableCollection<IRenderableSeries>	observableSeries	The ObservableCollection of renderable series which will take part in interaction.

setSourceMode(SourceMode sourceMode)

Sets the SourceMode type of series on which interaction is performed.

Declaration

public final void setSourceMode(SourceMode sourceMode)

Parameters

Type	Name	Description
SourceMode	sourceMode	The SourceMode type of series on which interaction is performed.

setUseInterpolation(boolean useInterpolation)

Sets a value indicating whether to use interpolation during updating tooltip or not.

Declaration

public final void setUseInterpolation(boolean useInterpolation)

Parameters

Type	Name	Description
boolean	useInterpolation	A value to set use interpolation or not.

Implements

com.scichart.core.common.Func1<com.scichart.charting.visuals.renderableSeries.IRenderableSeries,com.scichart.charting.visuals.renderableSeries.tooltips.ISeriesTooltip>