interface PrimitiveHit {
    cancelOnEscape?: boolean;
    cursor?: string;
    distance: number;
    draggable?: boolean;
    externalId: string;
    hoverKey?: string;
    paintedBy?: IPrimitive;
    priceScale?: PriceScale;
    zOrder: ZOrder;
}

Properties

cancelOnEscape?: boolean

Opt into Escape cancellation without a release. Listen for drag:cancel to discard the preview.

cursor?: string
distance: number

Pixel distance from the cursor (smaller wins ties before z-order). Never negative: zero is a hit on the shape itself, and the pane stops asking once the front band has one.

draggable?: boolean

Arm a drag on press. Price lines set cursor: 'ns-resize' and move on one axis; anything that moves on both (a drawing anchor, a whole shape) declares it here, and the drag callbacks receive time as well as price.

externalId: string
hoverKey?: string

Distinguishes hover regions which share one external click ID. Omission uses externalId.

paintedBy?: IPrimitive

The primitive that paints what was hit, when it is not the one answering: a drawing layer answers for the layers under it. The chart ranks the hit by where that primitive paints, so a series painted over it takes the context menu. Omission means the answering primitive painted it.

priceScale?: PriceScale

Coordinate scale for a bound primitive's drag prices. Unbound hits omit it.

zOrder: ZOrder