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.
#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.
#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.
#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.
#API
#ChartNavigator
| Prop | Type | Default | Description |
|---|---|---|---|
series | string | string[] | first series | Dataset 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 |
height | number | 60 | Height of the navigator area in pixels |
gap | number | 8 | Gap between the main chart and the navigator in pixels |
color | string | theme | Fill color for the mini area chart line and area. Defaults to the theme navigator series color |
opacity | 0–1 | 0.3 | Fill opacity for the area under the line |
selectionColor | string | theme | Border color for the selection window |
selectionFill | string | theme | Fill color for the selection window interior |
maskColor | string | theme | Color for the dimmed regions outside the selection window |
backgroundColor | string | theme | Background color of the navigator area |
gridColor | string | theme | Grid line color |
labelColor | string | theme | Time tick label color |
handleWidth | number | 6 | Width of the drag handles on the selection window edges in pixels |
gripLineGap | number | 3 | Spacing between the grip lines drawn on each handle in pixels |
padding | number | Partial<Padding> | x: 6, y: 4 | Inner padding around the navigator chart area. A number applies uniformly, or pass { top, right, bottom, left } |
animation | boolean | { duration?, easing? } | true | Animate x-domain transitions when new data arrives. true uses a 200ms easeOutCubic transition; false repaints instantly |
enabled | boolean | true | Show or hide the navigator |