Plot Style
==========

..  contents::
    :local:
    :depth: 2


Scatter Plots
-------------

..  contents::
    :local:
    :depth: 1

.. py:currentmodule:: tecplot.plot

Scatter
^^^^^^^

.. autoclass:: Scatter

    **Attributes**

    .. autosummary::
        :nosignatures:

        base_font
        legend
        reference_symbol
        relative_size
        relative_size_units
        sphere_render_quality
        variable
        variable_index

.. autoattribute:: Scatter.base_font
.. autoattribute:: Scatter.legend
.. autoattribute:: Scatter.reference_symbol
.. autoattribute:: Scatter.relative_size
.. autoattribute:: Scatter.relative_size_units
.. autoattribute:: Scatter.sphere_render_quality
.. autoattribute:: Scatter.variable
.. autoattribute:: Scatter.variable_index

.. py:currentmodule:: tecplot.plot

ScatterReferenceSymbol
^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: ScatterReferenceSymbol

    **Attributes**

    .. autosummary::
        :nosignatures:

        color
        fill_color
        filled
        line_thickness
        magnitude
        position
        show
        symbol_type

    **Methods**

    .. autosummary::

        symbol

.. autoattribute:: ScatterReferenceSymbol.color
.. autoattribute:: ScatterReferenceSymbol.fill_color
.. autoattribute:: ScatterReferenceSymbol.filled
.. autoattribute:: ScatterReferenceSymbol.line_thickness
.. autoattribute:: ScatterReferenceSymbol.magnitude
.. autoattribute:: ScatterReferenceSymbol.position
.. autoattribute:: ScatterReferenceSymbol.show
.. automethod:: ScatterReferenceSymbol.symbol
.. autoattribute:: ScatterReferenceSymbol.symbol_type

Vector Plots
------------

..  contents::
    :local:
    :depth: 1

.. py:currentmodule:: tecplot.plot

Vector2D
^^^^^^^^

.. autoclass:: Vector2D

    **Attributes**

    .. autosummary::
        :nosignatures:

        arrowhead_angle
        arrowhead_fraction
        arrowhead_size
        length
        reference_vector
        relative_length
        size_arrowhead_by_fraction
        u_variable
        u_variable_index
        use_grid_units
        use_relative
        v_variable
        v_variable_index

.. autoattribute:: Vector2D.arrowhead_angle
.. autoattribute:: Vector2D.arrowhead_fraction
.. autoattribute:: Vector2D.arrowhead_size
.. autoattribute:: Vector2D.length
.. autoattribute:: Vector2D.reference_vector
.. autoattribute:: Vector2D.relative_length
.. autoattribute:: Vector2D.size_arrowhead_by_fraction
.. autoattribute:: Vector2D.u_variable
.. autoattribute:: Vector2D.u_variable_index
.. autoattribute:: Vector2D.use_grid_units
.. autoattribute:: Vector2D.use_relative
.. autoattribute:: Vector2D.v_variable
.. autoattribute:: Vector2D.v_variable_index

.. py:currentmodule:: tecplot.plot

Vector3D
^^^^^^^^

.. autoclass:: Vector3D

    **Attributes**

    .. autosummary::
        :nosignatures:

        arrowhead_angle
        arrowhead_fraction
        arrowhead_size
        length
        reference_vector
        relative_length
        size_arrowhead_by_fraction
        u_variable
        u_variable_index
        use_grid_units
        use_relative
        v_variable
        v_variable_index
        w_variable
        w_variable_index

.. autoattribute:: Vector3D.arrowhead_angle
.. autoattribute:: Vector3D.arrowhead_fraction
.. autoattribute:: Vector3D.arrowhead_size
.. autoattribute:: Vector3D.length
.. autoattribute:: Vector3D.reference_vector
.. autoattribute:: Vector3D.relative_length
.. autoattribute:: Vector3D.size_arrowhead_by_fraction
.. autoattribute:: Vector3D.u_variable
.. autoattribute:: Vector3D.u_variable_index
.. autoattribute:: Vector3D.use_grid_units
.. autoattribute:: Vector3D.use_relative
.. autoattribute:: Vector3D.v_variable
.. autoattribute:: Vector3D.v_variable_index
.. autoattribute:: Vector3D.w_variable
.. autoattribute:: Vector3D.w_variable_index

.. py:currentmodule:: tecplot.plot

ReferenceVector
^^^^^^^^^^^^^^^

.. autoclass:: ReferenceVector

    **Attributes**

    .. autosummary::
        :nosignatures:

        angle
        color
        label
        line_thickness
        magnitude
        position
        show

.. autoattribute:: ReferenceVector.angle
.. autoattribute:: ReferenceVector.color
.. autoattribute:: ReferenceVector.label
.. autoattribute:: ReferenceVector.line_thickness
.. autoattribute:: ReferenceVector.magnitude
.. autoattribute:: ReferenceVector.position
.. autoattribute:: ReferenceVector.show

.. py:currentmodule:: tecplot.plot

ReferenceVectorLabel
^^^^^^^^^^^^^^^^^^^^

.. autoclass:: ReferenceVectorLabel

    **Attributes**

    .. autosummary::
        :nosignatures:

        color
        font
        format
        offset
        show

.. autoattribute:: ReferenceVectorLabel.color
.. autoattribute:: ReferenceVectorLabel.font
.. autoattribute:: ReferenceVectorLabel.format
.. autoattribute:: ReferenceVectorLabel.offset
.. autoattribute:: ReferenceVectorLabel.show

Legends
-------

..  contents::
    :local:
    :depth: 1

.. py:currentmodule:: tecplot.legend

ContourLegend
^^^^^^^^^^^^^

.. autoclass:: ContourLegend

    **Attributes**

    .. autosummary::
        :nosignatures:

        anchor_alignment
        auto_resize
        box
        header_font
        label_format
        label_increment
        label_location
        label_step
        number_font
        overlay_bar_grid
        position
        row_spacing
        show
        show_cutoff_levels
        show_header
        text_color
        vertical

