TLHighlightShape • tldraw Docs

A highlight shape representing a highlighting stroke drawn by the user. Highlight shapes are typically semi-transparent and used for marking up or emphasizing content on the canvas.

type TLHighlightShape = TLBaseShape<'highlight', TLHighlightShapeProps>

Example

const highlightShape: TLHighlightShape = {
  id: 'shape:highlight1',
  type: 'highlight',
  x: 100,
  y: 50,
  rotation: 0,
  index: 'a1',
  parentId: 'page:main',
  isLocked: false,
  opacity: 0.7,
  props: {
    color: 'yellow',
    size: 'l',
    segments: [],
    isComplete: false,
    isPen: false,
    scale: 1,
  },
  meta: {},
  typeName: 'shape',
}