Create a 2 point color gradient
str
low color
str
high color
callable()
, optionalMajor break points. Alternatively, a callable that takes a tuple of limits and returns a list of breaks. Default is to automatically calculate the breaks.
tuple
, optionalMultiplicative and additive expansion constants that determine how the scale is expanded. If specified must be of length 2 or 4. Specifically the values are in this order:
(mul, add)
(mul_low, add_low, mul_high, add_high)
For example,
(0, 0)
- Do not expand.
(0, 1)
- Expand lower and upper limits by 1 unit.
(1, 0)
- Expand lower and upper limits by 100%.
(0, 0, 0, 0)
- Do not expand, as(0, 0)
.
(0, 0, 0, 1)
- Expand upper limit by 1 unit.
(0, 1, 0.1, 0)
- Expand lower limit by 1 unit and upper limit by 10%.
(0, 0, 0.1, 2)
- Expand upper limit by 10% plus 2 units.
If not specified, suitable defaults are chosen.
str
, optionalName used as the label of the scale. This is what shows up as the axis label or legend title. Suitable defaults are chosen depending on the type of scale.
list
or callable()
, optionalList of str
. Labels at the breaks.
Alternatively, a callable that takes an array_like of
break points as input and returns a list of strings.
Limits of the scale. Most commonly, these are the min & max values for the scales. For scales that deal with categoricals, these may be a subset or superset of the categories.
callable()
, optionalFunction to map data points onto the scale. Most scales define their own palettes.
list
, optionallist of str
. Aesthetics covered by the
scale. These are defined by each scale and the
user should probably not change them. Have fun.
str
| function
Name of a trans function or a trans function.
See mizani.transforms
for possible options.
function
Function to deal with out of bounds (limits)
data points. Default is to turn them into
np.nan
, which then get dropped.
int
or callable()
or None
If a list-like, it is the minor breaks points.
If an integer, it is the number of minor breaks between
any set of major breaks.
If a function, it should have the signature
func(limits)
and return a list-like of consisting
of the minor break points.
If None
, no minor breaks are calculated.
The default is to automatically calculate them.
function
, optionalFunction to rescale data points so that they can be handled by the palette. Default is to rescale them onto the [0, 1] range. Scales that inherit from this class may have another default.
str
Color of missing values. Default is 'None'