Zooming and Panning

Zooming and panning is an efficient way to navigate a chart that contains many series points. A user can zoom and pan the chart using mouse commands or touch gestures, the scrollbar, or the RangeSelector widget. Each of these cases are detailed in this topic.

Using Mouse Commands or Touch Gestures

Users can zoom the chart by rotating the mouse wheel and pan it using the drag gesture. On touch-enabled devices, users can zoom the chart using the spread and pinch gestures and pan the chart using the drag gesture, too.

DevExtreme HTML5 JavaScript Charts Zooming Panning

Zooming and panning are configured in the zoomAndPan object. You can enable them separately for the argument and value axes by specifying the argumentAxis and valueAxis options:

jQuery
JavaScript
$(function() {
    $("#chartContainer").dxChart({
        // ...
        zoomAndPan: {
            argumentAxis: "both",  // or "zoom" | "pan" | "none"
            valueAxis: "both"      // or "zoom" | "pan" | "none"
        }
    });
});
Angular
HTML
TypeScript
<dx-chart ... >
    <dxo-zoom-and-pan
        argumentAxis="both"
        valueAxis="both"> <!-- or "zoom" | "pan" | "none" -->
    </dxo-zoom-and-pan>
</dx-chart>
import { DxChartModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxChartModule
    ],
    // ...
})

View Demo

Users can zoom the chart using the drag gesture (area selection) if you enable the dragToZoom option. To pan in this case, users should perform the drag gesture while pressing panKey. Zooming and panning should be enabled.

jQuery
JavaScript
$(function() {
    $("#chartContainer").dxChart({
        // ...
        zoomAndPan: {
            dragToZoom: true,
            panKey: "ctrl",
            argumentAxis: "both",
            valueAxis: "both"
        }
    });
});
Angular
HTML
TypeScript
<dx-chart ... >
    <dxo-zoom-and-pan
        [dragToZoom]="true"
        panKey="ctrl"
        argumentAxis="both"
        valueAxis="both">
    </dxo-zoom-and-pan>
</dx-chart>
import { DxChartModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxChartModule
    ],
    // ...
})

If you need to disable the mouse wheel or touch support, set the allowMouseWheel or allowTouchGestures option to false. In the following example, zooming and panning are enabled only on devices that use the mouse.

jQuery
JavaScript
$(function() {
    $("#chartContainer").dxChart({
        // ...
        zoomAndPan: {
            argumentAxis: "both",
            valueAxis: "both",
            allowTouchGestures: false
        }
    });
});
Angular
HTML
TypeScript
<dx-chart ... >
    <dxo-zoom-and-pan
        argumentAxis="both"
        valueAxis="both"
        [allowTouchGestures]="false">
    </dxo-zoom-and-pan>
</dx-chart>
import { DxChartModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxChartModule
    ],
    // ...
})

Users cannot zoom or scroll the chart out of the whole range. Refer to the Visual and Whole Ranges article for more information.

See Also

Using the Scroll Bar

The scrollbar is a chart element used for panning.

DevExtreme HTML5 JavaScript Charts ScrollBar

You can configure the scrollbar using the scrollBar object. To display the scrollbar, set this object's visible option to true after enabling zooming and panning.

jQuery
JavaScript
$(function() {
    $("#chartContainer").dxChart({
        // ...
        zoomAndPan: {
            argumentAxis: "both",
            valueAxis: "both"
        },
        scrollBar: {
            visible: true,
            //...
        }
    });
});
Angular
HTML
TypeScript
<dx-chart ... >
    <dxo-zoom-and-pan
        argumentAxis="both"
        valueAxis="both">
    </dxo-zoom-and-pan>
    <dxo-scroll-bar [visible]="true" ... ></dxo-scroll-bar>
</dx-chart>
import { DxChartModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxChartModule
    ],
    // ...
})

View Demo

Users cannot zoom or scroll the chart out of the whole range. Refer to the Visual and Whole Ranges article for more information.

See Also

Using the RangeSelector Widget

The Chart can be zoomed and panned using the RangeSelector widget. The following code shows how to bind these widgets. Note that the Chart and RangeSelector have a common data source and may have the same series configuration if the RangeSelector should display the Chart in the background.

jQuery
JavaScript
$(function() {
    // Common data source for both widgets
    var data = [ ... ];
    // Common series configuration for both widgets
    var seriesConfiguration = [ ... ];

    var chart = $("#chartContainer").dxChart({
        dataSource: data,
        series: seriesConfiguration
    }).dxChart("instance");

    $("#rangeSelectorContainer").dxRangeSelector({
        dataSource: data,
        // Displays the Chart in the background of the RangeSelector
        chart: {
            series: seriesConfiguration
        },
        onValueChanged: function (e) {
            // Zooms the Chart
            chart.getArgumentAxis().visualRange(e.value);
        },
        // Makes zooming and panning smoother
        behavior: { callValueChanged: "onMoving" }
    });
});
Angular
HTML
TypeScript
<dx-chart
    [dataSource]="data"
    [series]="seriesConfiguration">
    <dxo-argument-axis
        [(visualRange)]="chart_visualRange">
    </dxo-argument-axis>