.. autoattribute:: ContourLegend.anchor_alignment
.. autoattribute:: ContourLegend.auto_resize
.. autoattribute:: ContourLegend.box
.. autoattribute:: ContourLegend.header_font
.. autoattribute:: ContourLegend.label_format
.. autoattribute:: ContourLegend.label_increment
.. autoattribute:: ContourLegend.label_location
.. autoattribute:: ContourLegend.label_step
.. autoattribute:: ContourLegend.number_font
.. autoattribute:: ContourLegend.overlay_bar_grid
.. autoattribute:: ContourLegend.position
.. autoattribute:: ContourLegend.row_spacing
.. autoattribute:: ContourLegend.show
.. autoattribute:: ContourLegend.show_cutoff_levels
.. autoattribute:: ContourLegend.show_header
.. autoattribute:: ContourLegend.text_color
.. autoattribute:: ContourLegend.vertical

.. py:currentmodule:: tecplot.legend

LineLegend
^^^^^^^^^^

.. autoclass:: LineLegend

    **Attributes**

    .. autosummary::
        :nosignatures:

        anchor_alignment
        box
        font
        position
        row_spacing
        show
        show_text
        text_color

.. autoattribute:: LineLegend.anchor_alignment
.. autoattribute:: LineLegend.box
.. autoattribute:: LineLegend.font
.. autoattribute:: LineLegend.position
.. autoattribute:: LineLegend.row_spacing
.. autoattribute:: LineLegend.show
.. autoattribute:: LineLegend.show_text
.. autoattribute:: LineLegend.text_color

.. py:currentmodule:: tecplot.legend

RGBColoringLegend
^^^^^^^^^^^^^^^^^

.. autoclass:: RGBColoringLegend

    **Attributes**

    .. autosummary::
        :nosignatures:

        anchor_alignment
        blue_label
        box
        font
        green_label
        height
        orientation
        position
        red_label
        show
        show_labels
        text_color
        use_variable_for_blue_label
        use_variable_for_green_label
        use_variable_for_red_label

.. autoattribute:: RGBColoringLegend.anchor_alignment
.. autoattribute:: RGBColoringLegend.blue_label
.. autoattribute:: RGBColoringLegend.box
.. autoattribute:: RGBColoringLegend.font
.. autoattribute:: RGBColoringLegend.green_label
.. autoattribute:: RGBColoringLegend.height
.. autoattribute:: RGBColoringLegend.orientation
.. autoattribute:: RGBColoringLegend.position
.. autoattribute:: RGBColoringLegend.red_label
.. autoattribute:: RGBColoringLegend.show
.. autoattribute:: RGBColoringLegend.show_labels
.. autoattribute:: RGBColoringLegend.text_color
.. autoattribute:: RGBColoringLegend.use_variable_for_blue_label
.. autoattribute:: RGBColoringLegend.use_variable_for_green_label
.. autoattribute:: RGBColoringLegend.use_variable_for_red_label

.. py:currentmodule:: tecplot.legend

ScatterLegend
^^^^^^^^^^^^^

.. autoclass:: ScatterLegend

    **Attributes**

    .. autosummary::
        :nosignatures:

        anchor_alignment
        box
        font
        position
        row_spacing
        show
        show_text
        text_color

.. autoattribute:: ScatterLegend.anchor_alignment
.. autoattribute:: ScatterLegend.box
.. autoattribute:: ScatterLegend.font
.. autoattribute:: ScatterLegend.position
.. autoattribute:: ScatterLegend.row_spacing
.. autoattribute:: ScatterLegend.show
.. autoattribute:: ScatterLegend.show_text
.. autoattribute:: ScatterLegend.text_color

Contours
--------

..  contents::
    :local:
    :depth: 1

.. py:currentmodule:: tecplot.plot

ContourGroup
^^^^^^^^^^^^

.. autoclass:: ContourGroup

    **Attributes**

    .. autosummary::
        :nosignatures:

        color_cutoff
        colormap_filter
        colormap_name
        default_num_levels
        labels
        legend
        levels
        lines
        variable
        variable_index

.. autoattribute:: ContourGroup.color_cutoff
.. autoattribute:: ContourGroup.colormap_filter
.. autoattribute:: ContourGroup.colormap_name
.. autoattribute:: ContourGroup.default_num_levels
.. autoattribute:: ContourGroup.labels
.. autoattribute:: ContourGroup.legend
.. autoattribute:: ContourGroup.levels
.. autoattribute:: ContourGroup.lines
.. autoattribute:: ContourGroup.variable
.. autoattribute:: ContourGroup.variable_index

.. py:currentmodule:: tecplot.plot

ContourColorCutoff
^^^^^^^^^^^^^^^^^^

.. autoclass:: ContourColorCutoff

    **Attributes**

    .. autosummary::
        :nosignatures:

        include_max
        include_min
        inverted
        max
        min

.. autoattribute:: ContourColorCutoff.include_max
.. autoattribute:: ContourColorCutoff.include_min
.. autoattribute:: ContourColorCutoff.inverted
.. autoattribute:: ContourColorCutoff.max
.. autoattribute:: ContourColorCutoff.min

.. py:currentmodule:: tecplot.plot

ContourColormapFilter
^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: ContourColormapFilter

    **Attributes**

    .. autosummary::
        :nosignatures:

        continuous_max
        continuous_min
        distribution
        fast_continuous_flood
        num_cycles
        reversed
        show_overrides
        zebra_shade

    **Methods**

    .. autosummary::

        override

.. autoattribute:: ContourColormapFilter.continuous_max
.. autoattribute:: ContourColormapFilter.continuous_min
.. autoattribute:: ContourColormapFilter.distribution
.. autoattribute:: ContourColormapFilter.fast_continuous_flood
.. autoattribute:: ContourColormapFilter.num_cycles
.. automethod:: ContourColormapFilter.override
.. autoattribute:: ContourColormapFilter.reversed
.. autoattribute:: ContourColormapFilter.show_overrides
.. autoattribute:: ContourColormapFilter.zebra_shade

