report.FixedRangeLimit

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.

Attributes

fixed_range: float#

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']#

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.

Default:

'last'

center_fraction: float, optional#

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.

Default:

None

Additional Constructors

classmethod from_file(filename)#

Load a Flow360BaseModel from a .json file.

Parameters:

filename (str)

Return type:

Flow360BaseModel

Methods

help(methods=False)#

Print fields and methods of a Flow360BaseModel using rich.

Parameters:

methods (bool)

Return type:

None

to_file(filename, **kwargs)#

Export Flow360BaseModel instance to a .json file.

Parameters:
Return type:

None