Class: ChartPanelValueScale

Members

---

<readonly> actualTheme :Object

Returns actual theme.

Type:

• Object

---

autoScale

Auto-scales value scale.

---

<readonly> chart :StockChartX.Chart

The parent chart.

Type:

• StockChartX.Chart

---

<readonly> chartPanel :StockChartX.ChartPanel

The parent chart panel.

Type:

• StockChartX.ChartPanel

---

formatter :IntlPolyfill.NumberFormat|StockChartX.NumberFormat

The value formatter that is used to convert values to text.

Type:

• IntlPolyfill.NumberFormat | StockChartX.NumberFormat

---

maxAllowedValue :Number

Gets/Sets the maximum allowed value on the scale.

Type:

• Number

See:

• minAllowedValue to get/set min allowed value.

---

maxVisibleValue :Number

Gets/Sets maximum visible value.

Type:

• Number

See:

• minVisibleValue to get/set min visible value.

---

minAllowedValue :Number

Gets/Sets the minimum allowed value on the scale.

Type:

• Number

See:

• maxAllowedValue to get/set max allowed value.

---

minVisibleValue :Number

Gets/Sets minimum visible value.

Type:

• Number

See:

• maxVisibleValue to get/set max visible value.

---

<readonly> projection :StockChartX.Projection

Gets projection object to convert Y coordinate into value and vise versa.

Type:

• StockChartX.Projection

---

projectionFrame :StockChartX.Rect

The projection frame rectangle.

Type:

• StockChartX.Rect

---

theme :object

Gets/Sets theme.

Type:

• object

Methods

---

formatValue(value)

Returns string representation of a given value.

Parameters:

Name	Type	Description
value	number	The value

Returns:

Type

string

---

loadState(state)

Loads state.

Parameters:

Name	Type	Description
state	object	The state.

See:

• saveState to save state.

---

needsAutoScale()

Determines whether auto-scaling needs to be performed.

Returns:

Type

boolean

---

preferredWidth()

Returns preferred with of the scale.

Returns:

Type

number

---

saveState()

Save state.

See:

• loadState to load state.

Returns:

Type

Object

---

scrollOnPixels(pixels)

Scrolls scale on a given number of pixels.

Parameters:

Name	Type	Description
pixels	Number	The number of pixels to scroll.

Returns:

True if scroll was performed, false otherwise.

Type

Boolean

---

scrollOnValue(valueOffset)

Scrolls scale on a given value offset.

Parameters:

Name	Type	Description
valueOffset	Number	The value offset to scroll.

Returns:

True if scroll was performed, false otherwise.

Type

boolean

---

setNeedsAutoScale()

Marks that auto-scaling needs to be performed on next layout.

---

zoomOnPixels(pixels)

Zooms scale on a given number of pixels.

Parameters:

Name	Type	Description
pixels	Number	The number of pixels to zoom.

Returns:

True if zoom was performed, false otherwise.

Type

Boolean

---

zoomOnValue(valueOffset)

Zooms scale on a given value offset.

Parameters:

Name	Type	Description
valueOffset	Number	The value offset to zoom.

Returns:

True if zoom was performed, false otherwise.

Type

boolean