disruption_sankey

Capacity-spillover Sankey edges for a single disruption event.

Examples

from openbb import obb
# Sankey edges for the latest disruption event.
obb.imf.portwatch.disruption_sankey(event_id='LATEST', provider='imf')

Parameters

• standard
• imf

event_id: str | None
Default: LATEST
Disruption event ID, or 'LATEST' for the most recent event.

theme: str | None
Theme for the Sankey chart. Only used when chart=True.

---

Returns

results: DisruptionSankey

Serializable results.

provider: str | None

Provider name.

warnings: Optional[list[Warning_]]

List of warnings.

chart: Optional[Chart]

Chart object.

extra: dict[str, Any]

Extra info.

---

Data

• standard
• imf

eventid: int
Event identifier.

source: int
Source node index in the Sankey diagram.

target: int
Target node index in the Sankey diagram.

source_port: str
Display label for the source port (e.g. 'Colombo (Sri Lanka)').

target_port: str
Display label for the destination port.

source_port_id: str | None
IMF Port Watch port ID of the source.

target_port_id: str | None
IMF Port Watch port ID of the destination.

source_country_code: str | None
ISO3 country code of the source port.

target_country_code: str | None
ISO3 country code of the destination port.

perc_disaster_capacity: float | None
Share (%) of the disrupted capacity rerouted along this edge.

object_id: int | None
Internal ArcGIS feature row identifier.