graphinglib.Curve.create_slice_y#

Curve.create_slice_y(y1: float, y2: float, label: str | None = None, color: str | Inherit = Inherit, line_width: float | Inherit = Inherit, line_style: str | Inherit = Inherit, alpha: float | Inherit = Inherit, copy_first: bool = False) → Self[source]#

Creates a slice of the curve between two y values.

Parameters:

y1, y2float: The y values between which the slice is to be created.
labelstr, optional: Label of the slice to be displayed in the legend.
colorstr: Color of the slice. Default depends on the figure_style configuration.
line_widthfloat: Width of the slice. Typical range is 0.5 to 4. Default depends on the figure_style configuration.
line_stylestr: Style of the slice. Values include "-", "--", "-.", ":", "solid", "dashed", "dashdot", and "dotted". Default depends on the figure_style configuration.
alphafloat: Opacity of the slice. Range is 0 (transparent) to 1 (opaque). Default depends on the figure_style configuration.
copy_firstbool: If True, a copy of the curve (with all its parameters) will be returned with the slicing applied. Any other parameters passed to this method will also be applied to the copied curve. If False, a new curve will be created with the slicing applied and the parameters passed to this method.

Returns:

A Curve object which is the slice of the original curve between the two y
values.

Notes

Color parameters accept Matplotlib color formats: named colors ("blue"), short color strings ("b"), hex strings ("#0000ff"), grayscale strings ("0.5"), and RGB/RGBA tuples with values between 0 and 1 ((0, 0, 1) or (0, 0, 1, 0.5)).