flow360.report.FixedRangeLimit

class FixedRangeLimit

Bases: Flow360BaseModel

Class for setting up ylim in Chart2D by providing a fixed range of y values and strategy for centering.

fixed_range: float [Required]

Range of absolute y values that will be visible on the chart. For example, fixed_range=3 means that y_max - y_min = 3.

center_strategy: Literal['last', 'last_percent'] = 'last'

Describes which values will be considered for calculating ylim. “last” means that the last value will be the center. “last_percent” means that the middle point between max and min y values in the specified center_fraction will be the center.

center_fraction: pd.PositiveFloat | None = None

Used alongside center_strategy=”last_percent”, describes values that will be taken into account for calculating ylim. For example, center_fraction=0.3 means that the last 30% of data will be used.

type_name: Literal['FixedRangeLimit'] = 'FixedRangeLimit'