Expose trace modules

.npmignore

@@ -9,3 +9,12 @@ test
 dist/extras/mathjax
 
 circle.yml
+docker-compose.yml
+bower.json
+
+.ackrc
+.agignore
+.eslintignore
+.eslintrc
+
+npm-debug.log

CONTRIBUTING.md

@@ -106,9 +106,10 @@ To view the results of a run on CircleCI, download the `build/test_images/` and
 ### Repo organization
 
 - Distributed files are in `dist/`
+- CommonJS require-able modules are in `lib/`
 - Sources files are in `src/`, including the index
 - Build and repo management scripts are in `tasks/`
-- All tasks can be run using [`npm run-srcript`](https://docs.npmjs.com/cli/run-script)
+- All tasks can be run using [`npm run-script`](https://docs.npmjs.com/cli/run-script)
 - Tests are `test/`, they are partitioned into `image` and `jasmine` tests
 - Test dashboard and image viewer code is in `devtools/`
 - Non-distributed, built files are in `build/` (most files in here are git-ignored, the css and font built files are exceptions)

README.md

@@ -1,6 +1,6 @@
 <a href="https://plot.ly/javascript/"><img src="http://images.plot.ly/logo/[email protected]" height="70"></a>
 
-[![npm version](https://badge.fury.io/js/plotly.js.svg)](https://badge.fury.io/js/plotly.js) 
+[![npm version](https://badge.fury.io/js/plotly.js.svg)](https://badge.fury.io/js/plotly.js)
 [![circle ci](https://circleci.com/gh/plotly/plotly.js.png?&style=shield&circle-token=1f42a03b242bd969756fc3e53ede204af9b507c0)](https://circleci.com/gh/plotly/plotly.js)
 
 Built on top of [d3.js](http://d3js.org/) and [stack.gl](http://stack.gl/),
@@ -10,6 +10,7 @@ chart types, including 3D charts, statistical graphs, and SVG maps.
 ## Table of contents
 
 * [Quick start options](#quick-start-options)
+* [Modules](#modules)
 * [Bugs and feature requests](#bugs-and-feature-requests)
 * [Documentation](#documentation)
 * [Contributing](#contributing)
@@ -38,9 +39,46 @@ npm install plotly.js
 ```html
 <!-- Latest compiled and minified plotly.js JavaScript -->
 <script type="text/javascript" src="https://cdn.plot.ly/plotly-latest.min.js"></script>
+
+<!-- OR use a specific plotly.js release (e.g. version 1.5.0)-->
+<script type="text/javascript" src="https://cdn.plot.ly/plotly-1.5.0.min.js"></script>
 ```
 
-Read the [Getting started page](https://plot.ly/javascript/getting-started/) for examples.
+Read the [Getting started page](https://plot.ly/javascript/getting-started/) for more examples.
+
+## Modules
+
+If you would like to reduce the bundle size of plotly.js, you can create a *custom* bundle by using `plotly.js/lib/core`, and loading only the trace types that you need (e.g. `pie` or `choropleth`). The recommended way to do this is by creating a *bundling file*: 
+
+```javascript
+// in custom-plotly.js
+var plotlyCore = require('plotly.js/lib/core');
+
+// Load in the trace types for pie, and choropleth
+plotlyCore.register([
+    require('plotly.js/lib/pie'),
+    require('plotly.js/lib/choropleth');
+]);
+
+module.exports = customPlotly;
+```
+
+Then elsewhere in your code:
+
+```javascript
+var Plotly = require('./path/to/custom-plotly');
+```
+
+**IMPORTANT**: the plotly.js code base contains some non-ascii characters. Therefore, please make sure to set the `chartset` attribute to `"utf-8"` in the script tag that imports your plotly.js bundle. For example:
+
+```html
+<script type="text/javascript" src="my-plotly-bundle.js" charset="utf-8"></script>
+```
+
+
+#### Webpack Usage with Modules
+
+Browserify [transforms](https://github.com/substack/browserify-handbook#transforms) are required to build plotly.js, namely, [glslify](https://github.com/stackgl/glslify) to transform WebGL shaders and [cwise](https://github.com/scijs/cwise) to compile component-wise array operations. To make the trace module system work with Webpack, you will need to install [ify-loader](https://github.com/hughsk/ify-loader) and add it to your `webpack.config.json` for your build to correctly bundle plotly.js files.
 
 ## Bugs and feature requests
 

lib/bar.js

@@ -0,0 +1,9 @@
+/**
+* Copyright 2012-2016, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+module.exports = require('../src/traces/bar');

lib/box.js

@@ -0,0 +1,9 @@
+/**
+* Copyright 2012-2016, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+module.exports = require('../src/traces/box');

lib/choropleth.js

@@ -0,0 +1,9 @@
+/**
+* Copyright 2012-2016, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+module.exports = require('../src/traces/choropleth');

lib/contour.js

@@ -0,0 +1,9 @@
+/**
+* Copyright 2012-2016, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+module.exports = require('../src/traces/contour');

lib/core.js

@@ -0,0 +1,9 @@
+/**
+* Copyright 2012-2016, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+module.exports = require('../src/core');

lib/heatmap.js

@@ -0,0 +1,9 @@
+/**
+* Copyright 2012-2016, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+module.exports = require('../src/traces/heatmap');

lib/histogram.js

@@ -0,0 +1,9 @@
+/**
+* Copyright 2012-2016, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+module.exports = require('../src/traces/histogram');

lib/histogram2d.js

@@ -0,0 +1,9 @@
+/**
+* Copyright 2012-2016, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+module.exports = require('../src/traces/histogram2d');

lib/histogram2dcontour.js

@@ -0,0 +1,9 @@
+/**
+* Copyright 2012-2016, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+module.exports = require('../src/traces/histogram2dcontour');

lib/index.js

@@ -0,0 +1,35 @@
+/**
+* Copyright 2012-2016, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+'use strict';
+
+/*
+ * This file is browserify'ed into a standalone 'Plotly' object.
+ */
+
+var Core = require('./core');
+
+// Load all trace modules
+Core.register([
+    require('./bar'),
+    require('./box'),
+    require('./heatmap'),
+    require('./histogram'),
+    require('./histogram2d'),
+    require('./histogram2dcontour'),
+    require('./pie'),
+    require('./contour'),
+    require('./scatter3d'),
+    require('./surface'),
+    require('./mesh3d'),
+    require('./scattergeo'),
+    require('./choropleth'),
+    require('./scattergl')
+]);
+
+module.exports = Core;

lib/mesh3d.js

@@ -0,0 +1,9 @@
+/**
+* Copyright 2012-2016, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+module.exports = require('../src/traces/mesh3d');

lib/pie.js

@@ -0,0 +1,9 @@
+/**
+* Copyright 2012-2016, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+module.exports = require('../src/traces/pie');

lib/scatter.js

@@ -0,0 +1,9 @@
+/**
+* Copyright 2012-2016, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+module.exports = require('../src/traces/scatter');

lib/scatter3d.js

@@ -0,0 +1,9 @@
+/**
+* Copyright 2012-2016, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+module.exports = require('../src/traces/scatter3d');

lib/scattergeo.js

@@ -0,0 +1,9 @@
+/**
+* Copyright 2012-2016, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+module.exports = require('../src/traces/scattergeo');

lib/scattergl.js

@@ -0,0 +1,9 @@
+/**
+* Copyright 2012-2016, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+module.exports = require('../src/traces/scattergl');

lib/surface.js

@@ -0,0 +1,9 @@
+/**
+* Copyright 2012-2016, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+module.exports = require('../src/traces/surface');

package.json

@@ -3,8 +3,8 @@
   "version": "1.4.1",
   "description": "The open source javascript graphing library that powers plotly",
   "license": "MIT",
-  "main": "./src/index.js",
-  "webpack": "./dist/plotly.min.js",
+  "main": "./lib/index.js",
+  "webpack": "./dist/plotly.js",
   "repository": {
     "type": "git",
     "url": "https://github.com/plotly/plotly.js.git"

src/index.js → src/core.js

@@ -10,9 +10,6 @@
 
 /*
  * Export the plotly.js API methods.
- *
- * This file is browserify'ed into a standalone 'Plotly' object.
- *
  */
 
 var Plotly = require('./plotly');
@@ -32,6 +29,7 @@ exports.addTraces = Plotly.addTraces;
 exports.deleteTraces = Plotly.deleteTraces;
 exports.moveTraces = Plotly.moveTraces;
 exports.setPlotConfig = require('./plot_api/set_plot_config');
+exports.register = Plotly.register;
 
 // plot icons
 exports.Icons = require('../build/ploticon');
@@ -45,20 +43,3 @@ exports.Queue = Plotly.Queue;
 
 // export d3 used in the bundle
 exports.d3 = require('d3');
-
-Plotly.register([
-    require('./traces/bar'),
-    require('./traces/box'),
-    require('./traces/heatmap'),
-    require('./traces/histogram'),
-    require('./traces/histogram2d'),
-    require('./traces/histogram2dcontour'),
-    require('./traces/pie'),
-    require('./traces/contour'),
-    require('./traces/scatter3d'),
-    require('./traces/surface'),
-    require('./traces/mesh3d'),
-    require('./traces/scattergeo'),
-    require('./traces/choropleth'),
-    require('./traces/scattergl')
-]);

tasks/bundle.js

@@ -35,7 +35,7 @@ catch(e) {
 
 
 // Browserify plotly.js
-browserify(constants.pathToPlotlySrc, {
+browserify(constants.pathToPlotlyIndex, {
     debug: DEV,
     standalone: 'Plotly',
     transform: [compressAttributes]
@@ -65,7 +65,7 @@ browserify(constants.pathToPlotlyGeoAssetsSrc, {
 
 
 // Browserify the plotly.js with meta
-browserify(constants.pathToPlotlySrc, {
+browserify(constants.pathToPlotlyIndex, {
     debug: DEV,
     standalone: 'Plotly'
 })

tasks/cibundle.js

@@ -16,7 +16,7 @@ var constants = require('./util/constants');
 
 
 // Browserify plotly.js
-browserify(constants.pathToPlotlySrc, {
+browserify(constants.pathToPlotlyIndex, {
     standalone: 'Plotly',
     transform: [compressAttributes]
 })

tasks/header.js

@@ -32,8 +32,9 @@ pathsDist.forEach(headerLicense);
 var licenseSrc = constants.licenseSrc;
 var licenseStr = licenseSrc.substring(2, licenseSrc.length - 2);
 
-
-glob(path.join(constants.pathToSrc, '**/*.js'), function(err, files) {
+var srcGlob = path.join(constants.pathToSrc, '**/*.js');
+var libGlob = path.join(constants.pathToLib, '**/*.js');
+glob('{' + srcGlob + ',' + libGlob + '}', function(err, files){
     files.forEach(function(file) {
         fs.readFile(file, 'utf-8', function(err, code) {
 

tasks/preprocess.js

@@ -31,5 +31,5 @@ fs.copy(constants.pathToTopojsonSrc, constants.pathToTopojsonDist,
 );
 
 // inject package version into source index files
-updateVersion(constants.pathToPlotlySrc);
+updateVersion(constants.pathToPlotlyCore);
 updateVersion(constants.pathToPlotlyGeoAssetsSrc);