Chart¶
Summary¶
Represents the Chart Interface.
Signature
1 |
|
Namespace¶
cAlgo.API
Examples¶
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 |
|
Methods¶
ScrollXBy¶
Summary
Scrolls the chart by the X-axis for the specified number of bars.
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
bars | int | The number of bars |
Return Value
void
ScrollXTo (2)¶
ScrollXTo (1 of 2)
Summary
Scrolls the chart by the X-axis to the bar with the specified index.
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
barIndex | int | The index of the bar. |
Return Value
void
ScrollXTo (2 of 2)
Summary
Scrolls the chart by the X-axis to the specified date time.
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
time | DateTime | The X-axis date time |
Return Value
void
SetBarColor¶
Summary
Sets the color of the bar at the specified bar index. It will change the bar fill color and the outline color.
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
barIndex | long | The bar index number |
color | Color | The color for the bar |
Return Value
void
SetBarFillColor¶
Summary
Sets the fill color of the bar at the specified bar index.
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
barIndex | long | The bar index number |
color | Color | The color for filling the bar |
Return Value
void
SetBarOutlineColor¶
Summary
Sets the outline color of the bar at the specified bar index.
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
barIndex | long | The bar index number |
color | Color | The color for bar outline |
Return Value
void
SetTickVolumeColor¶
Summary
Sets the color of tick volume line at the specified bar index.
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
barIndex | long | The bar index number |
color | Color | The color for bar tick volume |
Return Value
void
ResetBarColor¶
Summary
Resets the color of the bar to the default.
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
barIndex | long | The bar index number |
Return Value
void
ResetBarColors¶
Summary
Resets the colors of all the bars.
Signature
1 |
|
Return Value
void
ResetTickVolumeColor¶
Summary
Resets the color of the tick volume line to the default at the specified bar index.
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
barIndex | long | The bar index number |
Return Value
void
ResetTickVolumeColors¶
Summary
Resets the color of all the tick volume bars.
Signature
1 |
|
Return Value
void
AddHotkey (4)¶
AddHotkey (1 of 4)
Summary
Adds an hotkey to the chart that will call the handler when pressed
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
hotkeyHandler | Action | The action delegate handler that will be called with a ChartKeyboardEventArgs |
key | Key | The Hotkey main key |
modifiers | ModifierKeys | The hotkey modifier key, default to None which means no modifer key |
Return Value
bool
See Also
AddHotkey (2 of 4)
Summary
Adds an hotkey to the chart that will call the handler when pressed
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
hotkeyHandler | Action | The action delegate handler that will be called with a ChartKeyboardEventArgs |
hotkey | string | The keyboard key for hotkey |
Return Value
bool
See Also
AddHotkey (3 of 4)
Summary
Adds an hotkey to the chart that will call the handler when pressed
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
hotkeyHandler | Action | The action delegate handler that will be called |
key | Key | The Hotkey main key |
modifiers | ModifierKeys | The hotkey modifier key, default to None which means no modifer key |
Return Value
bool
AddHotkey (4 of 4)
Summary
Adds an hotkey to the chart that will call the handler when pressed
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
hotkeyHandler | Action | The action delegate handler that will be called |
hotkey | string | The keyboard key for hotkey |
Return Value
bool
TryChangeTimeFrame¶
Summary
Changes the time frame on the chart.
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
timeFrame | TimeFrame | The time frame to change the current chart time frame to |
Return Value
bool
TryChangeTimeFrameAndSymbol¶
Summary
Changes the time frame and the symbol on the chart.
Signature
1 |
|
Parameters
Name | Type | Description |
---|---|---|
timeFrame | TimeFrame | The time frame to change the current chart time frame to |
symbolName | string | The symbol name to change the current chart symbol to |
Return Value
bool
TakeChartshot¶
Summary
Takes a chartshot from the chart that indicator / cBot runs on.
Remarks
TakeChartshot only works if chart is visible.
Signature
1 |
|
Return Value
byte[]
See Also
Related Tutorials
Properties¶
Id¶
Summary
Gets the unique Id of Chart.
Signature
1 |
|
Return Value
Guid
IndicatorAreas¶
Summary
Gets the read only list of the indicator areas.
Signature
1 |
|
Return Value
IReadonlyList
DisplaySettings¶
Summary
Gets the chart display settings.
Signature
1 |
|
Return Value
ChartDisplaySettings
ColorSettings¶
Summary
Gets the chart color settings.
Signature
1 |
|
Return Value
ChartColorSettings
ChartType¶
Summary
Gets or sets the type of the chart - Bar, Candlesticks, Line or Dots chart.
Signature
1 |
|
Return Value
ChartType
ZoomLevel¶
Summary
Gets or sets the zoom percent values. Valid values are from 5 to 500 with a step of 5, as can be seen on UI in thecharts Zoom control.
Signature
1 |
|
Return Value
int
FirstVisibleBarIndex¶
Summary
Gets the index of the first visible bar on the chart.
Signature
1 |
|
Return Value
int
LastVisibleBarIndex¶
Summary
Gets the index of the last visible bar on the chart.
Signature
1 |
|
Return Value
int
MaxVisibleBars¶
Summary
Gets the maximum number of the visible bars on the chart.
Signature
1 |
|
Return Value
int
BarsTotal¶
Summary
Gets the total number of the bars on the chart.
Signature
1 |
|
Return Value
int
Bars¶
Summary
Gets the chart Bar objects.
Signature
1 |
|
Return Value
Bars
Related Tutorials
TimeFrame¶
Summary
Gets the time frame of the chart from 1 minute to 1 month.
Signature
1 |
|
Return Value
TimeFrame
Symbol¶
Summary
Gets the chart symbol.
Signature
1 |
|
Return Value
Symbol
SymbolName¶
Summary
Gets the symbol name.
Signature
1 |
|
Return Value
string
IsScrollingEnabled¶
Summary
Gets or sets the value indicating whether the scrolling is enabled or disabled for the chart. If disabled, then thechart is not affected by scrolling, dragging, scaling, or pressing any keyboard keys, but is still affected byresizing, zooming, and API calls for changing X or Y-axis positions on the chart.
Signature
1 |
|
Return Value
bool
IsActive¶
Summary
True if Chart is active otherwise False
Signature
1 |
|
Return Value
bool
IsVisible¶
Summary
True if Chart is visible otherwise False.
Signature
1 |
|
Return Value
bool
Indicators¶
Summary
Gets the ChartIndicators operating on a chart.
Signature
1 |
|
Return Value
ChartIndicators
Related Tutorials
Robots¶
Summary
Gets the ChartRobots operating on a chart.
Signature
1 |
|
Return Value
ChartRobots
Events¶
Activated¶
Summary
Occurs when chart is activated
Signature
1 |
|
See Also
Deactivated¶
Summary
Occurs when chart is deactivated
Signature
1 |
|
See Also
DisplaySettingsChanged¶
Summary
Occurs when one or several charts display settings change.
Signature
1 |
|
ColorsChanged¶
Summary
Occurs when the chart color settings change.
Signature
1 |
|
ChartTypeChanged¶
Summary
Occurs when the chart type changes.
Signature
1 |
|
ZoomChanged¶
Summary
Occurs when the chart zoom options change.
Signature
1 |
|
IndicatorAreaAdded¶
Summary
Occurs when the indicator area is added.
Signature
1 |
|
IndicatorAreaRemoved¶
Summary
Occurs when the indicator area is removed.
Signature
1 |
|
KeyDown¶
Summary
Occurs when a keyboard key pressed while the mouse cursor is over the chart
Signature
1 |
|
VisibilityChanged¶
Summary
Occurs when chart visibility changes.
Signature
1 |
|
See Also