docstr: Construct a new Tickformatstop object
  
  Parameters
  ----------
  arg
      dict of properties compatible with this constructor or
      an instance of :class:`plotly.graph_objs.surface.colorb
      ar.Tickformatstop`
  dtickrange
      range [*min*, *max*], where "min", "max" - dtick values
      which describe some zoom level, it is possible to omit
      "min" or "max" value by passing "null"
  enabled
      Determines whether or not this stop is used. If
      `false`, this stop is ignored even within its
      `dtickrange`.
  name
      When used in a template, named items are created in the
      output figure in addition to any items the figure
      already has in this array. You can modify these items
      in the output figure by making your own item with
      `templateitemname` matching this `name` alongside your
      modifications (including `visible: false` or `enabled:
      false` to hide it). Has no effect outside of a
      template.
  templateitemname
      Used to refer to a named item in this array in the
      template. Named items from the template will be created
      even without a matching item in the input figure, but
      you can modify one by making an item with
      `templateitemname` matching its `name`, alongside your
      modifications (including `visible: false` or `enabled:
      false` to hide it). If there is no template or no
      matching item, this item will be hidden unless you
      explicitly show it with `visible: true`.
  value
      string - dtickformat for described zoom level, the same
      as "tickformat"
  
  Returns
  -------
  Tickformatstop
docstr_tok: ["Construct","a","new","Tickformatstop","object","Parameters","--","--","--","--","--","arg","dict","of","properties","compatible","with","this","constructor","or","an","instance","of",":","class",":","`","plotly.graph_objs.surface.colorb","ar.Tickformatstop","`","dtickrange","range","[","*","min","*",",","*","max","*","]",",","where","``","min","''",",","``","max","''","-","dtick","values","which","describe","some","zoom","level",",","it","is","possible","to","omit","``","min","''","or","``","max","''","value","by","passing","``","null","''","enabled","Determines","whether","or","not","this","stop","is","used",".","If","`","false","`",",","this","stop","is","ignored","even","within","its","`","dtickrange","`",".","name","When","used","in","a","template",",","named","items","are","created","in","the","output","figure","in","addition","to","any","items","the","figure","already","has","in","this","array",".","You","can","modify","these","items","in","the","output","figure","by","making","your","own","item","with","`","templateitemname","`","matching","this","`","name","`","alongside","your","modifications","(","including","`","visible",":","false","`","or","`","enabled",":","false","`","to","hide","it",")",".","Has","no","effect","outside","of","a","template",".","templateitemname","Used","to","refer","to","a","named","item","in","this","array","in","the","template",".","Named","items","from","the","template","will","be","created","even","without","a","matching","item","in","the","input","figure",",","but","you","can","modify","one","by","making","an","item","with","`","templateitemname","`","matching","its","`","name","`",",","alongside","your","modifications","(","including","`","visible",":","false","`","or","`","enabled",":","false","`","to","hide","it",")",".","If","there","is","no","template","or","no","matching","item",",","this","item","will","be","hidden","unless","you","explicitly","show","it","with","`","visible",":","true","`",".","value","string","-","dtickformat","for","described","zoom","level",",","the","same","as","``","tickformat","''","Returns","--","--","--","-","Tickformatstop"]
code: def __init__(
      self,
      arg=None,
      dtickrange=None,
      enabled=None,
      name=None,
      templateitemname=None,
      value=None,
      **kwargs,
  ):
      """
      Construct a new Tickformatstop object
  
      Parameters
      ----------
      arg
          dict of properties compatible with this constructor or
          an instance of :class:`plotly.graph_objs.surface.colorb
          ar.Tickformatstop`
      dtickrange
          range [*min*, *max*], where "min", "max" - dtick values
          which describe some zoom level, it is possible to omit
          "min" or "max" value by passing "null"
      enabled
          Determines whether or not this stop is used. If
          `false`, this stop is ignored even within its
          `dtickrange`.
      name
          When used in a template, named items are created in the
          output figure in addition to any items the figure
          already has in this array. You can modify these items
          in the output figure by making your own item with
          `templateitemname` matching this `name` alongside your
          modifications (including `visible: false` or `enabled:
          false` to hide it). Has no effect outside of a
          template.
      templateitemname
          Used to refer to a named item in this array in the
          template. Named items from the template will be created
          even without a matching item in the input figure, but
          you can modify one by making an item with
          `templateitemname` matching its `name`, alongside your
          modifications (including `visible: false` or `enabled:
          false` to hide it). If there is no template or no
          matching item, this item will be hidden unless you
          explicitly show it with `visible: true`.
      value
          string - dtickformat for described zoom level, the same
          as "tickformat"
  
      Returns
      -------
      Tickformatstop
      """
      super(Tickformatstop, self).__init__("tickformatstops")
  
      if "_parent" in kwargs:
          self._parent = kwargs["_parent"]
          return
  
      # 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.surface.colorbar.Tickformatstop
  constructor must be a dict or
  an instance of :class:`plotly.graph_objs.surface.colorbar.Tickformatstop`"""
          )
  
      # Handle skip_invalid
      # -------------------
      self._skip_invalid = kwargs.pop("skip_invalid", False)
      self._validate = kwargs.pop("_validate", True)
  
      # Populate data dict with properties
      # ----------------------------------
      _v = arg.pop("dtickrange", None)
      _v = dtickrange if dtickrange is not None else _v
      if _v is not None:
          self["dtickrange"] = _v
      _v = arg.pop("enabled", None)
      _v = enabled if enabled is not None else _v
      if _v is not None:
          self["enabled"] = _v
      _v = arg.pop("name", None)
      _v = name if name is not None else _v
      if _v is not None:
          self["name"] = _v
      _v = arg.pop("templateitemname", None)
      _v = templateitemname if templateitemname is not None else _v
      if _v is not None:
          self["templateitemname"] = _v
      _v = arg.pop("value", None)
      _v = value if value is not None else _v
      if _v is not None:
          self["value"] = _v
  
      # Process unknown kwargs
      # ----------------------
      self._process_kwargs(**dict(arg, **kwargs))
  
      # Reset skip_invalid
      # ------------------
      self._skip_invalid = False
  
file_path: plotly.py/packages/python/plotly/plotly/graph_objs/surface/colorbar/_tickformatstop.py
imports: from plotly.basedatatypes import BaseTraceHierarchyType
  import copy
label_desc: Use image node_id 12 to create a new Tickformatstop object from inherited base classes: _BaseTraceHierarchyType with example: obj = Tickformatstop(arg, dtickrange, enabled, name, templateitemname, value)