deephaven.plot.axisformat

This module implements the AxisFormat class that can be applied to format axis tick labels on a plot.

class AxisFormat(j_axis_format)

Bases: JObjectWrapper

The AxisFormat class defines the format for axis tick labels. For time values, this would be how the dates are formatted. For numerical values, this would be the number of significant digits, etc.

j_object_type

alias of AxisFormat

set_pattern(pattern)

Set the pattern used for formatting values.

For details on the supported patterns see the javadoc for DateTimeFormatter.

Parameters:

pattern (str) – pattern string indicating how values should be formatted.

Return type:

None

class DecimalAxisFormat

Bases: AxisFormat

A formatter for converting decimals into formatted strings.

For details on the supported patterns see the javadoc for DecimalFormat.

j_object_type

alias of AxisFormat

set_pattern(pattern)

Set the pattern used for formatting values.

For details on the supported patterns see the javadoc for DateTimeFormatter.

Parameters:

pattern (str) – pattern string indicating how values should be formatted.

Return type:

None

class NanosAxisFormat(tz=None)

Bases: AxisFormat

A formatter for converting nanoseconds into formatted strings.

Creates a new NanosAxisFormat with the specified timezone.

Parameters:

tz (TimeZone) – the timezone to use for formatting, default is None meaning to use the default time zone.

j_object_type

alias of AxisFormat

set_pattern(pattern)

Set the pattern used for formatting values.

For details on the supported patterns see the javadoc for DateTimeFormatter.

Parameters:

pattern (str) – pattern string indicating how values should be formatted.

Return type:

None