set_axis_format#

cherab.lhd.tools.visualization.set_axis_format(axis: XAxis | YAxis, formatter: Literal['scalar', 'log', 'symlog', 'asinh', 'percent', 'eng', 'centered'], linear_width: float = 1.0, offset_position: Literal['left', 'right'] = 'left', **kwargs) NoneSource#

Set axis format.

Set specified axis major formatter and both corresponding major and minor locators.

Parameters:
axisXAxis | YAxis

Matplotlib axis object.

formatter{“scalar”, “log”, “symlog”, “asinh”, “percent”, “eng”}

Formatter mode of the axis. Values in non-implemented modes are set to ScalarFormatter with useMathText=True.

linear_widthfloat, optional

Linear width of asinh/symlog norm, by default 1.0.

offset_position{“left”, “right”}, optional

Position of the offset text like \(\times 10^3\), by default "left". This parameter only affects YAxis object.

**kwargs

Keyword arguments for formatter.