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(p0)

Legend: description

legend.deselect_all()

This command has not yet been documented.

legend.format(p0)

Set the number format for legend labels.

legend.get_mainvarlist_select()

This command has not yet been documented.

legend.height(p0)

Set the height of the legend bar

legend.label_count(p0)

Legend: label_count

legend.location_x(p0)

Set the horizontal/vertical location of the legend on the screen.

legend.location_y(p0)

Set the horizontal/vertical location of the legend on the screen.

legend.modify_begin()

This command has not yet been documented.

legend.modify_end()

This command has not yet been documented.

legend.orientation(p0)

Set the legend bar to be either vertical or horizontal.

legend.query_count(args)

Legend: query_count

legend.query_display_attributes(args)

Legend: query_display_attributes

legend.query_selected_objects(args)

Legend: query_selected_objects

legend.relative_to(p0)

This command has not yet been documented.

legend.relative_viewport(p0)

This command has not yet been documented.

legend.rgb(p0, p1, p2)

Legend: rgb

legend.select_all()

Selects all legends that are currently visible, for which other attributes will be set or modified.

legend.select_all_invisible()

This command has not yet been documented.

legend.select_all_visible()

This command has not yet been documented.

legend.select_begin(*args, **kwargs)

Legend: select_begin

legend.select_default()

Sets the current legend selection to the default, so default attributes can be modified.

legend.select_palette_begin(args)

Selection of legends, for which attributes will be set or modified.

legend.select_palette_end()

Selection of legends, for which attributes will be set or modified.

legend.shadow_intensity(p0)

Legend: shadow_intensity

legend.shadow_offset(p0)

Legend: shadow_offset

legend.show_background(p0)

Legend: show_background

legend.show_minmax_marker(p0)

This command has not yet been documented.

legend.specify_label_count(p0)

Legend: specify_label_count

legend.text_position(p0)

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

legend.title_location(p0)

Set the visibility and location of a legend title in relation to the legend color bar.

legend.title_name(p0)

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.