Canvas type (#656)

mapbox · Jan 20, 2017 · 30323e0 · 30323e0
1 parent 25d721b
commit 30323e0
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 4 deletions.
diff --git a/lib/validate/validate_source.js b/lib/validate/validate_source.js
@@ -63,11 +63,20 @@ module.exports = function validateSource(options) {
                 styleSpec: styleSpec
             });
 
+        case 'canvas':
+            return validateObject({
+                key: key,
+                value: value,
+                valueSpec: styleSpec.source_canvas,
+                style: style,
+                styleSpec: styleSpec
+            });
+
         default:
             return validateEnum({
                 key: key + '.type',
                 value: value.type,
-                valueSpec: {values: ['vector', 'raster', 'geojson', 'video', 'image']},
+                valueSpec: {values: ['vector', 'raster', 'geojson', 'video', 'image', 'canvas']},
                 style: style,
                 styleSpec: styleSpec
             });

diff --git a/reference/v8.json b/reference/v8.json
@@ -109,7 +109,8 @@
     "source_tile",
     "source_geojson",
     "source_video",
-    "source_image"
+    "source_image",
+    "source_canvas"
   ],
   "source_tile": {
     "type": {
@@ -262,6 +263,40 @@
       }
     }
   },
+  "source_canvas": {
+    "type": {
+      "required": true,
+      "type": "enum",
+      "values": {
+        "canvas": {
+          "doc": "A canvas data source."
+        }
+      },
+      "doc": "The data type of the canvas source."
+    },
+    "coordinates": {
+      "required": true,
+      "doc": "Corners of canvas specified in longitude, latitude pairs.",
+      "type": "array",
+      "length": 4,
+      "value": {
+        "type": "array",
+        "length": 2,
+        "value": "number",
+        "doc": "A single longitude, latitude pair."
+      }
+    },
+    "animate": {
+      "type": "boolean",
+      "default": "true",
+      "doc": "Whether the canvas source is animated. If the canvas is static, `animate` should be set to `false` to improve performance."
+    },
+    "canvas": {
+      "type": "string",
+      "required": true,
+      "doc": "HTML ID of the canvas from which to read pixels."
+    }
+  },
   "layer": {
     "id": {
       "type": "string",