docstr: Construct a new Image object
  
  Parameters
  ----------
  arg
      dict of properties compatible with this constructor or
      an instance of :class:`plotly.graph_objs.layout.Image`
  layer
      Specifies whether images are drawn below or above
      traces. When `xref` and `yref` are both set to `paper`,
      image is drawn below the entire plot area.
  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.
  opacity
      Sets the opacity of the image.
  sizex
      Sets the image container size horizontally. The image
      will be sized based on the `position` value. When
      `xref` is set to `paper`, units are sized relative to
      the plot width. When `xref` ends with ` domain`, units
      are sized relative to the axis width.
  sizey
      Sets the image container size vertically. The image
      will be sized based on the `position` value. When
      `yref` is set to `paper`, units are sized relative to
      the plot height. When `yref` ends with ` domain`, units
      are sized relative to the axis height.
  sizing
      Specifies which dimension of the image to constrain.
  source
      Specifies the URL of the image to be used. The URL must
      be accessible from the domain where the plot code is
      run, and can be either relative or absolute.
  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`.
  visible
      Determines whether or not this image is visible.
  x
      Sets the image's x position. When `xref` is set to
      `paper`, units are sized relative to the plot height.
      See `xref` for more info
  xanchor
      Sets the anchor for the x position
  xref
      Sets the images's x coordinate axis. If set to a x axis
      id (e.g. "x" or "x2"), the `x` position refers to a x
      coordinate. If set to "paper", the `x` position refers
      to the distance from the left of the plotting area in
      normalized coordinates where 0 (1) corresponds to the
      left (right). If set to a x axis ID followed by
      "domain" (separated by a space), the position behaves
      like for "paper", but refers to the distance in
      fractions of the domain length from the left of the
      domain of that axis: e.g., *x2 domain* refers to the
      domain of the second x  axis and a x position of 0.5
      refers to the point between the left and the right of
      the domain of the second x axis.
  y
      Sets the image's y position. When `yref` is set to
      `paper`, units are sized relative to the plot height.
      See `yref` for more info
  yanchor
      Sets the anchor for the y position.
  yref
      Sets the images's y coordinate axis. If set to a y axis
      id (e.g. "y" or "y2"), the `y` position refers to a y
      coordinate. If set to "paper", the `y` position refers
      to the distance from the bottom of the plotting area in
      normalized coordinates where 0 (1) corresponds to the
      bottom (top). If set to a y axis ID followed by
      "domain" (separated by a space), the position behaves
      like for "paper", but refers to the distance in
      fractions of the domain length from the bottom of the
      domain of that axis: e.g., *y2 domain* refers to the
      domain of the second y  axis and a y position of 0.5
      refers to the point between the bottom and the top of
      the domain of the second y axis.
  
  Returns
  -------
  Image
docstr_tok: ["Construct","a","new","Image","object","Parameters","--","--","--","--","--","arg","dict","of","properties","compatible","with","this","constructor","or","an","instance","of",":","class",":","`","plotly.graph_objs.layout.Image","`","layer","Specifies","whether","images","are","drawn","below","or","above","traces",".","When","`","xref","`","and","`","yref","`","are","both","set","to","`","paper","`",",","image","is","drawn","below","the","entire","plot","area",".","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",".","opacity","Sets","the","opacity","of","the","image",".","sizex","Sets","the","image","container","size","horizontally",".","The","image","will","be","sized","based","on","the","`","position","`","value",".","When","`","xref","`","is","set","to","`","paper","`",",","units","are","sized","relative","to","the","plot","width",".","When","`","xref","`","ends","with","`","domain","`",",","units","are","sized","relative","to","the","axis","width",".","sizey","Sets","the","image","container","size","vertically",".","The","image","will","be","sized","based","on","the","`","position","`","value",".","When","`","yref","`","is","set","to","`","paper","`",",","units","are","sized","relative","to","the","plot","height",".","When","`","yref","`","ends","with","`","domain","`",",","units","are","sized","relative","to","the","axis","height",".","sizing","Specifies","which","dimension","of","the","image","to","constrain",".","source","Specifies","the","URL","of","the","image","to","be","used",".","The","URL","must","be","accessible","from","the","domain","where","the","plot","code","is","run",",","and","can","be","either","relative","or","absolute",".","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","`",".","visible","Determines","whether","or","not","this","image","is","visible",".","x","Sets","the","image","'s","x","position",".","When","`","xref","`","is","set","to","`","paper","`",",","units","are","sized","relative","to","the","plot","height",".","See","`","xref","`","for","more","info","xanchor","Sets","the","anchor","for","the","x","position","xref","Sets","the","images","'s","x","coordinate","axis",".","If","set","to","a","x","axis","id","(","e.g",".","``","x","''","or","``","x2","''",")",",","the","`","x","`","position","refers","to","a","x","coordinate",".","If","set","to","``","paper","''",",","the","`","x","`","position","refers","to","the","distance","from","the","left","of","the","plotting","area","in","normalized","coordinates","where","0","(","1",")","corresponds","to","the","left","(","right",")",".","If","set","to","a","x","axis","ID","followed","by","``","domain","''","(","separated","by","a","space",")",",","the","position","behaves","like","for","``","paper","''",",","but","refers","to","the","distance","in","fractions","of","the","domain","length","from","the","left","of","the","domain","of","that","axis",":","e.g.",",","*","x2","domain","*","refers","to","the","domain","of","the","second","x","axis","and","a","x","position","of","0.5","refers","to","the","point","between","the","left","and","the","right","of","the","domain","of","the","second","x","axis",".","y","Sets","the","image","'s","y","position",".","When","`","yref","`","is","set","to","`","paper","`",",","units","are","sized","relative","to","the","plot","height",".","See","`","yref","`","for","more","info","yanchor","Sets","the","anchor","for","the","y","position",".","yref","Sets","the","images","'s","y","coordinate","axis",".","If","set","to","a","y","axis","id","(","e.g",".","``","y","''","or","``","y2","''",")",",","the","`","y","`","position","refers","to","a","y","coordinate",".","If","set","to","``","paper","''",",","the","`","y","`","position","refers","to","the","distance","from","the","bottom","of","the","plotting","area","in","normalized","coordinates","where","0","(","1",")","corresponds","to","the","bottom","(","top",")",".","If","set","to","a","y","axis","ID","followed","by","``","domain","''","(","separated","by","a","space",")",",","the","position","behaves","like","for","``","paper","''",",","but","refers","to","the","distance","in","fractions","of","the","domain","length","from","the","bottom","of","the","domain","of","that","axis",":","e.g.",",","*","y2","domain","*","refers","to","the","domain","of","the","second","y","axis","and","a","y","position","of","0.5","refers","to","the","point","between","the","bottom","and","the","top","of","the","domain","of","the","second","y","axis",".","Returns","--","--","--","-","Image"]
code: def __init__(
      self,
      arg=None,
      layer=None,
      name=None,
      opacity=None,
      sizex=None,
      sizey=None,
      sizing=None,
      source=None,
      templateitemname=None,
      visible=None,
      x=None,
      xanchor=None,
      xref=None,
      y=None,
      yanchor=None,
      yref=None,
      **kwargs,
  ):
      """
      Construct a new Image object
  
      Parameters
      ----------
      arg
          dict of properties compatible with this constructor or
          an instance of :class:`plotly.graph_objs.layout.Image`
      layer
          Specifies whether images are drawn below or above
          traces. When `xref` and `yref` are both set to `paper`,
          image is drawn below the entire plot area.
      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.
      opacity
          Sets the opacity of the image.
      sizex
          Sets the image container size horizontally. The image
          will be sized based on the `position` value. When
          `xref` is set to `paper`, units are sized relative to
          the plot width. When `xref` ends with ` domain`, units
          are sized relative to the axis width.
      sizey
          Sets the image container size vertically. The image
          will be sized based on the `position` value. When
          `yref` is set to `paper`, units are sized relative to
          the plot height. When `yref` ends with ` domain`, units
          are sized relative to the axis height.
      sizing
          Specifies which dimension of the image to constrain.
      source
          Specifies the URL of the image to be used. The URL must
          be accessible from the domain where the plot code is
          run, and can be either relative or absolute.
      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`.
      visible
          Determines whether or not this image is visible.
      x
          Sets the image's x position. When `xref` is set to
          `paper`, units are sized relative to the plot height.
          See `xref` for more info
      xanchor
          Sets the anchor for the x position
      xref
          Sets the images's x coordinate axis. If set to a x axis
          id (e.g. "x" or "x2"), the `x` position refers to a x
          coordinate. If set to "paper", the `x` position refers
          to the distance from the left of the plotting area in
          normalized coordinates where 0 (1) corresponds to the
          left (right). If set to a x axis ID followed by
          "domain" (separated by a space), the position behaves
          like for "paper", but refers to the distance in
          fractions of the domain length from the left of the
          domain of that axis: e.g., *x2 domain* refers to the
          domain of the second x  axis and a x position of 0.5
          refers to the point between the left and the right of
          the domain of the second x axis.
      y
          Sets the image's y position. When `yref` is set to
          `paper`, units are sized relative to the plot height.
          See `yref` for more info
      yanchor
          Sets the anchor for the y position.
      yref
          Sets the images's y coordinate axis. If set to a y axis
          id (e.g. "y" or "y2"), the `y` position refers to a y
          coordinate. If set to "paper", the `y` position refers
          to the distance from the bottom of the plotting area in
          normalized coordinates where 0 (1) corresponds to the
          bottom (top). If set to a y axis ID followed by
          "domain" (separated by a space), the position behaves
          like for "paper", but refers to the distance in
          fractions of the domain length from the bottom of the
          domain of that axis: e.g., *y2 domain* refers to the
          domain of the second y  axis and a y position of 0.5
          refers to the point between the bottom and the top of
          the domain of the second y axis.
  
      Returns
      -------
      Image
      """
      super(Image, self).__init__("images")
  
      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.layout.Image 
  constructor must be a dict or 
  an instance of :class:`plotly.graph_objs.layout.Image`"""
          )
  
      # 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("layer", None)
      _v = layer if layer is not None else _v
      if _v is not None:
          self["layer"] = _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("opacity", None)
      _v = opacity if opacity is not None else _v
      if _v is not None:
          self["opacity"] = _v
      _v = arg.pop("sizex", None)
      _v = sizex if sizex is not None else _v
      if _v is not None:
          self["sizex"] = _v
      _v = arg.pop("sizey", None)
      _v = sizey if sizey is not None else _v
      if _v is not None:
          self["sizey"] = _v
      _v = arg.pop("sizing", None)
      _v = sizing if sizing is not None else _v
      if _v is not None:
          self["sizing"] = _v
      _v = arg.pop("source", None)
      _v = source if source is not None else _v
      if _v is not None:
          self["source"] = _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("visible", None)
      _v = visible if visible is not None else _v
      if _v is not None:
          self["visible"] = _v
      _v = arg.pop("x", None)
      _v = x if x is not None else _v
      if _v is not None:
          self["x"] = _v
      _v = arg.pop("xanchor", None)
      _v = xanchor if xanchor is not None else _v
      if _v is not None:
          self["xanchor"] = _v
      _v = arg.pop("xref", None)
      _v = xref if xref is not None else _v
      if _v is not None:
          self["xref"] = _v
      _v = arg.pop("y", None)
      _v = y if y is not None else _v
      if _v is not None:
          self["y"] = _v
      _v = arg.pop("yanchor", None)
      _v = yanchor if yanchor is not None else _v
      if _v is not None:
          self["yanchor"] = _v
      _v = arg.pop("yref", None)
      _v = yref if yref is not None else _v
      if _v is not None:
          self["yref"] = _v
  
      # Process unknown kwargs
      # ----------------------
      self._process_kwargs(**dict(arg, **kwargs))
  
      # Reset skip_invalid
      # ------------------
      self._skip_invalid = False
  
imports: from plotly.basedatatypes import BaseLayoutHierarchyType
  import copy
label_desc: Use image node_id 32 to create a new Image object from inherited base classes: _BaseLayoutHierarchyType with example: obj = Image(arg, layer, name, opacity, sizex, sizey, sizing, source, templateitemname, visible, x, xanchor, xref, y, yanchor, yref)