ChartArea

interface cAlgo.API

DesktopCLICloud

The Chart Area Interface.

Definition

public interface ChartArea

Namespace: cAlgo.API · Group: Chart

Examples

C#Python

ChartArea area = Chart.IndicatorAreas.Count > 0 ? Chart.IndicatorAreas[0] : Chart;
area.DrawHorizontalLine("middle", area.BottomY + (area.TopY - area.BottomY) / 2, Color.Gray);
Print("Area size: {0}x{1} | Objects: {2}", area.Width, area.Height, area.Objects.Count);

area = api.Chart.IndicatorAreas[0] if api.Chart.IndicatorAreas.Count > 0 else api.Chart
area.DrawHorizontalLine("middle", area.BottomY + (area.TopY - area.BottomY) / 2, Color.Gray)
api.Print(f"Area size: {area.Width}x{area.Height} | Objects: {area.Objects.Count}")

Methods

Name	Description
AddControl 6 overloadsDesktopCLICloud`void`	Adds a chart control from the Control Base to the main chart area or to the indicator area.
BarIndexToXDesktopCLICloud`double`	Converts Bar Index to X coordinate.
DrawAndrewsPitchfork 6 overloadsDesktopCLICloud`ChartAndrewsPitchfork`	Draws an Andrew's pitchfork.
DrawArrow 6 overloadsDesktopCLICloud`ChartArrow`	Draws an arrow.
DrawElliottCorrection 3 overloadsDesktopCLICloud`ChartElliottCorrection`	Draws an Elliott Correction Wave (A-B-C).
DrawElliottDoubleCombo 3 overloadsDesktopCLICloud`ChartElliottDoubleCombo`	Draws an Elliott Double Combo Wave (W-X-Y).
DrawElliottImpulse 3 overloadsDesktopCLICloud`ChartElliottImpulse`	Draws an Elliott Impulse Wave (1-2-3-4-5).
DrawElliottTriangle 3 overloadsDesktopCLICloud`ChartElliottTriangle`	Draws an Elliott Triangle Wave (A-B-C-D-E).
DrawElliottTripleCombo 3 overloadsDesktopCLICloud`ChartElliottTripleCombo`	Draws an Elliott Triple Combo Wave (W-X-Y-X-Z).
DrawEllipse 6 overloadsDesktopCLICloud`ChartEllipse`	Draws an ellipse.
DrawEquidistantChannel 6 overloadsDesktopCLICloud`ChartEquidistantChannel`	Draws an equidistant channel.
DrawFibonacciArc 6 overloadsDesktopCLICloud`ChartFibonacciArc`	Draws a Fibonacci arc.
DrawFibonacciExpansion 6 overloadsDesktopCLICloud`ChartFibonacciExpansion`	Draws a Fibonacci expansion.
DrawFibonacciFan 6 overloadsDesktopCLICloud`ChartFibonacciFan`	Draws a Fibonacci fan.
DrawFibonacciRetracement 6 overloadsDesktopCLICloud`ChartFibonacciRetracement`	Draws a Fibonacci retracement.
DrawFibonacciTimezones 6 overloadsDesktopCLICloud`ChartFibonacciTimezones`	Draws a Fibonacci timezones.
DrawGannBox 6 overloadsDesktopCLICloud`ChartGannBox`	Draws a Gann box.
DrawGannFan 6 overloadsDesktopCLICloud`ChartGannFan`	Draws a Gann fan.
DrawGannSquare 6 overloadsDesktopCLICloud`ChartGannSquare`	Draws a Gann square.
DrawGannSquareFixed 6 overloadsDesktopCLICloud`ChartGannSquareFixed`	Draws a Gann square fixed.
DrawHorizontalLine 3 overloadsDesktopCLICloud`ChartHorizontalLine`	Draws a horizontal line.
DrawIcon 2 overloadsDesktopCLICloud`ChartIcon`	Draws an icon.
DrawRectangle 6 overloadsDesktopCLICloud`ChartRectangle`	Draws a rectangle.
DrawStaticTextDesktopCLICloud`ChartStaticText`	Draws the static text.
DrawText 2 overloadsDesktopCLICloud`ChartText`	Draws the text.
DrawTrendLine 6 overloadsDesktopCLICloud`ChartTrendLine`	Draws a trend line.
DrawTriangle 6 overloadsDesktopCLICloud`ChartTriangle`	Draws a triangle.
DrawVerticalLine 6 overloadsDesktopCLICloud`ChartVerticalLine`	Draws a vertical line.
FindAllObjects 2 overloadsDesktopCLICloud`T[]`	Finds all the chart objects of the specified type.
FindObjectDesktopCLICloud`ChartObject`	Finds the chart object of the specified name.
MoveControl 5 overloadsDesktopCLICloud`void`	Moves a chart control to chart / indicator area on absolute bar index and price (x,y) coordinates.
RemoveAllObjectsDesktopCLICloud`void`	Removes all interactive and non-interactive objects available for the cBot or Indicator.
RemoveControlDesktopCLICloud`void`	Remove a chart control from the chart area.
RemoveObjectDesktopCLICloud`void`	Removes the chart object of the specified name.
ResetPriceScaleDesktopCLICloud`void`	Resets the price scale of the chart area to its default state: enables the auto scale and fits the Y-axis range to the visible bars and outputs. Does not change the price scale mode, the inversion or the price axis position. Ignored on the main chart area while the price to bar ratio is locked. Does nothing in the silent backtesting, the CLI and the cloud.
SetYRangeDesktopCLICloud`void`	Sets the Y-axis lowest and highest values range. Allows scrolling the chart by the Y-axis. If only one of the values is set, then the chart will be expanded regarding the lowest or highest value respectively. A range whose lowest value is not lower than its highest value is ignored, and so is any range on the main chart area while the price scale mode is Percent or IndexedTo100.
TimeToXDesktopCLICloud`double`	Converts area Time coordinate to Mouse X coordinate value.
XToBarIndexDesktopCLICloud`double`	Converts X coordinate to bar index.
XToTimeDesktopCLICloud`DateTime`	Converts Mouse X coordinate to area Time coordinate value.
YToYValueDesktopCLICloud`double`	Converts Mouse Y coordinate to area Y axis coordinate value.
YValueToYDesktopCLICloud`double`	Converts Area Y axis coordinate value to mouse Y coordinate.

