Merge branch 'master' into PR #414

Author: n-riesco

.eslintignore

@@ -4,4 +4,3 @@ build
 
 test/jasmine/assets/jquery-1.8.3.min.js
 src/plots/polar/micropolar.js
-src/plots/geo/projections.js

.eslintrc

@@ -1,22 +1,22 @@
 {
   "root": true,
   "extends": [
-    "eslint:recommended",
+    "eslint:recommended"
   ],
   "env": {
     "commonjs": true
   },
   "rules": {
     "no-trailing-spaces": [2],
-    "no-multiple-empty-lines": [2, {"max": 2, "maxEOF": 1}],
+    "no-multiple-empty-lines": [2, {"max": 2, "maxEOF": 0}],
     "eol-last": [2],
     "linebreak-style": [2, "unix"],
     "indent": [2, 4, {"SwitchCase": 1}],
     "max-len": [0, 80],
     "brace-style": [0, "stroustrup", {"allowSingleLine": true}],
     "curly": [0, "multi"],
     "camelcase": [0, {"properties": "never"}],
-    "comma-spacing": [0, {"before": false, "after": true}],
+    "comma-spacing": [2, {"before": false, "after": true}],
     "comma-style": [2, "last"],
     "semi": [2],
     "semi-spacing": [2, {"before": false, "after": true}],
@@ -36,9 +36,9 @@
     "no-whitespace-before-property": [2],
     "no-unexpected-multiline": [2],
     "no-floating-decimal": [2],
-    "space-infix-ops": [0, {"int32Hint": false}],
+    "space-infix-ops": [2, {"int32Hint": true}],
     "quotes": [2, "single"],
-    "dot-notation": [2, {"allowKeywords": false}],
+    "dot-notation": [2],
     "operator-linebreak": [2, "after"],
     "eqeqeq": [2],
     "new-cap": [0],
@@ -50,5 +50,5 @@
     "no-loop-func": [2],
     "no-console": [0],
     "no-unused-labels": [2]
-  },
+  }
 }

CHANGELOG.md

@@ -10,6 +10,117 @@ https://github.com/plotly/plotly.js/compare/vX.Y.Z...master
 where X.Y.Z is the semver of most recent plotly.js release.
 
 
