Class: ChartPanel

Extends

• StockChartX.Control

Members

---

<readonly> canvas :jQuery

Gets canvas element.

Type:

• jQuery

---

<readonly> chart :StockChartX.Chart

Gets parent chart.

Type:

• StockChartX.Chart

---

<readonly> chartPanelsContainer :StockChartX.ChartPanelsContainer

Gets parent chart panels container.

Type:

• StockChartX.ChartPanelsContainer

---

<readonly> contentFrame :StockChartX.Rect

Gets content frame rectangle.

Type:

• StockChartX.Rect

---

<readonly> context :CanvasRenderingContext2D

Gets canvas rendering context.

Type:

• CanvasRenderingContext2D

---

<readonly> drawings :Array.<StockChartX.Drawing>

Gets array of drawings on the panel.

Type:

• Array.<StockChartX.Drawing>

---

formatter :StockChartX.IntlNumberFormat|StockChartX.CustomNumberFormat

Gets/Sets value formatter.

Type:

• StockChartX.IntlNumberFormat | StockChartX.CustomNumberFormat

---

heightRatio :Number

Gets/Sets current height ratio. The value must be in range [minHeightRatio..maxHeightRatio].

Type:

• Number

---

<readonly> indicators :Array.<StockChartX.Indicator>

Gets array of indicators on the chart panel.

Type:

• Array.<StockChartX.Indicator>

---

maxHeightRatio :number

Gets/Sets maximum allowed height ratio. The value must be in range [minHeightRatio..1].

Type:

• number

---

minHeightRatio :number

Gets/Sets minimum allowed height ratio. The value must be in range [0..maxHeightRatio].

Type:

• number

---

moveDirection :StockChartX.PanelMoveDirection

Gets/Sets allowed move direction.

Type:

• StockChartX.PanelMoveDirection

---

moveKind :StockChartX.PanelMoveKind

Gets/Sets panel's move kind.

Type:

• StockChartX.PanelMoveKind

---

<readonly> plots :Array.<StockChartX.Plot>

Gets array of plots on the panel.

Type:

• Array.<StockChartX.Plot>

---

<readonly> projection :StockChartX.Projection

Gets projection object to convert coordinates.

Type:

• StockChartX.Projection

---

theme :object

Gets/Sets theme.

Type:

• object

---

<readonly> titleDiv :jQuery

Gets title div element.

Type:

• jQuery

---

<readonly> valueScale :StockChartX.ChartPanelValueScale

Gets value scale.

Type:

• StockChartX.ChartPanelValueScale

---

<readonly> valueScales :Array.<StockChartX.ChartPanelValueScale>

Gets array of value scales.

Type:

• Array.<StockChartX.ChartPanelValueScale>

---

xGridVisible :boolean

Gets/Sets flag that indicates whether X grid is visible.

Type:

• boolean

---

yGridVisible :boolean

Gets/Sets flag that indicates whether Y grid is visible.

Type:

• boolean

Methods

---

addDrawings(drawings)

Adds drawings.

Parameters:

Name	Type	Description
drawings	StockChartX.Drawing | Array.<StockChartX.Drawing>	The drawing or an array of drawings to add.

See:

• removeDrawings to remove drawings.

---

addPlot(plot)

Adds new plot.

Parameters:

Name	Type	Description
plot	StockChartX.Plot | Array.<StockChartX.Plot>	The plot or an array of plots to add.

See:

• removePlot to remove plot.

---

destroy()

Destroys chart panel (removes event subscriptions, html elements, etc.).

Overrides:

• StockChartX.Control#destroy

---

draw()

Draws control.

Inherited From:

• StockChartX.Control#draw

---

formatValue(value)

Returns the string representation of a given value.

Parameters:

Name	Type	Description
value	number	The value.

Returns:

Type

string

---

get()

The actual theme.

---

getAutoScaledMinMaxValues(valueScale)

Returns min/max values for auto-scaling.

Parameters:

Name	Type	Argument	Description
valueScale	StockChartX.ChartValueScale	<optional>	The value scale.

Returns:

Type

Object

---

getMinMaxValues(startIndex, count, valueScale)

Returns minimum and maximum plot's values.

Parameters:

Name	Type	Argument	Description
startIndex	number	<optional>	The starting index of the range to search.
count	number	<optional>	The length of the range to search.
valueScale	StockChartX.ValueScale	<optional>	The value scale.

See:

• getAutoScaledMinMaxValues to min/max values in visible range.

Returns:

An object that contains min and max values.

Type

Object

---

handleEvent(event)

Handles event.

Parameters:

Name	Type	Description
event	StockChartX.WindowEvent	The event object.

Inherited From:

• StockChartX.Control#handleEvent

Returns:

Type

boolean

---

hitTest(point)

Checks if a given point belongs to a frame rectangle.

Parameters:

Name	Type	Description
point	StockChartX.Point	The point.

Inherited From:

• StockChartX.Control#hitTest

Returns:

Type

boolean

---

layout(frame)

Layouts controls.

Parameters:

Name	Type	Description
frame	StockChartX.Rect	The frame rectangle related to parent container.

Inherited From:

• StockChartX.Control#layout

---

loadState(state)

Loads state.

Parameters:

Name	Type	Description
state	object	The state saved by saveState function.

See:

• saveState to save state.

---

removeDrawings(drawings)

Removes one or more drawings.

Parameters:

Name	Type	Argument	Description
drawings	StockChartX.Drawing | Array.<StockChartX.Drawing>	<optional>	The drawing or an array of drawings to remove. All drawings are removed if omitted.

See:

• addDrawings to add drawings.

---

removePlot(plot)

Removes given plot or an array of plots.

Parameters:

Name	Type	Description
plot	StockChartX.Plot | Array.<StockChartX.Plot>	The plot or an array of plots to remove.

See:

• addPlot to add plot.

---

saveState()

Saves state.

See:

• loadState to load state.

Returns:

Type

object

---

setNeedsAutoScale()

Marks that value scale needs to be auto-scaled on next layout.

---

update()

Layouts and draws chart panel.