Properties

Name	Description
BottomYDesktopCLICloud`double`	Gets the lowest visible Y-axis value.
DraggablesDesktopCLICloud`ChartDraggables`	Gets chart area draggables.
HeightDesktopCLICloud`double`	Gets the hight of the chart area.
IsAliveDesktopCLICloud`bool`	Checks whether the instance is still on the chart area.
IsAutoScaleEnabledDesktopCLICloud`bool`	Gets or sets the value indicating whether the auto scale is enabled for the chart area. When enabled, the Y-axis range is fitted automatically to the visible bars and outputs while the chart scrolls. Setting the Y-axis range with SetYRange, or dragging the price axis, disables the auto scale. On the main chart area the auto scale is always enabled while the price scale mode is Percent or IndexedTo100, and is always disabled while the price to bar ratio is locked; setting it to a conflicting value in these states is ignored. In the silent backtesting, the CLI and the cloud the value is only stored and has no visual effect.
ObjectsDesktopCLICloud`IReadonlyList<ChartObject>`	Gets the chart objects collection.
SelectedObjectsDesktopCLICloud`IReadonlyList<ChartObject>`	Gets the list of currently selected objects if any.
TopYDesktopCLICloud`double`	Gets the highest visible Y-axis value.
WidthDesktopCLICloud`double`	Gets the width of the chart area.

Events

Name	Description
DragDesktopCLICloud`Action<ChartDragEventArgs>`	Occurs when dragging a chart area.
DragEndDesktopCLICloud`Action<ChartDragEventArgs>`	Occurs when mouse button is released while dragging a chart area or a chart area loses mouse capture.
DragStartDesktopCLICloud`Action<ChartDragEventArgs>`	Occurs when MouseDown event is happening on a chart area and a mouse is captured for dragging.
MouseDownDesktopCLICloud`Action<ChartMouseEventArgs>`	Occurs when the left mouse button is pressed down.
MouseEnterDesktopCLICloud`Action<ChartMouseEventArgs>`	Occurs when the cursor hover over the chart area.
MouseLeaveDesktopCLICloud`Action<ChartMouseEventArgs>`	Occurs when the cursor leaves the chart area
MouseMoveDesktopCLICloud`Action<ChartMouseEventArgs>`	Occurs when the cursor moves over the chart area.
MouseUpDesktopCLICloud`Action<ChartMouseEventArgs>`	Occurs when the left mouse button is released.
MouseWheelDesktopCLICloud`Action<ChartMouseWheelEventArgs>`	Occurs when the mouse wheel button is rotated.
ObjectHoverChangedDesktopCLICloud`Action<ChartObjectHoverChangedEventArgs>`	Occurs when the cursor hovers over or leaves the object.
ObjectsAddedDesktopCLICloud`Action<ChartObjectsAddedEventArgs>`	Occurs when one or several chart objects are added to the chart area.
ObjectsMoveEndedDesktopCLICloud`Action<ChartObjectsMoveEndedEventArgs>`	Occurs when one or several chart objects are moved.
ObjectsMoveStartedDesktopCLICloud`Action<ChartObjectsMoveStartedEventArgs>`	Occurs when one or several chart objects move started.
ObjectsMovingDesktopCLICloud`Action<ChartObjectsMovingEventArgs>`	Occurs when one or several chart objects are moving.
ObjectsRemovedDesktopCLICloud`Action<ChartObjectsRemovedEventArgs>`	Occurs when one or several chart object are removed from the chart area.
ObjectsSelectionChangedDesktopCLICloud`Action<ChartObjectsSelectionChangedEventArgs>`	Occurs when chart objects are selected or deselected.
ObjectsUpdatedDesktopCLICloud`Action<ChartObjectsUpdatedEventArgs>`	Occurs when one or several chart objects are updated.
PriceScaleChangedDesktopCLICloud`Action<ChartPriceScaleEventArgs>`	Occurs when the price scale state of the chart area changes: the auto scale is enabled or disabled, or the price scale is reset. On the main chart area it also occurs when any chart level price scale setting changes: the price scale mode, the inversion, the price to bar ratio lock or value, the scale price chart only option or the price axis position. Not raised in the silent backtesting, the CLI and the cloud.
ScrollChangedDesktopCLICloud`Action<ChartScrollEventArgs>`	Occurs when the X-axis position value or the Y-axis position value changes while scrolling.
SizeChangedDesktopCLICloud`Action<ChartSizeEventArgs>`	Occurs when the chart area size has changed.

Deprecated members (4)

event Action<ChartObjectAddedEventArgs> ObjectAdded; — Use ObjectsAdded instead
event Action<ChartObjectUpdatedEventArgs> ObjectUpdated; — Use ObjectsUpdated instead
event Action<ChartObjectRemovedEventArgs> ObjectRemoved; — Use ObjectsRemoved instead
event Action<ChartObjectSelectionChangedEventArgs> ObjectSelectionChanged; — Use ObjectsSelectionChanged instead