## On this page # UserDefinedData Last update: 16.07.2026 ### *class* compolyx.plot\_data.UserDefinedData(graph, obj, parent=None, display\_data=None) ### Attributes NameDescription[`UserDefinedData.active`](compolyx.plot_data.UserDefinedData.active.md#compolyx.plot_data.UserDefinedData.active)Whether the plot is active or not; an inactive plot is not updated and it does not contain data.[`UserDefinedData.active_display_data`](compolyx.plot_data.UserDefinedData.active_display_data.md#compolyx.plot_data.UserDefinedData.active_display_data)Returns a dictionary containing display data for this plot owned by the active scene.[`UserDefinedData.all_display_data`](compolyx.plot_data.UserDefinedData.all_display_data.md#compolyx.plot_data.UserDefinedData.all_display_data)Returns a list of all display data classes in existence for this object.[`UserDefinedData.changed`](compolyx.plot_data.UserDefinedData.changed.md#compolyx.plot_data.UserDefinedData.changed)Status boolean.[`UserDefinedData.color_table`](compolyx.plot_data.UserDefinedData.color_table.md#compolyx.plot_data.UserDefinedData.color_table)[`UserDefinedData.component`](compolyx.plot_data.UserDefinedData.component.md#compolyx.plot_data.UserDefinedData.component)The requested result component for a specific plot, for example s1 for the stress in the 1-direction.[`UserDefinedData.components`](compolyx.plot_data.UserDefinedData.components.md#compolyx.plot_data.UserDefinedData.components)Return the possible component set on this plot type.[`UserDefinedData.data_scope`](compolyx.plot_data.UserDefinedData.data_scope.md#compolyx.plot_data.UserDefinedData.data_scope)Data scope of the plot where results will be evaluated.[`UserDefinedData.definition_id`](compolyx.plot_data.UserDefinedData.definition_id.md#compolyx.plot_data.UserDefinedData.definition_id)[`UserDefinedData.description_changed`](compolyx.plot_data.UserDefinedData.description_changed.md#compolyx.plot_data.UserDefinedData.description_changed)Status boolean.[`UserDefinedData.enabled`](compolyx.plot_data.UserDefinedData.enabled.md#compolyx.plot_data.UserDefinedData.enabled)Indicates whether the object is enabled.[`UserDefinedData.eval_position`](compolyx.plot_data.UserDefinedData.eval_position.md#compolyx.plot_data.UserDefinedData.eval_position)The finite element position at which the results are given, for example centroid or nodal.[`UserDefinedData.has_element_wise`](compolyx.plot_data.UserDefinedData.has_element_wise.md#compolyx.plot_data.UserDefinedData.has_element_wise)Whether the plot offers element-wise data.[`UserDefinedData.has_ply_wise`](compolyx.plot_data.UserDefinedData.has_ply_wise.md#compolyx.plot_data.UserDefinedData.has_ply_wise)Whether the plot offers ply-wise data.[`UserDefinedData.id`](compolyx.plot_data.UserDefinedData.id.md#compolyx.plot_data.UserDefinedData.id)ID of the object.[`UserDefinedData.is_dict_item`](compolyx.plot_data.UserDefinedData.is_dict_item.md#compolyx.plot_data.UserDefinedData.is_dict_item)Indicates whether the object is an item in a dictionary.[`UserDefinedData.is_list_item`](compolyx.plot_data.UserDefinedData.is_list_item.md#compolyx.plot_data.UserDefinedData.is_list_item)Indicates whether the object is an item of a list.[`UserDefinedData.link_path`](compolyx.plot_data.UserDefinedData.link_path.md#compolyx.plot_data.UserDefinedData.link_path)Root path of the current node in the tree for links to this object.[`UserDefinedData.locked`](compolyx.plot_data.UserDefinedData.locked.md#compolyx.plot_data.UserDefinedData.locked)Returns the locked status of the plot.[`UserDefinedData.minmax`](compolyx.plot_data.UserDefinedData.minmax.md#compolyx.plot_data.UserDefinedData.minmax)Min and max value of current data.[`UserDefinedData.minmax_last_query`](compolyx.plot_data.UserDefinedData.minmax_last_query.md#compolyx.plot_data.UserDefinedData.minmax_last_query)Min and max value of data of last query.[`UserDefinedData.name`](compolyx.plot_data.UserDefinedData.name.md#compolyx.plot_data.UserDefinedData.name)Name of the object.[`UserDefinedData.parent`](compolyx.plot_data.UserDefinedData.parent.md#compolyx.plot_data.UserDefinedData.parent)Parent object in the tree.[`UserDefinedData.ply_offset_scale_factor`](compolyx.plot_data.UserDefinedData.ply_offset_scale_factor.md#compolyx.plot_data.UserDefinedData.ply_offset_scale_factor)Offset scale factor.[`UserDefinedData.ply_wise`](compolyx.plot_data.UserDefinedData.ply_wise.md#compolyx.plot_data.UserDefinedData.ply_wise)Whether to plot ply-wise or element-wise.[`UserDefinedData.requires_solution`](compolyx.plot_data.UserDefinedData.requires_solution.md#compolyx.plot_data.UserDefinedData.requires_solution)[`UserDefinedData.root_path`](compolyx.plot_data.UserDefinedData.root_path.md#compolyx.plot_data.UserDefinedData.root_path)Root path of the current node in the tree.[`UserDefinedData.scope_entire_model`](compolyx.plot_data.UserDefinedData.scope_entire_model.md#compolyx.plot_data.UserDefinedData.scope_entire_model)Whether the plot scope is the entire model or a subset defined by the data\_scope.[`UserDefinedData.show_on_solids`](compolyx.plot_data.UserDefinedData.show_on_solids.md#compolyx.plot_data.UserDefinedData.show_on_solids)Whether to plot results on solid or shell elements.[`UserDefinedData.show_ply_offsets`](compolyx.plot_data.UserDefinedData.show_ply_offsets.md#compolyx.plot_data.UserDefinedData.show_ply_offsets)[`UserDefinedData.show_user_text`](compolyx.plot_data.UserDefinedData.show_user_text.md#compolyx.plot_data.UserDefinedData.show_user_text)Whether to show the user-defined text labels or not.[`UserDefinedData.solution`](compolyx.plot_data.UserDefinedData.solution.md#compolyx.plot_data.UserDefinedData.solution)Solution underlying the plot.[`UserDefinedData.solution_set`](compolyx.plot_data.UserDefinedData.solution_set.md#compolyx.plot_data.UserDefinedData.solution_set)Solution Set selection.[`UserDefinedData.spot`](compolyx.plot_data.UserDefinedData.spot.md#compolyx.plot_data.UserDefinedData.spot)Not applicable to a user-defined plot.[`UserDefinedData.spots`](compolyx.plot_data.UserDefinedData.spots.md#compolyx.plot_data.UserDefinedData.spots)Return the possible spot set on this plot type.[`UserDefinedData.status`](compolyx.plot_data.UserDefinedData.status.md#compolyx.plot_data.UserDefinedData.status)Status of the object.[`UserDefinedData.status_changed`](compolyx.plot_data.UserDefinedData.status_changed.md#compolyx.plot_data.UserDefinedData.status_changed)Boolean flag which is set to true in C++ when up-to-date status of object changes.[`UserDefinedData.text_threshold`](compolyx.plot_data.UserDefinedData.text_threshold.md#compolyx.plot_data.UserDefinedData.text_threshold)Threshold above/below which user text is hidden.[`UserDefinedData.text_threshold_type`](compolyx.plot_data.UserDefinedData.text_threshold_type.md#compolyx.plot_data.UserDefinedData.text_threshold_type)"show\_all" (default), "show\_only\_values\_above\_threshold", "show\_only\_values\_below\_threshold.[`UserDefinedData.uid`](compolyx.plot_data.UserDefinedData.uid.md#compolyx.plot_data.UserDefinedData.uid)UID of the object.[`UserDefinedData.updated`](compolyx.plot_data.UserDefinedData.updated.md#compolyx.plot_data.UserDefinedData.updated)Status boolean.[`UserDefinedData.uptodate`](compolyx.plot_data.UserDefinedData.uptodate.md#compolyx.plot_data.UserDefinedData.uptodate)Whether the plot is uptodate.[`UserDefinedData.user_data`](compolyx.plot_data.UserDefinedData.user_data.md#compolyx.plot_data.UserDefinedData.user_data)Access to the user-defined data of the plot.[`UserDefinedData.user_element_centroids`](compolyx.plot_data.UserDefinedData.user_element_centroids.md#compolyx.plot_data.UserDefinedData.user_element_centroids)Retrieve the centroids of the elements consistent with the current user element indices/labels.[`UserDefinedData.user_element_indices`](compolyx.plot_data.UserDefinedData.user_element_indices.md#compolyx.plot_data.UserDefinedData.user_element_indices)Access the indices for the given data-scope.[`UserDefinedData.user_element_labels`](compolyx.plot_data.UserDefinedData.user_element_labels.md#compolyx.plot_data.UserDefinedData.user_element_labels)Access the labels for the given data-scope.[`UserDefinedData.user_script`](compolyx.plot_data.UserDefinedData.user_script.md#compolyx.plot_data.UserDefinedData.user_script)Body of the script to be executed is user\_script\_enabled is set to True.[`UserDefinedData.user_script_enabled`](compolyx.plot_data.UserDefinedData.user_script_enabled.md#compolyx.plot_data.UserDefinedData.user_script_enabled)Whether to run a custom script on update.[`UserDefinedData.user_text`](compolyx.plot_data.UserDefinedData.user_text.md#compolyx.plot_data.UserDefinedData.user_text)Access to the user-defined text of the plot.[`UserDefinedData.vertex`](compolyx.plot_data.UserDefinedData.vertex.md#compolyx.plot_data.UserDefinedData.vertex)Raises an error if the object has been removed from the graph.### Methods NameDescription[`UserDefinedData.add_data_scope_entity`](compolyx.plot_data.UserDefinedData.add_data_scope_entity.md#compolyx.plot_data.UserDefinedData.add_data_scope_entity)(entity)Add 1 entity to the Data Scope of a plot.[`UserDefinedData.clear_data_scope`](compolyx.plot_data.UserDefinedData.clear_data_scope.md#compolyx.plot_data.UserDefinedData.clear_data_scope)()Clears the complete data scope of a plot, that is all scope entities are removed at once.[`UserDefinedData.display_data_create`](compolyx.plot_data.UserDefinedData.display_data_create.md#compolyx.plot_data.UserDefinedData.display_data_create)(\[parent\])Function for internal use, not meant for scripting.[`UserDefinedData.find_parent`](compolyx.plot_data.UserDefinedData.find_parent.md#compolyx.plot_data.UserDefinedData.find_parent)(type)Steps up the tree and returns the first parent with given type.[`UserDefinedData.get_data`](compolyx.plot_data.UserDefinedData.get_data.md#compolyx.plot_data.UserDefinedData.get_data)(\[visible, selected\])Get data of plot.[`UserDefinedData.get_deformations`](compolyx.plot_data.UserDefinedData.get_deformations.md#compolyx.plot_data.UserDefinedData.get_deformations)(\[visible, ...\])Function used internally to query matching nodal deformations for a given plot.[`UserDefinedData.get_element_indices`](compolyx.plot_data.UserDefinedData.get_element_indices.md#compolyx.plot_data.UserDefinedData.get_element_indices)(\[...\])Get element indices (ACP internal element numbers starting from 0) of plot.[`UserDefinedData.get_element_labels`](compolyx.plot_data.UserDefinedData.get_element_labels.md#compolyx.plot_data.UserDefinedData.get_element_labels)(\[...\])Get element labels (element numbers as read from / written to mesh files) of plot.[`UserDefinedData.get_full_description`](compolyx.plot_data.UserDefinedData.get_full_description.md#compolyx.plot_data.UserDefinedData.get_full_description)()This function returns information displayed together with the legend.[`UserDefinedData.get_ply_offsets`](compolyx.plot_data.UserDefinedData.get_ply_offsets.md#compolyx.plot_data.UserDefinedData.get_ply_offsets)(\[visible, ...\])Returns the offset between plies and reference surface.[`UserDefinedData.obj_exists`](compolyx.plot_data.UserDefinedData.obj_exists.md#compolyx.plot_data.UserDefinedData.obj_exists)()Checks if \_\_obj still references the c++ object (has not been reset to None by self.\_delete) and exists in the graph.[`UserDefinedData.remove_data_scope_entity`](compolyx.plot_data.UserDefinedData.remove_data_scope_entity.md#compolyx.plot_data.UserDefinedData.remove_data_scope_entity)(entity)Remove 1 entity to the Data Scope of a plot.[`UserDefinedData.serialize`](compolyx.plot_data.UserDefinedData.serialize.md#compolyx.plot_data.UserDefinedData.serialize)()Serialize to Python string.[`UserDefinedData.serialize_create_function`](compolyx.plot_data.UserDefinedData.serialize_create_function.md#compolyx.plot_data.UserDefinedData.serialize_create_function)()[`UserDefinedData.serialize_name_and_id`](compolyx.plot_data.UserDefinedData.serialize_name_and_id.md#compolyx.plot_data.UserDefinedData.serialize_name_and_id)()Serializes the name and ID.[`UserDefinedData.serialize_properties`](compolyx.plot_data.UserDefinedData.serialize_properties.md#compolyx.plot_data.UserDefinedData.serialize_properties)()Serialize to Python string.[`UserDefinedData.serialize_python_only_attributes`](compolyx.plot_data.UserDefinedData.serialize_python_only_attributes.md#compolyx.plot_data.UserDefinedData.serialize_python_only_attributes)()[`UserDefinedData.update`](compolyx.plot_data.UserDefinedData.update.md#compolyx.plot_data.UserDefinedData.update)()[`UserDefinedData.user_script_default`](compolyx.plot_data.UserDefinedData.user_script_default.md#compolyx.plot_data.UserDefinedData.user_script_default)()[`UserDefinedData.visit`](compolyx.plot_data.UserDefinedData.visit.md#compolyx.plot_data.UserDefinedData.visit)(visitor)Walk through the tree and let the visitor perform action on every descendant node.