+## [1.11.0] -- 2016-05-17
+
+### Added
+- Add top-level methods `Plotly.toImage` to convert a plotly graph to an image
+  data URL (svg, png, jpg, and webp are supported) and `Plotly.downloadImage` to
+  download a plotly graph as an image [#446]
+- Add the ability to add arbitrary images loaded from a url to a plot's layout
+  [#525]
+- Add the option of making legend span horizontally [#535]
+- Add `connectgaps` attribute to `scattergl` traces [#449]
+- Add new 'relative' bar mode which stacks on top of one another with negative
+  values below the axis, positive values above [#517]
+- Add support for the 'winkel tripel' projection in geo subplots [#492]
+- Event `plotly_relayout` is now emitted on gl2d subplot drag/pan/zoom
+  interactions [#466]
+- Add support for fill coloring in `contourgl` traces [#522, #543]
+
+### Changed
+- Cartesian on-hover routine is now uses a 50ms interval between search calls
+  instead of 100ms for smoother displaying hover labels [#514]
+- [Internal change] fullLayout `_has` fields are replaced by a `_has` method
+  which checks if a particular plot type is present on a graph [#491]
+
+### Fixed
+- Bar widths of traces with null coordinates are now correctly computed [#542]
+- Error bar spans on bar traces with null coordinates are now correctly computed
+  [#542]
+- All promises spawn in `Plotly.plot` are now guaranteed to be resolved before
+  the final resolve [#521]
+- Restyling `scatterternary` data attributes is now working [#540]
+- Error bar of 0 length in log axes are not included in hover labels (instead of
+  showing `NaN`s) [#533]
+
+
+## [1.10.2] -- 2016-05-05
+
+### Fixed
+- Subplot and range slider clip paths are now functional in AngularJS [#509]
+- `relayout` call involving axis `categoryorder` and `categoryarray` are now
+  working [#510]
+- Annotation drag interactions in `editable: true` mode are now functional (bug
+  introduced in 1.10.0)[#505]
+- Improved attribute description for shape `xref` and `yref` [#506]
+
+
+## [1.10.1] -- 2016-05-02
+
+### Fixed
+- Resizing a graph (e.g. via `Plotly.relayout` or Plotly.Plots.resize)
+  properly updates the plot area clip paths (bug introduced in 1.10.0) [#490]
+- `Plotly.Snapshot.toSVG` is now functional again in IE11 and old version of
+  Chrome and FF (bug introduced in 1.10.0) [#489]
+- Hover labels of superimposed traces when 'hovermode' is set to 'closest' are
+  properly displayed (bug introduced in 1.10.0) [#495]
+- Surface contour highlights are toggleable [#459]
+- Surface contour highlights style attributes are lower cased [#459]
+- Zoom overlay are drawn over shapes [#448]
+- Legend are draggable in `editable: true` contexts (bug introduced in 1.6.0)
+  [#487]
+- Legend scroll box are drawn outside the legend [#478]
+
+
+## [1.10.0] -- 2016-04-12
+
+### Added
+- Beta version of two new 2D WebGL trace types: `heatmapgl` and `contourgl`
+  [#427, #434]
+- Two new `scatter` line `fill` modes: `'toself'` and `'tonext'` [#462]
+- Fills for `scatterternary` traces are now supported [#462]
+- Configurable axis category ordering with `categoryorder` and an optional
+  `categoryarray` axis attributes [#419]
+- Configurable shapes layer position with shape attribute `layer` [#439]
+- Configurable range slider range (so that the initial xaxis range can differ
+  from the range slider range) [#473]
+
+### Changed
+- Nested SVG elements in SVG image exports are removed, making the to-image mode
+  bar button work in RStudio and SVG export compatible with Adobe Illustrator
+  [#415, #454, #442]
+- Use `country-regex` npm package instead of hard-coded file of ISO-3 code to
+  country regular expressions [#461]
+
+### Fixed
+- Legend positioning does not break on negative `x` and `y` settings (bug
+  introduced in 1.6.0) [#417]
+- Shapes are properly deleted when clearing all of them at once (bug introduced
+  in 1.9.0) [#465]
+- Promise are return after first render in gl3d and gl2d plots [#421]
+- Click and hover events are properly triggered when trace `hoverinfo` is set to
+  `'none'` [#438]
+- `plotly_unhover` events is now properly triggered on geo trace types [#429]
+- `plotly_relayout` event is now properly triggered on gl3d set camera [#458]
+- RGBA colors are now supported in `scatter` and `bar` custom color scales
+  [#422]
+- Range slider is now functional with `x0`/`dx` data [#441]
+- Range slider is now compatible with mode bar axis range buttons and double
+  click [#471]
+
+
+## [1.9.0] -- 2016-04-12
+
+### Added
+- Ternary plots with support for scatter traces (trace type `scatterternary`) [#390]
+
+### Fixed
+- Toggling the visibility of `scatter3d` traces with `surfaceaxis` now works [#405]
+- `scatter3d` traces with `surfaceaxis` turned now feature real 3D opacity [#408]
+- `plotly_unhover` is now properly triggered over `pie` traces [#407]
+- Better grammar in `scatter` attribute descriptions [#406]
+
+
 ## [1.8.0] -- 2016-04-04
 
 ### Added

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing to plotly.js
 
-### Opening issues
+## Opening issues
 
 Search for existing and closed issues. If your problem or idea is not addressed
 yet, [please open a new issue](https://github.com/plotly/plotly.js/issues/new).
@@ -10,48 +10,72 @@ Bug reports must be accompanied with a reproducible example. We recommend using
 [jsbin](https://jsbin.com) to share your example.
 
 Note that GitHub issues are reserved for bug reports and feature requests only.
-Implementation questions should be asked on Stack Overflow (tagged
-[`plotly`](https://stackoverflow.com/questions/tagged/plotly)) or on
-community.plot.ly (tagged [`plotly-js`](http://community.plot.ly/c/plotly-js)).
+Implementation questions should be asked on
+community.plot.ly (tagged [`plotly-js`](http://community.plot.ly/c/plotly-js)) or on Stack Overflow (tagged
+[`plotly`](https://stackoverflow.com/questions/tagged/plotly)).
 
-### Issue labels
+Comments on GitHub issues or pull requests should add content to the discussions. 
+Approbation comments such as *+1* or *I would like this feature to be implemented as well* 
+will be deleted by the maintainers. Please use 
+[GitHub reactions](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments) 
+instead.
 
-We use the following [labels](https://github.com/plotly/plotly.js/labels) to track issues:
+## Making pull requests
+
+Developers are strongly encouraged to first make a PR to their own plotly.js
+fork and ask one of the maintainers to review the modifications there. Once the
+pull request is deemed satisfactory, the developer will be asked to make a pull
+request to the main plotly.js repo and may be asked to squash some commits
+before doing so.
+
+Developers should `git rebase` their local branch off the latest `master` before 
+opening a pull request.
+
+Note that it is forbidden to force push (i.e. `git push -f`) to remote branches
+associated with opened pull requests. Force pushes make it hard for maintainers 
+to keep track of updates. Therefore, if required, please
+`git merge master` into your PR branch instead of `git rebase master`.
+
+
+## GitHub labels
+
+We use the following [labels](https://github.com/plotly/plotly.js/labels) to track issues and PRs:
 
 | Label | Purpose |
 |--------|---------|
 | `type: bug` | bug report confirmed by a plotly team member |
-| `type: enhancement` | planned feature or task |
+| `type: feature` | planned feature additions |
+| `type: performance` | performance related tasks |
+| `type: maintenace` | source code cleanup resulting in no enhancement for users |
 | `type: community` | issue left open for community input and pull requests |
-| `type: maintenace` | source code cleanup resulting in no enhancement for users | 
 | `type: duplicate` | *self-explanatory* |
 | `type: wontfix` | *self-explanatory* |
 | `status: discussion needed` | Issue or PR that required discussion among maintaners before moving forward |
 | `status: in progress` | PRs that required some intial feedback but not ready to merge |
 | `status: reviewable` | PRs that are completed from the author's perspective |
-| `status: on hold` | PRs that are put on hold | 
+| `status: on hold` | PRs that are put on hold |
 
-### Development
+## Development
 
-**Prerequisites**:
+#### Perequisites
 
 - git
 - [node.js](https://nodejs.org/en/). We recommend using node.js 4.2.x (LTS).
   Upgrading and managing node versions can be easily done using
   [`nvm`](https://github.com/creationix/nvm) or its Windows alternatives.
 
-**Step 1** Clone the plotly.js repo and install its dependencies
+#### Step 1: Clone the plotly.js repo and install its dependencies
 
 ```
 git clone https://github.com/plotly/plotly.js.git
 cd plotly.js
 npm install
 ```
 
-**Step 2** Start the test dashboard
+#### Step 2: Start the test dashboard
 
 ```
-npm run start-test_dashboard
+npm start
 ```
 
 This command bundles up the source files with source maps using
@@ -60,26 +84,43 @@ This command bundles up the source files with source maps using
 dev plotly.js bundle update every time a source file is saved) and opens up a
 tab in your browser.
 
-**Step 3** Open up the console and start developing
+#### Step 3: Open up the console and start developing
 
-Make some modifications to the source, refresh the page and check the results
-by for example pasting in the console:
+A typical workflow is to make some modifications to the source, update the
+test dashboard, inspect and debug the changes, then repeat. The test dashboard
+comes bundled with some useful tools while developing - all bundled under the
+`Tabs` object:
 
-```js
-Plotly.plot(Tabs.fresh(), [{x:[1,2,3], y:[2,1,2]}]);
-```
 
-- `Tabs.fresh()` creates a fresh graph div and return it and
-- `Tabs.getGraph()` returns the current graph div.
+| Method/Property        | Description |
+|------------------------|-------------|
+| `Tabs.fresh([id])` | Creates a fresh graph div and returns it (default id of `graph`). |
+| `Tabs.getGraph([id])` | Returns the default or specified graph div. |
+| `Tabs.plotMock(mock, [id])` | Plots the specified mock (`.json` extension is not required). |
+| `Tabs.snapshot([id])` | Creates a png snapshot of the plot and places it below. |
+| `Tabs.reload()` | Reloads the plotly.js script and will execute `Tabs.onReload` once completed. |
+| `Tabs.onReload()` | By default, set to `noop` but you may set `Tabs.onReload` to any function you wish. This is useful for replotting a mock or test every time you reload the plotly.js script. |
+| `Tabs.purge()` | Destroys all plots. |
+
+View [the source](https://github.com/plotly/plotly.js/blob/master/devtools/test_dashboard/devtools.js) for more info.
+
+Three additional helpers exist that are refreshed every second:
 
-**Other npm scripts**:
+* `gd` - this is the default plot div
+* `fullData` - shortcut to `gd._fullData`
+* `fullLayout` - shortcut to `gd._fullLayout`
+
+There is also a search bar in the top right of the dashboard. This fuzzy-searches
+image mocks based on their file name and trace type.
+
+#### Other npm scripts
 
 - `npm run preprocess`: pre-processes the css and svg source file in js. This
   script must be run manually when updating the css and svg source files.
 - `npm run watch`: starts a watchify file watcher just like the test dashboard but
   without booting up a server.
 
-### Testing
+## Testing
 
 Both jasmine and image tests are run on
 [CircleCI](https://circleci.com/gh/plotly/plotly.js) on every push to this
@@ -92,6 +133,15 @@ Jasmine tests are run in a browser using
 npm run test-jasmine
 ```
 
+To run a specific suite, use:
+
+```
+npm run test-jasmine -- tests/<suite>.js
+```
+
+where the `<suite>` corresponds to the suite's file name as found in [`test/jasmine/tests/`](https://github.com/plotly/plotly.js/tree/master/test/jasmine/tests).
+
+
 Image pixel comparison tests are run in a docker container. For more
 information on how to run them locally, please refer to [image test
 README](https://github.com/plotly/plotly.js/blob/master/test/image/README.md).
@@ -108,7 +158,7 @@ which shows the baseline image, the generated image, the diff and the json mocks
 To view the results of a run on CircleCI, download the `build/test_images/` and `build/test_images_diff/` artifacts into your local repo and then run `npm run start-image_viewer`.
 
 
-### Repo organization
+## Repo organization
 
 - Distributed files are in `dist/`
 - CommonJS require-able modules are in `lib/`
@@ -120,7 +170,7 @@ To view the results of a run on CircleCI, download the `build/test_images/` and
 - Non-distributed, built files are in `build/` (most files in here are git-ignored, the css and font built files are exceptions)
 
 
-### Coding style
+## Coding style
 
 Check if ok, with `npm run lint`