.. py:currentmodule:: tecplot.plot

ContourColormapOverride
^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: ContourColormapOverride

    **Attributes**

    .. autosummary::
        :nosignatures:

        color
        end_level
        show
        start_level

.. autoattribute:: ContourColormapOverride.color
.. autoattribute:: ContourColormapOverride.end_level
.. autoattribute:: ContourColormapOverride.show
.. autoattribute:: ContourColormapOverride.start_level

.. py:currentmodule:: tecplot.plot

ContourColormapZebraShade
^^^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: ContourColormapZebraShade

    **Attributes**

    .. autosummary::
        :nosignatures:

        color
        show
        transparent

.. autoattribute:: ContourColormapZebraShade.color
.. autoattribute:: ContourColormapZebraShade.show
.. autoattribute:: ContourColormapZebraShade.transparent

.. py:currentmodule:: tecplot.plot

ContourLabels
^^^^^^^^^^^^^

.. autoclass:: ContourLabels

    **Attributes**

    .. autosummary::
        :nosignatures:

        auto_align
        auto_generate
        background_color
        color
        filled
        font
        format
        label_by_level
        margin
        show
        spacing
        step

.. autoattribute:: ContourLabels.auto_align
.. autoattribute:: ContourLabels.auto_generate
.. autoattribute:: ContourLabels.background_color
.. autoattribute:: ContourLabels.color
.. autoattribute:: ContourLabels.filled
.. autoattribute:: ContourLabels.font
.. autoattribute:: ContourLabels.format
.. autoattribute:: ContourLabels.label_by_level
.. autoattribute:: ContourLabels.margin
.. autoattribute:: ContourLabels.show
.. autoattribute:: ContourLabels.spacing
.. autoattribute:: ContourLabels.step

.. py:currentmodule:: tecplot.plot

ContourLevels
^^^^^^^^^^^^^

.. autoclass:: ContourLevels

    **Methods**

    .. autosummary::

        add
        delete_nearest
        delete_range
        reset
        reset_levels
        reset_to_nice

.. automethod:: ContourLevels.add
.. automethod:: ContourLevels.delete_nearest
.. automethod:: ContourLevels.delete_range
.. automethod:: ContourLevels.reset
.. automethod:: ContourLevels.reset_levels
.. automethod:: ContourLevels.reset_to_nice

.. py:currentmodule:: tecplot.plot

ContourLines
^^^^^^^^^^^^

.. autoclass:: ContourLines

    **Attributes**

    .. autosummary::
        :nosignatures:

        mode
        pattern_length
        step

.. autoattribute:: ContourLines.mode
.. autoattribute:: ContourLines.pattern_length
.. autoattribute:: ContourLines.step

.. py:currentmodule:: tecplot.plot

RGBColoring
^^^^^^^^^^^

.. autoclass:: RGBColoring

    **Attributes**

    .. autosummary::
        :nosignatures:

        blue_variable
        blue_variable_index
        green_variable
        green_variable_index
        legend
        max_intensity
        min_intensity
        mode
        red_variable
        red_variable_index

.. autoattribute:: RGBColoring.blue_variable
.. autoattribute:: RGBColoring.blue_variable_index
.. autoattribute:: RGBColoring.green_variable
.. autoattribute:: RGBColoring.green_variable_index
.. autoattribute:: RGBColoring.legend
.. autoattribute:: RGBColoring.max_intensity
.. autoattribute:: RGBColoring.min_intensity
.. autoattribute:: RGBColoring.mode
.. autoattribute:: RGBColoring.red_variable
.. autoattribute:: RGBColoring.red_variable_index

Isosurface
----------

..  contents::
    :local:
    :depth: 1

.. py:currentmodule:: tecplot.plot

IsosurfaceGroup
^^^^^^^^^^^^^^^

.. autoclass:: IsosurfaceGroup

    **Attributes**

    .. autosummary::
        :nosignatures:

        contour
        definition_contour_group
        definition_contour_group_index
        effects
        isosurface_selection
        isosurface_values
        mesh
        obey_source_zone_blanking
        shade
        show
        surface_generation_method
        vector

    **Methods**

    .. autosummary::

        extract

.. autoattribute:: IsosurfaceGroup.contour
.. autoattribute:: IsosurfaceGroup.definition_contour_group
.. autoattribute:: IsosurfaceGroup.definition_contour_group_index
.. autoattribute:: IsosurfaceGroup.effects
.. automethod:: IsosurfaceGroup.extract
.. autoattribute:: IsosurfaceGroup.isosurface_selection
.. autoattribute:: IsosurfaceGroup.isosurface_values
.. autoattribute:: IsosurfaceGroup.mesh
.. autoattribute:: IsosurfaceGroup.obey_source_zone_blanking
.. autoattribute:: IsosurfaceGroup.shade
.. autoattribute:: IsosurfaceGroup.show
.. autoattribute:: IsosurfaceGroup.surface_generation_method
.. autoattribute:: IsosurfaceGroup.vector

.. py:currentmodule:: tecplot.plot

IsosurfaceContour
^^^^^^^^^^^^^^^^^

.. autoclass:: IsosurfaceContour

    **Attributes**

    .. autosummary::
        :nosignatures:

        contour_type
        flood_contour_group
        flood_contour_group_index
        line_color
        line_contour_group
        line_contour_group_index
        line_thickness
        show
        use_lighting_effect

.. autoattribute:: IsosurfaceContour.contour_type
.. autoattribute:: IsosurfaceContour.flood_contour_group
.. autoattribute:: IsosurfaceContour.flood_contour_group_index
.. autoattribute:: IsosurfaceContour.line_color
.. autoattribute:: IsosurfaceContour.line_contour_group
.. autoattribute:: IsosurfaceContour.line_contour_group_index
.. autoattribute:: IsosurfaceContour.line_thickness
.. autoattribute:: IsosurfaceContour.show
.. autoattribute:: IsosurfaceContour.use_lighting_effect

.. py:currentmodule:: tecplot.plot

IsosurfaceEffects
^^^^^^^^^^^^^^^^^

