Skip to content

guide_legend 

guide_legend(
    title: str | None = None,
    *,
    nrow: int | None = None,
    ncol: int | None = None,
    byrow: bool | None = None,
    override_aes: Mapping[str, Any] | None = None,
) -> FeatureSpec

Show a key legend for an aesthetic.

Parameters:

  • title (str, default: None ) –

    Legend title.

  • nrow (int, default: None ) –

    Number of rows or columns of legend keys.

  • ncol (int, default: None ) –

    Number of rows or columns of legend keys.

  • byrow (bool, default: None ) –

    True fills the keys row by row instead of column by column.

  • override_aes (dict, default: None ) –

    Constant aesthetics for the legend keys only, e.g. {"size": 5}.

Returns:

  • FeatureSpec –

    The guide.