AreaTargetGraphics#

class ansys.stk.core.stkobjects.AreaTargetGraphics#: Class to define the 2D attributes of an AreaTarget.

Overview#

Properties

`inherit`	Specify whether inheritable 2D Graphics attributes of the area target are inherited from Scenario-level settings.
`color`	The color in which the area target’s boundary, centroid and label are displayed in the 2D Graphics window.
`marker_style`	The style of the marker for the area target’s centroid.
`show_centroid`	Specify whether to display the centroid of the area target.
`show_label`	Specify whether to display the label of the area target.
`use_instance_name_label`	Specify whether to use the name of the area target (as shown in the Object Browser) as its label.
`show_boundary_points`	Specify whether the individual perimeter points used to define the boundary of an area target are marked along the area target’s boundary.
`boundary_style`	The style in which the area target’s boundary displays.
`boundary_width`	The width of the line with which the area target’s boundary displays.
`boundary_fill`	Specify whether to display the region covered by the area target as a filled area.
`show_boundary`	Specify whether to display the area target’s boundary.
`show_bounding_rectangle`	Specify whether to construct a rectangle using the outermost boundaries defined for the area target and display it around the actual region covered by the area target.
`label_name`	The user-specified name to use as a label for the area target.
`label_notes`	Notes attached to the object and displayed in the 2D and 3D Graphics windows.
`boundary_color`	Color in which the area target boundary is displayed.
`label_color`	Color in which the area target label is displayed.
`centroid_color`	Color in which the area target centroid is displayed.
`boundary_fill_percent_translucency`	Specify the percent translucency of the region covered by the area target. Translucency ranges from 0 to 100 percent, where 100 percent is invisible. Dimensionless.
`show_graphics`	Specify whether graphics attributes of the area target are visible.

Import detail#

from ansys.stk.core.stkobjects import AreaTargetGraphics

Property detail#

property AreaTargetGraphics.inherit: bool#: Specify whether inheritable 2D Graphics attributes of the area target are inherited from Scenario-level settings.

property AreaTargetGraphics.color: Color#: The color in which the area target’s boundary, centroid and label are displayed in the 2D Graphics window.

property AreaTargetGraphics.marker_style: str#: The style of the marker for the area target’s centroid.

property AreaTargetGraphics.show_centroid: bool#: Specify whether to display the centroid of the area target.

property AreaTargetGraphics.show_label: bool#: Specify whether to display the label of the area target.

property AreaTargetGraphics.use_instance_name_label: bool#: Specify whether to use the name of the area target (as shown in the Object Browser) as its label.

property AreaTargetGraphics.show_boundary_points: bool#: Specify whether the individual perimeter points used to define the boundary of an area target are marked along the area target’s boundary.

property AreaTargetGraphics.boundary_style: LineStyle#: The style in which the area target’s boundary displays.

property AreaTargetGraphics.boundary_width: int#: The width of the line with which the area target’s boundary displays.

property AreaTargetGraphics.boundary_fill: bool#: Specify whether to display the region covered by the area target as a filled area.

property AreaTargetGraphics.show_boundary: bool#: Specify whether to display the area target’s boundary.

property AreaTargetGraphics.show_bounding_rectangle: bool#: Specify whether to construct a rectangle using the outermost boundaries defined for the area target and display it around the actual region covered by the area target.

property AreaTargetGraphics.label_name: str#: The user-specified name to use as a label for the area target.

property AreaTargetGraphics.label_notes: LabelNoteCollection#: Notes attached to the object and displayed in the 2D and 3D Graphics windows.

property AreaTargetGraphics.boundary_color: Color#: Color in which the area target boundary is displayed.

property AreaTargetGraphics.label_color: Color#: Color in which the area target label is displayed.

property AreaTargetGraphics.centroid_color: Color#: Color in which the area target centroid is displayed.

property AreaTargetGraphics.boundary_fill_percent_translucency: float#: Specify the percent translucency of the region covered by the area target. Translucency ranges from 0 to 100 percent, where 100 percent is invisible. Dimensionless.

property AreaTargetGraphics.show_graphics: bool#: Specify whether graphics attributes of the area target are visible.