vlines_extras

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

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

Important

This function wraps vlines.

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

  • stack, stacked (bool, optional) – Whether to “stack” successive columns of the y1 array. If this is True and y2 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).