Merge pull request #6501 from zeehio/patch-1

[Documentation] Clarify x0,y0 in image trace

Author: archmoj

src/traces/image/attributes.js

@@ -84,13 +84,24 @@ module.exports = extendFlat({
         valType: 'any',
         dflt: 0,
         editType: 'calc+clearAxisTypes',
-        description: 'Set the image\'s x position.'
+        description: [
+            'Set the image\'s x position. The left edge of the image',
+            '(or the right edge if the x axis is reversed or dx is negative)',
+            'will be found at xmin=x0-dx/2'
+        ].join(' ')
     },
     y0: {
         valType: 'any',
         dflt: 0,
         editType: 'calc+clearAxisTypes',
-        description: 'Set the image\'s y position.'
+        description: [
+            'Set the image\'s y position. The top edge of the image',
+            '(or the bottom edge if the y axis is NOT reversed or if dy is negative)',
+            'will be found at ymin=y0-dy/2. By default when an image trace is',
+            'included, the y axis will be reversed so that the image is right-side-up,',
+            'but you can disable this by setting yaxis.autorange=true or by providing',
+            'an explicit y axis range.'
+        ].join(' ')
     },
     dx: {
         valType: 'number',

test/plot-schema.json

@@ -35630,7 +35630,7 @@
      ]
     },
     "x0": {
-     "description": "Set the image's x position.",
+     "description": "Set the image's x position. The left edge of the image (or the right edge if the x axis is reversed or dx is negative) will be found at xmin=x0-dx/2",
      "dflt": 0,
      "editType": "calc+clearAxisTypes",
      "valType": "any"
@@ -35642,7 +35642,7 @@
      "valType": "subplotid"
     },
     "y0": {
-     "description": "Set the image's y position.",
+     "description": "Set the image's y position. The top edge of the image (or the bottom edge if the y axis is NOT reversed or if dy is negative) will be found at ymin=y0-dy/2. By default when an image trace is included, the y axis will be reversed so that the image is right-side-up, but you can disable this by setting yaxis.autorange=true or by providing an explicit y axis range.",
      "dflt": 0,
      "editType": "calc+clearAxisTypes",
      "valType": "any"