default_legend_child#

class ansys.cfx.core.generated.post_processing.settings_261.default_legend_child.default_legend_child(name: str | None = None, parent=None)#

‘child_object_type’ of default_legend.

Attributes

Attribute	Summary
colour	‘colour’ child.
font	The font name for an item of text.
legend_aspect	Legend bar width control parameter.
legend_format	Parameter to modify string format of values on legend.
legend_orientation	Specifies whether to display the legend Vertically or Horizontally.
legend_plot	‘legend_plot’ child.
legend_position	XY position of the legend.
legend_resolution	Number of colour subdivisions on the legend bar.
legend_shading	Controls interpolated shading of colour on the legend bar.
legend_size	Scale factor to apply to legend.
legend_ticks	Number of points to provide variable values next to the Legend bar.
legend_title	Specifies the legend title when Legend Title Mode is set to User Specified.
legend_title_mode	Controls the legend title type.
legend_x_justification	‘legend_x_justification’ child.
legend_y_justification	Specifies the vertical justification of a text or overlay item.
related_object	Specifies the Object that this object is related to.
show_legend_units	Toggles display of units in the legend.
text_colour_mode	Determines where to get the text colour from.
text_height	The height an item of text should be, proportional to the screen.
text_rotation	Counter-clockwise rotation, in degrees, to be applied to a text item.
visibility	Toggles the visibility of this graphics object in the viewer. THIS PARAMETER IS DEPRECATED!.

Methods

Method	Summary
hide	Hide the object in a given view(s).
show	Show the object in a given view(s).
suspend	Suspend immediate update for the object.
unsuspend	Restore immediate update for the object.

Included in:

Parent	Summary
default_legend	‘default_legend’ child.