ResultDisplayOptions

class ansys.result_explorer.core.ResultDisplayOptions(result: str | None = None, set_id: int | None = None, component_index: int | None = None, deformation_scale: float | None = None, legend_range: tuple[float, float] | None = None, use_global_min_max: bool | None = None, _viewport_id: str | None = None, _client: Client | None = None, _viewport=None)

Result-specific display options for plot viewports.

These are sent to the application via the UpdateViewportRequest.display_options field. Changes to properties on this object auto-commit to the application.

Parameters:

resultstr, optional

Result name to display.

set_idint, optional

Actual set ID (from TimeFrequency.set_id), not an index.

component_indexint, optional

Component index for the result.

deformation_scalefloat, optional

Deformation scale factor.

legend_rangetuple of float, optional

Custom legend range as (min, max).

use_global_min_maxbool, optional

Whether to use the global min/max for the legend range.

Examples

>>> from ansys.result_explorer.core import ResultDisplayOptions
>>> opts = ResultDisplayOptions(component_index=2, deformation_scale=3.0)

Methods