Skip to main content
Back to top
Ctrl
+
K
Home
Getting started
User guide
Examples
API reference
More
Contribute
Release notes
Ctrl
+
K
Choose version
System Settings
Light
Dark
GitHub
View
×
×
Home
Getting started
User guide
Examples
API reference
Contribute
Release notes
Ctrl
+
K
Choose version
System Settings
Light
Dark
GitHub
Collapse Sidebar
Expand Sidebar
Section Navigation
Instance management
launch_result_explorer
ResultExplorerInstance
launch
stop
grpc_port
result_provider_name
server_process
session_id
web_session
web_url
ServerLaunchConfig
auth
grpc_port
ssl
WebLaunchConfig
browser_type
BrowserType
SYSTEM_DEFAULT
PLAYWRIGHT_CHROMIUM
PLAYWRIGHT_CHROMIUM_HEADLESS
ResultExplorerServerProcess
start
stop
ca_cert_path
gateway_grpc_port
gateway_http_port
grpc_port
is_running
port
url
ResultExplorerWebSession
close
launch
playwright_page
Client
Client
app_settings
authenticate_result_provider
connect_with_token
create_hps_solution
create_result_provider
create_solution
create_workspace
delete_result_provider
delete_solution
delete_viewport
delete_workspace
get_solution
get_workspace
hps_ls
import_workspace_from_template
list_result_providers
list_solutions
list_workspaces
ls
open_session
save_session
stop
update_app_settings
app_info
connection_token
default_result_provider
instance
web_session
web_url
Solution and views
Solution
create_chart
create_named_selection
create_plot
delete_chart
delete_named_selection
delete_plot
get_solver_out_content
update_chart
update_named_selection
update_plot
analysis_type
available_custom_selections
available_mesh_properties
available_results
available_trackers
bodies
cache_plot_data
chart_views
charts
configurable_charts
configurable_plots
contact_trackers_view
convergence_trackers_view
creation_time
description
distance_unit
element_groups
errors
files
id
live
logs_view
mesh_options
mesh_view
n_elements
n_nodes
n_results
n_sets
name
named_selections
outdated
physics_type
plot_views
plots
ready
result_provider
solver_named_selections
solver_text_outputs
solver_version
time_frequencies
time_frequencies_unit
unit_system
unsupported_element_types
views
warnings
ResultType
displacement
stress
nodal_stress
elastic_strain
nodal_elastic_strain
plastic_strain
nodal_plastic_strain
equivalent_nodal_plastic_strain
temperature
heat_flux
equivalent_plastic_strain
velocity
acceleration
user_defined
global_energy
contact
failure
electric_potential
electric_field
electric_flux_density
newton_raphson_residual
structural_temperature
thermal_strain
strain_energy
kinetic_energy
beam_results
Location
nodal
elemental
ResultFieldName
total_displacement
displacement
stress_tensor
stress_tensor_global
stress_tensor_fiber
equivalent_von_mises_stress
principal_stress
principal_stress_1
principal_stress_2
principal_stress_3
elastic_strain_tensor
elastic_strain_tensor_global
elastic_strain_tensor_fiber
equivalent_elastic_strain
principal_elastic_strain
principal_elastic_strain_1
principal_elastic_strain_2
principal_elastic_strain_3
equivalent_plastic_strain
temperature
heat_flux
total_heat_flux
velocity
total_velocity
acceleration
total_acceleration
global_kinetic_energy
global_internal_energy
global_total_energy
global_hourglass_energy
contact_status
contact_pressure
contact_penetration
contact_sliding_distance
contact_gap_distance
contact_friction_stress
contact_total_stress
contact_fluid_penetration_pressure
contact_surface_heat_flux
failure
total_force
total_moment
electric_potential
electric_field
total_electric_field
electric_flux_density
total_electric_flux_density
structural_temperature
thermal_strain
strain_energy
kinetic_energy
beam_axial_force
beam_bending_moment_y
beam_bending_moment_z
beam_torsional_moment
beam_axial_stress
beam_axial_strain
beam_shear_force_y
beam_shear_force_z
Field
name
Filter
min
max
average
ShellPosition
top
middle
bottom
all
Component
X
Y
Z
P1
P2
P3
XX
YY
ZZ
XY
YZ
XZ
PlotDefinition
from_proto
to_proto
all_sets
as_linear
average_by_entity
include_displacement
last_set
on_skin
shell_position
result_type
location
fields
custom_options
ChartResult
average_by_entity
on_skin
shell_position
result_type
fields
ChartDefinition
from_proto
to_proto
all_sets
plotly_figure
user_defined
name
results
custom_options
View
id
name
parent
solution
type
MeshView
id
name
options
parent
solution
type
PlotView
definition
id
name
parent
solution
type
ChartView
definition
id
name
parent
solution
type
Workspace and viewports
Workspace
assign_view
create_viewport
delete_viewport
exit_fullscreen
export_as_template
import_from_template
set_fullscreen_viewport
set_sync
viewport_at
viewport_grid
fullscreen_viewport_id
id
layout
name
sync_camera
sync_legend
sync_probe_entity
sync_probe_location
sync_time_freq
viewport_ids
viewports
WorkspaceLayout
describe
placement_of
viewport_at
grid_shape
is_grid
placements
ViewportPlacement
covers
viewport
row
column
row_span
column_span
x
y
width
height
Viewport
hide
save_snapshot
set_size
set_view
show
take_snapshot
update_display_options
display_options
hidden
id
metadata
ready
size
solution_id
view
view_id
CameraPosition
back
bottom
front
isometric
left
right_view
rotate_x
rotate_y
rotate_z
top
with_translation
with_zoom
forward
matrix
right
translation
up
zoom
ViewportMetadata
ChartViewportMetadata
chart_names
series_names
MeshViewportMetadata
PlotViewportMetadata
active_result
ContactTrackersViewportMetadata
contact_tracker_names
series_names
ConvergenceTrackersViewportMetadata
LogsViewportMetadata
DisplayOptions
ResultDisplayOptions
MeshDisplayOptions
camera_position
expanded_groups
explode
explode_direction
explode_scale_factor
show_mesh_edges
visible_bodies
visible_named_selection
PlotDisplayOptions
camera_position
expanded_groups
explode
explode_direction
explode_scale_factor
result_options
show_mesh_edges
show_min_max_labels
visible_bodies
ChartDisplayOptions
active_charts
active_series
chart_names
selected_x_axis
series_names
show_legend
show_table
split_direction
ContactTrackersDisplayOptions
active_contact_trackers
active_series
contact_tracker_names
series_names
show_legend
show_table
split_direction
ConvergenceTrackersDisplayOptions
selected_tracker_name
LogsDisplayOptions
log_path
Exceptions
ResultExplorerError
PyAnsys
API reference
Solution and views
PlotDefinition
average_by_entity
average_by_entity
#
PlotDefinition.
average_by_entity
:
bool
|
None
=
False
#
On this page
PlotDefinition.average_by_entity
Show Source
