Add a basic smith chart

lib/index.js

@@ -50,6 +50,7 @@ Plotly.register([
  require('./scatterpolar'),
  require('./scatterpolargl'),
  require('./barpolar'),
+ require('./scattersmith'),
 
  // transforms
  require('./aggregate'),

lib/scattersmith.js

@@ -0,0 +1,3 @@
+'use strict';
+
+module.exports = require('../src/traces/scattersmith');

src/plot_api/plot_api.js

@@ -3729,6 +3729,9 @@ function makePlotFramework(gd) {
  // single polar layer for the whole plot
  fullLayout._polarlayer = fullLayout._paper.append('g').classed('polarlayer', true);
 
+ // single smith layer for the whole plot
+ fullLayout._smithlayer = fullLayout._paper.append('g').classed('smithlayer', true);
+
  // single ternary layer for the whole plot
  fullLayout._ternarylayer = fullLayout._paper.append('g').classed('ternarylayer', true);
 

src/plots/smith/constants.js

@@ -0,0 +1,21 @@
+'use strict';
+
+module.exports = {
+ attr: 'subplot',
+ name: 'smith',
+
+ axisNames: ['imaginaryaxis', 'realaxis'],
+ axisName2dataArray: {imaginaryaxis: 'theta', realaxis: 'r'},
+
+ layerNames: [
+ 'draglayer',
+ 'plotbg',
+ 'angular-grid',
+ 'radial-grid',
+ 'frontplot',
+ 'angular-line',
+ 'radial-line',
+ 'angular-axis',
+ 'radial-axis'
+ ],
+};

src/plots/smith/index.js

@@ -0,0 +1,75 @@
+'use strict';
+
+var getSubplotCalcData = require('../get_data').getSubplotCalcData;
+var counterRegex = require('../../lib').counterRegex;
+
+var createSmith = require('./smith');
+var constants = require('./constants');
+
+var attr = constants.attr;
+var name = constants.name;
+var counter = counterRegex(name);
+
+var attributes = {};
+attributes[attr] = {
+ valType: 'subplotid',
+ dflt: name,
+ editType: 'calc',
+ description: [
+ 'Sets a reference between this trace\'s data coordinates and',
+ 'a smith subplot.',
+ 'If *smith* (the default value), the data refer to `layout.smith`.',
+ 'If *smith2*, the data refer to `layout.smith2`, and so on.'
+ ].join(' ')
+};
+
+function plot(gd) {
+ var fullLayout = gd._fullLayout;
+ var calcData = gd.calcdata;
+ var subplotIds = fullLayout._subplots[name];
+
+ for(var i = 0; i < subplotIds.length; i++) {
+ var id = subplotIds[i];
+ var subplotCalcData = getSubplotCalcData(calcData, name, id);
+ var subplot = fullLayout[id]._subplot;
+
+ if(!subplot) {
+ subplot = createSmith(gd, id);
+ fullLayout[id]._subplot = subplot;
+ }
+
+ subplot.plot(subplotCalcData, fullLayout, gd._promises);
+ }
+}
+
+function clean(newFullData, newFullLayout, oldFullData, oldFullLayout) {
+ var oldIds = oldFullLayout._subplots[name] || [];
+
+ for(var i = 0; i < oldIds.length; i++) {
+ var id = oldIds[i];
+ var oldSubplot = oldFullLayout[id]._subplot;
+
+ if(!newFullLayout[id] && !!oldSubplot) {
+ oldSubplot.framework.remove();
+ oldSubplot.layers['radial-axis-title'].remove();
+
+ for(var k in oldSubplot.clipPaths) {
+ oldSubplot.clipPaths[k].remove();
+ }
+ }
+ }
+}
+
+module.exports = {
+ attr: attr,
+ name: name,
+ idRoot: name,
+ idRegex: counter,
+ attrRegex: counter,
+ attributes: attributes,
+ layoutAttributes: require('./layout_attributes'),
+ supplyLayoutDefaults: require('./layout_defaults'),
+ plot: plot,
+ clean: clean,
+ toSVG: require('../cartesian').toSVG
+};

src/plots/smith/layout_attributes.js

@@ -0,0 +1,163 @@
+'use strict';
+
+var colorAttrs = require('../../components/color/attributes');
+var axesAttrs = require('../cartesian/layout_attributes');
+var domainAttrs = require('../domain').attributes;
+var extendFlat = require('../../lib').extendFlat;
+var overrideAll = require('../../plot_api/edit_types').overrideAll;
+
+var axisLineGridAttr = overrideAll({
+ color: axesAttrs.color,
+ showline: extendFlat({}, axesAttrs.showline, {dflt: true}),
+ linecolor: axesAttrs.linecolor,
+ linewidth: axesAttrs.linewidth,
+ showgrid: extendFlat({}, axesAttrs.showgrid, {dflt: true}),
+ gridcolor: axesAttrs.gridcolor,
+ gridwidth: axesAttrs.gridwidth
+}, 'plot', 'from-root');
+
+var axisTickAttrs = overrideAll({
+ tickmode: axesAttrs.tickmode,
+ tickvals: axesAttrs.tickvals,
+ ticktext: axesAttrs.ticktext,
+ ticks: axesAttrs.ticks,
+ ticklen: axesAttrs.ticklen,
+ tickwidth: axesAttrs.tickwidth,
+ tickcolor: axesAttrs.tickcolor,
+ showticklabels: axesAttrs.showticklabels,
+ showtickprefix: axesAttrs.showtickprefix,
+ tickprefix: axesAttrs.tickprefix,
+ showticksuffix: axesAttrs.showticksuffix,
+ ticksuffix: axesAttrs.ticksuffix,
+ showexponent: axesAttrs.showexponent,
+ exponentformat: axesAttrs.exponentformat,
+ minexponent: axesAttrs.minexponent,
+ separatethousands: axesAttrs.separatethousands,
+ tickfont: axesAttrs.tickfont,
+ tickangle: axesAttrs.tickangle,
+ tickformat: axesAttrs.tickformat,
+ tickformatstops: axesAttrs.tickformatstops,
+ layer: axesAttrs.layer
+}, 'plot', 'from-root');
+
+var realAxisAttrs = {
+ visible: extendFlat({}, axesAttrs.visible, {dflt: true}),
+
+ title: {
+ // radial title is not gui-editable at the moment,
+ // so it needs dflt: '', similar to carpet axes.
+ text: extendFlat({}, axesAttrs.title.text, {editType: 'plot', dflt: ''}),
+ font: extendFlat({}, axesAttrs.title.font, {editType: 'plot'}),
+
+ // TODO
+ // - might need a 'titleside' and even 'titledirection' down the road
+ // - what about standoff ??
+
+ editType: 'plot'
+ },
+
+ hoverformat: axesAttrs.hoverformat,
+
+ uirevision: {
+ valType: 'any',
+ editType: 'none',
+ description: [
+ 'Controls persistence of user-driven changes in axis `range`,',
+ '`autorange`, `angle`, and `title` if in `editable: true` configuration.',
+ 'Defaults to `smith<N>.uirevision`.'
+ ].join(' ')
+ },
+
+ editType: 'calc',
+};
+
+extendFlat(
+ realAxisAttrs,
+
+ // N.B. realaxis grid lines are circular,
+ // but realaxis lines are straight from circle center to outer bound
+ axisLineGridAttr,
+ axisTickAttrs
+);
+
+var imaginaryAxisAttrs = {
+ visible: extendFlat({}, axesAttrs.visible, {dflt: true}),
+
+ direction: {
+ valType: 'enumerated',
+ values: ['counterclockwise', 'clockwise'],
+ dflt: 'counterclockwise',
+ editType: 'calc',
+ description: [
+ 'Sets the direction corresponding to positive angles.'
+ ].join(' ')
+ },
+
+ rotation: {
+ valType: 'angle',
+ editType: 'calc',
+ description: [
+ 'Sets that start position (in degrees) of the angular axis',
+ 'By default, smith subplots with `direction` set to *counterclockwise*',
+ 'get a `rotation` of *0*',
+ 'which corresponds to due East (like what mathematicians prefer).',
+ 'In turn, smith with `direction` set to *clockwise* get a rotation of *90*',
+ 'which corresponds to due North (like on a compass),'
+ ].join(' ')
+ },
+
+ hoverformat: axesAttrs.hoverformat,
+
+ uirevision: {
+ valType: 'any',
+ editType: 'none',
+ description: [
+ 'Controls persistence of user-driven changes in axis `rotation`.',
+ 'Defaults to `smith<N>.uirevision`.'
+ ].join(' ')
+ },
+
+ editType: 'calc'
+};
+
+extendFlat(
+ imaginaryAxisAttrs,
+
+ // N.B. angular grid lines are straight lines from circle center to outer bound
+ // the angular line is circular bounding the smith plot area.
+ axisLineGridAttr,
+
+ // N.B. ticksuffix defaults to '°' for angular axes with `thetaunit: 'degrees'`
+ axisTickAttrs
+);
+
+module.exports = {
+ // TODO for x/y/zoom system for paper-based zooming:
+ // x: {},
+ // y: {},
+ // zoom: {},
+
+ domain: domainAttrs({name: 'smith', editType: 'plot'}),
+
+ bgcolor: {
+ valType: 'color',
+ editType: 'plot',
+ dflt: colorAttrs.background,
+ description: 'Set the background color of the subplot'
+ },
+
+ realaxis: realAxisAttrs,
+ imaginaryaxis: imaginaryAxisAttrs,
+
+ uirevision: {
+ valType: 'any',
+ editType: 'none',
+ description: [
+ 'Controls persistence of user-driven changes in axis attributes,',
+ 'if not overridden in the individual axes.',
+ 'Defaults to `layout.uirevision`.'
+ ].join(' ')
+ },
+
+ editType: 'calc'
+};