@mocanvas/editor · interface

OverlayOptionsWithDisplayValues

interface OverlayOptionsWithDisplayValues<D extends object = object>

The half of an overlay util's options that concerns paint.

An overlay's options interface extends this and adds whatever else it needs (a handle radius, a dash length), which is why the display-value function is optional here: an overlay with nothing theme-dependent to say simply omits it and getOverlayDisplayValues answers with an empty object.


Properties · 1

getDefaultDisplayValues?: TLGetDefaultOverlayDisplayValues<D> | undefined

Resolve this overlay's paint against a theme.

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.