The flourishcharts packages are provided by Canva as open source software under the MIT license(opens in a new tab or window).

Bind sankey diagram data

Usage

def bind_sankey_data(
self,
source: str = None,
target: str = None,
value: str = None,
filter: str = None,
facet: str = None,
step_from: str = None,
step_to: str = None,
metadata: Union[list, str] = None
)
PYTHON
bind_sankey_data(
.,
source = NULL,
target = NULL,
value = NULL,
filter = NULL,
facet = NULL,
step_from = NULL,
step_to = NULL,
metadata = NULL
)
R

Arguments

Arguments
Type hint
Description
self
Flourish
Returns the Flourish object
source
str, optional
Source. Suggested data type hints: string. Flourish type hint: column
target
str, optional
Target. Suggested data type hints: string. Flourish type hint: column
value
str, optional
Value of link. A numerical value used to set the thickness of the links. Suggested data type hints: number. Flourish type hint: column
filter
str, optional
Filter. Suggested data type hints: string, number, datetime. Flourish type hint: column
facet
str, optional
Grid of charts. Suggested data type hints: string. Flourish type hint: column
step_from
str, optional
Step from. An integer(whole number) used to indicate where a link starts from (used only in Alluvial mode). Suggested data type hints: number. Flourish type hint: column
step_to
str, optional
Step to. An integer(whole number) used to indicate where a link goes to (used only in Alluvial mode). Suggested data type hints: number. Flourish type hint: column
metadata
Union[list, str], optional
Info for popups. One or more columns of information (text, image URLs, embedded charts etc) to include in popups and panels Suggested data type hints: number, datetime, string. Flourish type hint: columns
Arguments
Description
.
Returns the Flourish object
source
Source. Suggested data type hints: string. Flourish type hint: column
target
Target. Suggested data type hints: string. Flourish type hint: column
value
Value of link. A numerical value used to set the thickness of the links. Suggested data type hints: number. Flourish type hint: column
filter
Filter. Suggested data type hints: string, number, datetime. Flourish type hint: column
facet
Grid of charts. Suggested data type hints: string. Flourish type hint: column
step_from
Step from. An integer(whole number) used to indicate where a link starts from (used only in Alluvial mode). Suggested data type hints: number. Flourish type hint: column
step_to
Step to. An integer(whole number) used to indicate where a link goes to (used only in Alluvial mode). Suggested data type hints: number. Flourish type hint: column
metadata
Info for popups. One or more columns of information (text, image URLs, embedded charts etc) to include in popups and panels Suggested data type hints: number, datetime, string. Flourish type hint: columns