.. autoclass:: IsosurfaceEffects

    **Attributes**

    .. autosummary::
        :nosignatures:

        lighting_effect
        surface_translucency
        use_translucency

.. autoattribute:: IsosurfaceEffects.lighting_effect
.. autoattribute:: IsosurfaceEffects.surface_translucency
.. autoattribute:: IsosurfaceEffects.use_translucency

.. py:currentmodule:: tecplot.plot

IsosurfaceMesh
^^^^^^^^^^^^^^

.. autoclass:: IsosurfaceMesh

    **Attributes**

    .. autosummary::
        :nosignatures:

        color
        line_thickness
        show

.. autoattribute:: IsosurfaceMesh.color
.. autoattribute:: IsosurfaceMesh.line_thickness
.. autoattribute:: IsosurfaceMesh.show

.. py:currentmodule:: tecplot.plot

IsosurfaceShade
^^^^^^^^^^^^^^^

.. autoclass:: IsosurfaceShade

    **Attributes**

    .. autosummary::
        :nosignatures:

        color
        show
        use_lighting_effect

.. autoattribute:: IsosurfaceShade.color
.. autoattribute:: IsosurfaceShade.show
.. autoattribute:: IsosurfaceShade.use_lighting_effect

.. py:currentmodule:: tecplot.plot

IsosurfaceVector
^^^^^^^^^^^^^^^^

.. autoclass:: IsosurfaceVector

    **Attributes**

    .. autosummary::
        :nosignatures:

        arrowhead_style
        color
        is_tangent
        line_thickness
        show
        vector_type

.. autoattribute:: IsosurfaceVector.arrowhead_style
.. autoattribute:: IsosurfaceVector.color
.. autoattribute:: IsosurfaceVector.is_tangent
.. autoattribute:: IsosurfaceVector.line_thickness
.. autoattribute:: IsosurfaceVector.show
.. autoattribute:: IsosurfaceVector.vector_type

Slice
-----

..  contents::
    :local:
    :depth: 1

.. py:currentmodule:: tecplot.plot

SliceGroup
^^^^^^^^^^

.. autoclass:: SliceGroup

    **Attributes**

    .. autosummary::
        :nosignatures:

        arbitrary_normal
        contour
        edge
        effects
        end_position
        mesh
        num_intermediate_slices
        obey_source_zone_blanking
        orientation
        origin
        shade
        show
        show_intermediate_slices
        show_primary_slice
        show_start_and_end_slices
        slice_source
        start_position
        surface_generation_method
        vector

    **Methods**

    .. autosummary::

        extract
        set_arbitrary_from_points

.. autoattribute:: SliceGroup.arbitrary_normal
.. autoattribute:: SliceGroup.contour
.. autoattribute:: SliceGroup.edge
.. autoattribute:: SliceGroup.effects
.. autoattribute:: SliceGroup.end_position
.. automethod:: SliceGroup.extract
.. autoattribute:: SliceGroup.mesh
.. autoattribute:: SliceGroup.num_intermediate_slices
.. autoattribute:: SliceGroup.obey_source_zone_blanking
.. autoattribute:: SliceGroup.orientation
.. autoattribute:: SliceGroup.origin
.. automethod:: SliceGroup.set_arbitrary_from_points
.. autoattribute:: SliceGroup.shade
.. autoattribute:: SliceGroup.show
.. autoattribute:: SliceGroup.show_intermediate_slices
.. autoattribute:: SliceGroup.show_primary_slice
.. autoattribute:: SliceGroup.show_start_and_end_slices
.. autoattribute:: SliceGroup.slice_source
.. autoattribute:: SliceGroup.start_position
.. autoattribute:: SliceGroup.surface_generation_method
.. autoattribute:: SliceGroup.vector

.. py:currentmodule:: tecplot.plot

SliceContour
^^^^^^^^^^^^

.. autoclass:: SliceContour

    **Attributes**

    .. autosummary::
        :nosignatures:

        contour_type
        flood_contour_group
        flood_contour_group_index
        line_color
        line_contour_group
        line_contour_group_index
        line_thickness
        show
        use_lighting_effect

.. autoattribute:: SliceContour.contour_type
.. autoattribute:: SliceContour.flood_contour_group
.. autoattribute:: SliceContour.flood_contour_group_index
.. autoattribute:: SliceContour.line_color
.. autoattribute:: SliceContour.line_contour_group
.. autoattribute:: SliceContour.line_contour_group_index
.. autoattribute:: SliceContour.line_thickness
.. autoattribute:: SliceContour.show
.. autoattribute:: SliceContour.use_lighting_effect

.. py:currentmodule:: tecplot.plot

SliceEdge
^^^^^^^^^

.. autoclass:: SliceEdge

    **Attributes**

    .. autosummary::
        :nosignatures:

        color
        edge_type
        line_thickness
        show

.. autoattribute:: SliceEdge.color
.. autoattribute:: SliceEdge.edge_type
.. autoattribute:: SliceEdge.line_thickness
.. autoattribute:: SliceEdge.show

.. py:currentmodule:: tecplot.plot

SliceEffects
^^^^^^^^^^^^

.. autoclass:: SliceEffects

    **Attributes**

    .. autosummary::
        :nosignatures:

        lighting_effect
        surface_translucency
        use_translucency

.. autoattribute:: SliceEffects.lighting_effect
.. autoattribute:: SliceEffects.surface_translucency
.. autoattribute:: SliceEffects.use_translucency

.. py:currentmodule:: tecplot.plot

SliceMesh
^^^^^^^^^

.. autoclass:: SliceMesh

    **Attributes**

    .. autosummary::
        :nosignatures:

        color
        line_thickness
        show

.. autoattribute:: SliceMesh.color
.. autoattribute:: SliceMesh.line_thickness
.. autoattribute:: SliceMesh.show

.. py:currentmodule:: tecplot.plot

SliceShade
^^^^^^^^^^

.. autoclass:: SliceShade

    **Attributes**

    .. autosummary::
        :nosignatures:

        color
        show
        use_lighting_effect

