Skip to content

Commit

Permalink
documentation for #1274
Browse files Browse the repository at this point in the history
  • Loading branch information
gordonwoodhull committed May 24, 2017
1 parent 93ef7f9 commit 5f56865
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions src/scatter-plot.js
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,20 @@ dc.scatterPlot = function (parent, chartGroup) {
return _chart;
};

/**
* Get or set the symbol generator. By default `dc.scatterPlot` will use
* {@link https://github.com/d3/d3-3.x-api-reference/blob/master/SVG-Shapes.md#symbol d3.svg.symbol()}
* to generate symbols. `dc.scatterPlot` will set the
* {@link https://github.com/d3/d3-3.x-api-reference/blob/master/SVG-Shapes.md#symbol_size size accessor}
* on the symbol generator.
* @method customSymbol
* @memberof dc.scatterPlot
* @instance
* @see {@link https://github.com/d3/d3-3.x-api-reference/blob/master/SVG-Shapes.md#symbol d3.svg.symbol}
* @see {@link https://stackoverflow.com/questions/25332120/create-additional-d3-js-symbols Create additional D3.js symbols}
* @param {String|Function} [customSymbol=d3.svg.symbol()]
* @returns {String|Function|dc.scatterPlot}
*/
_chart.customSymbol = function (customSymbol) {
if (!arguments.length) {
return _symbol;
Expand Down

0 comments on commit 5f56865

Please sign in to comment.