Skip to content

GC.cluster_label() ​

Add a label beside each cluster.

Usage ​

python
chart.cluster_label(
    title,
    show,
    width,
    cluster,
    position,
    align,
    wrap_label,
    wrap_options,
    subtitle,
    subtitle_font,
    spacing,
    **options,
)

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

chart is a GC chart.

Arguments ​

ArgumentTypeDescription
titlestr or list of str, optionalThe labels, one per cluster or recycled. Default: the cluster names.
showboolWhether to show the labels. Default True.
widthstr or float, optionalWidth of the label column.
clusterint, str or list, optionalThe clusters, by number (from 1) or name. Default: all.
positionstr, optional"left" or "right".
alignstr or list of str, optional"left", "center" or "right".
wrap_labelbool, optionalWhether to wrap long labels.
wrap_optionsdictOptions of the wrapping.
subtitlestr or list of str, optionalA second line under each label.
subtitle_fontdictFont options of the subtitle.
spacingfloat or list of float, optionalPixels between label and subtitle.
**optionsFurther options, e.g. font_weight="bold".

Value ​

GC: The chart.