text: from plotly.basedatatypes import BaseTraceType
  import copy
  
  
  class Heatmapgl(BaseTraceType):
  
      # autocolorscale
      # --------------
      @property
      def autocolorscale(self):
          """
          Determines whether or not the colorscale is picked using the
          sign of the input z values.
      
          The 'autocolorscale' property must be specified as a bool
          (either True, or False)
  
          Returns
          -------
          bool
          """
          return self['autocolorscale']
  
      @autocolorscale.setter
      def autocolorscale(self, val):
          self['autocolorscale'] = val
  
      # colorbar
      # --------
      @property
      def colorbar(self):
          """
          The 'colorbar' property is an instance of ColorBar
          that may be specified as:
            - An instance of plotly.graph_objs.heatmapgl.ColorBar
            - A dict of string/value properties that will be passed
              to the ColorBar constructor
      
              Supported dict properties:
                  
                  bgcolor
                      Sets the color of padded area.
                  bordercolor
                      Sets the axis line color.
                  borderwidth
                      Sets the width (in px) or the border enclosing
                      this color bar.
                  dtick
                      Sets the step in-between ticks on this axis.
                      Use with `tick0`. Must be a positive number, or
                      special strings available to *log* and *date*
                      axes. If the axis `type` is *log*, then ticks
                      are set every 10^(n*dtick) where n is the tick
                      number. For example, to set a tick mark at 1,
                      10, 100, 1000, ... set dtick to 1. To set tick
                      marks at 1, 100, 10000, ... set dtick to 2. To
                      set tick marks at 1, 5, 25, 125, 625, 3125, ...
                      set dtick to log_10(5), or 0.69897000433. *log*
                      has several special values; *L<f>*, where `f`
                      is a positive number, gives ticks linearly
                      spaced in value (but not position). For example
                      `tick0` = 0.1, `dtick` = *L0.5* will put ticks
                      at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10
                      plus small digits between, use *D1* (all
                      digits) or *D2* (only 2 and 5). `tick0` is
                      ignored for *D1* and *D2*. If the axis `type`
                      is *date*, then you must convert the time to
                      milliseconds. For example, to set the interval
                      between ticks to one day, set `dtick` to
                      86400000.0. *date* also has special values
                      *M<n>* gives ticks spaced by a number of
                      months. `n` must be a positive integer. To set
                      ticks on the 15th of every third month, set
                      `tick0` to *2000-01-15* and `dtick` to *M3*. To
                      set ticks every 4 years, set `dtick` to *M48*
                  exponentformat
                      Determines a formatting rule for the tick
                      exponents. For example, consider the number
                      1,000,000,000. If *none*, it appears as
                      1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If
                      *power*, 1x10^9 (with 9 in a super script). If
                      *SI*, 1G. If *B*, 1B.
                  len
                      Sets the length of the color bar This measure
                      excludes the padding of both ends. That is, the
                      color bar length is this length minus the
                      padding on both ends.
                  lenmode
                      Determines whether this color bar's length
                      (i.e. the measure in the color variation
                      direction) is set in units of plot *fraction*
                      or in *pixels. Use `len` to set the value.
                  nticks
                      Specifies the maximum number of ticks for the
                      particular axis. The actual number of ticks
                      will be chosen automatically to be less than or
                      equal to `nticks`. Has an effect only if
                      `tickmode` is set to *auto*.
                  outlinecolor
                      Sets the axis line color.
                  outlinewidth
                      Sets the width (in px) of the axis line.
                  separatethousands
                      If "true", even 4-digit integers are separated
                  showexponent
                      If *all*, all exponents are shown besides their
                      significands. If *first*, only the exponent of
                      the first tick is shown. If *last*, only the
                      exponent of the last tick is shown. If *none*,
                      no exponents appear.
                  showticklabels
                      Determines whether or not the tick labels are
                      drawn.
                  showtickprefix
                      If *all*, all tick labels are displayed with a
                      prefix. If *first*, only the first tick is
                      displayed with a prefix. If *last*, only the
                      last tick is displayed with a suffix. If
                      *none*, tick prefixes are hidden.
                  showticksuffix
                      Same as `showtickprefix` but for tick suffixes.
                  thickness
                      Sets the thickness of the color bar This
                      measure excludes the size of the padding, ticks
                      and labels.
                  thicknessmode
                      Determines whether this color bar's thickness
                      (i.e. the measure in the constant color
                      direction) is set in units of plot *fraction*
                      or in *pixels*. Use `thickness` to set the
                      value.
                  tick0
                      Sets the placement of the first tick on this
                      axis. Use with `dtick`. If the axis `type` is
                      *log*, then you must take the log of your
                      starting tick (e.g. to set the starting tick to
                      100, set the `tick0` to 2) except when
                      `dtick`=*L<f>* (see `dtick` for more info). If
                      the axis `type` is *date*, it should be a date
                      string, like date data. If the axis `type` is
                      *category*, it should be a number, using the
                      scale where each category is assigned a serial
                      number from zero in the order it appears.
                  tickangle
                      Sets the angle of the tick labels with respect
                      to the horizontal. For example, a `tickangle`
                      of -90 draws the tick labels vertically.
                  tickcolor
                      Sets the tick color.
                  tickfont
                      Sets the color bar's tick label font
                  tickformat
                      Sets the tick label formatting rule using d3
                      formatting mini-languages which are very
                      similar to those in Python. For numbers, see: h
                      ttps://github.com/d3/d3-format/blob/master/READ
                      ME.md#locale_format And for dates see:
                      https://github.com/d3/d3-time-
                      format/blob/master/README.md#locale_format We
                      add one item to d3's date formatter: *%{n}f*
                      for fractional seconds with n digits. For
                      example, *2016-10-13 09:15:23.456* with
                      tickformat *%H~%M~%S.%2f* would display
                      *09~15~23.46*
                  tickformatstops
                      plotly.graph_objs.heatmapgl.colorbar.Tickformat
                      stop instance or dict with compatible
                      properties
                  ticklen
                      Sets the tick length (in px).
                  tickmode
                      Sets the tick mode for this axis. If *auto*,
                      the number of ticks is set via `nticks`. If
                      *linear*, the placement of the ticks is
                      determined by a starting position `tick0` and a
                      tick step `dtick` (*linear* is the default
                      value if `tick0` and `dtick` are provided). If
                      *array*, the placement of the ticks is set via
                      `tickvals` and the tick text is `ticktext`.
                      (*array* is the default value if `tickvals` is
                      provided).
                  tickprefix
                      Sets a tick label prefix.
                  ticks
                      Determines whether ticks are drawn or not. If
                      **, this axis' ticks are not drawn. If
                      *outside* (*inside*), this axis' are drawn
                      outside (inside) the axis lines.
                  ticksuffix
                      Sets a tick label suffix.
                  ticktext
                      Sets the text displayed at the ticks position
                      via `tickvals`. Only has an effect if
                      `tickmode` is set to *array*. Used with
                      `tickvals`.
                  ticktextsrc
                      Sets the source reference on plot.ly for
                      ticktext .
                  tickvals
                      Sets the values at which ticks on this axis
                      appear. Only has an effect if `tickmode` is set
                      to *array*. Used with `ticktext`.
                  tickvalssrc
                      Sets the source reference on plot.ly for
                      tickvals .
                  tickwidth
                      Sets the tick width (in px).
                  title
                      Sets the title of the color bar.
                  titlefont
                      Sets this color bar's title font.
                  titleside
                      Determines the location of the colorbar title
                      with respect to the color bar.
                  x
                      Sets the x position of the color bar (in plot
                      fraction).
                  xanchor
                      Sets this color bar's horizontal position
                      anchor. This anchor binds the `x` position to
                      the *left*, *center* or *right* of the color
                      bar.
                  xpad
                      Sets the amount of padding (in px) along the x
                      direction.
                  y
                      Sets the y position of the color bar (in plot
                      fraction).
                  yanchor
                      Sets this color bar's vertical position anchor
                      This anchor binds the `y` position to the
                      *top*, *middle* or *bottom* of the color bar.
                  ypad
                      Sets the amount of padding (in px) along the y
                      direction.
  
          Returns
          -------
          plotly.graph_objs.heatmapgl.ColorBar
          """
          return self['colorbar']
  
      @colorbar.setter
      def colorbar(self, val):
          self['colorbar'] = val
  
      # colorscale
      # ----------
      @property
      def colorscale(self):
          """
          Sets the colorscale. The colorscale must be an array containing
          arrays mapping a normalized value to an rgb, rgba, hex, hsl,
          hsv, or named color string. At minimum, a mapping for the
          lowest (0) and highest (1) values are required. For example,
          `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the
          bounds of the colorscale in z space, use zmin and zmax
      
          The 'colorscale' property is a colorscale and may be
          specified as:
            - A list of 2-element lists where the first element is the
              normalized color level value (starting at 0 and ending at 1), 
              and the second item is a valid color string.
              (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']])
            - One of the following named colorscales:
                  ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu',
                  'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet',
                  'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis']
  
          Returns
          -------
          str
          """
          return self['colorscale']
  
      @colorscale.setter
      def colorscale(self, val):
          self['colorscale'] = val
  
      # customdata
      # ----------
      @property
      def customdata(self):
          """
          Assigns extra data each datum. This may be useful when
          listening to hover, click and selection events. Note that,
          *scatter* traces also appends customdata items in the markers
          DOM elements
      
          The 'customdata' property is an array that may be specified as a tuple,
          list, numpy array, or pandas Series
  
          Returns
          -------
          numpy.ndarray
          """
          return self['customdata']
  
      @customdata.setter
      def customdata(self, val):
          self['customdata'] = val
  
      # customdatasrc
      # -------------
      @property
      def customdatasrc(self):
          """
          Sets the source reference on plot.ly for  customdata .
      
          The 'customdatasrc' property must be specified as a string or
          as a plotly.grid_objs.Column object
  
          Returns
          -------
          str
          """
          return self['customdatasrc']
  
      @customdatasrc.setter
      def customdatasrc(self, val):
          self['customdatasrc'] = val
  
      # dx
      # --
      @property
      def dx(self):
          """
          Sets the x coordinate step. See `x0` for more info.
      
          The 'dx' property is a number and may be specified as:
            - An int or float
  
          Returns
          -------
          int|float
          """
          return self['dx']
  
      @dx.setter
      def dx(self, val):
          self['dx'] = val
  
      # dy
      # --
      @property
      def dy(self):
          """
          Sets the y coordinate step. See `y0` for more info.
      
          The 'dy' property is a number and may be specified as:
            - An int or float
  
          Returns
          -------
          int|float
          """
          return self['dy']
  
      @dy.setter
      def dy(self, val):
          self['dy'] = val
  
      # hoverinfo
      # ---------
      @property
      def hoverinfo(self):
          """
          Determines which trace information appear on hover. If `none`
          or `skip` are set, no information is displayed upon hovering.
          But, if `none` is set, click and hover events are still fired.
      
          The 'hoverinfo' property is a flaglist and may be specified
          as a string containing:
            - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters
              (e.g. 'x+y')
              OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip')
            - A list or array of the above
  
          Returns
          -------
          Any|numpy.ndarray
          """
          return self['hoverinfo']
  
      @hoverinfo.setter
      def hoverinfo(self, val):
          self['hoverinfo'] = val
  
      # hoverinfosrc
      # ------------
      @property
      def hoverinfosrc(self):
          """
          Sets the source reference on plot.ly for  hoverinfo .
      
          The 'hoverinfosrc' property must be specified as a string or
          as a plotly.grid_objs.Column object
  
          Returns
          -------
          str
          """
          return self['hoverinfosrc']
  
      @hoverinfosrc.setter
      def hoverinfosrc(self, val):
          self['hoverinfosrc'] = val
  
      # hoverlabel
      # ----------
      @property
      def hoverlabel(self):
          """
          The 'hoverlabel' property is an instance of Hoverlabel
          that may be specified as:
            - An instance of plotly.graph_objs.heatmapgl.Hoverlabel
            - A dict of string/value properties that will be passed
              to the Hoverlabel constructor
      
              Supported dict properties:
                  
                  bgcolor
                      Sets the background color of the hover labels
                      for this trace
                  bgcolorsrc
                      Sets the source reference on plot.ly for
                      bgcolor .
                  bordercolor
                      Sets the border color of the hover labels for
                      this trace.
                  bordercolorsrc
                      Sets the source reference on plot.ly for
                      bordercolor .
                  font
                      Sets the font used in hover labels.
                  namelength
                      Sets the length (in number of characters) of
                      the trace name in the hover labels for this
                      trace. -1 shows the whole name regardless of
                      length. 0-3 shows the first 0-3 characters, and
                      an integer >3 will show the whole name if it is
                      less than that many characters, but if it is
                      longer, will truncate to `namelength - 3`
                      characters and add an ellipsis.
                  namelengthsrc
                      Sets the source reference on plot.ly for
                      namelength .
  
          Returns
          -------
          plotly.graph_objs.heatmapgl.Hoverlabel
          """
          return self['hoverlabel']
  
      @hoverlabel.setter
      def hoverlabel(self, val):
          self['hoverlabel'] = val
  
      # ids
      # ---
      @property
      def ids(self):
          """
          Assigns id labels to each datum. These ids for object constancy
          of data points during animation. Should be an array of strings,
          not numbers or any other type.
      
          The 'ids' property is an array that may be specified as a tuple,
          list, numpy array, or pandas Series
  
          Returns
          -------
          numpy.ndarray
          """
          return self['ids']
  
      @ids.setter
      def ids(self, val):
          self['ids'] = val
  
      # idssrc
      # ------
      @property
      def idssrc(self):
          """
          Sets the source reference on plot.ly for  ids .
      
          The 'idssrc' property must be specified as a string or
          as a plotly.grid_objs.Column object
  
          Returns
          -------
          str
          """
          return self['idssrc']
  
      @idssrc.setter
      def idssrc(self, val):
          self['idssrc'] = val
  
      # legendgroup
      # -----------
      @property
      def legendgroup(self):
          """
          Sets the legend group for this trace. Traces part of the same
          legend group hide/show at the same time when toggling legend
          items.
      
          The 'legendgroup' property is a string and must be specified as:
            - A string
            - A number that will be converted to a string
  
          Returns
          -------
          str
          """
          return self['legendgroup']
  
      @legendgroup.setter
      def legendgroup(self, val):
          self['legendgroup'] = val
  
      # name
      # ----
      @property
      def name(self):
          """
          Sets the trace name. The trace name appear as the legend item
          and on hover.
      
          The 'name' property is a string and must be specified as:
            - A string
            - A number that will be converted to a string
  
          Returns
          -------
          str
          """
          return self['name']
  
      @name.setter
      def name(self, val):
          self['name'] = val
  
      # opacity
      # -------
      @property
      def opacity(self):
          """
          Sets the opacity of the trace.
      
          The 'opacity' property is a number and may be specified as:
            - An int or float in the interval [0, 1]
  
          Returns
          -------
          int|float
          """
          return self['opacity']
  
      @opacity.setter
      def opacity(self, val):
          self['opacity'] = val
  
      # reversescale
      # ------------
      @property
      def reversescale(self):
          """
          Reverses the colorscale.
      
          The 'reversescale' property must be specified as a bool
          (either True, or False)
  
          Returns
          -------
          bool
          """
          return self['reversescale']
  
      @reversescale.setter
      def reversescale(self, val):
          self['reversescale'] = val
  
      # selectedpoints
      # --------------
      @property
      def selectedpoints(self):
          """
          Array containing integer indices of selected points. Has an
          effect only for traces that support selections. Note that an
          empty array means an empty selection where the `unselected` are
          turned on for all points, whereas, any other non-array values
          means no selection all where the `selected` and `unselected`
          styles have no effect.
      
          The 'selectedpoints' property accepts values of any type
  
          Returns
          -------
          Any
          """
          return self['selectedpoints']
  
      @selectedpoints.setter
      def selectedpoints(self, val):
          self['selectedpoints'] = val
  
      # showlegend
      # ----------
      @property
      def showlegend(self):
          """
          Determines whether or not an item corresponding to this trace
          is shown in the legend.
      
          The 'showlegend' property must be specified as a bool
          (either True, or False)
  
          Returns
          -------
          bool
          """
          return self['showlegend']
  
      @showlegend.setter
      def showlegend(self, val):
          self['showlegend'] = val
  
      # showscale
      # ---------
      @property
      def showscale(self):
          """
          Determines whether or not a colorbar is displayed for this
          trace.
      
          The 'showscale' property must be specified as a bool
          (either True, or False)
  
          Returns
          -------
          bool
          """
          return self['showscale']
  
      @showscale.setter
      def showscale(self, val):
          self['showscale'] = val
  
      # stream
      # ------
      @property
      def stream(self):
          """
          The 'stream' property is an instance of Stream
          that may be specified as:
            - An instance of plotly.graph_objs.heatmapgl.Stream
            - A dict of string/value properties that will be passed
              to the Stream constructor
      
              Supported dict properties:
                  
                  maxpoints
                      Sets the maximum number of points to keep on
                      the plots from an incoming stream. If
                      `maxpoints` is set to *50*, only the newest 50
                      points will be displayed on the plot.
                  token
                      The stream id number links a data trace on a
                      plot with a stream. See
                      https://plot.ly/settings for more details.
  
          Returns
          -------
          plotly.graph_objs.heatmapgl.Stream
          """
          return self['stream']
  
      @stream.setter
      def stream(self, val):
          self['stream'] = val
  
      # text
      # ----
      @property
      def text(self):
          """
          Sets the text elements associated with each z value.
      
          The 'text' property is an array that may be specified as a tuple,
          list, numpy array, or pandas Series
  
          Returns
          -------
          numpy.ndarray
          """
          return self['text']
  
      @text.setter
      def text(self, val):
          self['text'] = val
  
      # textsrc
      # -------
      @property
      def textsrc(self):
          """
          Sets the source reference on plot.ly for  text .
      
          The 'textsrc' property must be specified as a string or
          as a plotly.grid_objs.Column object
  
          Returns
          -------
          str
          """
          return self['textsrc']
  
      @textsrc.setter
      def textsrc(self, val):
          self['textsrc'] = val
  
      # transpose
      # ---------
      @property
      def transpose(self):
          """
          Transposes the z data.
      
          The 'transpose' property must be specified as a bool
          (either True, or False)
  
          Returns
          -------
          bool
          """
          return self['transpose']
  
      @transpose.setter
      def transpose(self, val):
          self['transpose'] = val
  
      # uid
      # ---
      @property
      def uid(self):
          """
          The 'uid' property is a string and must be specified as:
            - A string
            - A number that will be converted to a string
  
          Returns
          -------
          str
          """
          return self['uid']
  
      @uid.setter
      def uid(self, val):
          self['uid'] = val
  
      # visible
      # -------
      @property
      def visible(self):
          """
          Determines whether or not this trace is visible. If
          *legendonly*, the trace is not drawn, but can appear as a
          legend item (provided that the legend itself is visible).
      
          The 'visible' property is an enumeration that may be specified as:
            - One of the following enumeration values:
                  [True, False, 'legendonly']
  
          Returns
          -------
          Any
          """
          return self['visible']
  
      @visible.setter
      def visible(self, val):
          self['visible'] = val
  
      # x
      # -
      @property
      def x(self):
          """
          Sets the x coordinates.
      
          The 'x' property is an array that may be specified as a tuple,
          list, numpy array, or pandas Series
  
          Returns
          -------
          numpy.ndarray
          """
          return self['x']
  
      @x.setter
      def x(self, val):
          self['x'] = val
  
      # x0
      # --
      @property
      def x0(self):
          """
          Alternate to `x`. Builds a linear space of x coordinates. Use
          with `dx` where `x0` is the starting coordinate and `dx` the
          step.
      
          The 'x0' property accepts values of any type
  
          Returns
          -------
          Any
          """
          return self['x0']
  
      @x0.setter
      def x0(self, val):
          self['x0'] = val
  
      # xaxis
      # -----
      @property
      def xaxis(self):
          """
          Sets a reference between this trace's x coordinates and a 2D
          cartesian x axis. If *x* (the default value), the x coordinates
          refer to `layout.xaxis`. If *x2*, the x coordinates refer to
          `layout.xaxis2`, and so on.
      
          The 'xaxis' property is an identifier of a particular
          subplot, of type 'x', that may be specified as the string 'x'
          optionally followed by an integer >= 1
          (e.g. 'x', 'x1', 'x2', 'x3', etc.)
  
          Returns
          -------
          str
          """
          return self['xaxis']
  
      @xaxis.setter
      def xaxis(self, val):
          self['xaxis'] = val
  
      # xsrc
      # ----
      @property
      def xsrc(self):
          """
          Sets the source reference on plot.ly for  x .
      
          The 'xsrc' property must be specified as a string or
          as a plotly.grid_objs.Column object
  
          Returns
          -------
          str
          """
          return self['xsrc']
  
      @xsrc.setter
      def xsrc(self, val):
          self['xsrc'] = val
  
      # xtype
      # -----
      @property
      def xtype(self):
          """
          If *array*, the heatmap's x coordinates are given by *x* (the
          default behavior when `x` is provided). If *scaled*, the
          heatmap's x coordinates are given by *x0* and *dx* (the default
          behavior when `x` is not provided).
      
          The 'xtype' property is an enumeration that may be specified as:
            - One of the following enumeration values:
                  ['array', 'scaled']
  
          Returns
          -------
          Any
          """
          return self['xtype']
  
      @xtype.setter
      def xtype(self, val):
          self['xtype'] = val
  
      # y
      # -
      @property
      def y(self):
          """
          Sets the y coordinates.
      
          The 'y' property is an array that may be specified as a tuple,
          list, numpy array, or pandas Series
  
          Returns
          -------
          numpy.ndarray
          """
          return self['y']
  
      @y.setter
      def y(self, val):
          self['y'] = val
  
      # y0
      # --
      @property
      def y0(self):
          """
          Alternate to `y`. Builds a linear space of y coordinates. Use
          with `dy` where `y0` is the starting coordinate and `dy` the
          step.
      
          The 'y0' property accepts values of any type
  
          Returns
          -------
          Any
          """
          return self['y0']
  
      @y0.setter
      def y0(self, val):
          self['y0'] = val
  
      # yaxis
      # -----
      @property
      def yaxis(self):
          """
          Sets a reference between this trace's y coordinates and a 2D
          cartesian y axis. If *y* (the default value), the y coordinates
          refer to `layout.yaxis`. If *y2*, the y coordinates refer to
          `layout.yaxis2`, and so on.
      
          The 'yaxis' property is an identifier of a particular
          subplot, of type 'y', that may be specified as the string 'y'
          optionally followed by an integer >= 1
          (e.g. 'y', 'y1', 'y2', 'y3', etc.)
  
          Returns
          -------
          str
          """
          return self['yaxis']
  
      @yaxis.setter
      def yaxis(self, val):
          self['yaxis'] = val
  
      # ysrc
      # ----
      @property
      def ysrc(self):
          """
          Sets the source reference on plot.ly for  y .
      
          The 'ysrc' property must be specified as a string or
          as a plotly.grid_objs.Column object
  
          Returns
          -------
          str
          """
          return self['ysrc']
  
      @ysrc.setter
      def ysrc(self, val):
          self['ysrc'] = val
  
      # ytype
      # -----
      @property
      def ytype(self):
          """
          If *array*, the heatmap's y coordinates are given by *y* (the
          default behavior when `y` is provided) If *scaled*, the
          heatmap's y coordinates are given by *y0* and *dy* (the default
          behavior when `y` is not provided)
      
          The 'ytype' property is an enumeration that may be specified as:
            - One of the following enumeration values:
                  ['array', 'scaled']
  
          Returns
          -------
          Any
          """
          return self['ytype']
  
      @ytype.setter
      def ytype(self, val):
          self['ytype'] = val
  
      # z
      # -
      @property
      def z(self):
          """
          Sets the z data.
      
          The 'z' property is an array that may be specified as a tuple,
          list, numpy array, or pandas Series
  
          Returns
          -------
          numpy.ndarray
          """
          return self['z']
  
      @z.setter
      def z(self, val):
          self['z'] = val
  
      # zauto
      # -----
      @property
      def zauto(self):
          """
          Determines the whether or not the color domain is computed with
          respect to the input data.
      
          The 'zauto' property must be specified as a bool
          (either True, or False)
  
          Returns
          -------
          bool
          """
          return self['zauto']
  
      @zauto.setter
      def zauto(self, val):
          self['zauto'] = val
  
      # zmax
      # ----
      @property
      def zmax(self):
          """
          Sets the upper bound of color domain.
      
          The 'zmax' property is a number and may be specified as:
            - An int or float
  
          Returns
          -------
          int|float
          """
          return self['zmax']
  
      @zmax.setter
      def zmax(self, val):
          self['zmax'] = val
  
      # zmin
      # ----
      @property
      def zmin(self):
          """
          Sets the lower bound of color domain.
      
          The 'zmin' property is a number and may be specified as:
            - An int or float
  
          Returns
          -------
          int|float
          """
          return self['zmin']
  
      @zmin.setter
      def zmin(self, val):
          self['zmin'] = val
  
      # zsrc
      # ----
      @property
      def zsrc(self):
          """
          Sets the source reference on plot.ly for  z .
      
          The 'zsrc' property must be specified as a string or
          as a plotly.grid_objs.Column object
  
          Returns
          -------
          str
          """
          return self['zsrc']
  
      @zsrc.setter
      def zsrc(self, val):
          self['zsrc'] = val
  
      # type
      # ----
      @property
      def type(self):
          return self._props['type']
  
      # property parent name
      # --------------------
      @property
      def _parent_path_str(self):
          return ''
  
      # Self properties description
      # ---------------------------
      @property
      def _prop_descriptions(self):
          return """\
          autocolorscale
              Determines whether or not the colorscale is picked
              using the sign of the input z values.
          colorbar
              plotly.graph_objs.heatmapgl.ColorBar instance or dict
              with compatible properties
          colorscale
              Sets the colorscale. The colorscale must be an array
              containing arrays mapping a normalized value to an rgb,
              rgba, hex, hsl, hsv, or named color string. At minimum,
              a mapping for the lowest (0) and highest (1) values are
              required. For example, `[[0, 'rgb(0,0,255)', [1,
              'rgb(255,0,0)']]`. To control the bounds of the
              colorscale in z space, use zmin and zmax
          customdata
              Assigns extra data each datum. This may be useful when
              listening to hover, click and selection events. Note
              that, *scatter* traces also appends customdata items in
              the markers DOM elements
          customdatasrc
              Sets the source reference on plot.ly for  customdata .
          dx
              Sets the x coordinate step. See `x0` for more info.
          dy
              Sets the y coordinate step. See `y0` for more info.
          hoverinfo
              Determines which trace information appear on hover. If
              `none` or `skip` are set, no information is displayed
              upon hovering. But, if `none` is set, click and hover
              events are still fired.
          hoverinfosrc
              Sets the source reference on plot.ly for  hoverinfo .
          hoverlabel
              plotly.graph_objs.heatmapgl.Hoverlabel instance or dict
              with compatible properties
          ids
              Assigns id labels to each datum. These ids for object
              constancy of data points during animation. Should be an
              array of strings, not numbers or any other type.
          idssrc
              Sets the source reference on plot.ly for  ids .
          legendgroup
              Sets the legend group for this trace. Traces part of
              the same legend group hide/show at the same time when
              toggling legend items.
          name
              Sets the trace name. The trace name appear as the
              legend item and on hover.
          opacity
              Sets the opacity of the trace.
          reversescale
              Reverses the colorscale.
          selectedpoints
              Array containing integer indices of selected points.
              Has an effect only for traces that support selections.
              Note that an empty array means an empty selection where
              the `unselected` are turned on for all points, whereas,
              any other non-array values means no selection all where
              the `selected` and `unselected` styles have no effect.
          showlegend
              Determines whether or not an item corresponding to this
              trace is shown in the legend.
          showscale
              Determines whether or not a colorbar is displayed for
              this trace.
          stream
              plotly.graph_objs.heatmapgl.Stream instance or dict
              with compatible properties
          text
              Sets the text elements associated with each z value.
          textsrc
              Sets the source reference on plot.ly for  text .
          transpose
              Transposes the z data.
          uid
  
          visible
              Determines whether or not this trace is visible. If
              *legendonly*, the trace is not drawn, but can appear as
              a legend item (provided that the legend itself is
              visible).
          x
              Sets the x coordinates.
          x0
              Alternate to `x`. Builds a linear space of x
              coordinates. Use with `dx` where `x0` is the starting
              coordinate and `dx` the step.
          xaxis
              Sets a reference between this trace's x coordinates and
              a 2D cartesian x axis. If *x* (the default value), the
              x coordinates refer to `layout.xaxis`. If *x2*, the x
              coordinates refer to `layout.xaxis2`, and so on.
          xsrc
              Sets the source reference on plot.ly for  x .
          xtype
              If *array*, the heatmap's x coordinates are given by
              *x* (the default behavior when `x` is provided). If
              *scaled*, the heatmap's x coordinates are given by *x0*
              and *dx* (the default behavior when `x` is not
              provided).
          y
              Sets the y coordinates.
          y0
              Alternate to `y`. Builds a linear space of y
              coordinates. Use with `dy` where `y0` is the starting
              coordinate and `dy` the step.
          yaxis
              Sets a reference between this trace's y coordinates and
              a 2D cartesian y axis. If *y* (the default value), the
              y coordinates refer to `layout.yaxis`. If *y2*, the y
              coordinates refer to `layout.yaxis2`, and so on.
          ysrc
              Sets the source reference on plot.ly for  y .
          ytype
              If *array*, the heatmap's y coordinates are given by
              *y* (the default behavior when `y` is provided) If
              *scaled*, the heatmap's y coordinates are given by *y0*
              and *dy* (the default behavior when `y` is not
              provided)
          z
              Sets the z data.
          zauto
              Determines the whether or not the color domain is
              computed with respect to the input data.
          zmax
              Sets the upper bound of color domain.
          zmin
              Sets the lower bound of color domain.
          zsrc
              Sets the source reference on plot.ly for  z .
          """
  
      def __init__(
          self,
          arg=None,
          autocolorscale=None,
          colorbar=None,
          colorscale=None,
          customdata=None,
          customdatasrc=None,
          dx=None,
          dy=None,
          hoverinfo=None,
          hoverinfosrc=None,
          hoverlabel=None,
          ids=None,
          idssrc=None,
          legendgroup=None,
          name=None,
          opacity=None,
          reversescale=None,
          selectedpoints=None,
          showlegend=None,
          showscale=None,
          stream=None,
          text=None,
          textsrc=None,
          transpose=None,
          uid=None,
          visible=None,
          x=None,
          x0=None,
          xaxis=None,
          xsrc=None,
          xtype=None,
          y=None,
          y0=None,
          yaxis=None,
          ysrc=None,
          ytype=None,
          z=None,
          zauto=None,
          zmax=None,
          zmin=None,
          zsrc=None,
          **kwargs
      ):
          """
          Construct a new Heatmapgl object
          
          WebGL version of the heatmap trace type.
  
          Parameters
          ----------
          arg
              dict of properties compatible with this constructor or
              an instance of plotly.graph_objs.Heatmapgl
          autocolorscale
              Determines whether or not the colorscale is picked
              using the sign of the input z values.
          colorbar
              plotly.graph_objs.heatmapgl.ColorBar instance or dict
              with compatible properties
          colorscale
              Sets the colorscale. The colorscale must be an array
              containing arrays mapping a normalized value to an rgb,
              rgba, hex, hsl, hsv, or named color string. At minimum,
              a mapping for the lowest (0) and highest (1) values are
              required. For example, `[[0, 'rgb(0,0,255)', [1,
              'rgb(255,0,0)']]`. To control the bounds of the
              colorscale in z space, use zmin and zmax
          customdata
              Assigns extra data each datum. This may be useful when
              listening to hover, click and selection events. Note
              that, *scatter* traces also appends customdata items in
              the markers DOM elements
          customdatasrc
              Sets the source reference on plot.ly for  customdata .
          dx
              Sets the x coordinate step. See `x0` for more info.
          dy
              Sets the y coordinate step. See `y0` for more info.
          hoverinfo
              Determines which trace information appear on hover. If
              `none` or `skip` are set, no information is displayed
              upon hovering. But, if `none` is set, click and hover
              events are still fired.
          hoverinfosrc
              Sets the source reference on plot.ly for  hoverinfo .
          hoverlabel
              plotly.graph_objs.heatmapgl.Hoverlabel instance or dict
              with compatible properties
          ids
              Assigns id labels to each datum. These ids for object
              constancy of data points during animation. Should be an
              array of strings, not numbers or any other type.
          idssrc
              Sets the source reference on plot.ly for  ids .
          legendgroup
              Sets the legend group for this trace. Traces part of
              the same legend group hide/show at the same time when
              toggling legend items.
          name
              Sets the trace name. The trace name appear as the
              legend item and on hover.
          opacity
              Sets the opacity of the trace.
          reversescale
              Reverses the colorscale.
          selectedpoints
              Array containing integer indices of selected points.
              Has an effect only for traces that support selections.
              Note that an empty array means an empty selection where
              the `unselected` are turned on for all points, whereas,
              any other non-array values means no selection all where
              the `selected` and `unselected` styles have no effect.
          showlegend
              Determines whether or not an item corresponding to this
              trace is shown in the legend.
          showscale
              Determines whether or not a colorbar is displayed for
              this trace.
          stream
              plotly.graph_objs.heatmapgl.Stream instance or dict
              with compatible properties
          text
              Sets the text elements associated with each z value.
          textsrc
              Sets the source reference on plot.ly for  text .
          transpose
              Transposes the z data.
          uid
  
          visible
              Determines whether or not this trace is visible. If
              *legendonly*, the trace is not drawn, but can appear as
              a legend item (provided that the legend itself is
              visible).
          x
              Sets the x coordinates.
          x0
              Alternate to `x`. Builds a linear space of x
              coordinates. Use with `dx` where `x0` is the starting
              coordinate and `dx` the step.
          xaxis
              Sets a reference between this trace's x coordinates and
              a 2D cartesian x axis. If *x* (the default value), the
              x coordinates refer to `layout.xaxis`. If *x2*, the x
              coordinates refer to `layout.xaxis2`, and so on.
          xsrc
              Sets the source reference on plot.ly for  x .
          xtype
              If *array*, the heatmap's x coordinates are given by
              *x* (the default behavior when `x` is provided). If
              *scaled*, the heatmap's x coordinates are given by *x0*
              and *dx* (the default behavior when `x` is not
              provided).
          y
              Sets the y coordinates.
          y0
              Alternate to `y`. Builds a linear space of y
              coordinates. Use with `dy` where `y0` is the starting
              coordinate and `dy` the step.
          yaxis
              Sets a reference between this trace's y coordinates and
              a 2D cartesian y axis. If *y* (the default value), the
              y coordinates refer to `layout.yaxis`. If *y2*, the y
              coordinates refer to `layout.yaxis2`, and so on.
          ysrc
              Sets the source reference on plot.ly for  y .
          ytype
              If *array*, the heatmap's y coordinates are given by
              *y* (the default behavior when `y` is provided) If
              *scaled*, the heatmap's y coordinates are given by *y0*
              and *dy* (the default behavior when `y` is not
              provided)
          z
              Sets the z data.
          zauto
              Determines the whether or not the color domain is
              computed with respect to the input data.
          zmax
              Sets the upper bound of color domain.
          zmin
              Sets the lower bound of color domain.
          zsrc
              Sets the source reference on plot.ly for  z .
  
          Returns
          -------
          Heatmapgl
          """
          super(Heatmapgl, self).__init__('heatmapgl')
  
          # Validate arg
          # ------------
          if arg is None:
              arg = {}
          elif isinstance(arg, self.__class__):
              arg = arg.to_plotly_json()
          elif isinstance(arg, dict):
              arg = copy.copy(arg)
          else:
              raise ValueError(
                  """\
  The first argument to the plotly.graph_objs.Heatmapgl 
  constructor must be a dict or 
  an instance of plotly.graph_objs.Heatmapgl"""
              )
  
          # Import validators
          # -----------------
          from plotly.validators import (heatmapgl as v_heatmapgl)
  
          # Initialize validators
          # ---------------------
          self._validators['autocolorscale'
                          ] = v_heatmapgl.AutocolorscaleValidator()
          self._validators['colorbar'] = v_heatmapgl.ColorBarValidator()
          self._validators['colorscale'] = v_heatmapgl.ColorscaleValidator()
          self._validators['customdata'] = v_heatmapgl.CustomdataValidator()
          self._validators['customdatasrc'
                          ] = v_heatmapgl.CustomdatasrcValidator()
          self._validators['dx'] = v_heatmapgl.DxValidator()
          self._validators['dy'] = v_heatmapgl.DyValidator()
          self._validators['hoverinfo'] = v_heatmapgl.HoverinfoValidator()
          self._validators['hoverinfosrc'] = v_heatmapgl.HoverinfosrcValidator()
          self._validators['hoverlabel'] = v_heatmapgl.HoverlabelValidator()
          self._validators['ids'] = v_heatmapgl.IdsValidator()
          self._validators['idssrc'] = v_heatmapgl.IdssrcValidator()
          self._validators['legendgroup'] = v_heatmapgl.LegendgroupValidator()
          self._validators['name'] = v_heatmapgl.NameValidator()
          self._validators['opacity'] = v_heatmapgl.OpacityValidator()
          self._validators['reversescale'] = v_heatmapgl.ReversescaleValidator()
          self._validators['selectedpoints'
                          ] = v_heatmapgl.SelectedpointsValidator()
          self._validators['showlegend'] = v_heatmapgl.ShowlegendValidator()
          self._validators['showscale'] = v_heatmapgl.ShowscaleValidator()
          self._validators['stream'] = v_heatmapgl.StreamValidator()
          self._validators['text'] = v_heatmapgl.TextValidator()
          self._validators['textsrc'] = v_heatmapgl.TextsrcValidator()
          self._validators['transpose'] = v_heatmapgl.TransposeValidator()
          self._validators['uid'] = v_heatmapgl.UidValidator()
          self._validators['visible'] = v_heatmapgl.VisibleValidator()
          self._validators['x'] = v_heatmapgl.XValidator()
          self._validators['x0'] = v_heatmapgl.X0Validator()
          self._validators['xaxis'] = v_heatmapgl.XAxisValidator()
          self._validators['xsrc'] = v_heatmapgl.XsrcValidator()
          self._validators['xtype'] = v_heatmapgl.XtypeValidator()
          self._validators['y'] = v_heatmapgl.YValidator()
          self._validators['y0'] = v_heatmapgl.Y0Validator()
          self._validators['yaxis'] = v_heatmapgl.YAxisValidator()
          self._validators['ysrc'] = v_heatmapgl.YsrcValidator()
          self._validators['ytype'] = v_heatmapgl.YtypeValidator()
          self._validators['z'] = v_heatmapgl.ZValidator()
          self._validators['zauto'] = v_heatmapgl.ZautoValidator()
          self._validators['zmax'] = v_heatmapgl.ZmaxValidator()
          self._validators['zmin'] = v_heatmapgl.ZminValidator()
          self._validators['zsrc'] = v_heatmapgl.ZsrcValidator()
  
          # Populate data dict with properties
          # ----------------------------------
          v = arg.pop('autocolorscale', None)
          self.autocolorscale = autocolorscale if autocolorscale is not None else v
          v = arg.pop('colorbar', None)
          self.colorbar = colorbar if colorbar is not None else v
          v = arg.pop('colorscale', None)
          self.colorscale = colorscale if colorscale is not None else v
          v = arg.pop('customdata', None)
          self.customdata = customdata if customdata is not None else v
          v = arg.pop('customdatasrc', None)
          self.customdatasrc = customdatasrc if customdatasrc is not None else v
          v = arg.pop('dx', None)
          self.dx = dx if dx is not None else v
          v = arg.pop('dy', None)
          self.dy = dy if dy is not None else v
          v = arg.pop('hoverinfo', None)
          self.hoverinfo = hoverinfo if hoverinfo is not None else v
          v = arg.pop('hoverinfosrc', None)
          self.hoverinfosrc = hoverinfosrc if hoverinfosrc is not None else v
          v = arg.pop('hoverlabel', None)
          self.hoverlabel = hoverlabel if hoverlabel is not None else v
          v = arg.pop('ids', None)
          self.ids = ids if ids is not None else v
          v = arg.pop('idssrc', None)
          self.idssrc = idssrc if idssrc is not None else v
          v = arg.pop('legendgroup', None)
          self.legendgroup = legendgroup if legendgroup is not None else v
          v = arg.pop('name', None)
          self.name = name if name is not None else v
          v = arg.pop('opacity', None)
          self.opacity = opacity if opacity is not None else v
          v = arg.pop('reversescale', None)
          self.reversescale = reversescale if reversescale is not None else v
          v = arg.pop('selectedpoints', None)
          self.selectedpoints = selectedpoints if selectedpoints is not None else v
          v = arg.pop('showlegend', None)
          self.showlegend = showlegend if showlegend is not None else v
          v = arg.pop('showscale', None)
          self.showscale = showscale if showscale is not None else v
          v = arg.pop('stream', None)
          self.stream = stream if stream is not None else v
          v = arg.pop('text', None)
          self.text = text if text is not None else v
          v = arg.pop('textsrc', None)
          self.textsrc = textsrc if textsrc is not None else v
          v = arg.pop('transpose', None)
          self.transpose = transpose if transpose is not None else v
          v = arg.pop('uid', None)
          self.uid = uid if uid is not None else v
          v = arg.pop('visible', None)
          self.visible = visible if visible is not None else v
          v = arg.pop('x', None)
          self.x = x if x is not None else v
          v = arg.pop('x0', None)
          self.x0 = x0 if x0 is not None else v
          v = arg.pop('xaxis', None)
          self.xaxis = xaxis if xaxis is not None else v
          v = arg.pop('xsrc', None)
          self.xsrc = xsrc if xsrc is not None else v
          v = arg.pop('xtype', None)
          self.xtype = xtype if xtype is not None else v
          v = arg.pop('y', None)
          self.y = y if y is not None else v
          v = arg.pop('y0', None)
          self.y0 = y0 if y0 is not None else v
          v = arg.pop('yaxis', None)
          self.yaxis = yaxis if yaxis is not None else v
          v = arg.pop('ysrc', None)
          self.ysrc = ysrc if ysrc is not None else v
          v = arg.pop('ytype', None)
          self.ytype = ytype if ytype is not None else v
          v = arg.pop('z', None)
          self.z = z if z is not None else v
          v = arg.pop('zauto', None)
          self.zauto = zauto if zauto is not None else v
          v = arg.pop('zmax', None)
          self.zmax = zmax if zmax is not None else v
          v = arg.pop('zmin', None)
          self.zmin = zmin if zmin is not None else v
          v = arg.pop('zsrc', None)
          self.zsrc = zsrc if zsrc is not None else v
  
          # Read-only literals
          # ------------------
          from _plotly_utils.basevalidators import LiteralValidator
          self._props['type'] = 'heatmapgl'
          self._validators['type'] = LiteralValidator(
              plotly_name='type', parent_name='heatmapgl'
          )
  
          # Process unknown kwargs
          # ----------------------
          self._process_kwargs(**dict(arg, **kwargs))
  