Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update all dc.mixin docs #999

Merged
merged 3 commits into from
Sep 18, 2015
Merged

Update all dc.mixin docs #999

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
736c2fc
Update baseMixin docs
mtraynham Aug 27, 2015
06bc331
Fix lint issue with scatter plot
mtraynham Aug 27, 2015
09ac529
Update all mixin docs
mtraynham Sep 13, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Update all mixin docs
  • Loading branch information
@mtraynham
mtraynham committed Sep 13, 2015
commit 09ac5299fb799a9a66f7caeedc31fc9be3c6bb49
28 changes: 17 additions & 11 deletions src/bar-chart.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/**
* Concrete bar chart/histogram implementation.
*
* Examples:
* - [Nasdaq 100 Index](http://dc-js.github.com/dc.js/)
* - [Canadian City Crime Stats](http://dc-js.github.com/dc.js/crime/index.html)
Expand All @@ -20,7 +21,7 @@
* in a [Composite Chart](#composite-chart) then pass in the parent composite chart instance.
* @param {String} [chartGroup] - The name of the chart group this chart instance should be placed in.
* Interaction with a chart will only trigger events and redraws within the chart's group.
* @returns {BarChart}
* @return {dc.barChart}
*/
dc.barChart = function (parent, chartGroup) {
var MIN_BAR_WIDTH = 1;
Expand Down Expand Up @@ -174,12 +175,13 @@ dc.barChart = function (parent, chartGroup) {
};

/**
* Whether the bar chart will render each bar centered around the data position on x axis
* Whether the bar chart will render each bar centered around the data position on the x-axis.
* @name centerBar
* @memberof dc.barChart
* @instance
* @param {Boolean} [centerBar=false]
* @returns {Boolean}
* @return {Boolean}
* @return {dc.barChart}
*/
_chart.centerBar = function (centerBar) {
if (!arguments.length) {
Expand All @@ -201,8 +203,9 @@ dc.barChart = function (parent, chartGroup) {
* @name barPadding
* @memberof dc.barChart
* @instance
* @param {Number} [barPadding]
* @returns {Number}
* @param {Number} [barPadding=0]
* @return {Number}
* @return {dc.barChart}
*/
_chart.barPadding = function (barPadding) {
if (!arguments.length) {
Expand All @@ -224,7 +227,8 @@ dc.barChart = function (parent, chartGroup) {
* @memberof dc.barChart
* @instance
* @param {Number} [padding=0.5]
* @returns {Number}
* @return {Number}
* @return {dc.barChart}
*/
_chart.outerPadding = _chart._outerRangeBandPadding;

Expand All @@ -236,7 +240,8 @@ dc.barChart = function (parent, chartGroup) {
* @memberof dc.barChart
* @instance
* @param {Number} [gap=2]
* @returns {Number}
* @return {Number}
* @return {dc.barChart}
*/
_chart.gap = function (gap) {
if (!arguments.length) {
Expand All @@ -260,19 +265,20 @@ dc.barChart = function (parent, chartGroup) {
};

/**
* Set or get whether rounding is enabled when bars are centered. Default: false. If false, using
* Set or get whether rounding is enabled when bars are centered. If false, using
* rounding with centered bars will result in a warning and rounding will be ignored. This flag
* has no effect if bars are not centered.
* has no effect if bars are not {@link #dc.barChart+centerBar centered}.
* When using standard d3.js rounding methods, the brush often doesn't align correctly with
* centered bars since the bars are offset. The rounding function must add an offset to
* compensate, such as in the following example.
* @name alwaysUseRounding
* @memberof dc.barChart
* @instance
* @example
* chart.round(function(n) {return Math.floor(n)+0.5});
* chart.round(function(n) { return Math.floor(n) + 0.5; });
* @param {Boolean} [alwaysUseRounding=false]
* @returns {Boolean}
* @return {Boolean}
* @return {dc.barChart}
*/
_chart.alwaysUseRounding = function (alwaysUseRounding) {
if (!arguments.length) {
Expand Down
29 changes: 27 additions & 2 deletions src/base-mixin.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
* @name baseMixin
* @memberof dc
* @mixin
* @param {{}} _chart
* @param {Object} _chart
* @return {dc.baseMixin}
*/
dc.baseMixin = function (_chart) {
Expand Down Expand Up @@ -120,6 +120,7 @@ dc.baseMixin = function (_chart) {
* chart.height(null); // reset the height to the default auto calculation
* @param {Number|Function} [height]
* @return {Number}
* @return {dc.baseMixin}
*/
_chart.height = function (height) {
if (!arguments.length) {
Expand All @@ -144,6 +145,7 @@ dc.baseMixin = function (_chart) {
* });
* @param {Number|Function} [width]
* @return {Number}
* @return {dc.baseMixin}
*/
_chart.width = function (width) {
if (!arguments.length) {
Expand All @@ -161,6 +163,7 @@ dc.baseMixin = function (_chart) {
* @see {@link #dc.baseMixin+width width}
* @param {Number} [minWidth=200]
* @return {Number}
* @return {dc.baseMixin}
*/
_chart.minWidth = function (minWidth) {
if (!arguments.length) {
Expand All @@ -178,6 +181,7 @@ dc.baseMixin = function (_chart) {
* @see {@link #dc.baseMixin+height height}
* @param {Number} [minHeight=200]
* @return {Number}
* @return {dc.baseMixin}
*/
_chart.minHeight = function (minHeight) {
if (!arguments.length) {
Expand Down Expand Up @@ -205,6 +209,7 @@ dc.baseMixin = function (_chart) {
* chart.dimension(dimension);
* @param {crossfilter.dimension} [dimension]
* @return {crossfilter.dimension}
* @return {dc.baseMixin}
*/
_chart.dimension = function (dimension) {
if (!arguments.length) {
Expand All @@ -229,6 +234,7 @@ dc.baseMixin = function (_chart) {
* chart.data(function (group) { return group.top(5); });
* @param {Function} [callback]
* @return {*}
* @return {dc.baseMixin}
*/
_chart.data = function (callback) {
if (!arguments.length) {
Expand Down Expand Up @@ -261,6 +267,7 @@ dc.baseMixin = function (_chart) {
* @param {crossfilter.group} [group]
* @param {String} [name]
* @return {crossfilter.group}
* @return {dc.baseMixin}
*/
_chart.group = function (group, name) {
if (!arguments.length) {
Expand All @@ -284,6 +291,7 @@ dc.baseMixin = function (_chart) {
* _chart.ordering(dc.pluck('key'));
* @param {Function} [orderFunction]
* @return {Function}
* @return {dc.baseMixin}
*/
_chart.ordering = function (orderFunction) {
if (!arguments.length) {
Expand Down Expand Up @@ -370,6 +378,7 @@ dc.baseMixin = function (_chart) {
* @instance
* @param {anchorChart|anchorSelector|anchorNode} [a]
* @param {String} [chartGroup]
* @return {String|node|d3.selection}
* @return {dc.baseMixin}
*/
_chart.anchor = function (a, chartGroup) {
Expand Down Expand Up @@ -420,6 +429,7 @@ dc.baseMixin = function (_chart) {
* @see {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement HTMLElement}
* @param {HTMLElement} [rootElement]
* @return {HTMLElement}
* @return {dc.baseMixin}
*/
_chart.root = function (rootElement) {
if (!arguments.length) {
Expand All @@ -439,6 +449,7 @@ dc.baseMixin = function (_chart) {
* @see {@link https://developer.mozilla.org/en-US/docs/Web/API/SVGElement SVGElement}
* @param {SVGElement} [svgElement]
* @return {SVGElement}
* @return {dc.baseMixin}
*/
_chart.svg = function (svgElement) {
if (!arguments.length) {
Expand Down Expand Up @@ -485,6 +496,7 @@ dc.baseMixin = function (_chart) {
* @instance
* @param {Function} [filterPrinterFunction=dc.printers.filter]
* @return {Function}
* @return {dc.baseMixin}
*/
_chart.filterPrinter = function (filterPrinterFunction) {
if (!arguments.length) {
Expand Down Expand Up @@ -539,6 +551,7 @@ dc.baseMixin = function (_chart) {
* @instance
* @param {Number} [duration=750]
* @return {Number}
* @return {dc.baseMixin}
*/
_chart.transitionDuration = function (duration) {
if (!arguments.length) {
Expand Down Expand Up @@ -687,6 +700,7 @@ dc.baseMixin = function (_chart) {
* });
* @param {Function} [hasFilterHandler]
* @return {Function}
* @return {dc.baseMixin}
*/
_chart.hasFilterHandler = function (hasFilterHandler) {
if (!arguments.length) {
Expand Down Expand Up @@ -748,6 +762,7 @@ dc.baseMixin = function (_chart) {
* });
* @param {Function} [removeFilterHandler]
* @return {Function}
* @return {dc.baseMixin}
*/
_chart.removeFilterHandler = function (removeFilterHandler) {
if (!arguments.length) {
Expand Down Expand Up @@ -785,6 +800,7 @@ dc.baseMixin = function (_chart) {
* });
* @param {Function} [addFilterHandler]
* @return {Function}
* @return {dc.baseMixin}
*/
_chart.addFilterHandler = function (addFilterHandler) {
if (!arguments.length) {
Expand Down Expand Up @@ -981,6 +997,7 @@ dc.baseMixin = function (_chart) {
* });
* @param {Function} [filterHandler]
* @return {Function}
* @return {dc.baseMixin}
*/
_chart.filterHandler = function (filterHandler) {
if (!arguments.length) {
Expand Down Expand Up @@ -1037,6 +1054,7 @@ dc.baseMixin = function (_chart) {
* chart.keyAccessor(function(p) { return p.value.absGain; });
* @param {Function} [keyAccessor]
* @return {Function}
* @return {dc.baseMixin}
*/
_chart.keyAccessor = function (keyAccessor) {
if (!arguments.length) {
Expand All @@ -1061,6 +1079,7 @@ dc.baseMixin = function (_chart) {
* chart.valueAccessor(function(p) { return p.value.percentageGain; });
* @param {Function} [valueAccessor]
* @return {Function}
* @return {dc.baseMixin}
*/
_chart.valueAccessor = function (valueAccessor) {
if (!arguments.length) {
Expand All @@ -1085,6 +1104,7 @@ dc.baseMixin = function (_chart) {
* chart.label(function(d) { return d.data.key + '(' + Math.floor(d.data.value / all.value() * 100) + '%)'; });
* @param {Function} [labelFunction]
* @return {Function}
* @return {dc.baseMixin}
*/
_chart.label = function (labelFunction) {
if (!arguments.length) {
Expand All @@ -1102,6 +1122,7 @@ dc.baseMixin = function (_chart) {
* @instance
* @param {Boolean} [renderLabel=false]
* @return {Boolean}
* @return {dc.baseMixin}
*/
_chart.renderLabel = function (renderLabel) {
if (!arguments.length) {
Expand Down Expand Up @@ -1133,6 +1154,7 @@ dc.baseMixin = function (_chart) {
* });
* @param {Function} [titleFunction]
* @return {Function}
* @return {dc.baseMixin}
*/
_chart.title = function (titleFunction) {
if (!arguments.length) {
Expand All @@ -1150,6 +1172,7 @@ dc.baseMixin = function (_chart) {
* @instance
* @param {Boolean} [renderTitle=true]
* @return {Boolean}
* @return {dc.baseMixin}
*/
_chart.renderTitle = function (renderTitle) {
if (!arguments.length) {
Expand Down Expand Up @@ -1181,7 +1204,7 @@ dc.baseMixin = function (_chart) {
* moveChart.filter(chart.filter());
* });
* @param {Function} renderletFunction
* @return {Function}
* @return {dc.baseMixin}
*/
_chart.renderlet = dc.logger.deprecate(function (renderletFunction) {
_chart.on('renderlet.' + dc.utils.uniqueId(), renderletFunction);
Expand All @@ -1196,6 +1219,7 @@ dc.baseMixin = function (_chart) {
* @instance
* @param {String} [chartGroup]
* @return {String}
* @return {dc.baseMixin}
*/
_chart.chartGroup = function (chartGroup) {
if (!arguments.length) {
Expand Down Expand Up @@ -1237,6 +1261,7 @@ dc.baseMixin = function (_chart) {
* chart.legend(dc.legend().x(400).y(10).itemHeight(13).gap(5))
* @param {dc.legend} [legend]
* @return {dc.legend}
* @return {dc.baseMixin}
*/
_chart.legend = function (legend) {
if (!arguments.length) {
Expand Down
22 changes: 14 additions & 8 deletions src/bubble-mixin.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
* @memberof dc
* @mixin
* @mixes dc.colorMixin
* @param {Chart} _chart
* @returns {Chart}
* @param {Object} _chart
* @return {dc.bubbleMixin}
*/
dc.bubbleMixin = function (_chart) {
var _maxBubbleRelativeSize = 0.3;
Expand Down Expand Up @@ -35,8 +35,10 @@ dc.bubbleMixin = function (_chart) {
* @name r
* @memberof dc.bubbleMixin
* @instance
* @param {Number[]} [bubbleRadiusScale]
* @returns {Number[]}
* @see {@link http://github.com/mbostock/d3/wiki/Scales d3.scale}
* @param {d3.scale} [bubbleRadiusScale=d3.scale.linear().domain([0, 100])]
* @return {d3.scale}
* @return {dc.bubbleMixin}
*/
_chart.r = function (bubbleRadiusScale) {
if (!arguments.length) {
Expand All @@ -55,7 +57,8 @@ dc.bubbleMixin = function (_chart) {
* @memberof dc.bubbleMixin
* @instance
* @param {Function} [radiusValueAccessor]
* @returns {Function}
* @return {Function}
* @return {dc.bubbleMixin}
*/
_chart.radiusValueAccessor = function (radiusValueAccessor) {
if (!arguments.length) {
Expand Down Expand Up @@ -150,7 +153,8 @@ dc.bubbleMixin = function (_chart) {
* @memberof dc.bubbleMixin
* @instance
* @param {Number} [radius=10]
* @returns {Number}
* @return {Number}
* @return {dc.bubbleMixin}
*/
_chart.minRadius = function (radius) {
if (!arguments.length) {
Expand All @@ -167,7 +171,8 @@ dc.bubbleMixin = function (_chart) {
* @memberof dc.bubbleMixin
* @instance
* @param {Number} [radius=10]
* @returns {Number}
* @return {Number}
* @return {dc.bubbleMixin}
*/

_chart.minRadiusWithLabel = function (radius) {
Expand All @@ -185,7 +190,8 @@ dc.bubbleMixin = function (_chart) {
* @memberof dc.bubbleMixin
* @instance
* @param {Number} [relativeSize=0.3]
* @returns {Number}
* @return {Number}
* @return {dc.bubbleMixin}
*/
_chart.maxBubbleRelativeSize = function (relativeSize) {
if (!arguments.length) {
Expand Down
Loading