gradpyent

Gradient

Gradient.

class gradpyent.gradient.Gradient(gradient_start: ~gradpyent.library.rgb.RGB | list | tuple | str = <gradpyent.library.rgb.RGB object>, gradient_end: ~gradpyent.library.rgb.RGB | list | tuple | str = <gradpyent.library.rgb.RGB object>, opacity: float | None = 1.0)

Bases: object

Gradient class.

get_gradient_series(series: array | Series | list, fmt: str | None = None, default: str | None = 'black', force_rescale: bool | None = False) list

Create the gradient series.

Parameters:
  • series – Input series to create color gradient from

  • fmt – Desired output format

  • default – Default color for nulls

  • force_rescale – Force rescale (even if not needed)

Returns:

List of color in specified format

property gradient_end

Return the gradient ending value as an RGB object.

property gradient_start

Return the gradient starting value as an RGB object.

property opacity

Return the opacity value as a float.

set_gradient_bounds(gradient_start: RGB | list | tuple | str, gradient_end: RGB | list | tuple | str)

Set gradient start and end colors.

Parameters:
  • gradient_start – Start color

  • gradient_end – End color

Returns:

None

Library