Skip to main content

Function: withUiAxisValue()

withUiAxisValue(axis, value): UiAxis

Defined in: ui/types/ui-axis.ts:193

Returns a copy of axis with its size (UiPointAxis.size) or margin (UiStretchAxis.margin) replaced by value - whichever field this axis's kind actually has - leaving anchor(s)/pivot untouched. The write-side counterpart to uiAxisValue.

Parameters​

axis​

UiAxis

The axis to copy.

value​

number

The new size (for a point axis) or margin (for a stretch axis).

Returns​

UiAxis

The updated axis.