Loading...
Searching...
No Matches
ATAS.Indicators.PriceSelectionValue Class Reference

Represents a class for defining price level selection in clusters and bars. Using in PriceSelectionDataSeries. More...

Public Member Functions

 PriceSelectionValue (decimal price)
 Constructor for creating a price selection with a given price.
 
Color GetPriceSelectionColor ()
 Gets the current price selection color.
 
Color GetObjectsColor ()
 Gets the current graphic objects color.
 
Color GetTextColor (Color chartBackground)
 Gets the color of the value text drawn inside the object: the explicitly set TextColor, or a contrasting color (black or white) derived from the effective objects color over the given chart background.
 
RenderPen GetBorderPen ()
 Gets the render pen for the border of the graphic objects.
 

Properties

decimal MinimumPrice [get, set]
 Minimum price of the selection.
 
decimal MaximumPrice [get, set]
 Maximum price of the selection.
 
int Size [get, set]
 Graphic objects size.
 
decimal? BarLocation [get, set]
 Horizontal location of the graphic object within the bar, in percent from left to right. A null value keeps the object centered in the bar.
 
string Tooltip = string.Empty [get, set]
 Tooltip associated with the selection.
 
bool DrawValue [get, set]
 Draw value inside object.
 
decimal? RenderValue [get, set]
 Render value inside object.
 
decimal? RenderMoney [get, set]
 Money value drawn inside the object instead of RenderValue, with the sign of RenderCurrency. RenderValue stays the traded volume the object stands for.
 
string? RenderCurrency [get, set]
 Currency code of RenderMoney (USD, EUR, USDT...).
 
SelectionType SelectionSide [get, set]
 Selection type.
 
ObjectType VisualObject [get, set]
 Visual object type.
 
CrossColor PriceSelectionColor [get, set]
 Color of the price selection. Use alpha channel for transparency.
 
CrossColor ObjectColor [get, set]
 Color of the graphic objects.
 
CrossColor? TextColor [get, set]
 Color of the value text drawn inside the object. If not set, a contrasting color (black or white) is derived from the effective objects color.
 
decimal HeightFactor [get, set]
 Height Factor (obsolete).
 
object Context = null! [get, set]
 Коэффициент уменьшения высоты выделения цены. Если значение 100, выделяется вся высота, если 50, выделяется половина
 
int ObjectsTransparency [get, set]
 Transparency of objects filling.
 

Detailed Description

Represents a class for defining price level selection in clusters and bars. Using in PriceSelectionDataSeries.

Constructor & Destructor Documentation

◆ PriceSelectionValue()

ATAS.Indicators.PriceSelectionValue.PriceSelectionValue ( decimal  price)

Constructor for creating a price selection with a given price.

Parameters
priceThe price to set as both minimum and maximum.

Member Function Documentation

◆ GetBorderPen()

RenderPen ATAS.Indicators.PriceSelectionValue.GetBorderPen ( )

Gets the render pen for the border of the graphic objects.

Returns
The render pen for the border of the graphic objects.

◆ GetObjectsColor()

Color ATAS.Indicators.PriceSelectionValue.GetObjectsColor ( )

Gets the current graphic objects color.

Returns
The current graphic objects color.

◆ GetPriceSelectionColor()

Color ATAS.Indicators.PriceSelectionValue.GetPriceSelectionColor ( )

Gets the current price selection color.

Returns
The current price selection color.

◆ GetTextColor()

Color ATAS.Indicators.PriceSelectionValue.GetTextColor ( Color  chartBackground)

Gets the color of the value text drawn inside the object: the explicitly set TextColor, or a contrasting color (black or white) derived from the effective objects color over the given chart background.

Parameters
chartBackgroundChart background color the object is drawn over.
Returns
The color of the value text.

Property Documentation

◆ BarLocation

decimal? ATAS.Indicators.PriceSelectionValue.BarLocation
getset

Horizontal location of the graphic object within the bar, in percent from left to right. A null value keeps the object centered in the bar.

◆ Context

object ATAS.Indicators.PriceSelectionValue.Context = null!
getset

Коэффициент уменьшения высоты выделения цены. Если значение 100, выделяется вся высота, если 50, выделяется половина

Context object associated with the price selection.

◆ DrawValue

bool ATAS.Indicators.PriceSelectionValue.DrawValue
getset

Draw value inside object.

◆ HeightFactor

decimal ATAS.Indicators.PriceSelectionValue.HeightFactor
getset

Height Factor (obsolete).

◆ MaximumPrice

decimal ATAS.Indicators.PriceSelectionValue.MaximumPrice
getset

Maximum price of the selection.

◆ MinimumPrice

decimal ATAS.Indicators.PriceSelectionValue.MinimumPrice
getset

Minimum price of the selection.

◆ ObjectColor

CrossColor ATAS.Indicators.PriceSelectionValue.ObjectColor
getset

Color of the graphic objects.

◆ ObjectsTransparency

int ATAS.Indicators.PriceSelectionValue.ObjectsTransparency
getset

Transparency of objects filling.

◆ PriceSelectionColor

CrossColor ATAS.Indicators.PriceSelectionValue.PriceSelectionColor
getset

Color of the price selection. Use alpha channel for transparency.

◆ RenderCurrency

string? ATAS.Indicators.PriceSelectionValue.RenderCurrency
getset

Currency code of RenderMoney (USD, EUR, USDT...).

◆ RenderMoney

decimal? ATAS.Indicators.PriceSelectionValue.RenderMoney
getset

Money value drawn inside the object instead of RenderValue, with the sign of RenderCurrency. RenderValue stays the traded volume the object stands for.

◆ RenderValue

decimal? ATAS.Indicators.PriceSelectionValue.RenderValue
getset

Render value inside object.

◆ SelectionSide

SelectionType ATAS.Indicators.PriceSelectionValue.SelectionSide
getset

Selection type.

◆ Size

int ATAS.Indicators.PriceSelectionValue.Size
getset

Graphic objects size.

◆ TextColor

CrossColor? ATAS.Indicators.PriceSelectionValue.TextColor
getset

Color of the value text drawn inside the object. If not set, a contrasting color (black or white) is derived from the effective objects color.

◆ Tooltip

string ATAS.Indicators.PriceSelectionValue.Tooltip = string.Empty
getset

Tooltip associated with the selection.

◆ VisualObject

ObjectType ATAS.Indicators.PriceSelectionValue.VisualObject
getset

Visual object type.


The documentation for this class was generated from the following file: