IAntennaContour#

class ansys.stk.core.stkobjects.IAntennaContour#

IAntennaContour Interface for a antenna’s contour properties.

Overview#

show_at_altitude

Enable the ability to view the contours at a set altitude.

altitude

Get or set the altitude to view the contours.

relative_to_maximum_gain

The contours value represents the gain value relative to the maximum.

show_labels

Get or set the option for showing contour labels.

number_of_label_decimal_digits

Get or set the integer number of decimal places to display in the contour label.

line_width

Select the line width in which antenna 2D graphics display from the LineWidth enumeration.

color_method

Color method for contours (color ramp or explicit).

start_color

The color ramp start color.

stop_color

The color ramp stop color.

type

Get the contour type.

levels

Get the collection of contour levels.

Import detail#

from ansys.stk.core.stkobjects import IAntennaContour

Property detail#

property IAntennaContour.show_at_altitude: bool#

Enable the ability to view the contours at a set altitude.

property IAntennaContour.altitude: float#

Get or set the altitude to view the contours.

property IAntennaContour.relative_to_maximum_gain: bool#

The contours value represents the gain value relative to the maximum.

property IAntennaContour.show_labels: bool#

Get or set the option for showing contour labels.

property IAntennaContour.number_of_label_decimal_digits: int#

Get or set the integer number of decimal places to display in the contour label.

property IAntennaContour.line_width: LineWidth#

Select the line width in which antenna 2D graphics display from the LineWidth enumeration.

property IAntennaContour.color_method: FigureOfMeritGraphics2DColorMethod#

Color method for contours (color ramp or explicit).

property IAntennaContour.start_color: Color#

The color ramp start color.

property IAntennaContour.stop_color: Color#

The color ramp stop color.

property IAntennaContour.type: AntennaContourType#

Get the contour type.

property IAntennaContour.levels: AntennaContourLevelCollection#

Get the collection of contour levels.