revise dtypes

Author: archmoj

src/lib/array.js

@@ -52,8 +52,8 @@ exports.ensureArray = function(out, n) {
 };
 
 var typedArrays = {
-    c1: typeof Uint8ClampedArray === 'undefined' ? undefined :
-               Uint8ClampedArray, // not supported in numpy?
+    u1c: typeof Uint8ClampedArray === 'undefined' ? undefined :
+                Uint8ClampedArray, // not supported in numpy?
 
     i1: typeof Int8Array === 'undefined' ? undefined :
                Int8Array,
@@ -89,6 +89,16 @@ var typedArrays = {
     */
 };
 
+typedArrays.uint8c = typedArrays.u1c;
+typedArrays.uint8 = typedArrays.u1;
+typedArrays.int8 = typedArrays.i1;
+typedArrays.uint16 = typedArrays.u2;
+typedArrays.int16 = typedArrays.i2;
+typedArrays.uint32 = typedArrays.u4;
+typedArrays.int32 = typedArrays.i4;
+typedArrays.float32 = typedArrays.f4;
+typedArrays.float64 = typedArrays.f8;
+
 function isArrayBuffer(a) {
     return a.constructor === ArrayBuffer;
 }

src/lib/coerce.js

@@ -25,13 +25,21 @@ exports.valObjectMeta = {
             '(1) a regular {array} object',
             '(2) a typed array (e.g. Float32Array)',
             '(3) an object with keys dtype, bdata, and optionally shape.',
-            'In this 3rd form, dtype is one of *i1*, *u1*, *c1*,',
-            '*i2*, *u2*, *i4*, *u4*, *f4*, or *f8*.',
+            'In this 3rd form, dtype is one of',
+            '*f8*, *f4*.',
+            '*i4*, *u4*,',
+            '*i2*, *u2*,',
+            '*i1*, *u1* or *u1c* for Uint8ClampedArray.',
+            'In addition to shorthand `dtype` above one could also use the following forms:',
+            '*float64*, *float32*,',
+            '*int32*, *uint32*,',
+            '*int16*, *uint16*,',
+            '*int8*, *uint8* or *uint8c* for Uint8ClampedArray.',
             '`bdata` is either a base64-encoded string or the ArrayBuffer of',
             'an integer or float typed array.',
             'For either multi-dimensional arrays you must also',
             'provide its dimensions separated by comma via `shape`.',
-            'For exmaple using `dtype`: *f4* and `shape`: *5,100* you can',
+            'For example using `dtype`: *f4* and `shape`: *5,100* you can',
             'declare a 2-D array that has 5 rows and 100 columns',
             'containing float32 values i.e. 4 bits per value.',
             '`shape` is optional for one dimensional arrays.'

test/jasmine/tests/toimage_test.js

@@ -458,7 +458,7 @@ describe('Plotly.toImage', function() {
                     z: {bdata: z, dtype: 'i1'},
                     marker: {
                         color: {bdata: c, dtype: 'u1'},
-                        size: {bdata: s, dtype: 'c1'}
+                        size: {bdata: s, dtype: 'u1c'}
                     }
                 }])
                 .then(function(gd) {
@@ -495,7 +495,7 @@ describe('Plotly.toImage', function() {
                     }
 
                     expect(trace.marker.size.bdata).toEqual('ADx48A==');
-                    expect(trace.marker.size.dtype).toEqual('c1');
+                    expect(trace.marker.size.dtype).toEqual('u1c');
                     expect(trace.marker.size.shape).toEqual('4');
 
                     expect(trace.marker.color.bdata).toEqual('ADx48A==');

test/plot-schema.json

@@ -479,7 +479,7 @@
     "requiredOpts": []
    },
    "data_array": {
-    "description": "An {array} of data. The value must represent an {array} or it will be ignored, but this array can be provided in several forms: (1) a regular {array} object (2) a typed array (e.g. Float32Array) (3) an object with keys dtype, bdata, and optionally shape. In this 3rd form, dtype is one of *i1*, *u1*, *c1*, *i2*, *u2*, *i4*, *u4*, *f4*, or *f8*. `bdata` is either a base64-encoded string or the ArrayBuffer of an integer or float typed array. For either multi-dimensional arrays you must also provide its dimensions separated by comma via `shape`. For exmaple using `dtype`: *f4* and `shape`: *5,100* you can declare a 2-D array that has 5 rows and 100 columns containing float32 values i.e. 4 bits per value. `shape` is optional for one dimensional arrays.",
+    "description": "An {array} of data. The value must represent an {array} or it will be ignored, but this array can be provided in several forms: (1) a regular {array} object (2) a typed array (e.g. Float32Array) (3) an object with keys dtype, bdata, and optionally shape. In this 3rd form, dtype is one of *f8*, *f4*. *i4*, *u4*, *i2*, *u2*, *i1*, *u1* or *u1c* for Uint8ClampedArray. In addition to shorthand `dtype` above one could also use the following forms: *float64*, *float32*, *int32*, *uint32*, *int16*, *uint16*, *int8*, *uint8* or *uint8c* for Uint8ClampedArray. `bdata` is either a base64-encoded string or the ArrayBuffer of an integer or float typed array. For either multi-dimensional arrays you must also provide its dimensions separated by comma via `shape`. For example using `dtype`: *f4* and `shape`: *5,100* you can declare a 2-D array that has 5 rows and 100 columns containing float32 values i.e. 4 bits per value. `shape` is optional for one dimensional arrays.",
     "otherOpts": [
      "dflt"
     ],