VolumetricGraphics3DLegend#

class ansys.stk.core.stkobjects.VolumetricGraphics3DLegend#: Class defining Boundary/Fill legend for volumetric object.

Overview#

Properties

`position_x`	Set the x value for the pixel location for the upper left corner of the legend.
`position_y`	Set the y value for the pixel location for the upper left corner of the legend.
`translucency`	Set the percent Translucency for the legend.
`background_color`	Set the color of the legend background.
`title`	Set the text to appear at the top of the legend.
`decimal_digits`	Set the precision, or number of digits that should display to the right of the decimal point, with which real numbers should display.
`notation`	Set the legend numeric notation. A member of the VolumetricLegendNumericNotationType enumeration.
`text_color`	Set the color of the legend text.
`level_order`	Set the legend numeric notation. A member of the VolumetricLevelOrder enumeration.
`maximum_color_squares`	Set the number of colors per row or column depending on the selected LevelOrder. Number between 1 and 1000.
`color_square_width`	Set the width of the individual color band. Number between 1 and 100.
`color_square_height`	Set the height of the individual color band. Number between 1 and 100.

from ansys.stk.core.stkobjects import VolumetricGraphics3DLegend

property VolumetricGraphics3DLegend.position_x: int#: Set the x value for the pixel location for the upper left corner of the legend.

property VolumetricGraphics3DLegend.position_y: int#: Set the y value for the pixel location for the upper left corner of the legend.

property VolumetricGraphics3DLegend.translucency: float#: Set the percent Translucency for the legend.

property VolumetricGraphics3DLegend.background_color: Color#: Set the color of the legend background.

property VolumetricGraphics3DLegend.title: str#: Set the text to appear at the top of the legend.

property VolumetricGraphics3DLegend.decimal_digits: int#: Set the precision, or number of digits that should display to the right of the decimal point, with which real numbers should display.

property VolumetricGraphics3DLegend.notation: VolumetricLegendNumericNotationType#: Set the legend numeric notation. A member of the VolumetricLegendNumericNotationType enumeration.

property VolumetricGraphics3DLegend.text_color: Color#: Set the color of the legend text.

property VolumetricGraphics3DLegend.level_order: VolumetricLevelOrder#: Set the legend numeric notation. A member of the VolumetricLevelOrder enumeration.

property VolumetricGraphics3DLegend.maximum_color_squares: int#: Set the number of colors per row or column depending on the selected LevelOrder. Number between 1 and 1000.

property VolumetricGraphics3DLegend.color_square_width: int#: Set the width of the individual color band. Number between 1 and 100.

property VolumetricGraphics3DLegend.color_square_height: int#: Set the height of the individual color band. Number between 1 and 100.