Sankey

Sankey

Sankey(
    *,
    series_name: str = "series",
    nodes: Nodes,
    connections: Connections,
    widget_id: Optional[str] = None,
    formatting: Optional[NumberFormatting] = None,
    title: WidgetTitleType = ""
)

Spec for Sankey widget.

Construct spec for Sankey widget.

Parameters:

Name	Type	Description	Default
series_name	str	name shown next to values in nodes and connections.	'series'
nodes	Nodes	spec for nodes.	required
connections	Connections	spec for connections.	required
widget_id	Optional[str]	unique widget id in a dashboard.	None
formatting	Optional[NumberFormatting]	formatting spec for value associated with nodes and connections.	None
title	WidgetTitleType	title of widget can be either a string (fixed value) or determined by a value from another widget using a WidgetLink.	''

Examples:

Create a minimal Sankey widget

import pandas as pd
from engineai.sdk.dashboard.dashboard import Dashboard
from engineai.sdk.dashboard.widgets import sankey

nodes = pd.DataFrame({"id": ["company", "imports", "exports"]})
connections = pd.DataFrame(
    {
        "from": ["company", "company"],
        "to": ["imports", "exports"],
        "value": [0.76, 0.24],
    }
)
sankey_widget = sankey.Sankey(
    nodes=sankey.Nodes(
        data=nodes,
    ),
    connections=sankey.Connections(
        data=connections,
    ),
)
Dashboard(content=sankey_widget)

Components

Connections module-attribute

Connections = BaseConnections[DataFrame]

ConnectionsStyling

ConnectionsStyling(
    *,
    color_spec: Optional[ColorSpec] = None,
    data_column: Optional[TemplatedStringItem] = None
)

Spec to style connections in a Sankey widget.

Construct style spec for a node.

Parameters:

Name	Type	Description	Default
color_spec	Optional[ColorSpec]	spec for coloring a node.	None
data_column	Optional[TemplatedStringItem]	name of column in pandas dataframe(s) used for color spec if a gradient is used.	None

Raises:

Type	Description
SankeyDataColumnMissingError	if color_spec is DiscreteMap/Gradient and data_column has not been specified

Nodes module-attribute

Nodes = BaseNodes[DataFrame]

NodesStyling

NodesStyling(
    *,
    color_spec: Optional[ColorSpec] = None,
    data_column: Optional[TemplatedStringItem] = None,
    width: int = 8
)

Spec to style nodes in a Sankey widget.

Construct style spec for a node.

Parameters:

Name	Type	Description	Default
color_spec	Optional[ColorSpec]	spec for coloring a node.	None
data_column	Optional[TemplatedStringItem]	name of column in pandas dataframe(s) used for color spec if a gradient is used.	None
width	int	width of nodes in pixels.	8

Raises:

Type	Description
SankeyDataColumnMissingError	if color_spec is DiscreteMap/Gradient and data_column has not been specified

Tooltips

CategoryTooltipItem

CategoryTooltipItem(
    *,
    data_column: TemplatedStringItem,
    formatting: MapperFormatting,
    label: Optional[Union[str, DataField]] = None
)

Customize tooltips for categorical data in Chart widget.

Define specifications for a category tooltip item within a Chart widget to customize the appearance and content of tooltips displayed for categorical data.

Constructor for CategoryTooltipItem.

Parameters:

Name	Type	Description	Default
data_column	TemplatedStringItem	name of column in pandas dataframe(s) used for the value of the tooltip item.	required
formatting	MapperFormatting	tooltip formatting spec.	required
label	Optional[Union[str, DataField]]	label to be used for tooltip item, it can be either a string or a DataField object.	None

DatetimeTooltipItem

DatetimeTooltipItem(
    *,
    data_column: TemplatedStringItem,
    formatting: Optional[DateTimeFormatting] = None,
    label: Optional[Union[str, DataField]] = None
)

Customize tooltips for datetime data in Chart.

Define specifications for a datetime item within a tooltip for a Chart widget to customize the appearance and content of tooltips displayed for datetime data.

Constructor for DatetimeTooltipItem.

Parameters:

Name	Type	Description	Default
data_column	TemplatedStringItem	name of column in pandas dataframe(s) used for the value of the tooltip item.	required
formatting	DateTimeFormatting	tooltip formatting spec Defaults to DateTimeFormatting for Dates (i.e. not include HH:MM).	None
label	Optional[Union[str, DataField]]	label to be used for tooltip item, it can be either a string or a DataField object.	None

NumberTooltipItem

NumberTooltipItem(
    *,
    data_column: TemplatedStringItem,
    formatting: Optional[NumberFormatting] = None,
    label: Optional[Union[str, DataField]] = None
)

Customize tooltips for numerical data in Chart.

Define specifications for a number item within a tooltip for a Chart widget to customize the appearance and content of tooltips displayed for numerical data.

Constructor for NumberTooltipItem.

Parameters:

Name	Type	Description	Default
data_column	TemplatedStringItem	name of column in pandas dataframe(s) used for the value of the tooltip item.	required
formatting	Optional[NumberFormatting]	tooltip formatting spec. Defaults to None (Base NumberFormatting).	None
label	Optional[Union[str, DataField]]	label to be used for tooltip item, it can be either a string or a DataField object.	None

TextTooltipItem

TextTooltipItem(
    *,
    data_column: TemplatedStringItem,
    formatting: Optional[TextFormatting] = None,
    label: Optional[Union[str, DataField]] = None
)

Customize tooltips for textual data in Chart.

Define specifications for a text item within a tooltip for a Chart widget to customize the appearance and content of tooltips displayed for textual data.

Constructor for TextTooltipItem.

Parameters:

Name	Type	Description	Default
data_column	TemplatedStringItem	name of column in pandas dataframe(s) used for the value of the tooltip item.	required
formatting	Optional[TextFormatting]	tooltip formatting spec. Defaults to TextFormatting(max_characters=30).	None
label	Optional[Union[str, DataField]]	label to be used for tooltip item, it can be either a string or a DataField object.	None