Help us shape the 2021 DevExtreme Roadmap. Take our 5 minute survey.
Dismiss

wholeRange

Defines the range where the axis can be zoomed and panned.

Type:

Object

|

Array<Number | String | Date>

Default Value: undefined

This option 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 argumentType. You can also set one of the array values to null to specify an open-ended range.

    wholeRange: [50, 70]
    // Open-ended range
    wholeRange: [null, 70]
  • An object with the startValue and endValue fields

    An alternative to the two-item array.

    wholeRange: {
        startValue: 50,
        endValue: 70
    }
    // Open-ended range
    wholeRange: {
        startValue: null,
        endValue: 70
    }
  • An object with the length and a startValue or endValue field

    Specifies the range using a start or end value and length.

    wholeRange: {
        startValue: 50,
        length: 20
    }
    // ===== or =====
    wholeRange: {
        endValue: 70,
        length: 20
    }
  • An object with the length field

    Sets the range of the specified length using the last axis value as the end value.

    wholeRange: {
        length: 20
    }
See Also

endValue

The range's end value.

Type:

Number

|

Date

|

String

Default Value: undefined
Raised Events: optionChanged

length

The range's length.

Type:

Number

|

Object

|

String

Default Value: undefined
Accepted Values: 'day' | 'hour' | 'millisecond' | 'minute' | 'month' | 'quarter' | 'second' | 'week' | 'year'

If the axis/scale displays numbers, set this option 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

When using the widget as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control, you can specify this option with the VizTimeInterval enum which accepts the same predefined values, but they start with an upper-case letter, for example, "day" becomes Day.

startValue

The range's start value.

Type:

Number

|

Date

|

String

Default Value: undefined
Raised Events: optionChanged