hlines_extras

hlines_extras(self, *args, **kwargs)[source]

Plot horizontal lines with flexible positional arguments and optionally use different colors for “negative” and “positive” lines.

Important

This function wraps hlines.

Parameters
  • *args ((x1,), (y, x1), or (y, x1, x2)) – The y and x coordinates. If y is not provided, it will be inferred from x1. If x1 and x2 are provided, this function will draw lines between these points. If x1 or x2 are 2D, this function is called with each column. The default value for x2 is 0.

  • stack, stacked (bool, optional) – Whether to “stack” successive columns of the x1 array. If this is True and x2 was provided, it will be ignored.

  • negpos (bool, optional) – Whether to color lines greater than zero with poscolor and lines less than zero with negcolor.

  • negcolor, poscolor (color-spec, optional) – Colors to use for the negative and positive lines. Ignored if negpos is False. Defaults are rc.negcolor = 'blue7' and rc.poscolor = 'red7'.

  • color, colors (color-spec or list thereof, optional) – The line color(s).

  • linestyle, linestyles (linestyle-spec or list thereof, optional) – The line style(s).

  • lw, linewidth, linewidths (linewidth-spec or list thereof, optional) – The line width(s).