Axes and Axis Settings¶

Field Axes
- Cartesian2DFieldAxes
- Cartesian3DFieldAxes
Field Axis
- Cartesian2DFieldAxis
- Cartesian3DFieldAxis
Line Axes
- PolarLineAxes
- XYLineAxes
Line Axis
Sketch Axes
- SketchAxes
- SketchAxis

Field Axes ¶

Cartesian2DFieldAxes ¶

class tecplot.plot.Cartesian2DFieldAxes(plot)[source]¶

axis_mode¶

Axis relations regarding functional dependency

Type:	`AxisMode`

Possible values: Independent, XYDependent.

Cartesian3DFieldAxes ¶

class tecplot.plot.Cartesian3DFieldAxes(plot)[source]¶

aspect_ratio_limit¶

Scale limit of the axes aspect ratio.

Type:	`float`

This is the limit above which the axes relative scales will be pegged to aspect_ratio_reset. The following example will set the aspect ratio between scales to 1 if they first exceed a ratio of 10:

>>> plot.axes.aspect_ratio_limit = 10
>>> plot.axes.aspect_ratio_reset = 1
>>> plot.axes.reset_scale()

aspect_ratio_reset¶

Axes scale aspect ratio used when aspect_ratio_limit is exceeded.

Type:	`float`

This is the aspect ratio used to scale the axes when the data’s aspect ratio exceeds the value set to aspect_ratio_limit. The following example will set the aspect ratio between scales to 10 if they first exceed a ratio of 15:

>>> plot.axes.aspect_ratio_limit = 15
>>> plot.axes.aspect_ratio_reset = 10
>>> plot.axes.reset_scale()

axis_mode¶

Axis relations regarding functional dependency

Type:	`AxisMode`

Possible values: Independent, XYZDependent, XYDependent.

edge_auto_reset¶

Enable automatically choosing which edges to label.

Type:	`bool`

Example usage:

>>> plot.axes.edge_auto_reset = True

range_aspect_ratio_limit¶

Range limit of the axes aspect ratio.

Type:	`float`

This is the limit above which the axes’ relative ranges will be pegged to range_aspect_ratio_reset. The following example will set the aspect ratio between ranges to 1 if they first exceed a ratio of 10:

>>> plot.axes.range_aspect_ratio_limit = 10
>>> plot.axes.range_aspect_ratio_reset = 1
>>> plot.axes.reset_ranges()

range_aspect_ratio_reset¶

Axes range aspect ratio used range_aspect_ratio_limit is exceeded.

Type:	`float`

This is the aspect ratio used to set the ranges of the axes when the axes’ aspect ratios exceed the value of range_aspect_ratio_limit. The following example will set the aspect ratio between ranges to 10 if they first exceed a ratio of 15:

>>> plot.axes.range_aspect_ratio_limit = 15
>>> plot.axes.range_aspect_ratio_reset = 10
>>> plot.axes.reset_ranges()

reset_scale()¶

Recalculate the scale factors for each axis.

Aspect ratio limits are taken into account.

viewport¶

Viewport position and extent control

Type:	`ReadOnlyViewport`

Example usage:

>>> print(plot.axes.viewport.bottom)
5

xz_ratio¶

Axis scaling ratio X/Y.

Type:	`float` in percent

Example usage:

>>> plot.axes.xz_ratio = 20

Field Axis ¶

Cartesian2DFieldAxis ¶

class tecplot.plot.Cartesian2DFieldAxis(axes, name, **kwargs)[source]¶

variable¶

The Variable assigned to this axis.

Type:	`Variable`

This is the spatial variable associated with this axis and is usually one of (X, Y, Z).

Example::

>>> import tecplot as tp
>>> fr = tp.active_frame()
>>> ds = fr.dataset
>>> axes = fr.plot().axes
>>> axes.x_axis.variable.name, axes.y_axis.variable.name
('X', 'Y')
>>> axes.x_axis.variable = ds.variable('U')
>>> axes.y_axis.variable = ds.variable('V')
>>> axes.x_axis.variable.name, axes.y_axis.variable.name
('U', 'V')

Cartesian3DFieldAxis ¶

class tecplot.plot.Cartesian3DFieldAxis(axes, name, **kwargs)[source]¶

variable¶

The Variable assigned to this axis.

Type:	`Variable`

This is the spatial variable associated with this axis and is usually one of (X, Y, Z).

Example::

>>> import tecplot as tp
>>> fr = tp.active_frame()
>>> ds = fr.dataset
>>> axes = fr.plot().axes
>>> axes.x_axis.variable.name, axes.y_axis.variable.name
('X', 'Y')
>>> axes.x_axis.variable = ds.variable('U')
>>> axes.y_axis.variable = ds.variable('V')
>>> axes.x_axis.variable.name, axes.y_axis.variable.name
('U', 'V')