Charts - Navigator

Add a mini overview chart below the main chart with a draggable selection window for zooming and panning.

#Usage

import { ChartNavigator, ChartSvg, ChartZoom } from '@primeui/vue-chart';
<ChartSvg>
    <!-- series and axes -->
    <ChartZoom />
    <ChartNavigator />
</ChartSvg>

The navigator renders a compact overview of the full dataset below the main chart with a draggable selection window. It shares zoom state with ChartZoom: dragging the navigator handle updates the main chart and vice versa. Add both components together for the full zoom-and-navigate experience.

#Basic

Add ChartNavigator alongside ChartZoom to display a compact overview of the full dataset below the main chart. Drag the selection window to pan, drag its edges to resize, and click outside the window to jump to a position. The navigator and zoom share the same zoom state. Dragging the navigator handle updates the main chart and vice versa.

Loading Demo...

#Series

By default the navigator displays the first registered series as a filled area chart. Set series to a dataset ID to pin the navigator to a specific series. Pass an array of IDs to show multiple series. The first drives the X axis and gets the filled area treatment; remaining series appear as lines on a shared Y scale.

Loading Demo...

#Height & Gap

Set height to control how tall the navigator area is. Set gap to adjust the spacing between the main chart and the navigator.

Loading Demo...

#Styling

Set color and opacity to customize the mini area chart fill. Use selectionColor and selectionFill to style the selection window border and interior. Use maskColor to control the dimmed regions outside the selection. Set backgroundColor to set the navigator background and gridColor to adjust the grid line color. All navigator colors default to the active chart theme and adapt to dark mode automatically; override any of them to take manual control.

Loading Demo...

#API

#ChartNavigator

PropTypeDefaultDescription
seriesstring | string[]first seriesDataset ID or array of IDs to display in the mini chart. The first ID drives the X axis; remaining IDs render as additional lines. Defaults to the first registered series
heightnumber60Height of the navigator area in pixels
gapnumber8Gap between the main chart and the navigator in pixels
colorstringthemeFill color for the mini area chart line and area. Defaults to the theme navigator series color
opacity0–10.3Fill opacity for the area under the line
selectionColorstringthemeBorder color for the selection window
selectionFillstringthemeFill color for the selection window interior
maskColorstringthemeColor for the dimmed regions outside the selection window
backgroundColorstringthemeBackground color of the navigator area
gridColorstringthemeGrid line color
labelColorstringthemeTime tick label color
handleWidthnumber6Width of the drag handles on the selection window edges in pixels
gripLineGapnumber3Spacing between the grip lines drawn on each handle in pixels
paddingnumber | Partial<Padding>x: 6, y: 4Inner padding around the navigator chart area. A number applies uniformly, or pass { top, right, bottom, left }
animationboolean | { duration?, easing? }trueAnimate x-domain transitions when new data arrives. true uses a 200ms easeOutCubic transition; false repaints instantly
enabledbooleantrueShow or hide the navigator