## On this page

  

 

 # ScalarFieldData

 Last update: 16.07.2026 

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

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

### Attributes

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

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