Skip to content

PositionArguments

PositionArguments(
    row_height: float = 1.0,
    row_space: float = 0.1,
    row_bigspace: float = 1.2,
    col_width: float = 1.0,
    col_space: float = 0.1,
    col_bigspace: float = 0.5,
    col_annot_offset: float = 3.0,
    col_annot_angle: float = 30.0,
    expand_xmin: float = 0.0,
    expand_xmax: float = 2.0,
    expand_ymin: float = 0.0,
    expand_ymax: float = 0.0,
    col_annot_position: Literal["top", "bottom"] = "top",
    col_group_radius: float = 0.0,
    legend_position: Literal[
        "bottom", "right", "none"
    ] = "bottom",
)

Spacing and placement settings of a funky_heatmap; see position_arguments.

Build one with position_arguments(), which checks the values and documents each field.

Examples:

>>> from ggrust.bistro import position_arguments
>>> positions = position_arguments(row_height=1.2, legend_position="right")
>>> positions.row_height, positions.legend_position
(1.2, 'right')

col_annot_angle class-attribute

col_annot_angle = 30.0

Convert a string or number to a floating-point number, if possible.

col_annot_offset class-attribute

col_annot_offset = 3.0

Convert a string or number to a floating-point number, if possible.

col_annot_position class-attribute

col_annot_position = 'top'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to 'utf-8'. errors defaults to 'strict'.

col_bigspace class-attribute

col_bigspace = 0.5

Convert a string or number to a floating-point number, if possible.

col_group_radius class-attribute

col_group_radius = 0.0

Convert a string or number to a floating-point number, if possible.

col_space class-attribute

col_space = 0.1

Convert a string or number to a floating-point number, if possible.

col_width class-attribute

col_width = 1.0

Convert a string or number to a floating-point number, if possible.

expand_xmax class-attribute

expand_xmax = 2.0

Convert a string or number to a floating-point number, if possible.

expand_xmin class-attribute

expand_xmin = 0.0

Convert a string or number to a floating-point number, if possible.

expand_ymax class-attribute

expand_ymax = 0.0

Convert a string or number to a floating-point number, if possible.

expand_ymin class-attribute

expand_ymin = 0.0

Convert a string or number to a floating-point number, if possible.

legend_position class-attribute

legend_position = 'bottom'

str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.str() (if defined) or repr(object). encoding defaults to 'utf-8'. errors defaults to 'strict'.

row_bigspace class-attribute

row_bigspace = 1.2

Convert a string or number to a floating-point number, if possible.

row_height class-attribute

row_height = 1.0

Convert a string or number to a floating-point number, if possible.

row_space class-attribute

row_space = 0.1

Convert a string or number to a floating-point number, if possible.