flow360.report.SubsetLimit

class SubsetLimit

Bases: Flow360BaseModel

Class for setting up ylim in Chart2D by providing a subset of values and an offset, which will be applied to the range of y values.

subset: Tuple[pd.NonNegativeFloat, pd.NonNegativeFloat] [Required]

Tuple of fractions between 0 and 1 describing the lower and upper range of the subset of values that will be used to calculate the ylim.

offset: float [Required]

“Padding” that will be added to the top and bottom of the charts y_range. It scales with with calculated range of y values. For example, if range of y value is 10, an offset=0.3 will “expand” the range by 0.3*10 on both sides, resulting in a final range of y values equal to 16.

type_name: Literal['SubsetLimit'] = 'SubsetLimit'