ternary scaffolding

Author: alexcjohnson

src/plot_api/plot_api.js

@@ -280,6 +280,7 @@ Plotly.plot = function(gd, data, layout, config) {
         if(fullLayout._hasCartesian || fullLayout._hasPie) {
             plotRegistry.cartesian.plot(gd);
         }
+        if(fullLayout._hasTernary) plotRegistry.ternary.plot(gd);
 
         // clean up old scenes that no longer have associated data
         // will this be a performance hit?
@@ -2595,7 +2596,8 @@ function makePlotFramework(gd) {
 
     if(fullLayout._hasCartesian) makeCartesianPlotFramwork(gd, subplots);
 
-    // single shape and pie layers for the whole plot
+    // single ternary, shape and pie layers for the whole plot
+    fullLayout._ternarylayer = fullLayout._paper.append('g').classed('ternarylayer', true);
     fullLayout._shapelayer = fullLayout._paper.append('g').classed('shapelayer', true);
     fullLayout._pielayer = fullLayout._paper.append('g').classed('pielayer', true);
 

src/plots/layout_attributes.js

@@ -188,6 +188,10 @@ module.exports = {
         valType: 'boolean',
         dflt: false
     },
+    _hasTernary: {
+        valType: 'boolean',
+        dflt: false
+    },
     _composedModules: {
         '*': 'Fx'
     },
@@ -200,6 +204,7 @@ module.exports = {
         'geo': 'geo',
         'legend': 'Legend',
         'annotations': 'Annotations',
-        'shapes': 'Shapes'
+        'shapes': 'Shapes',
+        'ternary': 'ternary'
     }
 };

src/plots/plots.js

@@ -470,6 +470,7 @@ plots.supplyDefaults = function(gd) {
         else if(plots.traceIs(fullTrace, 'geo')) newFullLayout._hasGeo = true;
         else if(plots.traceIs(fullTrace, 'pie')) newFullLayout._hasPie = true;
         else if(plots.traceIs(fullTrace, 'gl2d')) newFullLayout._hasGL2D = true;
+        else if(plots.traceIs(fullTrace, 'ternary')) newFullLayout._hasTernary = true;
         else if('r' in fullTrace) newFullLayout._hasPolar = true;
 
         _module = fullTrace._module;
@@ -714,6 +715,7 @@ plots.supplyLayoutGlobalDefaults = function(layoutIn, layoutOut) {
     coerce('_hasGeo');
     coerce('_hasPie');
     coerce('_hasGL2D');
+    coerce('_hasTernary');
 };
 
 plots.supplyLayoutModuleDefaults = function(layoutIn, layoutOut, fullData) {

src/plots/ternary/index.js

@@ -0,0 +1,71 @@
+/**
+* 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';
+
+var Ternary = require('./ternary');
+
+var Plots = require('../../plots/plots');
+
+
+exports.name = 'ternary';
+
+exports.attr = 'ternary';
+
+exports.idRoot = 'ternary';
+
+exports.idRegex = /^ternary([2-9]|[1-9][0-9]+)?$/;
+
+exports.attrRegex = /^ternary([2-9]|[1-9][0-9]+)?$/;
+
+exports.attributes = require('./layout/attributes');
+
+exports.layoutAttributes = require('./layout/layout_attributes');
+
+exports.supplyLayoutDefaults = require('./layout/defaults');
+
+exports.plot = function plotTernary(gd) {
+    var fullLayout = gd._fullLayout,
+        fullData = gd._fullData,
+        ternaryIds = Plots.getSubplotIds(fullLayout, 'ternary');
+
+    for(var i = 0; i < ternaryIds.length; i++) {
+        var ternaryId = ternaryIds[i],
+            fullTernaryData = Plots.getSubplotData(fullData, 'ternary', ternaryId),
+            ternary = fullLayout[ternaryId]._ternary;
+
+        // If ternary is not instantiated, create one!
+        if(ternary === undefined) {
+            ternary = new Ternary({
+                id: ternaryId,
+                graphDiv: gd,
+                container: fullLayout._ternarycontainer.node()
+            },
+                fullLayout
+            );
+
+            fullLayout[ternaryId]._ternary = ternary;
+        }
+
+        ternary.plot(fullTernaryData, fullLayout, gd._promises);
+    }
+};
+
+exports.clean = function(newFullData, newFullLayout, oldFullData, oldFullLayout) {
+    var oldTernaryKeys = Plots.getSubplotIds(oldFullLayout, 'ternary');
+
+    for(var i = 0; i < oldTernaryKeys.length; i++) {
+        var oldTernaryKey = oldTernaryKeys[i];
+        var oldTernary = oldFullLayout[oldTernaryKey]._ternary;
+
+        if(!newFullLayout[oldTernaryKey] && !!oldTernary) {
+            oldTernary.ternaryDiv.remove();
+        }
+    }
+};

src/plots/ternary/layout/axis_defaults.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';
+
+var Lib = require('../../../lib');
+var layoutAttributes = require('./axis_attributes');
+
+var axesNames = ['aaxis', 'baxis', 'caxis'];
+
+
+module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, options) {
+    var containerIn, containerOut;
+
+    function coerce(attr, dflt) {
+        return Lib.coerce(containerIn, containerOut, layoutAttributes, attr, dflt);
+    }
+
+    for(var j = 0; j < axesNames.length; j++) {
+        var axName = axesNames[j];
+        containerIn = layoutIn[axName] || {};
+
+        containerOut = {
+            _name: axName
+        };
+
+        // TODO - what can we reuse from cartesian?
+    }
+};

src/plots/ternary/layout/defaults.js

@@ -0,0 +1,32 @@
+/**
+* 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';
+
+var handleSubplotDefaults = require('../../subplot_defaults');
+var layoutAttributes = require('./layout_attributes');
+var supplyTernaryAxisLayoutDefaults = require('./axis_defaults');
+
+module.exports = function supplyLayoutDefaults(layoutIn, layoutOut, fullData) {
+    if(!layoutOut._hasTernary) return;
+
+    handleSubplotDefaults(layoutIn, layoutOut, fullData, {
+        type: 'ternary',
+        attributes: layoutAttributes,
+        handleDefaults: handleTernaryDefaults,
+        font: layoutOut.font
+    });
+};
+
+function handleTernaryDefaults(ternaryLayoutIn, ternaryLayoutOut, coerce, options) {
+    coerce('bgcolor');
+    coerce('sum');
+
+    supplyTernaryAxisLayoutDefaults(ternaryLayoutIn, ternaryLayoutOut, options);
+}