format

legend.format(p0: str) → int

Set the number format for legend labels.

If you are not familiar with the C language, any C language manual will have a description of valid number formats and how they affect the displayed appearance of a number.

Args:

p0:

‘number_format’ This can be any valid C language number format, such as:

p1:

‘number_format’ %.2e

p2:

‘number_format’ %12.5e

p3:

‘number_format’ %f

p4:

‘number_format’ %g

p5:

‘number_format’ %.4f

Examples:

ensight.legend.select_palette_begin("pressure")
ensight.legend.format("%.2e")

Returns:

zero on success, non-zero on error