plotting.plot_mode_shape

plotting.plot_mode_shape(
    shape,
    *,
    labels=None,
    positions=None,
    title='Mode shape',
    **layout,
)

Plot a mode’s wave amplitudes along the edges: magnitude (top) over phase (bottom).

Parameters

Name	Type	Description	Default
shape	ndarray	Complex array `(n_edges, n_char)` – one mode projected onto every edge (e.g. from :meth:`EigenmodeResult.mode_shape`).	required
labels	sequence of str	Per-characteristic symbols (LaTeX fragments); defaults to `("f", "g", "h")`.	`None`
positions	array_like	x-axis positions per edge (default: edge index).	`None`
title	str	Figure title.	`'Mode shape'`
**layout		Forwarded to `Figure.update_layout`.	`{}`

Name	Type	Description
	plotly.graph_objects.Figure