ParameterProperty

General script for parameter properties

ParameterProperty

Canonical path: ParameterProperty.ParameterProperty

Definition of class ParameterProperty

attribute_id property writable

attribute_id: int | list[int]

Get the attribute id of the property

Returns:

• int | list[int] –

  attribute id of the property.

attribute_id_str property writable

attribute_id_str: str

Get the attribute id string of the property

Returns:

• str –

  attribute id of the property.

dimensions property writable

dimensions: str

Get the dimensions of the property in case of a list

Returns:

• str –

  dimensions.

enum_dict property writable

enum_dict: dict[int, IntEnum]

Get the enumeration list for the input values

Returns:

• dict[int, IntEnum] –

  enumeration list

exclude_identical property writable

exclude_identical: bool

Get the exclude identical state

If True, the parameter is not used for checking identical PythonParts

Returns:

• bool –

  returns

group_name property writable

group_name: str

Get the group name of the property

Returns:

• str –

  name of the property.

input_type property writable

input_type: InputType

Getter for input type parameter

Returns:

• InputType –

  Input type of parameter property.

is_modified property writable

is_modified: bool

Get the modified state

Returns:

• bool –

  returns

list_reverse property writable

list_reverse: bool

Get the list reverse state

Returns:

• bool –

  returns

list_squeeze property writable

list_squeeze: bool

Get the list squeeze state

Returns:

• bool –

  returns

list_state property writable

list_state: int

Get the list as block state

Returns:

• int –

  returns

name property writable

name: str

Get the name of the property

Returns:

• str –

  name of the property.

named_tuple_def property

named_tuple_def: NamedTupleDef | None

Get the named tuple definition

Returns:

• NamedTupleDef | None –

  named tuple definition

persistent property writable

persistent: Persistent

Get the persistent state of the property

Returns:

• Persistent –

  persistent state (save in the PythonPart data).

selected_value property writable

selected_value: Any

Get the selected value of the property

Returns:

• Any –

  value of the property.

value property writable

value: Any

Get the value of the property

Returns:

• Any –

  value of the property.

value_list_util property writable

value_list_util: ComboBoxValueListUtil | None

Get the combo box value list utility

Returns:

• ComboBoxValueListUtil | None –

  combo box value list utility

value_type property writable

value_type: ParameterPropertyValueType

Get the value type of the property

Returns:

• ParameterPropertyValueType –

  value type.

InputType

Canonical path: ParameterProperty.ParameterProperty.InputType

Bases: IntEnum

Class used to define the type of inputs

Persistent

Canonical path: ParameterProperty.ParameterProperty.Persistent

Bases: IntEnum

Definition of class PersistentType

__init__

__init__()

initialize

__repr__

__repr__() -> str

Print class information

Returns:

• str –

  parameter property as string

deep_copy

deep_copy() -> ParameterProperty

deep copy of the parameter values

Returns:

• ParameterProperty –

  copied parameter property

reset_modified

reset_modified()

Reset the is_modified state

set_named_tuple_def

set_named_tuple_def(typename: str, field_names: list[str])

Set the named tuple definition

Parameters:

• typename (str) –

  description

• field_names (list[str]) –

  description

Placeholder