@mocanvas/mocanvas · class

ArrowBindingHintOverlayUtil

declare class ArrowBindingHintOverlayUtil extends OverlayUtil<Editor, ArrowBindingHintOverlayUtilOptions>

Marks the anchor each bound terminal of the selected arrow is attached to.

Only for a selected arrow: the dots are an editing aid, and drawing one on every bound terminal on the page would bury the board in them.

The binding is read structurally — props.terminal and props.normalizedAnchor off a binding of type arrow — rather than through the arrow shape's own helpers. That keeps this file out of the shape and binding modules entirely, which matters because the package barrel loads the overlays before either of them.


Methods · 6

protected getArrows(): UnknownShape[]

The arrows whose bindings are worth marking: the selected ones.

getDisplayValues(): ArrowBindingHintOverlayUtilDisplayValues

The colours to draw with, read fresh from the theme on every frame.

getGeometry(): Geometry2d | undefined

A marker, not a control: dragging the terminal is the arrow handle's job.

getOverlays(): TLArrowBindingHintOverlay[]
isActive(): boolean
render(ctx: CanvasRenderingContext2D): void

Properties · 3

static options: ArrowBindingHintOverlayUtilOptions
static type: string
static zIndex: number

mocanvas is built by Symbio. Free for non-commercial, non-profit and development use; commercial use needs an agreement. Not affiliated with or endorsed by tldraw.