.. autoattribute:: SliceShade.color
.. autoattribute:: SliceShade.show
.. autoattribute:: SliceShade.use_lighting_effect

.. py:currentmodule:: tecplot.plot

SliceVector
^^^^^^^^^^^

.. autoclass:: SliceVector

    **Attributes**

    .. autosummary::
        :nosignatures:

        arrowhead_style
        color
        is_tangent
        line_thickness
        show
        vector_type

.. autoattribute:: SliceVector.arrowhead_style
.. autoattribute:: SliceVector.color
.. autoattribute:: SliceVector.is_tangent
.. autoattribute:: SliceVector.line_thickness
.. autoattribute:: SliceVector.show
.. autoattribute:: SliceVector.vector_type

Streamtraces
------------

..  contents::
    :local:
    :depth: 1

.. py:currentmodule:: tecplot.plot

Streamtraces
^^^^^^^^^^^^

.. autoclass:: Streamtraces

    **Attributes**

    .. autosummary::
        :nosignatures:

        active
        arrowhead_size
        arrowhead_spacing
        color
        count
        dash_skip
        has_terminating_line
        line_thickness
        marker_color
        marker_size
        marker_symbol_type
        max_steps
        min_step_size
        obey_source_zone_blanking
        rod_ribbon
        show_arrows
        show_dashes
        show_markers
        show_paths
        step_size
        termination_line
        timing

    **Methods**

    .. autosummary::

        add
        add_on_zone_surface
        add_rake
        delete_all
        delete_range
        extract
        marker_symbol
        position
        set_termination_line
        streamtrace_type

.. autoattribute:: Streamtraces.active
.. automethod:: Streamtraces.add
.. automethod:: Streamtraces.add_on_zone_surface
.. automethod:: Streamtraces.add_rake
.. autoattribute:: Streamtraces.arrowhead_size
.. autoattribute:: Streamtraces.arrowhead_spacing
.. autoattribute:: Streamtraces.color
.. autoattribute:: Streamtraces.count
.. autoattribute:: Streamtraces.dash_skip
.. automethod:: Streamtraces.delete_all
.. automethod:: Streamtraces.delete_range
.. automethod:: Streamtraces.extract
.. autoattribute:: Streamtraces.has_terminating_line
.. autoattribute:: Streamtraces.line_thickness
.. autoattribute:: Streamtraces.marker_color
.. autoattribute:: Streamtraces.marker_size
.. automethod:: Streamtraces.marker_symbol
.. autoattribute:: Streamtraces.marker_symbol_type
.. autoattribute:: Streamtraces.max_steps
.. autoattribute:: Streamtraces.min_step_size
.. autoattribute:: Streamtraces.obey_source_zone_blanking
.. automethod:: Streamtraces.position
.. autoattribute:: Streamtraces.rod_ribbon
.. automethod:: Streamtraces.set_termination_line
.. autoattribute:: Streamtraces.show_arrows
.. autoattribute:: Streamtraces.show_dashes
.. autoattribute:: Streamtraces.show_markers
.. autoattribute:: Streamtraces.show_paths
.. autoattribute:: Streamtraces.step_size
.. automethod:: Streamtraces.streamtrace_type
.. autoattribute:: Streamtraces.termination_line
.. autoattribute:: Streamtraces.timing

.. py:currentmodule:: tecplot.plot

StreamtraceRodRibbon
^^^^^^^^^^^^^^^^^^^^

.. autoclass:: StreamtraceRodRibbon

    **Attributes**

    .. autosummary::
        :nosignatures:

        contour
        effects
        mesh
        num_rod_points
        shade
        width

.. autoattribute:: StreamtraceRodRibbon.contour
.. autoattribute:: StreamtraceRodRibbon.effects
.. autoattribute:: StreamtraceRodRibbon.mesh
.. autoattribute:: StreamtraceRodRibbon.num_rod_points
.. autoattribute:: StreamtraceRodRibbon.shade
.. autoattribute:: StreamtraceRodRibbon.width

.. py:currentmodule:: tecplot.plot

StreamtraceTiming
^^^^^^^^^^^^^^^^^

.. autoclass:: StreamtraceTiming

    **Attributes**

    .. autosummary::
        :nosignatures:

        anchor
        delta
        end
        start

    **Methods**

    .. autosummary::

        reset_delta

.. autoattribute:: StreamtraceTiming.anchor
.. autoattribute:: StreamtraceTiming.delta
.. autoattribute:: StreamtraceTiming.end
.. automethod:: StreamtraceTiming.reset_delta
.. autoattribute:: StreamtraceTiming.start

.. py:currentmodule:: tecplot.plot

StreamtraceRodRibbonContour
^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: StreamtraceRodRibbonContour

    **Attributes**

    .. autosummary::
        :nosignatures:

        flood_contour_group
        flood_contour_group_index
        show
        use_lighting_effect

.. autoattribute:: StreamtraceRodRibbonContour.flood_contour_group
.. autoattribute:: StreamtraceRodRibbonContour.flood_contour_group_index
.. autoattribute:: StreamtraceRodRibbonContour.show
.. autoattribute:: StreamtraceRodRibbonContour.use_lighting_effect

.. py:currentmodule:: tecplot.plot

StreamtraceRodRibbonEffects
^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: StreamtraceRodRibbonEffects

    **Attributes**

    .. autosummary::
        :nosignatures:

        lighting_effect
        surface_translucency
        use_translucency

.. autoattribute:: StreamtraceRodRibbonEffects.lighting_effect
.. autoattribute:: StreamtraceRodRibbonEffects.surface_translucency
.. autoattribute:: StreamtraceRodRibbonEffects.use_translucency

.. py:currentmodule:: tecplot.plot

StreamtraceRodRibbonMesh
^^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: StreamtraceRodRibbonMesh

    **Attributes**

    .. autosummary::
        :nosignatures:

        line_thickness
        show

.. autoattribute:: StreamtraceRodRibbonMesh.line_thickness
.. autoattribute:: StreamtraceRodRibbonMesh.show

