GetDistanceToIndex Method (FinancialSeries)

Returns a distance value (not necessarily pixels), that indicates how 'close' a world position is to an indexed value in the series. Not every series can necessarily answer this question, it can't or the world position or index is invalid, NaN will be returned.

Syntax

Visual Basic

'Declaration
 
Protected Friend Overrides Function GetDistanceToIndex( _
   ByVal world As Point, _
   ByVal index As Integer, _
   ByVal axis As Axis, _
   ByVal p As ScalerParams, _
   ByVal offset As Double _
) As Double

C#

protected internal override double GetDistanceToIndex( 
   Point world,
   int index,
   Axis axis,
   ScalerParams p,
   double offset
)

Parameters

world

The world position for which to get a distance.

index

The index to get a distance to.

axis

The axis in context.

p

The scaler parameters in context.

offset

The distance between the edge of the axis and the first or last data item.

Return Value

A distance value to the world position.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2