Skip to main content
`Ctrl`+`K`

# PColorMeshItem

class pyqtgraph.PColorMeshItem(*args, **kwargs)

  Bases: `GraphicsObject`

  __init__(*args, **kwargs)

    Create a pseudocolor plot with convex polygons.

    Call signature:

    `PColorMeshItem([x, y,] z, **kwargs)`

    x and y can be used to specify the corners of the quadrilaterals. z must be used to specified to color of the quadrilaterals.

    Parameters:

      - x (`numpy.ndarray`, optional, default `None`) – 2D array containing the coordinates of the polygons

      - y (`numpy.ndarray`, optional, default `None`) – 2D array containing the coordinates of the polygons

      - z (`numpy.ndarray`) –

        2D array containing the value which will be mapped into the polygons colors. If x and y is None, the polygons will be displaced on a grid otherwise x and y will be used as polygons vertices coordinates as:

            (x[i+1, j], y[i+1, j])           (x[i+1, j+1], y[i+1, j+1])
                                +---------+
                                | z[i, j] |
                                +---------+
                (x[i, j], y[i, j])           (x[i, j+1], y[i, j+1])

        ”ASCII from: <https://matplotlib.org/3.2.1/api/_as_gen/matplotlib.pyplot.pcolormesh.html>”.

      - colorMap (`pyqtgraph.ColorMap`) – Colormap used to map the z value to colors. default `pyqtgraph.colormap.get('viridis')`

      - levels (`tuple`, optional, default `None`) – Sets the minimum and maximum values to be represented by the colormap (min, max). Values outside this range will be clipped to the colors representing min or max. `None` disables the limits, meaning that the colormap will autoscale the next time `setData()` is called with new data.

      - enableAutoLevels (`bool`, optional, default `True`) – Causes the colormap levels to autoscale whenever `setData()` is called. It is possible to override this value on a per-change-basis by using the `autoLevels` keyword argument when calling `setData()`. If `enableAutoLevels==False` and `levels==None`, autoscaling will be performed once when the first z data is supplied.

      - edgecolors (`dict`, optional) – The color of the edges of the polygons. Default None means no edges. Only cosmetic pens are supported. The dict may contains any arguments accepted by `mkColor()`. Example: `mkPen(color='w', width=2)`

      - antialiasing (`bool`, default `False`) – Whether to draw edgelines with antialiasing. Note that if edgecolors is None, antialiasing is always False.

  getLevels()

    Returns a tuple containing the current level settings. See `setLevels()`. The format is `(low, high)`.

  setData(*args, **kwargs)

    Set the data to be drawn.

    Parameters:

      - x (`numpy.ndarray`, optional, default `None`) – 2D array containing the coordinates of the polygons

      - y (`numpy.ndarray`, optional, default `None`) – 2D array containing the coordinates of the polygons

      - z (`numpy.ndarray`) –

        2D array containing the value which will be mapped into the polygons colors. If x and y is None, the polygons will be displaced on a grid otherwise x and y will be used as polygons vertices coordinates as:

            (x[i+1, j], y[i+1, j])           (x[i+1, j+1], y[i+1, j+1])
                                +---------+
                                | z[i, j] |
                                +---------+
                (x[i, j], y[i, j])           (x[i, j+1], y[i, j+1])

        ”ASCII from: <https://matplotlib.org/3.2.1/api/_as_gen/

          matplotlib.pyplot.pcolormesh.html>”.

      - autoLevels (`bool`, optional) – If set, overrides the value of `enableAutoLevels`

  setLevels(levels, update=True)

    Sets color-scaling levels for the mesh.

    Parameters:

      - levels (`tuple`) – `(low, high)` sets the range for which values can be represented in the colormap.

      - update (`bool`, optional) – Controls if mesh immediately updates to reflect the new color levels.