getOverlayDisplayValues • tldraw Docs

Get the resolved display values for an overlay, merging the base values with any overrides.

function getOverlayDisplayValues<
  Overlay extends TLOverlay,
  DisplayValues extends object,
>(
  util: {
    editor: Editor;
    options: OverlayOptionsWithDisplayValues<Overlay, DisplayValues>;
  },
  overlay: Overlay,
  colorMode?: "dark" | "light",
): DisplayValues;

Parameters

Name	Description
`util`	`{ editor: Editor; options: OverlayOptionsWithDisplayValues< Overlay, DisplayValues >; };`
`overlay`	`Overlay;`
`colorMode`	`"dark" \| "light";`

Returns

DisplayValues;