Version: 1.0.0

Set Crosshair Position

Programmatically update or lock crosshair coordinates using API inputs to synchronize multiple charts.

Introduction

The cursor crosshair is activated when a user hovers over a chart. In multi-frame dashboard setups, programmatically controlling this crosshair allows you to track and mirror mouse movements across multiple widgets.

API Usage

Force crosshair focus to a specific bar index or price coordinate using setCrosshairPosition:

// Move crosshair to x-pixel position 450, tracking price $68,500
chart.setCrosshairPosition({
  x: 450,
  price: 68500
});

Clearing Position

To hide programmatic cursor lines when no mouse is active, execute the clear method:

chart.clearCrosshairPosition();

Synchronizing Multiple Charts

Combine crosshair move subscriptions with crosshair position setter updates to achieve multi-chart cursor mirroring:

// Synchronizing chartA to mirror hover on chartB
chartA.subscribeCrosshairMove((param) => {
  if (!param.point) {
    chartB.clearCrosshairPosition();
    return;
  }
  
  // Mirror cursor coordinates onto chartB
  chartB.setCrosshairPosition({
    x: param.point.x,
    price: param.seriesData[0]?.close
  });
});