## On this page

  

 

 # FieldDefinitionData

 Last update: 16.07.2026 

<a id="compolyx.plot_data.FieldDefinitionData"></a>

### *class* compolyx.plot\_data.FieldDefinitionData(graph, obj, parent=None, display\_data=None)

### Attributes

NameDescription[`FieldDefinitionData.active`](compolyx.plot_data.FieldDefinitionData.active.md#compolyx.plot_data.FieldDefinitionData.active)Whether the plot is active or not; an inactive plot is not updated and it does not contain data.[`FieldDefinitionData.active_display_data`](compolyx.plot_data.FieldDefinitionData.active_display_data.md#compolyx.plot_data.FieldDefinitionData.active_display_data)Returns a dictionary containing display data for this plot owned by the active scene.[`FieldDefinitionData.all_display_data`](compolyx.plot_data.FieldDefinitionData.all_display_data.md#compolyx.plot_data.FieldDefinitionData.all_display_data)Returns a list of all display data classes in existence for this object.[`FieldDefinitionData.changed`](compolyx.plot_data.FieldDefinitionData.changed.md#compolyx.plot_data.FieldDefinitionData.changed)Status boolean.[`FieldDefinitionData.color_table`](compolyx.plot_data.FieldDefinitionData.color_table.md#compolyx.plot_data.FieldDefinitionData.color_table)[`FieldDefinitionData.component`](compolyx.plot_data.FieldDefinitionData.component.md#compolyx.plot_data.FieldDefinitionData.component)The requested result component for a specific plot, for example s1 for the stress in the 1-direction.[`FieldDefinitionData.components`](compolyx.plot_data.FieldDefinitionData.components.md#compolyx.plot_data.FieldDefinitionData.components)Return the possible component set on this plot type.[`FieldDefinitionData.data_scope`](compolyx.plot_data.FieldDefinitionData.data_scope.md#compolyx.plot_data.FieldDefinitionData.data_scope)Data scope of the plot where results will be evaluated.[`FieldDefinitionData.definition_id`](compolyx.plot_data.FieldDefinitionData.definition_id.md#compolyx.plot_data.FieldDefinitionData.definition_id)[`FieldDefinitionData.description_changed`](compolyx.plot_data.FieldDefinitionData.description_changed.md#compolyx.plot_data.FieldDefinitionData.description_changed)Status boolean.[`FieldDefinitionData.enabled`](compolyx.plot_data.FieldDefinitionData.enabled.md#compolyx.plot_data.FieldDefinitionData.enabled)Indicates whether the object is enabled.[`FieldDefinitionData.eval_position`](compolyx.plot_data.FieldDefinitionData.eval_position.md#compolyx.plot_data.FieldDefinitionData.eval_position)The finite element position at which the results are given, for example centroid or nodal.[`FieldDefinitionData.field_variable_name`](compolyx.plot_data.FieldDefinitionData.field_variable_name.md#compolyx.plot_data.FieldDefinitionData.field_variable_name)The underlying field variable name.[`FieldDefinitionData.has_element_wise`](compolyx.plot_data.FieldDefinitionData.has_element_wise.md#compolyx.plot_data.FieldDefinitionData.has_element_wise)Whether the plot offers element-wise data.[`FieldDefinitionData.has_ply_wise`](compolyx.plot_data.FieldDefinitionData.has_ply_wise.md#compolyx.plot_data.FieldDefinitionData.has_ply_wise)Whether the plot offers ply-wise data.[`FieldDefinitionData.id`](compolyx.plot_data.FieldDefinitionData.id.md#compolyx.plot_data.FieldDefinitionData.id)ID of the object.[`FieldDefinitionData.is_dict_item`](compolyx.plot_data.FieldDefinitionData.is_dict_item.md#compolyx.plot_data.FieldDefinitionData.is_dict_item)Indicates whether the object is an item in a dictionary.[`FieldDefinitionData.is_list_item`](compolyx.plot_data.FieldDefinitionData.is_list_item.md#compolyx.plot_data.FieldDefinitionData.is_list_item)Indicates whether the object is an item of a list.[`FieldDefinitionData.link_path`](compolyx.plot_data.FieldDefinitionData.link_path.md#compolyx.plot_data.FieldDefinitionData.link_path)Root path of the current node in the tree for links to this object.[`FieldDefinitionData.locked`](compolyx.plot_data.FieldDefinitionData.locked.md#compolyx.plot_data.FieldDefinitionData.locked)Returns the locked status of the plot.[`FieldDefinitionData.minmax`](compolyx.plot_data.FieldDefinitionData.minmax.md#compolyx.plot_data.FieldDefinitionData.minmax)Min and max value of current data.[`FieldDefinitionData.minmax_last_query`](compolyx.plot_data.FieldDefinitionData.minmax_last_query.md#compolyx.plot_data.FieldDefinitionData.minmax_last_query)Min and max value of data of last query.[`FieldDefinitionData.name`](compolyx.plot_data.FieldDefinitionData.name.md#compolyx.plot_data.FieldDefinitionData.name)Name of the object.[`FieldDefinitionData.parent`](compolyx.plot_data.FieldDefinitionData.parent.md#compolyx.plot_data.FieldDefinitionData.parent)Parent object in the tree.[`FieldDefinitionData.ply_offset_scale_factor`](compolyx.plot_data.FieldDefinitionData.ply_offset_scale_factor.md#compolyx.plot_data.FieldDefinitionData.ply_offset_scale_factor)Offset scale factor.[`FieldDefinitionData.ply_wise`](compolyx.plot_data.FieldDefinitionData.ply_wise.md#compolyx.plot_data.FieldDefinitionData.ply_wise)Whether to plot ply-wise or element-wise.[`FieldDefinitionData.requires_solution`](compolyx.plot_data.FieldDefinitionData.requires_solution.md#compolyx.plot_data.FieldDefinitionData.requires_solution)[`FieldDefinitionData.root_path`](compolyx.plot_data.FieldDefinitionData.root_path.md#compolyx.plot_data.FieldDefinitionData.root_path)Root path of the current node in the tree.[`FieldDefinitionData.scope_entire_model`](compolyx.plot_data.FieldDefinitionData.scope_entire_model.md#compolyx.plot_data.FieldDefinitionData.scope_entire_model)Whether the plot scope is the entire model or a subset defined by the data\_scope.[`FieldDefinitionData.show_on_solids`](compolyx.plot_data.FieldDefinitionData.show_on_solids.md#compolyx.plot_data.FieldDefinitionData.show_on_solids)Whether to plot results on solid or shell elements.[`FieldDefinitionData.show_ply_offsets`](compolyx.plot_data.FieldDefinitionData.show_ply_offsets.md#compolyx.plot_data.FieldDefinitionData.show_ply_offsets)[`FieldDefinitionData.solution`](compolyx.plot_data.FieldDefinitionData.solution.md#compolyx.plot_data.FieldDefinitionData.solution)Solution underlying the plot.[`FieldDefinitionData.solution_set`](compolyx.plot_data.FieldDefinitionData.solution_set.md#compolyx.plot_data.FieldDefinitionData.solution_set)Solution Set selection.[`FieldDefinitionData.spot`](compolyx.plot_data.FieldDefinitionData.spot.md#compolyx.plot_data.FieldDefinitionData.spot)Not applicable to a field definition plot.[`FieldDefinitionData.spots`](compolyx.plot_data.FieldDefinitionData.spots.md#compolyx.plot_data.FieldDefinitionData.spots)Return the possible spot set on this plot type.[`FieldDefinitionData.status`](compolyx.plot_data.FieldDefinitionData.status.md#compolyx.plot_data.FieldDefinitionData.status)Status of the object.[`FieldDefinitionData.status_changed`](compolyx.plot_data.FieldDefinitionData.status_changed.md#compolyx.plot_data.FieldDefinitionData.status_changed)Boolean flag which is set to true in C++ when up-to-date status of object changes.[`FieldDefinitionData.uid`](compolyx.plot_data.FieldDefinitionData.uid.md#compolyx.plot_data.FieldDefinitionData.uid)UID of the object.[`FieldDefinitionData.updated`](compolyx.plot_data.FieldDefinitionData.updated.md#compolyx.plot_data.FieldDefinitionData.updated)Status boolean.[`FieldDefinitionData.uptodate`](compolyx.plot_data.FieldDefinitionData.uptodate.md#compolyx.plot_data.FieldDefinitionData.uptodate)Whether the plot is uptodate.[`FieldDefinitionData.vertex`](compolyx.plot_data.FieldDefinitionData.vertex.md#compolyx.plot_data.FieldDefinitionData.vertex)Raises an error if the object has been removed from the graph.### Methods

NameDescription[`FieldDefinitionData.add_data_scope_entity`](compolyx.plot_data.FieldDefinitionData.add_data_scope_entity.md#compolyx.plot_data.FieldDefinitionData.add_data_scope_entity)(entity)Add 1 entity to the Data Scope of a plot.[`FieldDefinitionData.clear_data_scope`](compolyx.plot_data.FieldDefinitionData.clear_data_scope.md#compolyx.plot_data.FieldDefinitionData.clear_data_scope)()Clears the complete data scope of a plot, that is all scope entities are removed at once.[`FieldDefinitionData.display_data_create`](compolyx.plot_data.FieldDefinitionData.display_data_create.md#compolyx.plot_data.FieldDefinitionData.display_data_create)(\[parent\])Function for internal use, not meant for scripting.[`FieldDefinitionData.find_parent`](compolyx.plot_data.FieldDefinitionData.find_parent.md#compolyx.plot_data.FieldDefinitionData.find_parent)(type)Steps up the tree and returns the first parent with given type.[`FieldDefinitionData.get_data`](compolyx.plot_data.FieldDefinitionData.get_data.md#compolyx.plot_data.FieldDefinitionData.get_data)(\[visible, selected\])Get data of plot.[`FieldDefinitionData.get_deformations`](compolyx.plot_data.FieldDefinitionData.get_deformations.md#compolyx.plot_data.FieldDefinitionData.get_deformations)(\[...\])Function used internally to query matching nodal deformations for a given plot.[`FieldDefinitionData.get_element_indices`](compolyx.plot_data.FieldDefinitionData.get_element_indices.md#compolyx.plot_data.FieldDefinitionData.get_element_indices)(\[...\])Get element indices (ACP internal element numbers starting from 0) of plot.[`FieldDefinitionData.get_element_labels`](compolyx.plot_data.FieldDefinitionData.get_element_labels.md#compolyx.plot_data.FieldDefinitionData.get_element_labels)(\[...\])Get element labels (element numbers as read from / written to mesh files) of plot.[`FieldDefinitionData.get_full_description`](compolyx.plot_data.FieldDefinitionData.get_full_description.md#compolyx.plot_data.FieldDefinitionData.get_full_description)()This function returns information displayed together with the legend.[`FieldDefinitionData.get_ply_offsets`](compolyx.plot_data.FieldDefinitionData.get_ply_offsets.md#compolyx.plot_data.FieldDefinitionData.get_ply_offsets)(\[...\])Returns the offset between plies and reference surface.[`FieldDefinitionData.obj_exists`](compolyx.plot_data.FieldDefinitionData.obj_exists.md#compolyx.plot_data.FieldDefinitionData.obj_exists)()Checks if \_\_obj still references the c++ object (has not been reset to None by self.\_delete) and exists in the graph.[`FieldDefinitionData.remove_data_scope_entity`](compolyx.plot_data.FieldDefinitionData.remove_data_scope_entity.md#compolyx.plot_data.FieldDefinitionData.remove_data_scope_entity)(entity)Remove 1 entity to the Data Scope of a plot.[`FieldDefinitionData.serialize`](compolyx.plot_data.FieldDefinitionData.serialize.md#compolyx.plot_data.FieldDefinitionData.serialize)()Serialize to Python string.[`FieldDefinitionData.serialize_create_function`](compolyx.plot_data.FieldDefinitionData.serialize_create_function.md#compolyx.plot_data.FieldDefinitionData.serialize_create_function)()[`FieldDefinitionData.serialize_name_and_id`](compolyx.plot_data.FieldDefinitionData.serialize_name_and_id.md#compolyx.plot_data.FieldDefinitionData.serialize_name_and_id)()Serializes the name and ID.[`FieldDefinitionData.serialize_properties`](compolyx.plot_data.FieldDefinitionData.serialize_properties.md#compolyx.plot_data.FieldDefinitionData.serialize_properties)()Serialize to Python string.[`FieldDefinitionData.serialize_python_only_attributes`](compolyx.plot_data.FieldDefinitionData.serialize_python_only_attributes.md#compolyx.plot_data.FieldDefinitionData.serialize_python_only_attributes)()[`FieldDefinitionData.update`](compolyx.plot_data.FieldDefinitionData.update.md#compolyx.plot_data.FieldDefinitionData.update)()[`FieldDefinitionData.visit`](compolyx.plot_data.FieldDefinitionData.visit.md#compolyx.plot_data.FieldDefinitionData.visit)(visitor)Walk through the tree and let the visitor perform action on every descendant node.