Sankey

SankeyPlayback

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

Spec for Base Sankey Playback widget.

Construct spec for base Sankey Playback 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
playback	Playback	specs for Playback component.	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 Playback widget

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

nodes = {}
connections = {}
frames = []

# We now create a sankey playback with 3 frames, bases on the first
# three months

data = [[0.76, 0.24], [0.23, 0.53], [0.13, 0.11]]

for month, values in zip(["Jan", "Feb", "Mar"], data):
    nodes[month] = pd.DataFrame({"id": ["company", "imports", "exports"]})
    connections[month] = pd.DataFrame(
        {
            "from": ["company", "company"],
            "to": ["imports", "exports"],
            "value": values,
        }
    )
    frames.append({"id": month})

sankey_widget = playback.SankeyPlayback(
    nodes=playback.Nodes(
        data=nodes,
    ),
    connections=playback.Connections(
        data=connections,
    ),
    playback=playback.Playback(
        data=pd.DataFrame(data=frames),
    ),
)

Dashboard(content=sankey_widget)

Components

Connections module-attribute

Connections = BaseConnections[Dict[str, 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[Dict[str, 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

Playback

Playback

Playback(
    *,
    id_column: str = "id",
    data: Union[DataType, DataFrame],
    label_column: Optional[str] = None,
    label_formatting: Optional[FormattingType] = None,
    update_interval: int = 1,
    loop: bool = False,
    auto_play: bool = False,
    initial_state: Optional[InitialState] = None
)

Spec for Playback widget.

Construct spec for Playback widget.

Parameters:

Name	Type	Description	Default
id_column	str	Id Column to match the field in the Data for the Frame.	'id'
data	Union[DataType, DataFrame]	data for the widget. Can be a pandas dataframe or Storage object if the data is to be retrieved from a storage.	required
label_column	Optional[str]	Label Column to match the field in the Data for the Frame Label.	None
label_formatting	Optional[FormattingType]	Class to modify the Frame Label Formatting.	None
update_interval	int	Configuration for update interval.	1
loop	bool	Configuration for Loop.	False
auto_play	bool	Configuration for Auto Play.	False
initial_state	Optional[InitialState]	Class to add an initial state.	None

InitialState

InitialState(
    *,
    start_frame_id: Optional[str] = None,
    end_frame_id: Optional[str] = None
)

Spec for InitialState widget.

Construct spec for Playback Initial State widget.

Parameters:

Name	Type	Description	Default
start_frame_id	Optional[str]	column in Pandas DataFrame to define the starting frame.	None
end_frame_id	Optional[str]	column in Pandas DataFrame to define the ending frame.	None

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