`GC.scale()`

Set the scale of the clusters, and add an axis.

Usage

python

chart.scale(
    cluster,
    start,
    end,
    padding,
    hidden,
    breaks,
    tick_values,
    reverse,
    axis_position,
    axis_type,
    y,
    scale_breaks,
    scale_break_threshold,
    scale_break_padding,
    ticks_count,
    ticks_format,
    tick_style,
    text_style,
    line_style,
    **options,
)

An argument shown without a default is optional too: left out, the chart keeps its default.

chart is a GC chart.

Arguments

Argument	Type	Description
`cluster`	int, str or list, optional	The clusters, by number (from 1) or name. Default: all.
`start`, `end`	float or list of float, optional	Start and end of the scale, per cluster or for all.
`padding`	float or str, optional	Padding around the genes, in percent or e.g. "500bp".
`hidden`	bool	Whether to hide the axis. Default False.
`breaks`	list of dict or pandas.DataFrame	Breaks in the scale, e.g. `[{"start": 100, "end": 200}]`, or a data frame with `start` and `end` columns and, for breaks per cluster, a `cluster` column.
`tick_values`	list of float, optional	Positions of the ticks.
`reverse`	bool	Whether to reverse the scale. Default False.
`axis_position`	str, optional	"bottom" or "top".
`axis_type`	str	"position" or "range". Default "position".
`y`	float, optional	Vertical position of the axis.
`scale_breaks`	bool	Whether to break the scale where genes are far apart (`autoBreaks` in the spec). Default False.
`scale_break_threshold`	float	Gaps longer than this percentage of the cluster get a break (`autoBreakThreshold`). Default 20.
`scale_break_padding`	float or str	Room around automatic breaks, in percent or e.g. "500bp" (`breakPadding`). Default 1.
`ticks_count`	int, optional	Number of ticks.
`ticks_format`	str, optional	d3 format of the tick labels, e.g. ",.0f".
`tick_style`, `text_style`, `line_style`	dict	Styles of the ticks, their text and the axis line.
`**options`		Further options.

Value

GC: The chart.