pycatia3dx.sma_mpa_results.sim_legend

Module initially auto generated using DSYAutomation files from CATIA 3DX R2025x on 2025-09-28 13:20:20.191090

Warning

The notes denoted “3DEXPERIENCE Automation Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia3dx.sma_mpa_results.sim_legend.SimLegend(com_object)
property active_data: bool
Returns:

bool

are_min_max_values_imposed(ob_is_min_value_imposed: bool, ob_is_max_value_imposed: bool) → None
Parameters:
  • ob_is_min_value_imposed (bool)

  • ob_is_max_value_imposed (bool)

Returns:

None

get_color_modifiers(ob_smooth: bool, ob_inverse: bool) → None
Parameters:
  • ob_smooth (bool)

  • ob_inverse (bool)

Returns:

None

get_colors() → tuple
Returns:

tuple

get_computed_min_max_range(od_min_value: float, od_max_value: float, ib_current_units: bool) → None
Parameters:
  • od_min_value (float)

  • od_max_value (float)

  • ib_current_units (bool)

Returns:

None

get_data_list(ib_visible_only: bool, o_data_list: tuple) → None
Parameters:
  • ib_visible_only (bool)

  • o_data_list (tuple)

Returns:

None

get_linear_values() → tuple
Returns:

tuple

get_min_max_value(od_min_value: float, od_max_value: float, ib_current_units: bool, ib_allow_invalid: bool) → None
Parameters:
  • od_min_value (float)

  • od_max_value (float)

  • ib_current_units (bool)

  • ib_allow_invalid (bool)

Returns:

None

get_number_display(on_number_format: int, on_nb_significant_digits: int) → None
Parameters:
  • on_number_format (int)

  • on_nb_significant_digits (int)

Returns:

None

get_values(opd_values: tuple, on_num_values: int, ib_current_units: bool) → None
Parameters:
  • opd_values (tuple)

  • on_num_values (int)

  • ib_current_units (bool)

Returns:

None

has_empty_min_max_range(ib_computed: bool) → bool
Parameters:

ib_computed (bool)

Returns:

bool

property nb_colors: int
Returns:

int

property nb_significant_digits: int
Returns:

int

property number_format: int
Returns:

int

reset_max_value() → None
Returns:

None

reset_min_max_value(ib_reset_min: bool, ib_reset_max: bool) → None
Parameters:
  • ib_reset_min (bool)

  • ib_reset_max (bool)

Returns:

None

reset_min_value() → None
Returns:

None

set_color_modifiers(ib_smooth: bool, ib_inverse: bool) → None
Parameters:
  • ib_smooth (bool)

  • ib_inverse (bool)

Returns:

None

set_max_value(id_max_value: float, ib_current_units: bool) → None
Parameters:
  • id_max_value (float)

  • ib_current_units (bool)

Returns:

None

set_min_max_value(id_min_value: float, id_max_value: float, ib_current_units: bool) → None
Parameters:
  • id_min_value (float)

  • id_max_value (float)

  • ib_current_units (bool)

Returns:

None

set_min_value(id_min_value: float, ib_current_units: bool) → None
Parameters:
  • id_min_value (float)

  • ib_current_units (bool)

Returns:

None

start_animation_range(id_min_value: float, id_max_value: float, ib_current_units: bool) → None
Parameters:
  • id_min_value (float)

  • id_max_value (float)

  • ib_current_units (bool)

Returns:

None

stop_animation_range() → None
Returns:

None

property style: str
Returns:

str