Framework Reference
WEALTHLAB FRAMEWORK / CLASS REFERENCE

VolumeProfileItem

API documentation, members, signatures, and C# examples.

Search the framework

Find classes, members, and documentation.

NamespaceWealthLab.Core
Parent
Object

The VolumeProfileItem class represents a single horizontal price bin in a Volume Profile. The VolumeProfile.Items collection contains the VolumeProfileItem instances generated for a Volume Profile. Each item represents a specific price range and contains the up volume, down volume, Value Area status, Point of Control status, and relative display widths associated with that range.

Members

11

DownVolume

public double DownVolume

Contains the down volume assigned to this Volume Profile price range. The VolumeProfile calculation considers a source bar to be down when its Close is less than the previous bar's Close.

InValueArea

public bool InValueArea

Returns true if this VolumeProfileItem is included in the Volume Profile's Value Area. The Value Area begins at the Point of Control and expands outward until approximately VolumeProfile.ValueRangePct percent of the profile's total volume has been included.

IsPOC

public bool IsPOC

Returns true if this VolumeProfileItem is the Point of Control. The Point of Control is the VolumeProfileItem having the greatest TotalVolume in the profile.

IsValueInRange

public bool IsValueInRange(double value)
public bool IsValueInRange(
double high,
double low)

Determines whether a value or price range intersects this VolumeProfileItem's price range. The single-value overload returns true when:

value >= RangeMin && value < RangeMax

Consequently, RangeMin is inclusive and RangeMax is exclusive. The second overload returns true when the price range represented by high and low intersects the VolumeProfileItem's range. This includes cases where:

  • low falls within the item's range,
  • high falls within the item's range, or
  • the high/low range completely spans the item's range.

RangeMax

public double RangeMax

Contains the upper boundary of the price range represented by this VolumeProfileItem. For IsValueInRange(double value), this boundary is exclusive.

RangeMin

public double RangeMin

Contains the lower boundary of the price range represented by this VolumeProfileItem. For IsValueInRange(double value), this boundary is inclusive.

TotalVolume

public double TotalVolume

Returns the total volume assigned to this VolumeProfileItem. It is calculated as:

UpVolume + DownVolume

UpVolume

public double UpVolume

Contains the up volume assigned to this Volume Profile price range. The VolumeProfile calculation considers a source bar to be up when its Close is greater than or equal to the previous bar's Close.

WidthPct

public double WidthPct

Contains the relative width of this VolumeProfileItem compared to the Point of Control. It is calculated as:

TotalVolume / PointOfControlItem.TotalVolume

The Point of Control therefore has a WidthPct of 1.0, while lower-volume profile items have proportionally smaller values.

WidthPctDown

public double WidthPctDown

Contains this item's DownVolume relative to the Point of Control's total volume. It is calculated as:

DownVolume / PointOfControlItem.TotalVolume

WidthPctUp

public double WidthPctUp

Contains this item's UpVolume relative to the Point of Control's total volume. It is calculated as:

UpVolume / PointOfControlItem.TotalVolume

Need help with this API?

Ask the community or explore custom development services.

Visit DiscussionsConcierge Services