</dx-chart>
<dx-range-selector
    [dataSource]="data"
    [(value)]="chart_visualRange">
    <!-- Displays the Chart in the background of the RangeSelector -->
    <dxo-chart [series]="seriesConfiguration"></dxo-chart>
    <!-- Makes zooming and panning smoother -->
    <dxo-behavior callValueChanged="onMoving"></dxo-behavior>
</dx-range-selector>
import { DxChartModule, DxRangeSelectorModule } from "devextreme-angular";
// ...
export class AppComponent {
    // Common data source for both widgets
    data = [ ... ];
    // Common series configuration for both widgets
    seriesConfiguration = [ ... ];
}
@NgModule({
    imports: [
        // ...
        DxChartModule,
        DxRangeSelectorModule
    ],
    // ...
})

View Demo

When your data source is updated in real time, the behavior of both the Chart's visual range and the RangeSelector's selected range depends on the selectedRangeUpdateMode option specified for the RangeSelector:

jQuery
JavaScript
$(function() {
    // ...
    // The Chart is configured here

    $("#rangeSelectorContainer").dxRangeSelector({
        // ...
        selectedRangeUpdateMode: "keep" // the ranges remain unchanged
    });
});
Angular
HTML
TypeScript
<dx-chart ... ></dx-chart>
<dx-range-selector ... 
    selectedRangeUpdateMode="keep"> <!-- the ranges remain unchanged -->
</dx-range-selector>
import { DxChartModule, DxRangeSelectorModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxChartModule,
        DxRangeSelectorModule
    ],
    // ...
})

If you need to fix the zoom window and allow users to only move it along the scale, set the scale object's minRange and maxRange options to a single value defining the zoom window's length. Make sure you specify the initial zoom factor using the value option.

jQuery
JavaScript
$(function() {
    // ...
    // The Chart is configured here

    $("#rangeSelectorContainer").dxRangeSelector({
        // ...
        scale: {
            minRange: 10,
            maxRange: 10
        },
        value: [0, 10]
    });
});
Angular
HTML
TypeScript
<dx-chart ... ></dx-chart>
<dx-range-selector ... 
    [value]="[0, 10]">
    <dxo-scale [minRange]="10" [maxRange]="10"></dxo-scale>
</dx-range-selector>
import { DxChartModule, DxRangeSelectorModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxChartModule,
        DxRangeSelectorModule
    ],
    // ...
})
See Also

Set the Initial Zoom

To zoom a standalone Chart initially, specify the axis' visualRange.

jQuery
JavaScript
$(function() {
    $("#chartContainer").dxChart({
        argumentAxis: {
            visualRange: [0, 10]
        }
    });
});
Angular
HTML
TypeScript
<dx-chart ... >
    <dxo-argument-axis
        [visualRange]="[0, 10]">
    </dxo-argument-axis>
</dx-chart>
import { DxChartModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxChartModule
    ],
    // ...
})
See Also

If the Chart is bound to the RangeSelector, specify the Chart's initial zoom factor by setting the RangeSelector's value option.

jQuery
JavaScript
$(function() {
    // ...
    // The Chart is configured here

    $("#rangeSelectorContainer").dxRangeSelector({
        // ...
        value: [0, 10]
    });
});
Angular
HTML
TypeScript
<dx-chart ... >
    <dxo-argument-axis
        [(visualRange)]="chart_visualRange">
    </dxo-argument-axis>
</dx-chart>
<dx-range-selector ...
    [(value)]="chart_visualRange">
</dx-range-selector>
import { DxChartModule, DxRangeSelectorModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
    chart_visualRange = [0, 10];
}
@NgModule({
    imports: [
        // ...
        DxChartModule,
        DxRangeSelectorModule
    ],
    // ...
})

Stop Zooming or Panning

The Chart provides the onZoomEnd event handler that can be used to stop zooming or panning when a specific condition is met.

For example, you can disallow users to zoom in further if the visual range's length is less than 1:

jQuery
JavaScript
$(function() {
    $("#chartContainer").dxChart({
        // ...
        onZoomEnd: function(e) {
            e.cancel = (e.range.endValue - e.range.startValue) < 1;
        },
        zoomAndPan: {
            argumentAxis: "both",
            valueAxis: "both"
        }
    });
});
Angular
HTML
TypeScript
<dx-chart ...
    (onZoomEnd)="chart_zoomEnd($event)">
    <dxo-zoom-and-pan
        argumentAxis="both"
        valueAxis="both">
    </dxo-zoom-and-pan>
</dx-chart>
import { DxChartModule } from "devextreme-angular";
// ...
export class AppComponent {
    chart_zoomEnd(e) {
        e.cancel = (e.range.endValue - e.range.startValue) < 1;
    }
}
@NgModule({
    imports: [
        // ...
        DxChartModule
    ],
    // ...
})