legend#
- class ansys.api.pyensight.ensight_api.legend(session: Session)#
Class wrapper for EnSight legend module
This class acts as a proxy for the EnSight Python module ensight.legend
Methods
Legend: description
This command has not yet been documented.
legend.format
(p0)Set the number format for legend labels.
This command has not yet been documented.
legend.height
(p0)Set the height of the legend bar
Legend: label_count
Set the horizontal/vertical location of the legend on the screen.
Set the horizontal/vertical location of the legend on the screen.
This command has not yet been documented.
This command has not yet been documented.
Set the legend bar to be either vertical or horizontal.
legend.query_count
(args)Legend: query_count
Legend: query_display_attributes
Legend: query_selected_objects
This command has not yet been documented.
This command has not yet been documented.
legend.rgb
(p0, p1, p2)Legend: rgb
Selects all legends that are currently visible, for which other attributes will be set or modified.
This command has not yet been documented.
This command has not yet been documented.
legend.select_begin
(*args, **kwargs)Legend: select_begin
Sets the current legend selection to the default, so default attributes can be modified.
Selection of legends, for which attributes will be set or modified.
Selection of legends, for which attributes will be set or modified.
Legend: shadow_intensity
Legend: shadow_offset
Legend: show_background
This command has not yet been documented.
Legend: specify_label_count
Set the visibility and location of legend labels in relation to the legend color bar.
legend.text_rgb
(p0, p1, p2)Sets the color of the legend text for title and labels.
legend.text_size
(p0)Sets the size of font to use for legend title and labels.
legend.text_type
(p0)This command has not yet been documented.
legend.title
(p0)Legend: title
Set the visibility and location of a legend title in relation to the legend color bar.
This command has not yet been documented.
legend.type
(p0)Set the type of bar to use for color representation of legend values.
legend.visible
(p0)To turn the visibility of a legend on or off.
legend.width
(p0)Set the width of the legend bar.