PitchKit
API Reference@pitchkit/coreFunctions

labelBox()

function labelBox(
   placement, 
   lines, 
   fontSize, 
   minTarget
): object;

Defined in: packages/core/src/polar/labels.ts:49

The clickable box behind a placed label, in the label's own rotated frame: the text's estimated extent plus padding, never smaller than minTarget either way (WCAG 2.5.8).

Parameters

ParameterType
placementLabelPlacement
linesreadonly string[]
fontSizenumber
minTargetnumber

Returns

object

height

readonly height: number;

width

readonly width: number;

x

readonly x: number;

y

readonly y: number;

On this page