plot

class ansys.api.pyensight.ensight_api.plot(session: Session)

Class wrapper for EnSight plot module

This class acts as a proxy for the EnSight Python module ensight.plot

Methods

plot.animate_curves(p0)	Turns animation of curves with time on or off for the currently selected plot(s).
plot.auto_scale(p0)	Plot: auto_scale
plot.axis_2_autoscale(p0)	Plot: axis_2_autoscale
plot.axis_2_labelformat(p0)	Plot: axis_2_labelformat
plot.axis_2_labelrgb(p0, p1, p2)	Plot: axis_2_labelrgb
plot.axis_2_labelsize(p0)	Plot: axis_2_labelsize
plot.axis_2_labeltype(p0)	Plot: axis_2_labeltype
plot.axis_2_max(p0)	Plot: axis_2_max
plot.axis_2_min(p0)	Plot: axis_2_min
plot.axis_2_title(p0)	Plot: axis_2_title
plot.axis_2_titlergb(p0, p1, p2)	Plot: axis_2_titlergb
plot.axis_2_titlesize(p0)	Plot: axis_2_titlesize
plot.axis_2_variable(p0)	Plot: axis_2_variable
plot.axis_2_visible(p0)	Plot: axis_2_visible
plot.axis_auto_layout(p0)	Plot: axis_auto_layout
plot.axis_auto_update(p0)	Plot: axis_auto_update
plot.axis_linewidth(p0)	Sets the axis line width of the currently selected plot(s).
plot.axis_rgb(p0, p1, p2)	Specifies the RGB color value of the axis for the currently selected plot(s).
plot.axis_swap(p0)	Plot: axis_swap
plot.axis_swap_minmax(p0)	Swaps the axis min and max values for the specified axis of the currently selected plot.
plot.axis_title(p0)	Plot: axis_title
plot.axis_titles(p0)	Plot: axis_titles
plot.axis_x_autoscale(p0)	This command has not yet been documented.
plot.axis_x_gridtype(p0)	Specifies the type of grid that will be drawn for the x/y axis of the currently selected plot.
plot.axis_x_labelformat(p0)	Sets the format to be used for x/y axis value labels in the currently selected plot.
plot.axis_x_labelrgb(p0, p1, p2)	Specifies the RGB color value of the x/y axis label for the currently selected plot(s).
plot.axis_x_labelsize(p0)	Sets the size of the x/y axis label text in the currently selected plot.
plot.axis_x_labeltype(p0)	Specifies how the x/y axis is labeled in the currently selected plot.
plot.axis_x_max(p0)	Sets the maximum value for the x/y axis labels in the currently selected plot.
plot.axis_x_min(p0)	Sets the minimum value for the x/y axis labels in the currently selected plot.
plot.axis_x_numgrid(p0)	Sets the number of grid lines to be used along the x/y axis of the currently selected plot(s).
plot.axis_x_numsubgrid(p0)	Sets the number of subgrid lines to be used along the x/y axis of the currently selected plot(s).
plot.axis_x_origin(p0)	Sets the value of the x/y axis origin for the currently selected plot(s).
plot.axis_x_scale(p0)	Selects the type of scale used for the x/y axis of the currently selected plot(s).
plot.axis_x_sgridtype(p0)	Specifies the type of subgrid that will be drawn for the x/y axis of the currently selected plot.
plot.axis_x_size(p0)	This command has not yet been documented.
plot.axis_x_title(p0)	Sets the title string for the x/y axis of the currently selected plot.
plot.axis_x_titlergb(p0, p1, p2)	Specifies the RGB color value of the x/y axis title for the currently selected plot(s).
plot.axis_x_titlesize(p0)	Sets the size of the x/y axis title in the currently selected plot.
plot.axis_x_visible(p0)	Controls the visibility of the x/y axis of the currently selected plot(s).
plot.axis_y_autoscale(p0)	This command has not yet been documented.
plot.axis_y_gridtype(p0)	Specifies the type of grid that will be drawn for the x/y axis of the currently selected plot.
plot.axis_y_labelformat(p0)	Sets the format to be used for x/y axis value labels in the currently selected plot.
plot.axis_y_labelrgb(p0, p1, p2)	Specifies the RGB color value of the x/y axis label for the currently selected plot(s).
plot.axis_y_labelsize(p0)	Sets the size of the x/y axis label text in the currently selected plot.
plot.axis_y_labeltype(p0)	Specifies how the x/y axis is labeled in the currently selected plot.
plot.axis_y_max(p0)	Sets the maximum value for the x/y axis labels in the currently selected plot.
plot.axis_y_min(p0)	Sets the minimum value for the x/y axis labels in the currently selected plot.
plot.axis_y_numgrid(p0)	Sets the number of grid lines to be used along the x/y axis of the currently selected plot(s).
plot.axis_y_numsubgrid(p0)	Sets the number of subgrid lines to be used along the x/y axis of the currently selected plot(s).
plot.axis_y_origin(p0)	Sets the value of the x/y axis origin for the currently selected plot(s).
plot.axis_y_scale(p0)	Selects the type of scale used for the x/y axis of the currently selected plot(s).
plot.axis_y_sgridtype(p0)	Specifies the type of subgrid that will be drawn for the x/y axis of the currently selected plot.
plot.axis_y_size(p0)	This command has not yet been documented.
plot.axis_y_title(p0)	Sets the title string for the x/y axis of the currently selected plot.
plot.axis_y_titlergb(p0, p1, p2)	Specifies the RGB color value of the x/y axis title for the currently selected plot(s).
plot.axis_y_titlesize(p0)	Sets the size of the x/y axis title in the currently selected plot.
plot.axis_y_variable(p0)	Plot: axis_y_variable
plot.axis_y_visible(p0)	Controls the visibility of the x/y axis of the currently selected plot(s).
plot.background_rgb(p0, p1, p2)	Specifies the background RGB color value for the currently selected plot(s).
plot.background_transparency(p0)	Plot: background_transparency
plot.background_type(p0)	Specifies the background type of the currently selected plot.
plot.border_rgb(p0, p1, p2)	Specifies the border RGB color value for the currently selected plot(s).
plot.border_visible(p0)	Controls the visibility of the border of the currently selected plot(s).
plot.curve_title(p0)	Plot: curve_title
plot.delete()	Plot: delete
plot.delete_plot()	Deletes the currently selected plot(s).
plot.detached_background_rgb(p0, p1, p2)	This command has not yet been documented.
plot.detached_window(p0)	This command has not yet been documented.
plot.entity_select_begin()	Plot: entity_select_begin
plot.entity_select_end()	Plot: entity_select_end
plot.graph_title(p0)	Plot: graph_title
plot.graph_titles(p0)	Plot: graph_titles
plot.grid_linetype(p0)	Specifies the type of grid lines that will be drawn for the currently selected plot.
plot.grid_linewidth(p0)	Sets the grid line width of the currently selected plot(s).
plot.grid_rgb(p0, p1, p2)	Specifies the RGB color value of the grid for the currently selected plot(s).
plot.group(p0)	Plot: group
plot.height(p0)	Sets the height of the currently selected plot.
plot.legend_color_by(p0)	This command has not yet been documented.
plot.legend_minmax_origin_x(p0)	This command has not yet been documented.
plot.legend_minmax_origin_y(p0)	This command has not yet been documented.
plot.legend_minmax_textsize(p0)	This command has not yet been documented.
plot.legend_minmax_visible(p0)	This command has not yet been documented.
plot.legend_origin_x(p0)	This command has not yet been documented.
plot.legend_origin_y(p0)	This command has not yet been documented.
plot.legend_rgb(p0, p1, p2)	Specifies the RGB color value of the legend for the currently selected plot(s).
plot.legend_textsize(p0)	Sets the size of legend text in the currently selected plot.
plot.legend_visible(p0)	Controls the visibility of the legend for the currently selected plot(s).
plot.new_plot()	Plot: new_plot
plot.new_plot_ifnotexist(p0)	This command has not yet been documented.
plot.origin_x(p0)	Specifies the x/y coordinate of the origin of the selected plot in the graphics window.
plot.origin_y(p0)	Specifies the x/y coordinate of the origin of the selected plot in the graphics window.
plot.plot_activate()	Plot: plot_activate
plot.plot_desc(p0)	Plot: plot_desc
plot.plot_title(p0)	Sets the title string for the currently selected plot.
plot.query_count(args)	Plot: query_count
plot.query_display_attributes(args)	Plot: query_display_attributes
plot.query_object_atwindowxy(args)	Plot: query_object_atwindowxy
plot.query_objects_atwindowxy(args)	Plot: query_objects_atwindowxy
plot.rescale(p0)	Plot: rescale
plot.restore(p0)	Plot: restore
plot.save(p0)	Plot: save
plot.select_all()	Selects all of the plots in the graphics window as the target for future plot: commands.
plot.select_axis(p0)	Plot: select_axis
plot.select_begin(*args, **kwargs)	Selects one or more plots in the graphics window as the target for future plot: commands
plot.select_default()	Plot: select_default
plot.subgrid_linetype(p0)	Specifies the type of subgrid lines that will be drawn for the currently selected plot.
plot.subgrid_linewidth(p0)	Sets the subgrid line width of the currently selected plot(s).
plot.subgrid_rgb(p0, p1, p2)	Specifies the RGB color value of the subgrid for the currently selected plot(s).
plot.time_marker(p0)	Controls the visibility of the time marker in the selected plot(s).
plot.time_marker_rgb(p0, p1, p2)	Controls the color of the time marker in the selected plot(s).
plot.time_marker_style(p0)	Controls the line style of the time marker in the selected plot(s).
plot.time_marker_value(p0)	This command has not yet been documented.
plot.time_marker_width(p0)	Controls the width of the time marker in the selected plot(s).
plot.title_rgb(p0, p1, p2)	Specifies the RGB color value of the title for the currently selected plot(s).
plot.title_textsize(p0)	Sets the size of title text in the currently selected plot.
plot.unplot_deactivate()	Plot: unplot_deactivate
plot.visible(p0)	Controls the visibility of the selected plot(s) in the graphics window.
plot.width(p0)	Sets the width of the currently selected plot.