.. py:currentmodule:: tecplot.plot

StreamtraceRodRibbonShade
^^^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: StreamtraceRodRibbonShade

    **Attributes**

    .. autosummary::
        :nosignatures:

        color
        show
        use_lighting_effect

.. autoattribute:: StreamtraceRodRibbonShade.color
.. autoattribute:: StreamtraceRodRibbonShade.show
.. autoattribute:: StreamtraceRodRibbonShade.use_lighting_effect

.. py:currentmodule:: tecplot.plot

StreamtraceTerminationLine
^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: StreamtraceTerminationLine

    **Attributes**

    .. autosummary::
        :nosignatures:

        active
        color
        line_pattern
        line_thickness
        pattern_length
        show

.. autoattribute:: StreamtraceTerminationLine.active
.. autoattribute:: StreamtraceTerminationLine.color
.. autoattribute:: StreamtraceTerminationLine.line_pattern
.. autoattribute:: StreamtraceTerminationLine.line_thickness
.. autoattribute:: StreamtraceTerminationLine.pattern_length
.. autoattribute:: StreamtraceTerminationLine.show

Text
----

..  contents::
    :local:
    :depth: 1

.. py:currentmodule:: tecplot.text

Font
^^^^

.. autoclass:: Font

    **Attributes**

    .. autosummary::
        :nosignatures:

        bold
        italic
        size
        size_units
        typeface

.. autoattribute:: Font.bold
.. autoattribute:: Font.italic
.. autoattribute:: Font.size
.. autoattribute:: Font.size_units
.. autoattribute:: Font.typeface

.. py:currentmodule:: tecplot.text

BaseFont
^^^^^^^^

.. autoclass:: BaseFont

    **Attributes**

    .. autosummary::
        :nosignatures:

        bold
        italic
        typeface

.. autoattribute:: BaseFont.bold
.. autoattribute:: BaseFont.italic
.. autoattribute:: BaseFont.typeface

.. py:currentmodule:: tecplot.text

TextBox
^^^^^^^

.. autoclass:: TextBox

    **Attributes**

    .. autosummary::
        :nosignatures:

        box_type
        color
        fill_color
        line_thickness
        margin

.. autoattribute:: TextBox.box_type
.. autoattribute:: TextBox.color
.. autoattribute:: TextBox.fill_color
.. autoattribute:: TextBox.line_thickness
.. autoattribute:: TextBox.margin

.. py:currentmodule:: tecplot.text

LabelFormat
^^^^^^^^^^^

.. autoclass:: LabelFormat

    **Attributes**

    .. autosummary::
        :nosignatures:

        custom_labels_index
        datetime_format
        format_type
        negative_prefix
        negative_suffix
        num_custom_labels
        positive_prefix
        positive_suffix
        precision
        remove_leading_zeros
        show_decimals_on_whole_numbers
        show_negative_sign
        zero_prefix
        zero_suffix

    **Methods**

    .. autosummary::

        add_custom_labels
        custom_labels

.. automethod:: LabelFormat.add_custom_labels
.. automethod:: LabelFormat.custom_labels
.. autoattribute:: LabelFormat.custom_labels_index
.. autoattribute:: LabelFormat.datetime_format
.. autoattribute:: LabelFormat.format_type
.. autoattribute:: LabelFormat.negative_prefix
.. autoattribute:: LabelFormat.negative_suffix
.. autoattribute:: LabelFormat.num_custom_labels
.. autoattribute:: LabelFormat.positive_prefix
.. autoattribute:: LabelFormat.positive_suffix
.. autoattribute:: LabelFormat.precision
.. autoattribute:: LabelFormat.remove_leading_zeros
.. autoattribute:: LabelFormat.show_decimals_on_whole_numbers
.. autoattribute:: LabelFormat.show_negative_sign
.. autoattribute:: LabelFormat.zero_prefix
.. autoattribute:: LabelFormat.zero_suffix

Data Labels
-----------

..  contents::
    :local:
    :depth: 1

.. py:currentmodule:: tecplot.plot

FieldPlotDataLabels
^^^^^^^^^^^^^^^^^^^

.. autoclass:: FieldPlotDataLabels

    **Attributes**

    .. autosummary::
        :nosignatures:

        cell_label_type
        cell_variable
        cell_variable_index
        color
        color_by_map
        font
        index_step
        label_format
        node_label_type
        node_variable
        node_variable_index
        show_box
        show_cell_labels
        show_node_labels

.. autoattribute:: FieldPlotDataLabels.cell_label_type
.. autoattribute:: FieldPlotDataLabels.cell_variable
.. autoattribute:: FieldPlotDataLabels.cell_variable_index
.. autoattribute:: FieldPlotDataLabels.color
.. autoattribute:: FieldPlotDataLabels.color_by_map
.. autoattribute:: FieldPlotDataLabels.font
.. autoattribute:: FieldPlotDataLabels.index_step
.. autoattribute:: FieldPlotDataLabels.label_format
.. autoattribute:: FieldPlotDataLabels.node_label_type
.. autoattribute:: FieldPlotDataLabels.node_variable
.. autoattribute:: FieldPlotDataLabels.node_variable_index
.. autoattribute:: FieldPlotDataLabels.show_box
.. autoattribute:: FieldPlotDataLabels.show_cell_labels
.. autoattribute:: FieldPlotDataLabels.show_node_labels

.. py:currentmodule:: tecplot.plot

LinePlotDataLabels
^^^^^^^^^^^^^^^^^^

.. autoclass:: LinePlotDataLabels

    **Attributes**

    .. autosummary::
        :nosignatures:

        color
        color_by_map
        font
        index_step
        label_format
        node_label_type
        show_box
        show_node_labels
        step_distance
        step_mode

