pyalluv.fluxes¶
-
class
Flux
(flux, source_cluster=None, target_cluster=None, relative_flux=False, **kwargs)[source]¶ Bases:
object
Parameters: - relative_flux (bool) – If
True
the fraction of the height of parameter source_cluster is taken, if the source_cluster is none, then the relative height form the target_cluster is taken. - source_cluster (
pyalluv.clusters.Cluster
(default=None)) – Cluster from which the flux originates. - target_cluster (
pyalluv.clusters.Cluster
(default=None)) – Cluster into which the flux leads. - optional parameter (**kwargs) –
interpolation_steps:
out_flux_vanish: str (default=’top’)
default_fc: (default=’gray’)
default_ec: (default=’gray’)
default_alpha: int (default=0.3)
closed readonly facecolors edgecolors linewidths linestyles antialiaseds
-
flux
¶ The size of the flux which will translate to the height of the flux in the Alluvial diagram.
Type: float
-
source_cluster
¶ Cluster from which the flux originates.
Type: pyalluv.clusters.Cluster
(default=None)
-
target_cluster
¶ Cluster into which the flux leads.
Type: pyalluv.clusters.Cluster
(default=None)
- relative_flux (bool) – If