### Navigation

- ☰
- PyTecplot-0.7 »
- Module code »

# Source code for tecplot.plot.axis

    from builtins import super, bytes

    import ctypes

    from six import string_types

    from ..tecutil import _tecutil
    from ..constant import *
    from ..exception import *
    from .. import macro, session
    from ..tecutil import Index, lock, lock_attributes, sv
    from .grid import (GridLines, GridLines2D, MarkerGridLine, MarkerGridLine2D,
                       MinorGridLines, MinorGridLines2D, PolarAngleGridLines,
                       PolarAngleMarkerGridLine, PolarAngleMinorGridLines)
    from .ticks import (RadialTicks, RadialTickLabels, TickLabels2D, TickLabels3D,
                        Ticks2D, Ticks3D)
    from .title import (Axis2DTitle, DataAxis2DTitle, DataAxis3DTitle,
                        RadialAxisTitle)

    class Axis(session.Style):
        def __init__(self, axes, name, **kwargs):
            self.axes = axes
            self.name, self._sv_name, self._sv_detail = Axis._sv_axis_detail(name)
            kw = axes._style_attrs.copy()
            kw.update(**kwargs)
            super().__init__(axes._sv, self._sv_detail, **kw)

        @staticmethod
        def _sv_axis_detail(name):
            if isinstance(name, string_types):
                name = name.upper()
                svname = getattr(sv, name)
                svdetail = getattr(sv, name+'DETAIL')
            else:
                _tr = {sv.X: 'X', sv.Y: 'Y', sv.Z: 'Z', sv.R: 'R',
                       sv.THETA: 'THETA'}
                _tr_detail = {sv.X: sv.XDETAIL, sv.Y: sv.YDETAIL, sv.Z: sv.ZDETAIL,
                              sv.R: sv.RDETAIL, sv.THETA: sv.THETADETAIL}
                svdetail = _tr_detail[name]
                svname = name
                name = _tr[svname]
            return name, svname, svdetail

        def __eq__(self, that):
            return (isinstance(that, type(self)) and self.name == that.name and
                    self.axes == that.axes)

        def __ne__(self, that):
            return not (self == that)

        @property
        def show(self):
            """Enable drawing of this axis.

            :type: `boolean <bool>`

            Example usage::

                >>> # get axis via "plot.axes.x_axis(0)" for line plots
                >>> # or "plot.axes.x_axis" for field or sketch plots
                >>> axis.show = True
            """
            return self._get_style(bool, sv.SHOWAXIS)

        @show.setter
        def show(self, show):
            self._set_style(bool(show), sv.SHOWAXIS)

        @property
        def min(self):
            """Lower bound of this axis' range.

            :type: `float`

            Example usage::

                >>> # get axis via "plot.axes.x_axis(0)" for line plots
                >>> # or "plot.axes.x_axis" for field or sketch plots
                >>> axis.min = 0.0
            """
            return self._get_style(float, sv.RANGEMIN)

        @min.setter
        def min(self, value):
            self._set_style(float(value), sv.RANGEMIN)

        @property
        def max(self):
            """Upper bound of this axis' range.

            :type: `float`

            Example usage::

                >>> # get axis via "plot.axes.x_axis(0)" for line plots
                >>> # or "plot.axes.x_axis" for field or sketch plots
                >>> axis.max = 1.0
            """
            return self._get_style(float, sv.RANGEMAX)

        @max.setter
        def max(self, value):
            self._set_style(float(value), sv.RANGEMAX)

        @property
        def ticks(self):
            """Axis major and minor ticks style control.

            :type: `Ticks2D`

            Example usage::

                >>> # get axis via "plot.axes.x_axis(0)" for line plots
                >>> # or "plot.axes.x_axis" for field or sketch plots
                >>> axis.ticks.line_thickness = 0.8
            """
            return Ticks2D(self)

        @property
        def tick_labels(self):
            """Axis ticks labels style control.

            :type: `TickLabels2D`

            Example usage::

                >>> # get axis via "plot.axes.x_axis(0)" for line plots
                >>> # or "plot.axes.x_axis" for field or sketch plots
                >>> axis.tick_labels.show = False
            """
            return TickLabels2D(self)

        @property
        def grid_lines(self):
            """Major grid lines style control.

            :type: `GridLines2D`

            Major grid lines are attached to the locations of the major ticks. See
            `minor_grid_lines <XYLineAxis.minor_grid_lines>` for lines attached to
            minor ticks. Example usage::

                >>> # get axis via "plot.axes.x_axis(0)" for line plots
                >>> # or "plot.axes.x_axis" for field or sketch plots
                >>> axis.grid_lines.show = True
            """
            return GridLines2D(self)

        @property
        def minor_grid_lines(self):
            """Minor grid lines style control.

            :type: `MinorGridLines2D`

            Minor grid lines are attached to the locations of the minor ticks.
            Example usage::

                >>> # get axis via "plot.axes.x_axis(0)" for line plots
                >>> # or "plot.axes.x_axis" for field or sketch plots
                >>> axis.minor_grid_lines.show = True
            """
            return MinorGridLines2D(self)

        @property
        def title(self):
            """Axis title.

            :type: `string <str>`

            This is the primary label for the axis and usually includes units::

                >>> # get axis via "plot.axes.x_axis(0)" for line plots
                >>> # or "plot.axes.x_axis" for field or sketch plots
                >>> axis.title.text = 'distance (m)'
            """
            return Axis2DTitle(self)

        @property
        def line(self):
            """Axis line style control.

            :type: `Cartesian2DAxisLine`

            Example usage::

                >>> # get axis via "plot.axes.x_axis(0)" for line plots
                >>> # or "plot.axes.x_axis" for field or sketch plots
                >>> axis.line.line_thickness = 0.6
            """
            return Cartesian2DAxisLine(self)

        @lock()
        def fit_range(self):
            """Set range of axis to variable minimum and maximum.

            Example usage::

                >>> # get axis via "plot.axes.x_axis(0)" for line plots
                >>> # or "plot.axes.x_axis" for field or sketch plots
                >>> axis.fit_range()
            """
            with self.axes.plot.frame.activated():
                axis_name = ctypes.c_char(bytes(self.name[0], 'utf-8'))
                axis_num = getattr(self, 'index', 0) + 1
                if not _tecutil.ViewAxisFit(axis_name, axis_num):
                    raise TecplotSystemError()

        @lock()
        def fit_range_to_nice(self):
            """Set range of axis to nice values near variable minimum and maximum.

            This method resets the range to equal the minimum and maximum of the
            data being plotted, but makes the axis values "nice" by setting labels
            to have the smallest number of significant digits possible. If the axis
            dependency is not independent then this action may also affect the
            range on another axis::

                >>> # get axis via "plot.axes.x_axis(0)" for line plots
                >>> # or "plot.axes.x_axis" for field or sketch plots
                >>> axis.fit_range_to_nice()
            """
            with self.axes.plot.frame.activated():
                axis_num = getattr(self, 'index', 0) + 1
                if not _tecutil.ViewAxisNiceFit(ctypes.c_char(bytes(self.name[0], 'utf-8')), axis_num):
                    raise TecplotSystemError()

        @lock()
        def adjust_range_to_nice(self):
            """Adjust current range to nice values.

            This adjusts the axis label values such that all currently displayed
            values are set to have the smallest number of significant digits
            possible::

                >>> # get axis via "plot.axes.x_axis(0)" for line plots
                >>> # or "plot.axes.x_axis" for field or sketch plots
                >>> axis.adjust_range_to_nice()
            """
            with self.axes.plot.frame.activated():
                axis_num = getattr(self, 'index', 0) + 1
                if not _tecutil.ViewAxisMakeCurValsNice(ctypes.c_char(bytes(self.name[0], 'utf-8')), axis_num):
                    raise TecplotSystemError()

        @property
        def marker_grid_line(self):
            """Marker line to indicate a particular position along an axis.

            :type: `MarkerGridLine2D`

            Example usage::

                >>> # get axis via "plot.axes.x_axis(0)" for line plots
                >>> # or "plot.axes.x_axis" for field or sketch plots
                >>> axis.marker_grid_line.show = True
                >>> axis.marker_grid_line.position = 0.5
            """
            return MarkerGridLine2D(self)

    class ReversibleAxis(Axis):
        @property
        def reverse(self):
            """Reverse the direction of the axis scale.

            :type: `boolean <bool>`

            Example usage::

                >>> # get axis via "plot.axes.x_axis(0)" for line plots
                >>> # or "plot.axes.x_axis" for field or sketch plots
                >>> axis.reverse = True
            """
            return self._get_style(bool, sv.ISREVERSED)

        @reverse.setter
        def reverse(self, value):
            self._set_style(bool(value), sv.ISREVERSED)

    class Cartesian2DAxis(Axis):
        @property
        def log_scale(self):
            """Use logarithmic scale for this axis.

            :type: `boolean <bool>`

            Example usage::

                >>> # get axis via "plot.axes.x_axis(0)" for line plots
                >>> # or "plot.axes.x_axis" for field or sketch plots
                >>> # or "plot.axes.r_axis" for the radial axis in polar plots
                >>> axis.log_scale = True
            """
            return self._get_style(CoordScale, sv.COORDSCALE) is CoordScale.Log

        @log_scale.setter
        def log_scale(self, value):
            cscale = CoordScale.Log if value else CoordScale.Linear
            self._set_style(cscale, sv.COORDSCALE)

    class DataAxis(Axis):
        @property
        def title(self):
            """Axis title.

            :type: `string <str>`

            This is the primary label for the axis and usually includes units::

                >>> # get axis via "plot.axes.x_axis(0)" for line plots
                >>> # or "plot.axes.x_axis" for field or sketch plots
                >>> axis.title.text = 'distance (m)'
            """
            return DataAxis2DTitle(self)

    class FieldAxis(DataAxis):
        @property
        def variable(self):
            """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 usage::

                >>> 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')
            """
            ds = self.axes.plot.frame.dataset
            return ds.variable(self.variable_index)

        @variable.setter
        def variable(self, v):
            self.variable_index = v.index

        @property
        def variable_index(self):
            """Index of the `Variable` assigned to this axis.

            :type: `Index` (zero-based)

            Example usage, interchanging the (x, y) axes::

                >>> v0 = plot.axes.x_axis.variable_index
                >>> v1 = plot.axes.y_axis.variable_index
                >>> plot.axes.x_axis.variable_index = v1
                >>> plot.axes.y_axis.variable_index = v0
            """
            return self._get_style(Index, sv.VARNUM)

        @variable_index.setter
        def variable_index(self, i):
            self._set_style(Index(i), sv.VARNUM)

        @lock()
        def fit_range(self, consider_blanking=False):
            """Set range of axis to variable minimum and maximum.

            Example usage::

                >>> plot.axes.x_axis.fit_range(consider_blanking=True)
            """
            with self.axes.plot.frame.activated():
                if consider_blanking:
                    cmd = r'''\
                        $!VIEW AXISFIT
                          CONSIDERBLANKING = YES
                          AXIS = '{}'
                          AXISNUM = 1'''.format(self.name[0])
                    macro.execute_command(cmd)
                else:
                    axis_name = ctypes.c_char(bytes(self.name[0], 'utf-8'))
                    if not _tecutil.ViewAxisFit(axis_name, 1):
                        raise TecplotSystemError()

    class IndexedLineAxis(DataAxis, Cartesian2DAxis, ReversibleAxis):
        def __init__(self, axes, name, index):
            self.index = Index(index)
            super().__init__(axes, name, offset1=self.index)

        def __eq__(self, that):
            return (isinstance(that, type(self)) and self.index == that.index and
                    self.name == that.name and self.axes == that.axes)

        def __ne__(self, that):
            return not (self == that)

    class PolarLineAxis(DataAxis, ReversibleAxis):
        @property
        def line(self):
            """Axis line style control.

            :type: `AxisLine2D`

            Example usage::

                >>> plot.axes.r_axis.line.line_thickness = 0.6
                >>> plot.axes.theta_axis.line.line_thickness = 0.6
            """
            return AxisLine2D(self)

        @property
        def origin(self):
            """Value at the origin of the axis.

            :type: `float`

            Example usage::

                # value at center of plot equal to 10
                >>> plot.axes.r_axis.origin = 10
                # rotate theta axis 45 degrees clockwise
                >>> plot.axes.theta_axis.origin = 45
            """
            return self._get_style(float, sv.VALUEATORIGIN)

        @origin.setter
        def origin(self, value):
            self._set_style(float(value), sv.VALUEATORIGIN)

        @property
        def clip_data(self):
            """Do not show data outside the axes area.

            :type: `boolean <bool>`

            Example usage::

                >>> plot.axes.clip_data = True
            """
            return self._get_style(bool, sv.CLIPDATA)

        @clip_data.setter
        def clip_data(self, value):
            self._set_style(bool(value), sv.CLIPDATA)

    class Cartesian2DFieldAxis(FieldAxis, Cartesian2DAxis, ReversibleAxis):
        """X or Y axis for 2D field plots.

        .. code-block:: python
            :emphasize-lines: 18-24,26-33

            from os import path
            import tecplot as tp
            from tecplot.constant import PlotType, AxisMode, AxisTitleMode

            examples_dir = tp.session.tecplot_examples_directory()
            infile = path.join(examples_dir, '2D', 'exchng.plt')
            dataset = tp.data.load_tecplot(infile)

            frame = tp.active_frame()
            plot = frame.plot(PlotType.Cartesian2D)

            plot.show_contour = True

            plot.axes.axis_mode = AxisMode.Independent
            plot.axes.viewport.right = 75
            plot.axes.preserve_scale = False

            xaxis = plot.axes.x_axis
            xaxis.title.text = 'Longitudinal (m)'
            xaxis.title.title_mode = AxisTitleMode.UseText
            xaxis.min = 3.8
            xaxis.max = 5.3
            xaxis.grid_lines.show = True
            xaxis.grid_lines.draw_last = True

            yaxis = plot.axes.y_axis
            yaxis.title.text = 'Transverse (m)'
            yaxis.title.title_mode = AxisTitleMode.UseText
            yaxis.min = 2.8
            yaxis.max = 4.3
            yaxis.grid_lines.show = True
            yaxis.minor_grid_lines.show = True
            yaxis.minor_grid_lines.draw_last = True

            tp.export.save_png('axis_2d.png',600)

        ..  figure:: /_static/images/axis_2d.png
            :width: 300px
            :figwidth: 300px
        """

    class Cartesian3DFieldAxis(FieldAxis):
        """X, Y or Z axis on 3D field plots.

        .. code-block:: python
            :emphasize-lines: 26,31-36

            from os import path
            import tecplot as tp
            from tecplot.constant import PlotType, Color, AxisLine3DAssignment

            examples_dir = tp.session.tecplot_examples_directory()
            infile = path.join(examples_dir, '3D_Volume', 'waveintensity.plt')
            dataset = tp.data.load_tecplot(infile)

            frame = tp.active_frame()
            plot = frame.plot(PlotType.Cartesian3D)
            plot.activate()

            plot.show_contour = True

            contour = plot.contour(0)
            contour.variable = dataset.variable('INTENS')
            contour.colormap_name = 'Sequential - Yellow/Green/Blue'
            contour.legend.show = False
            plot.axes.grid_area.filled = False

            txt = next(frame.texts())
            txt.color = Color.Red
            txt.size = 18
            txt.anchor_position = 1.5, 95

            axes = [plot.axes.x_axis, plot.axes.y_axis, plot.axes.z_axis]
            assignments = [AxisLine3DAssignment.YMinZMax,
                           AxisLine3DAssignment.ZMaxXMin,
                           AxisLine3DAssignment.XMaxYMin]

            for ax, asgn in zip(axes, assignments):
                ax.show = True
                ax.grid_lines.show = False
                ax.title.show = False
                ax.line.show = False
                ax.line.edge_assignment = asgn

            plot.axes.z_axis.grid_lines.show = True

            plot.view.fit()

            tp.export.save_png('axis_3d.png', 600)

        ..  figure:: /_static/images/axis_3d.png
            :width: 300px
            :figwidth: 300px
        """

        @property
        def title(self):
            """Axis title.

            :type: `string <str>`

            This is the primary label for the axis and usually includes units::

                >>> plot.axes.x_axis.title.text = 'distance (m)'
            """
            return DataAxis3DTitle(self)

        @property
        def line(self):
            """Axis line style control.

            :type: `AxisLine3D`

            Example usage::

                >>> plot.axes.x_axis.line.line_thickness = 0.6
            """
            return AxisLine3D(self)

        @property
        def ticks(self):
            """Axis major and minor ticks style control.

            :type: `Ticks3D`

            Example usage::

                >>> plot.axes.x_axis.ticks.line_thickness = 0.8
            """
            return Ticks3D(self)

        @property
        def tick_labels(self):
            """Axis ticks labels style control.

            :type: `TickLabels3D`

            Example usage::

                >>> plot.axes.x_axis.tick_labels.show = False
            """
            return TickLabels3D(self)

        @property
        def scale_factor(self):
            """Factor used for axis scaling.

            :type: `float`

            This will automatically scale the other axes if axis mode dependent. Setting the axis mode to independent allows each axis to have their own scale factor::

                >>> from tecplot.constant import AxisMode
                >>> plot.axes.axis_mode = AxisMode.Independent
                >>> plot.axes.x_axis.scale_factor = 1
                >>> plot.axes.y_axis.scale_factor = 2
                >>> plot.axes.z_axis.scale_factor = 3
            """
            style = session.Style(sv.GLOBALTHREED, sv.AXISSCALEFACT,
                                  **self._style_attrs)
            return style._get_style(float, self._sv_name)

        @scale_factor.setter
        def scale_factor(self, value):
            style = session.Style(sv.GLOBALTHREED, sv.AXISSCALEFACT,
                                  **self._style_attrs)
            style._set_style(float(value), self._sv_name)

        @property
        def grid_lines(self):
            """Major grid lines style control.

            :type: `GridLines`

            Major grid lines are attached to the locations of the major ticks. See
            `minor_grid_lines <Cartesian3DFieldAxis.minor_grid_lines>` for lines
            attached to minor ticks. Example usage::

                >>> plot.axes.x_axis.grid_lines.show = True
            """
            return GridLines(self)

        @property
        def minor_grid_lines(self):
            """Minor grid lines style control.

            :type: `MinorGridLines`

            Minor grid lines are attached to the locations of the minor ticks.
            Example usage::

                >>> plot.axes.x_axis.minor_grid_lines.show = True
            """
            return MinorGridLines(self)

        @property
        def marker_grid_line(self):
            """Marker line to indicate a particular position along an axis.

            :type: `MarkerGridLine`

            Example usage::

                >>> plot.axes.x_axis.marker_grid_line.show = True
                >>> plot.axes.x_axis.marker_grid_line.position = 0.5
            """
            return MarkerGridLine(self)

    class PolarAngleLineAxis(PolarLineAxis):
        """Theta axis for polar plots.

        This example manipulates both the theta and radial axes to produce a star
        plot. Custom labels are created for each data point::

            import numpy as np
            import tecplot as tp
            from tecplot.constant import PlotType, ThetaMode, NumberFormat, AxisAlignment

            np.random.seed(2)
            npoints = 7
            theta = np.linspace(0, npoints, npoints+1)

            frame = tp.active_frame()
            dataset = frame.create_dataset('Data', ['Magnitude', 'Property'])

            for i in range(3):
                r = list(np.random.uniform(0.01, 0.99, npoints))
                r.append(r[0])
                zone = dataset.add_ordered_zone('Zone {}'.format(i), (npoints+1,))
                zone.values('Magnitude')[:] = r
                zone.values('Property')[:] = theta

            plot = frame.plot(PlotType.PolarLine)
            plot.activate()
            plot.delete_linemaps()

            for i, zone in enumerate(dataset.zones()):
                lmap = plot.add_linemap('Linemap {}'.format(i), zone,
                                        dataset.variable('Magnitude'),
                                        dataset.variable('Property'))
                lmap.line.line_thickness = 0.8

            r_axis = plot.axes.r_axis
            r_axis.max = 1
            r_axis.line.show = False
            r_axis.title.position = 85
            r_axis.line.alignment = AxisAlignment.WithOpposingAxisValue
            r_axis.line.opposing_axis_value = 1

            theta_axis = plot.axes.theta_axis
            theta_axis.origin = 1
            theta_axis.mode = ThetaMode.Arbitrary
            theta_axis.min = 0
            theta_axis.max = theta.max()
            theta_axis.period = npoints
            theta_axis.ticks.auto_spacing = False
            theta_axis.ticks.spacing = 1
            theta_axis.ticks.minor_num_ticks = 0
            theta_axis.title.show = False

            theta_labels = theta_axis.tick_labels.format
            theta_labels.format_type = NumberFormat.CustomLabel
            theta_labels.add_custom_labels('A', 'B', 'C', 'D', 'E', 'F', 'G')
            theta_labels.custom_labels_index = 0

            plot.view.fit()

            tp.export.save_png('star_plot.png', 600)

        ..  figure:: /_static/images/star_plot.png
            :width: 300px
            :figwidth: 300px
        """
        def __init__(self, axes):
            super().__init__(axes, sv.THETA)

        @property
        def grid_lines(self):
            """Theta angle major grid lines.

            :type: `PolarAngleGridLines`

            Example usage::

                >>> plot.axes.theta_axis.grid_lines.show = True
            """
            return PolarAngleGridLines(self)

        @property
        def minor_grid_lines(self):
            """Theta angle minor grid lines.

            :type: `PolarAngleMinorGridLines`

            Example usage::

                >>> plot.axes.theta_axis.minor_grid_lines.show = True
            """
            return PolarAngleMinorGridLines(self)

        @property
        def marker_grid_line(self):
            """Theta angle marker grid line.

            :type: `PolarAngleMarkerGridLine`

            Example usage::

                >>> plot.axes.theta_axis.marker_grid_line.show = True
            """
            return PolarAngleMarkerGridLine(self)

        @property
        def mode(self):
            """Units or scale used for the theta axis.

            :type: `ThetaMode`

            Possible values: `ThetaMode.Degrees`, `ThetaMode.Radians`,
            `ThetaMode.Arbitrary`.

            Example usage::

                >>> from tecplot.constant import ThetaMode
                >>> plot.axes.theta_axis.mode = ThetaMode.Radians
            """
            return self.axes._get_style(ThetaMode, sv.THETAMODE)

        @mode.setter
        def mode(self, value):
            self.axes._set_style(ThetaMode(value), sv.THETAMODE)

        @property
        def period(self):
            """Number of (min, max) cycles to include in 360 degrees.

            :type: `float`

            Example usage::

                >>> plot.axes.theta_axis.period = 2
            """
            return self.axes._get_style(float, sv.THETAPERIOD)

        @period.setter
        def period(self, value):
            self.axes._set_style(float(value), sv.THETAPERIOD)

        @lock()
        def set_range_to_entire_circle(self):
            """Set theta range to entire circle.

            Example usage::

                >>> plot.axes.theta_axis.set_range_to_entire_circle()
            """
            with self.axes.plot.frame.activated():
                axis_num = getattr(self, 'index', 0) + 1
                if not _tecutil.ViewAxisFitToEntireCircle(ctypes.c_char(bytes(self.name[0], 'utf-8')), axis_num):
                    raise TecplotSystemError()

    class RadialLineAxis(PolarLineAxis, Cartesian2DAxis):
        """The R axis for polar plots

        See the example shown for the `theta axis <PolarAngleLineAxis>`.
        """
        def __init__(self, axes):
            super().__init__(axes, sv.R)

        @property
        def title(self):
            """Axis title.

            :type: `string <str>`

            This is the primary label for the axis and usually includes units::

                >>> plot.axes.r_axis.title.text = 'distance (m)'
            """
            return RadialAxisTitle(self)

        @property
        def line(self):
            """Radial axis line style control.

            :type: `RadialAxisLine2D`

            Example usage::

                >>> plot.axes.r_axis.line.line_thickness = 0.6
            """
            return RadialAxisLine2D(self)

        @property
        def ticks(self):
            """Axis major and minor ticks style control.

            :type: `RadialTicks`

            Example usage::

                >>> plot.axes.r_axis.ticks.line_thickness = 0.8
            """
            return RadialTicks(self)

        @property
        def tick_labels(self):
            """Axis ticks labels style control.

            :type: `RadialTickLabels`

            Example usage::

                >>> plot.axes.r_axis.tick_labels.show = False
            """
            return RadialTickLabels(self)

    class SketchAxis(Cartesian2DAxis):
        """X or Y axis for sketch plots.

        .. code-block:: python
            :emphasize-lines: 11-15,17-18

            import tecplot as tp
            from tecplot.constant import PlotType

            plot = tp.active_frame().plot(PlotType.Sketch)

            viewport = plot.axes.viewport
            viewport.left = 10
            viewport.right = 90
            viewport.bottom = 10

            xaxis = plot.axes.x_axis
            xaxis.show = True
            xaxis.min = 0
            xaxis.max = 360
            xaxis.title.text = 'Angle (Degrees)'

            xaxis.ticks.auto_spacing = False
            xaxis.ticks.spacing = 60

            tp.export.save_png('axis_sketch.png', 600)

        ..  figure:: /_static/images/axis_sketch.png
            :width: 300px
            :figwidth: 300px
        """

    class XYLineAxis(IndexedLineAxis):
        """X or Y axis for line plots.

        .. code-block:: python
            :emphasize-lines: 24-28,31

            from os import path
            import tecplot as tp
            from tecplot.constant import PlotType, AxisAlignment

            examples_dir = tp.session.tecplot_examples_directory()
            infile = path.join(examples_dir, 'XY', 'y_axis2.plt')
            dataset = tp.data.load_tecplot(infile)

            plot = tp.active_frame().plot(PlotType.XYLine)
            plot.activate()

            plot.axes.viewport.left = 25
            plot.axes.viewport.right = 75

            # set position of the y axes based on viewport width
            viewport_width = plot.axes.viewport.right - plot.axes.viewport.left

            for i, pos in enumerate([-25,0,100,125]):
                lmap = plot.linemap(i)
                lmap.show = True
                lmap.line.line_thickness = 0.6
                lmap.y_axis_index = i

                yax = plot.axes.y_axis(i)
                yax.line.alignment = AxisAlignment.WithGridMin
                yax.line.color = lmap.line.color
                yax.title.color = lmap.line.color
                yax.tick_labels.color = lmap.line.color

                # convert position in viewport width units to offset in frame width units
                yax.line.offset = -pos * (viewport_width / 100)

            tp.export.save_png('axis_line.png', 600)

        ..  figure:: /_static/images/axis_line.png
            :width: 300px
            :figwidth: 300px
        """

    class AxisLine(session.Style):
        def __init__(self, axis):
            self.axis = axis
            super().__init__(axis._sv, sv.AXISLINE, **axis._style_attrs)

        @property
        def show(self):
            """Draw the primary axis line on the plot.

            :type: `boolean <bool>`

            Example usage::

                >>> # get axis via "plot.axes.x_axis(0)" for line plots
                >>> # or "plot.axes.x_axis" for field or sketch plots
                >>> axis.line.show = False
            """
            return self._get_style(bool, sv.SHOW)

        @show.setter
        def show(self, show):
            self._set_style(bool(show), sv.SHOW)

        @property
        def color(self):
            """Color of the axis line.

            :type: `Color`

            Example usage::

                >>> from tecplot.constant import Color
                >>> # get axis via "plot.axes.x_axis(0)" for line plots
                >>> # or "plot.axes.x_axis" for field or sketch plots
                >>> axis.line.color = Color.Blue
            """
            return self._get_style(Color, sv.COLOR)

        @color.setter
        def color(self, value):
            self._set_style(Color(value), sv.COLOR)

        @property
        def line_thickness(self):
            """Width of the axis line to be drawn.

            :type: `float`

            Example usage::

                >>> # get axis via "plot.axes.x_axis(0)" for line plots
                >>> # or "plot.axes.x_axis" for field or sketch plots
                >>> axis.line.line_thickness = 0.5
            """
            return self._get_style(float, sv.LINETHICKNESS)

        @line_thickness.setter
        def line_thickness(self, value):
            self._set_style(float(value), sv.LINETHICKNESS)

    class AxisLine2D(AxisLine):
        """Graduated axis line for 2D plots.

        Cartesian *(x, y)* plots use an extension of this class
        (`Cartesian2DAxisLine`). Polar plots use this class directly. Example
        usage::

            from os import path
            import tecplot as tp
            from tecplot.tecutil import sv
            from tecplot.constant import PlotType, Color, AxisAlignment

            examples_dir = tp.session.tecplot_examples_directory()
            infile = path.join(examples_dir, '2D', 'polarplot.plt')
            dataset = tp.data.load_tecplot(infile)

            plot = tp.active_frame().plot(PlotType.Cartesian2D)
            plot.activate()

            plot.show_contour = True
            plot.contour(0).colormap_name = 'Sequential - Yellow/Green/Blue'

            plot.axes.preserve_scale = True
            plot.axes.x_axis.fit_range()
            xmin, xmax = plot.axes.x_axis.min, plot.axes.x_axis.max

            xline = plot.axes.x_axis.line
            xline.color = Color.DeepRed
            xline.alignment = AxisAlignment.WithOpposingAxisValue
            xline.opposing_axis_value = 0

            yline = plot.axes.y_axis.line
            yline.color = Color.DeepRed
            yline.alignment = AxisAlignment.WithOpposingAxisValue
            yline.opposing_axis_value = 0

            fr = tp.active_page().add_frame()
            polar_plot = fr.plot(PlotType.PolarLine)
            polar_plot.activate()

            fr.transparent = True
            polar_plot.delete_linemaps()

            # these values obtained using 360 EX interactively
            tp.session.set_style(-2.30, sv.POLARVIEW, sv.EXTENTS, sv.X1)
            tp.session.set_style( 2.57, sv.POLARVIEW, sv.EXTENTS, sv.X2)
            tp.session.set_style(-2.14, sv.POLARVIEW, sv.EXTENTS, sv.Y1)
            tp.session.set_style( 2.17, sv.POLARVIEW, sv.EXTENTS, sv.Y2)

            polar_plot.axes.r_axis.show = False
            polar_plot.axes.r_axis.min = 0.83

            tp.export.save_png('axis_line_2d.png', 600)

        ..  figure:: /_static/images/axis_line_2d.png
            :width: 300px
            :figwidth: 300px
        """

        @property
        def offset(self):
            """Axis line placement with respect to the grid border.

            :type: `float` (percent of frame height)

            This is the offset from the grid border-aligned position dictated by
            properties such as `AxisLine2D.alignment`. The example moves the axis
            line into the plot by 5% of the frame height::

                >>> # get axis via "plot.axes.x_axis(0)" for line plots
                >>> # or "plot.axes.x_axis" for field or sketch plots
                >>> axis.line.offset = -5
            """
            return self._get_style(float, sv.OFFSET)

        @offset.setter
        def offset(self, value):
            self._set_style(float(value), sv.OFFSET)

        @property
        def opposing_axis_value(self):
            """Axis line placement with respect to the opposing axis.

            :type: `float`

            The axis alignment must be set to `AxisAlignment.WithOpposingAxisValue`
            to make this property relevant::

                >>> from tecplot.constant import AxisAlignment
                >>> # get axis via "plot.axes.x_axis(0)" for line plots
                >>> # or "plot.axes.x_axis" for field or sketch plots
                >>> axis.line.alignment = AxisAlignment.WithOpposingAxisValue
                >>> axis.line.opposing_axis_value = 0.5
            """
            return self._get_style(float, sv.OPPOSINGAXISVALUE)

        @opposing_axis_value.setter
        def opposing_axis_value(self, value):
            self._set_style(float(value), sv.OPPOSINGAXISVALUE)

        @property
        def alignment(self):
            """Axis line placement.

            :type: `AxisAlignment`

            Possible values: `WithViewport`, `WithOpposingAxisValue`,
            `WithGridMin`, `WithGridMax`, `WithGridAreaTop`, `WithGridAreaBottom`,
            `WithGridAreaLeft` or `WithGridAreaRight`.

            Not all values will be available for every plot type. Example usage::

                >>> from tecplot.constant import AxisAlignment
                >>> # get axis via "plot.axes.x_axis(0)" for line plots
                >>> # or "plot.axes.x_axis" for field or sketch plots
                >>> axis.line.alignment = AxisAlignment.WithGridMin
            """
            return self._get_style(AxisAlignment, sv.AXISALIGNMENT)

        @alignment.setter
        def alignment(self, value):
            self._set_style(AxisAlignment(value), sv.AXISALIGNMENT)

    class Cartesian2DAxisLine(AxisLine2D):
        """Axis line for 2D field plots.

        .. code-block:: python

            from os import path
            import tecplot as tp
            from tecplot.constant import PlotType, Color, AxisAlignment

            examples_dir = tp.session.tecplot_examples_directory()
            infile = path.join(examples_dir, '2D', 'polarplot.plt')
            dataset = tp.data.load_tecplot(infile)

            plot = tp.active_frame().plot(PlotType.Cartesian2D)
            plot.activate()

            plot.show_contour = True
            plot.contour(0).colormap_name = 'Sequential - Yellow/Green/Blue'

            plot.axes.preserve_scale = True
            plot.axes.x_axis.fit_range()

            xline = plot.axes.x_axis.line
            xline.color = Color.DeepRed
            xline.alignment = AxisAlignment.WithOpposingAxisValue
            xline.opposing_axis_value = 0

            yline = plot.axes.y_axis.line
            yline.color = Color.DeepRed
            yline.alignment = AxisAlignment.WithOpposingAxisValue
            yline.opposing_axis_value = 0

            tp.export.save_png('axis_line_cartesian2d.png', 600)

        ..  figure:: /_static/images/axis_line_cartesian2d.png
            :width: 300px
            :figwidth: 300px
        """

        @property
        def position(self):
            """Axis line placement with respect to the viewport.

            :type: `float`

            The axis alignment must be set to `AxisAlignment.WithViewport`
            to make this property relevant::

                >>> from tecplot.constant import AxisAlignment
                >>> # get axis via "plot.axes.x_axis(0)" for line plots
                >>> # or "plot.axes.x_axis" for field or sketch plots
                >>> axis.line.alignment = AxisAlignment.WithViewport
                >>> axis.line.position = 0.5
            """
            return self._get_style(float, sv.POSITION)

        @position.setter
        def position(self, value):
            self._set_style(float(value), sv.POSITION)

    class AxisLine3D(AxisLine):
        """X, Y or Z axis for 3D field plots.

        This represents the line along which ticks and labels are drawn. The color
        affects the line itself and the associated tick marks but not labels or
        axis titles::

            from os import path
            import tecplot as tp
            from tecplot.constant import PlotType, Color

            examples_dir = tp.session.tecplot_examples_directory()
            infile = path.join(examples_dir, '3D_Volume', 'tritorus.lpk')
            dataset = tp.load_layout(infile)

            frame = tp.active_frame()
            plot = frame.plot()

            plot.show_mesh = False
            plot.axes.grid_area.fill_color = Color.Grey

            for ax in [plot.axes.x_axis, plot.axes.y_axis, plot.axes.z_axis]:
                ax.show = True
                ax.grid_lines.show = False
                ax.line.color = Color.Cyan
                ax.line.line_thickness = 0.2
                ax.line.show_on_opposite_edge = True

            plot.view.fit()

            tp.export.save_png('axis_line_3d.png', 600)

        ..  figure:: /_static/images/axis_line_3d.png
            :width: 300px
            :figwidth: 300px
        """

        @property
        def show_on_opposite_edge(self):
            """Draw axis line on opposite edge of axes box.

            :type: `boolean <bool>`

            Example usage::

                >>> plot.axes.x_axis.line.show_on_opposite_edge = True
            """
            return self._get_style(bool, sv.SHOWOPPOSITEEDGE)

        @show_on_opposite_edge.setter
        def show_on_opposite_edge(self, value):
            self._set_style(bool(value), sv.SHOWOPPOSITEEDGE)

        @property
        def edge_assignment(self):
            """Edge to use when drawing the primary axis line.

            :type: `AxisLine3DAssignment` or `None`

            Possible values: `AxisLine3DAssignment.Automatic` (aliased to `None`),
            `YMinZMin`, `YMaxZMin`, `YMinZMax`, `YMaxZMax`.

            Example usage::

                >>> from tecplot.constant import AxisLine3DAssignment
                >>> axis.line.edge_assignment = AxisLine3DAssignment.YMinZMin
            """
            style = session.Style(**self._style_attrs)
            auto_reset = style._get_style(bool, sv.THREEDAXIS, sv.EDGEAUTORESET)
            if auto_reset:
                return AxisLine3DAssignment.Automatic
            else:
                return self._get_style(AxisLine3DAssignment, sv.EDGE)

        @edge_assignment.setter
        def edge_assignment(self, value):
            style = session.Style(**self._style_attrs)
            if value in (None, AxisLine3DAssignment.Automatic):
                style._set_style(True, sv.THREEDAXIS, sv.EDGEAUTORESET)
            else:
                style._set_style(False, sv.THREEDAXIS, sv.EDGEAUTORESET)
                self._set_style(AxisLine3DAssignment(value), sv.EDGE)

    class RadialAxisLine2D(AxisLine2D):
        """Radial axis line for polar plots.

        .. code-block:: python
            :emphasize-lines: 26-27

            import numpy as np
            import tecplot as tp
            from tecplot.constant import PlotType, Color

            npoints = 300
            r = np.linspace(0, 2000, npoints)
            theta = np.linspace(0, 700, npoints)

            frame = tp.active_frame()
            dataset = frame.create_dataset('Data', ['R', 'Theta'])
            zone = dataset.add_ordered_zone('Zone', (300,))
            zone.values('R')[:] = r
            zone.values('Theta')[:] = theta

            plot = frame.plot(PlotType.PolarLine)
            plot.activate()

            plot.axes.r_axis.max = np.max(r)

            plot.delete_linemaps()
            lmap = plot.add_linemap('Linemap', zone, dataset.variable('R'),
                                    dataset.variable('Theta'))
            lmap.line.line_thickness = 0.8

            raxis = plot.axes.r_axis
            raxis.line.show_both_directions = True
            raxis.line.show_perpendicular = True

            plot.view.fit()

            tp.export.save_png('axis_line_radial.png', 600)

        ..  figure:: /_static/images/axis_line_radial.png
            :width: 300px
            :figwidth: 300px
        """

        @property
        def show_both_directions(self):
            """Mirror the radial axis 180 degrees from the primary line.

            :type: `boolean <bool>`

            If `RadialAxisLine2D.show_perpendicular` is `True`, this will mirror
            that axis line as well resulting in four axis lines, 90 degrees apart.
            Example usage::

                >>> r_axis.line.show_both_directions = True
            """
            return self._get_style(bool, sv.SHOWBOTHDIRECTIONS)

        @show_both_directions.setter
        def show_both_directions(self, value):
            self._set_style(bool(value), sv.SHOWBOTHDIRECTIONS)

        @property
        def show_perpendicular(self):
            """Mirror the radial axis 90 degrees from the primary line.

            :type: `boolean <bool>`

            Example usage::

                >>> r_axis.line.show_perpendicular = True
            """
            return self._get_style(bool, sv.SHOWPERPENDICULAR)

        @show_perpendicular.setter
        def show_perpendicular(self, value):
            self._set_style(bool(value), sv.SHOWPERPENDICULAR)

        @property
        def alignment(self):
            """Axis line placement.

            :type: `AxisAlignment`

            Possible values: `WithOpposingAxisValue`, `WithGridMin`, `WithGridMax`,
            `WithSpecificAngle`, `WithGridAreaTop`, `WithGridAreaBottom`,
            `WithGridAreaLeft` or `WithGridAreaRight`.

            Not all values will be available for every plot type. Example usage::

                >>> from tecplot.constant import AxisAlignment
                >>> plot.r_axis.line.alignment = AxisAlignment.WithOpposingAxisValue
                >>> plot.r_axis.line.opposing_axis_value = 45
            """
            return self._get_style(AxisAlignment, sv.AXISALIGNMENT)

        @alignment.setter
        def alignment(self, value):
            self._set_style(AxisAlignment(value), sv.AXISALIGNMENT)

        @property
        def angle(self):
            """Specific angle to place the radial axis line.

            :type: `float`

            The alignment must be set to `AxisAlignment.WithSpecificAngle`::

                >>> from tecplot.constant import AxisAlignment
                >>> plot.r_axis.line.alignment = AxisAlignment.WithSpecificAngle
                >>> plot.r_axis.line.angle = 45
            """
            return self._get_style(float, sv.ANGLE)

        @angle.setter
        def angle(self, value):
            self._set_style(float(value), sv.ANGLE)

### Navigation

- index
- modules |