AutoRowHeaderSize

Options

autoRowHeaderSize

Can be set at: grid

autoRowHeaderSize.autoRowHeaderSize : object | boolean

The autoRowHeaderSize option configures the AutoRowHeaderSize plugin.

The plugin sizes the row header column to its widest label, the way AutoColumnSize sizes a data column to its widest cell. Turning it on is all you need: it takes the row header’s width over, so any rowHeaderWidth already set is ignored while the plugin is enabled.

You can set the autoRowHeaderSize option to one of the following:

Setting	Description
`false`	Disable the `AutoRowHeaderSize` plugin
`true`	Enable the plugin with the default configuration
An object	Enable the plugin and modify its options

If you set the autoRowHeaderSize option to an object, you can set the following options:

Property	Possible values	Description
`samplingRatio`	A number	The number of samples of the same label length used in the measurement (default: `3`)
`allowSampleDuplicates`	`true` \| `false`	When two rows carry the same label: `true`: measure both `false`: measure it once (default: `false`)
`syncLimit`	A number \| a percent string	How many rows are read before the first paint; the rest are read in idle time (default: `500`)

By default, the autoRowHeaderSize option is set to undefined, which disables the plugin.

Finding the longest label means reading every row header once. On a large grid that work is split: the first syncLimit rows are read before the first paint, and the rest are read in the browser’s idle time, so a header can widen a moment after the grid appears. While that is running a header only ever widens, so its width never jumps back and forth. The result is cached, so later draws cost nothing.

Editing a cell does not re-read the whole grid. Only the rows that changed are read, because a row header label can be built from cell values, and that reading waits for an idle moment too. It can make a header wider, but never narrower: a header shrinks again on the next full pass, which is started by loading or replacing the data, adding or removing a row, sorting, hiding or showing a row, switching the theme, or a recalculation by the Formulas plugin.

A grid can render more than one row header, by pushing a renderer through the afterGetRowHeaderRenderers hook. Every one of them is measured on its own, so each gets exactly the width its own labels need.

The measured width leaves a little room around the longest label, so the text never sits flush against the cell border. The grid’s own row header renderer wraps its label in a padded element, but a renderer pushed through afterGetRowHeaderRenderers writes straight into the cell and has none of its own.

Two rows carrying the same label are measured once, since the same text renders to the same width. Set allowSampleDuplicates to true when that is not true of your grid - a row header that is indented per row, as nestedRows does, renders the same label at a different width depending on its depth. Raise samplingRatio along with it: labels are grouped by length and only samplingRatio of each group are measured, so with the default of 3 a fourth copy of the same label is still left out, however deep it sits.

This option can only be set at the grid level. It has no effect when set in the columns, cells, or cell options.

Default: undefined
Since: 19.0.0
Example

1
// size the row header column to its longest label
2
autoRowHeaderSize: true,
3

4
// the same, with the measurement tuned
5
autoRowHeaderSize: {
6
  // measure repeated labels too, for headers that render differently per row
7
  allowSampleDuplicates: true,
8
},

AutoRowHeaderSize

Options

autoRowHeaderSize

Members

CALCULATION_BUDGET

CALCULATION_STEP

DEFAULT_SETTINGS

MEASUREMENT_PADDING

PLUGIN_KEY

PLUGIN_PRIORITY

SETTING_KEYS

SYNC_CALCULATION_LIMIT

Methods

clearCache

destroy

disablePlugin

enablePlugin

getRowHeaderWidth

getRowHeaderWidths

getSyncCalculationLimit

isEnabled

updatePlugin