.. autoattribute:: LinePlotDataLabels.color
.. autoattribute:: LinePlotDataLabels.color_by_map
.. autoattribute:: LinePlotDataLabels.font
.. autoattribute:: LinePlotDataLabels.index_step
.. autoattribute:: LinePlotDataLabels.label_format
.. autoattribute:: LinePlotDataLabels.node_label_type
.. autoattribute:: LinePlotDataLabels.show_box
.. autoattribute:: LinePlotDataLabels.show_node_labels
.. autoattribute:: LinePlotDataLabels.step_distance
.. autoattribute:: LinePlotDataLabels.step_mode

Viewport
--------

..  contents::
    :local:
    :depth: 1

.. py:currentmodule:: tecplot.plot

ReadOnlyViewport
^^^^^^^^^^^^^^^^

.. autoclass:: ReadOnlyViewport

    **Attributes**

    .. autosummary::
        :nosignatures:

        bottom
        left
        right
        top

.. autoattribute:: ReadOnlyViewport.bottom
.. autoattribute:: ReadOnlyViewport.left
.. autoattribute:: ReadOnlyViewport.right
.. autoattribute:: ReadOnlyViewport.top

.. py:currentmodule:: tecplot.plot

Viewport
^^^^^^^^

.. autoclass:: Viewport

    **Attributes**

    .. autosummary::
        :nosignatures:

        bottom
        left
        right
        top

.. autoattribute:: Viewport.bottom
.. autoattribute:: Viewport.left
.. autoattribute:: Viewport.right
.. autoattribute:: Viewport.top

.. py:currentmodule:: tecplot.plot

Cartesian2DViewport
^^^^^^^^^^^^^^^^^^^

.. autoclass:: Cartesian2DViewport

    **Attributes**

    .. autosummary::
        :nosignatures:

        bottom
        left
        nice_fit_buffer
        right
        top
        top_snap_target
        top_snap_tolerance

.. autoattribute:: Cartesian2DViewport.bottom
.. autoattribute:: Cartesian2DViewport.left
.. autoattribute:: Cartesian2DViewport.nice_fit_buffer
.. autoattribute:: Cartesian2DViewport.right
.. autoattribute:: Cartesian2DViewport.top
.. autoattribute:: Cartesian2DViewport.top_snap_target
.. autoattribute:: Cartesian2DViewport.top_snap_tolerance

.. py:currentmodule:: tecplot.plot

PolarViewport
^^^^^^^^^^^^^

.. autoclass:: PolarViewport

    **Attributes**

    .. autosummary::
        :nosignatures:

        border_color
        border_thickness
        bottom
        fill_color
        left
        right
        show_border
        top

.. autoattribute:: PolarViewport.border_color
.. autoattribute:: PolarViewport.border_thickness
.. autoattribute:: PolarViewport.bottom
.. autoattribute:: PolarViewport.fill_color
.. autoattribute:: PolarViewport.left
.. autoattribute:: PolarViewport.right
.. autoattribute:: PolarViewport.show_border
.. autoattribute:: PolarViewport.top

View and Lighting
-----------------

..  contents::
    :local:
    :depth: 1

.. py:currentmodule:: tecplot.plot

Cartesian2DFieldView
^^^^^^^^^^^^^^^^^^^^

.. autoclass:: Cartesian2DFieldView

    **Attributes**

    .. autosummary::
        :nosignatures:

        magnification

    **Methods**

    .. autosummary::

        adjust_to_nice
        center
        fit
        fit_data
        fit_to_nice
        translate
        zoom

.. automethod:: Cartesian2DFieldView.adjust_to_nice
.. automethod:: Cartesian2DFieldView.center
.. automethod:: Cartesian2DFieldView.fit
.. automethod:: Cartesian2DFieldView.fit_data
.. automethod:: Cartesian2DFieldView.fit_to_nice
.. autoattribute:: Cartesian2DFieldView.magnification
.. automethod:: Cartesian2DFieldView.translate
.. automethod:: Cartesian2DFieldView.zoom

.. py:currentmodule:: tecplot.plot

Cartesian3DView
^^^^^^^^^^^^^^^

.. autoclass:: Cartesian3DView

    **Attributes**

    .. autosummary::
        :nosignatures:

        alpha
        distance
        field_of_view
        magnification
        position
        projection
        psi
        rotation_origin
        theta
        width

    **Methods**

    .. autosummary::

        center
        fit
        fit_data
        fit_surfaces
        rotate_axes
        rotate_to_angles
        rotate_viewer
        translate
        zoom

.. autoattribute:: Cartesian3DView.alpha
.. automethod:: Cartesian3DView.center
.. autoattribute:: Cartesian3DView.distance
.. autoattribute:: Cartesian3DView.field_of_view
.. automethod:: Cartesian3DView.fit
.. automethod:: Cartesian3DView.fit_data
.. automethod:: Cartesian3DView.fit_surfaces
.. autoattribute:: Cartesian3DView.magnification
.. autoattribute:: Cartesian3DView.position
.. autoattribute:: Cartesian3DView.projection
.. autoattribute:: Cartesian3DView.psi
.. automethod:: Cartesian3DView.rotate_axes
.. automethod:: Cartesian3DView.rotate_to_angles
.. automethod:: Cartesian3DView.rotate_viewer
.. autoattribute:: Cartesian3DView.rotation_origin
.. autoattribute:: Cartesian3DView.theta
.. automethod:: Cartesian3DView.translate
.. autoattribute:: Cartesian3DView.width
.. automethod:: Cartesian3DView.zoom

.. py:currentmodule:: tecplot.plot

XYLineView
^^^^^^^^^^

.. autoclass:: XYLineView

    **Attributes**

    .. autosummary::
        :nosignatures:

        extents
        magnification

    **Methods**

    .. autosummary::

        adjust_to_nice
        center
        fit
        fit_data
        fit_to_nice
        translate
        zoom

.. automethod:: XYLineView.adjust_to_nice
.. automethod:: XYLineView.center
.. autoattribute:: XYLineView.extents
.. automethod:: XYLineView.fit
.. automethod:: XYLineView.fit_data
.. automethod:: XYLineView.fit_to_nice
.. autoattribute:: XYLineView.magnification
.. automethod:: XYLineView.translate
.. automethod:: XYLineView.zoom

