Merge branch 'master' into new-plot-new-canvas

Author: etpinard

shelly/plotlyjs/static/plotlyjs/src/axes.js

@@ -100,7 +100,14 @@ axes.layoutAttributes = {
             {valType: 'number'},
             {valType: 'number'}
         ],
-        description: 'Sets the range of this axis.'
+        description: [
+            'Sets the range of this axis.',
+            'If the axis `type` is *log*, then you must take the log of your desired range',
+            '(e.g. to set the range from 1 to 100, set the range from 0 to 2).',
+            'If the axis `type` is *date*, then you must convert the date to unix time in milliseconds',
+            '(the number of milliseconds since January 1st, 1970). For example, to set the date range from',
+            'January 1st 1970 to November 4th, 2013, set the range from 0 to 1380844800000.0'
+        ].join(' ')
     },
     fixedrange: {
         valType: 'boolean',
@@ -143,14 +150,31 @@ axes.layoutAttributes = {
         role: 'style',
         description: [
             'Sets the placement of the first tick on this axis.',
-            'Use with `dtick`.'
+            'Use with `dtick`.',
+            'If the axis `type` is *log*, then you must take the log of your starting tick',
+            '(e.g. to set the starting tick to 100, set the `tick0` to 2).',
+            'If the axis `type` is *date*, then you must convert the date to unix time in milliseconds',
+            '(the number of milliseconds since January 1st, 1970).',
+            'For example, to set the starting tick to',
+            'November 4th, 2013, set the range to 1380844800000.0.'
        ].join(' ')
     },
     dtick: {
         valType: 'any',
         dflt: 1,
         role: 'style',
-        description: 'Sets the step in-between ticks on this axis'
+        description: [
+            'Sets the step in-between ticks on this axis',
+            'Use with `tick0`.',
+            'If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n',
+            'is the tick number. For example,',
+            'to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1.',
+            'To set tick marks at 1, 100, 10000, ... set dtick to 2.',
+            'To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433.',
+            'If the axis `type` is *date*, then you must convert the time to milliseconds.',
+            'For example, to set the interval between ticks to one day,',
+            'set `dtick` to 86400000.0.'
+        ].join(' ')
     },
     tickvals: {
         valType: 'data_array',

shelly/plotlyjs/static/plotlyjs/src/colorbar.js

@@ -542,7 +542,7 @@ colorbar.attributes = {
         description: [
             'Determines whether this color bar\'s thickness',
             '(i.e. the measure in the constant color direction)',
-            'is set in units of plot *fraction* or in *pixels.',
+            'is set in units of plot *fraction* or in *pixels*.',
             'Use `thickness` to set the value.'
         ].join(' ')
     },
@@ -583,6 +583,8 @@ colorbar.attributes = {
     x: {
         valType: 'number',
         dflt: 1.02,
+        min: -2,
+        max: 3,
         role: 'style',
         description: [
             'Sets the x position of the color bar (in plot fraction).'
@@ -594,7 +596,7 @@ colorbar.attributes = {
         dflt: 'left',
         role: 'style',
         description: [
-            'Sets this color bar\'s horizontal position anchor',
+            'Sets this color bar\'s horizontal position anchor.',
             'This anchor binds the `x` position to the *left*, *center*',
             'or *right* of the color bar.'
         ].join(' ')
@@ -610,6 +612,8 @@ colorbar.attributes = {
         valType: 'number',
         role: 'style',
         dflt: 0.5,
+        min: -2,
+        max: 3,
         description: [
             'Sets the y position of the color bar (in plot fraction).'
         ].join(' ')

shelly/plotlyjs/static/plotlyjs/src/graph_obj.js

@@ -1640,7 +1640,19 @@ plots.fontAttrs = {
         valType: 'string',
         role: 'style',
         noBlank: true,
-        strict: true
+        strict: true,
+        description: [
+            'HTML font family - the typeface that will be applied by the web browser.',
+            'The web browser will only be able to apply a font if it is available on the system',
+            'which it operates. Provide multiple font families, separated by commas, to indicate',
+            'the preference in which to apply fonts if they aren\'t available on the system.',
+            'The plotly service (at https://plot.ly or on-premise) generates images on a server,',
+            'where only a select number of',
+            'fonts are installed and supported.',
+            'These include *Arial*, *Balto*, *Courier New*, *Droid Sans*,, *Droid Serif*,',
+            '*Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*,',
+            '*PT Sans Narrow*, *Raleway*, *Times New Roman*.'
+        ].join(' ')
     },
     size: {
         valType: 'number',
@@ -1793,7 +1805,7 @@ plots.layoutAttributes = {
             'Determines whether or not a text link citing the data source is',
             'placed at the bottom-right cored of the figure.',
             'Has only an effect only on graphs that have been generated via',
-            'forked graphs from the plotly cloud.'
+            'forked graphs from the plotly service (at https://plot.ly or on-premise).'
         ].join(' ')
     },
     smith: {

shelly/plotlyjs/static/plotlyjs/src/legend.js

@@ -73,7 +73,7 @@ legend.layoutAttributes = {
         dflt: 'left',
         role: 'info',
         description: [
-            'Sets the legend\'s horizontal position anchor',
+            'Sets the legend\'s horizontal position anchor.',
             'This anchor binds the `x` position to the *left*, *center*',
             'or *right* of the legend.'
         ].join(' ')

shelly/plotlyjs/static/plotlyjs/src/scatter.js

@@ -11,7 +11,8 @@ var scatter = module.exports = {};
 Plotly.Plots.register(scatter, 'scatter',
     ['cartesian', 'symbols', 'markerColorscale', 'errorBarsOK', 'showLegend'], {
     description: [
-        'The data visualized as scatter point or lines is set in `x` and `y`',
+        'The scatter trace type encompasses line charts, scatter charts, text charts, and bubble charts.',
+        'The data visualized as scatter point or lines is set in `x` and `y`.',
         'Text (appearing either on the chart or on hover only) is via `text`.',
         'Bubble charts are achieved by setting `marker.size` and/or `marker.color`',
         'to a numerical arrays.'
@@ -93,7 +94,9 @@ scatter.attributes = {
             'Determines the drawing mode for this scatter trace.',
             'If the provided `mode` includes *text* then the `text` elements',
             'appear at the coordinates. Otherwise, the `text` elements',
-            'appear on hover.'
+            'appear on hover.',
+            'If there are less than ' + scatter.PTS_LINESONLY + ' points,',
+            'then the default is *lines+markers*. Otherwise, *lines*.'
         ].join(' ')
     },
     line: {
@@ -141,7 +144,10 @@ scatter.attributes = {
             values: ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'],
             dflt: 'solid',
             role: 'style',
-            description: 'Sets the style of the lines.'
+            description: [
+                'Sets the style of the lines. Set to a dash string type',
+                'or a dash length in px.'
+            ].join(' ')
         }
     },
     connectgaps: {
@@ -329,7 +335,7 @@ scatter.attributes = {
                 valType: 'colorscale',
                 role: 'style',
                 description: [
-                    'Has only an effect if `marker.color.line` is set to a numerical array.',
+                    'Has only an effect if `marker.line.color` is set to a numerical array.',
                     'Sets the colorscale.'
                 ].join(' ')
             },
@@ -338,7 +344,7 @@ scatter.attributes = {
                 dflt: true,
                 role: 'style',
                 description: [
-                    'Has only an effect if `marker.color.line` is set to a numerical array.',
+                    'Has only an effect if `marker.line.color` is set to a numerical array.',
                     'Determines the whether or not the color domain is computed',
                     'with respect to the input data.'
                 ].join(' ')
@@ -348,7 +354,7 @@ scatter.attributes = {
                 dflt: null,
                 role: 'info',
                 description: [
-                    'Has only an effect if `marker.color.line` is set to a numerical array.',
+                    'Has only an effect if `marker.line.color` is set to a numerical array.',
                     'Sets the upper bound of the color domain.'
                 ].join(' ')
             },
@@ -357,7 +363,7 @@ scatter.attributes = {
                 dflt: null,
                 role: 'info',
                 description: [
-                    'Has only an effect if `marker.color.line` is set to a numerical array.',
+                    'Has only an effect if `marker.line.color` is set to a numerical array.',
                     'Sets the lower bound of the color domain.'
                 ].join(' ')
             },
@@ -366,7 +372,7 @@ scatter.attributes = {
                 dflt: true,
                 role: 'style',
                 description: [
-                    'Has only an effect if `marker.color.line` is set to a numerical array.',
+                    'Has only an effect if `marker.line.color` is set to a numerical array.',
                     'Determines whether or not the colorscale is picked using',
                     'the sign of values inside `marker.line.color`.'
                 ].join(' ')
@@ -376,7 +382,7 @@ scatter.attributes = {
                 dflt: false,
                 role: 'style',
                 description: [
-                    'Has only an effect if `marker.color.line` is set to a numerical array.',
+                    'Has only an effect if `marker.line.color` is set to a numerical array.',
                     'Reverses the colorscale.'
                 ].join(' ')
             }

shelly/plotlyjs/static/plotlyjs/src/shapes.js

@@ -10,28 +10,6 @@ var extendFlat = Plotly.Lib.extendFlat,
 
 shapes.layoutAttributes = {
     _isLinkedToArray: true,
-    opacity: {
-        valType: 'number',
-        min: 0,
-        max: 1,
-        dflt: 1,
-        role: 'info',
-        description: 'Sets the opacity of the shape.'
-    },
-    line: {
-        color: scatterLineAttrs.color,
-        width: scatterLineAttrs.width,
-        dash: scatterLineAttrs.dash,
-        role: 'info'
-    },
-    fillcolor: {
-        valType: 'color',
-        dflt: 'rgba(0,0,0,0)',
-        role: 'info',
-        description: [
-            'Sets the color filling the shape\'s interior.'
-        ].join(' ')
-    },
     type: {
         valType: 'enumerated',
         values: ['circle', 'rect', 'path', 'line'],
@@ -132,6 +110,29 @@ shapes.layoutAttributes = {
             'Therefore we\'ll use underscore for this purpose:',
             '2015-02-21_13:45:56.789'
         ].join(' ')
+    },
+
+    opacity: {
+        valType: 'number',
+        min: 0,
+        max: 1,
+        dflt: 1,
+        role: 'info',
+        description: 'Sets the opacity of the shape.'
+    },
+    line: {
+        color: scatterLineAttrs.color,
+        width: scatterLineAttrs.width,
+        dash: scatterLineAttrs.dash,
+        role: 'info'
+    },
+    fillcolor: {
+        valType: 'color',
+        dflt: 'rgba(0,0,0,0)',
+        role: 'info',
+        description: [
+            'Sets the color filling the shape\'s interior.'
+        ].join(' ')
     }
 };