Box
Map

JavaScript/jQuery PolarChart - valueAxis.visualRange

Defines the axis' displayed range. Cannot be wider than the wholeRange.

Type:

Object

|

Array<Number | String | Date>

Raised Events: onOptionChanged
Cannot be used in themes.

This property accepts one of the following:

  • A two-item array

    Specifies the range's start and end. The array can contain a pair of numeric, string, or date-time values, depending on the axis's valueType. You can also set one of the array values to null to specify an open-ended range.

    index.js
    • $(#polarChart).dxPolarChart({
    • valueAxis: {
    • visualRange: [50, 70]
    • }
    • })
    • // Open-ended range
    • $(#polarChart).dxPolarChart({
    • valueAxis: {
    • visualRange: [null, 70]
    • }
    • })
  • An object with the startValue and endValue fields

    An alternative to the two-item array.

    index.js
    • $(#polarChart).dxPolarChart({
    • valueAxis: {
    • visualRange: { startValue: 50, endValue: 70 }
    • }
    • })
    • // Open-ended range
    • $(#polarChart).dxPolarChart({
    • valueAxis: {
    • visualRange: { startValue: null, endValue: 70 }
    • }
    • })
  • An object with the length and startValue or endValue

    Specifies the range using length and start or end values.

    index.js
    • $(#polarChart).dxPolarChart({
    • valueAxis: {
    • visualRange: { startValue: 50, length: 20 }
    • }
    • })
    • // or
    • $(#polarChart).dxPolarChart({
    • valueAxis: {
    • visualRange: { endValue: 70, length: 20 }
    • }
    • })

    If you specify only length, the component defines the endValue property as the largest scale value.

To specify the minimum visual range that a user can set, use the minVisualRangeLength property.

View Demo

See Also

endValue

The range's end value.

Type:

Number

|

Date

|

String

| undefined
Default Value: undefined
Raised Events: onOptionChanged

length

The range's length.

Type:

Number

|

Object

|

TimeInterval

| undefined
Default Value: undefined

If the axis/scale displays numbers, set this property to a number:

  • length: 100 // a hundred axis/scale values

If the axis/scale displays date-time values, set it to an accepted string value or object that contains a field described further in this section:

  • length: 'day' // one day
  • length: { days: 2 } // two days

startValue

The range's start value.

Type:

Number

|

Date

|

String

| undefined
Default Value: undefined
Raised Events: onOptionChanged