.. py:currentmodule:: tecplot.plot

PolarView
^^^^^^^^^

.. autoclass:: PolarView

    **Attributes**

    .. autosummary::
        :nosignatures:

        extents
        magnification

    **Methods**

    .. autosummary::

        center
        fit
        fit_data
        translate
        zoom

.. automethod:: PolarView.center
.. autoattribute:: PolarView.extents
.. automethod:: PolarView.fit
.. automethod:: PolarView.fit_data
.. autoattribute:: PolarView.magnification
.. automethod:: PolarView.translate
.. automethod:: PolarView.zoom

.. py:currentmodule:: tecplot.plot

LightSource
^^^^^^^^^^^

.. autoclass:: LightSource

    **Attributes**

    .. autosummary::
        :nosignatures:

        background_light
        direction
        force_gouraud_for_contour_flood
        force_paneled_for_cell_flood
        intensity
        specular_intensity
        specular_shininess
        surface_color_contrast

.. autoattribute:: LightSource.background_light
.. autoattribute:: LightSource.direction
.. autoattribute:: LightSource.force_gouraud_for_contour_flood
.. autoattribute:: LightSource.force_paneled_for_cell_flood
.. autoattribute:: LightSource.intensity
.. autoattribute:: LightSource.specular_intensity
.. autoattribute:: LightSource.specular_shininess
.. autoattribute:: LightSource.surface_color_contrast

Frame Linking
-------------

..  contents::
    :local:
    :depth: 1

.. py:currentmodule:: tecplot.plot

SketchPlotLinkingBetweenFrames
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: SketchPlotLinkingBetweenFrames

    **Attributes**

    .. autosummary::
        :nosignatures:

        group
        link_frame_size_and_position
        link_solution_time

.. autoattribute:: SketchPlotLinkingBetweenFrames.group
.. autoattribute:: SketchPlotLinkingBetweenFrames.link_frame_size_and_position
.. autoattribute:: SketchPlotLinkingBetweenFrames.link_solution_time

.. py:currentmodule:: tecplot.plot

Cartesian2DPlotLinkingBetweenFrames
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: Cartesian2DPlotLinkingBetweenFrames

    **Attributes**

    .. autosummary::
        :nosignatures:

        group
        link_axis_position
        link_contour_levels
        link_frame_size_and_position
        link_solution_time
        link_value_blanking
        link_x_axis_range
        link_y_axis_range

.. autoattribute:: Cartesian2DPlotLinkingBetweenFrames.group
.. autoattribute:: Cartesian2DPlotLinkingBetweenFrames.link_axis_position
.. autoattribute:: Cartesian2DPlotLinkingBetweenFrames.link_contour_levels
.. autoattribute:: Cartesian2DPlotLinkingBetweenFrames.link_frame_size_and_position
.. autoattribute:: Cartesian2DPlotLinkingBetweenFrames.link_solution_time
.. autoattribute:: Cartesian2DPlotLinkingBetweenFrames.link_value_blanking
.. autoattribute:: Cartesian2DPlotLinkingBetweenFrames.link_x_axis_range
.. autoattribute:: Cartesian2DPlotLinkingBetweenFrames.link_y_axis_range

.. py:currentmodule:: tecplot.plot

Cartesian3DPlotLinkingBetweenFrames
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: Cartesian3DPlotLinkingBetweenFrames

    **Attributes**

    .. autosummary::
        :nosignatures:

        group
        link_contour_levels
        link_frame_size_and_position
        link_isosurface_values
        link_slice_positions
        link_solution_time
        link_value_blanking
        link_view

.. autoattribute:: Cartesian3DPlotLinkingBetweenFrames.group
.. autoattribute:: Cartesian3DPlotLinkingBetweenFrames.link_contour_levels
.. autoattribute:: Cartesian3DPlotLinkingBetweenFrames.link_frame_size_and_position
.. autoattribute:: Cartesian3DPlotLinkingBetweenFrames.link_isosurface_values
.. autoattribute:: Cartesian3DPlotLinkingBetweenFrames.link_slice_positions
.. autoattribute:: Cartesian3DPlotLinkingBetweenFrames.link_solution_time
.. autoattribute:: Cartesian3DPlotLinkingBetweenFrames.link_value_blanking
.. autoattribute:: Cartesian3DPlotLinkingBetweenFrames.link_view

.. py:currentmodule:: tecplot.plot

XYLinePlotLinkingBetweenFrames
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: XYLinePlotLinkingBetweenFrames

    **Attributes**

    .. autosummary::
        :nosignatures:

        group
        link_axis_position
        link_frame_size_and_position
        link_solution_time
        link_value_blanking
        link_x_axis_range
        link_y_axis_range

.. autoattribute:: XYLinePlotLinkingBetweenFrames.group
.. autoattribute:: XYLinePlotLinkingBetweenFrames.link_axis_position
.. autoattribute:: XYLinePlotLinkingBetweenFrames.link_frame_size_and_position
.. autoattribute:: XYLinePlotLinkingBetweenFrames.link_solution_time
.. autoattribute:: XYLinePlotLinkingBetweenFrames.link_value_blanking
.. autoattribute:: XYLinePlotLinkingBetweenFrames.link_x_axis_range
.. autoattribute:: XYLinePlotLinkingBetweenFrames.link_y_axis_range

.. py:currentmodule:: tecplot.plot

PolarPlotLinkingBetweenFrames
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: PolarPlotLinkingBetweenFrames

    **Attributes**

    .. autosummary::
        :nosignatures:

        group
        link_frame_size_and_position
        link_solution_time
        link_value_blanking
        link_view

.. autoattribute:: PolarPlotLinkingBetweenFrames.group
.. autoattribute:: PolarPlotLinkingBetweenFrames.link_frame_size_and_position
.. autoattribute:: PolarPlotLinkingBetweenFrames.link_solution_time
.. autoattribute:: PolarPlotLinkingBetweenFrames.link_value_blanking
.. autoattribute:: PolarPlotLinkingBetweenFrames.link_view
