TODO rename to outerRangeBandPadding and add documentation, check if it can be moved to conf
TODO rename to rangeBandPadding and add documentation, check if it can be moved to conf
Chart groups are rendered or redrawn together since it is expected they share the same underlying data set.
chartGroup is passed to teh chart constructor. Setting it directly can have unintended consequences.
Overrides the color selection algorithm, replacing it with a simple function.
Normally colors will be determined by calling the colorAccessor to get a value, and then passing that
value through the colorScale.
But sometimes it is difficult to get a color scale to produce the desired effect. The colorCalculator
takes the datum and index and returns a color directly.
Set or get the current domain for the color mapping function. The domain must be supplied as an array.
Note: previously this method accepted a callback function. Instead, you may use a custom scale set by colorScale.
dc charts use on the ColorHelpers for color.
To color chart elements (like Pie slice, a row, a bar, etc.), typically
the underlying data element will be used to determine the color.
In most of the cases output of colorAccessor(d, i) will be used to determine the color.
Usually charts would used use one of
Different implementations of ColorAccessors provide different functionality:
// TODO example
Use any of d3 scales for color. This method is a shorthand for the following:
chart.scaledColors(scale); // same as chart.colorHelper(new ColorScaleHelper(scale));
Depending on type of scale, it will need either setting domain for the scale or
compute it as per your data using calculateColorDomain.
TODO add details
Protected handleCurrent height of the chart.
To explicitly set height, please set height as part of the chart configuration.
If not set explicitly the size will be as per the anchor HTML element subject to a minimum as set in minHeight. In that case it will keep automatically resizing as well.
Attach a Legend widget to this chart. The legend widget will automatically draw legend labels based on the color setting and names associated with each group.
chart.legend(new Legend().x(400).y(10).itemHeight(13).gap(5))
Get or set the margins for a particular coordinate grid chart instance. The margins is stored as an associative Javascript array.
let leftMargin = chart.margins().left; // 30 by default
chart.margins().left = 50;
leftMargin = chart.margins().left; // now 50
Ordinal colors are used most commonly in dc charts.
This call is a shorthand for using an OrdinalColors instance
as colorHelper.
chart.ordinalColors(colorList); // same as chart.colorHelper(new OrdinalColors(colorList));
Calling redraw will cause the chart to re-render data changes incrementally. If there is no change in the underlying data dimension then calling this method will have no effect on the chart. Most chart interaction in dc will automatically trigger this method through internal events; therefore, you only need to manually invoke this function if data is manipulated outside of dc's control (for example if data is loaded in the background using crossfilter.add).
Typically you would invoke redrawGroup which will redraw all charts within the chartGroup.
Redraw all charts in the same group as this chart, typically in reaction to a filter change. If the chart has a commitHandler, it will be executed and waited for. It internally calls redrawAll
Invoking this method will force the chart to re-render everything from scratch. Generally it should only be used to render the chart for the first time on the page or if you want to make sure everything is redrawn from scratch instead of relying on the default incremental redrawing behaviour.
Typically you would invoke renderGroup which will redraw all charts within the chartGroup.
Renders all charts in the same group as this chart. If the chart has a commitHandler, it will be executed and waited for. It internally calls redrawAll
A renderlet is similar to an event listener on rendering event. Multiple renderlets can be added to an individual chart. Each time a chart is rerendered or redrawn the renderlets are invoked right after the chart finishes its transitions, giving you a way to modify the SVGElements. Renderlet functions take the chart instance as the only input parameter and you can use the dc API or use raw d3 to achieve pretty much any effect.
Use on with a 'renderlet' prefix. Generates a random key for the renderlet, which makes it hard to remove.
chart.renderlet has been deprecated. Please use chart.on("renderlet.
// do this instead of .renderlet(function(chart) { ... })
chart.on("renderlet", function(chart){
// mix of dc API and d3 manipulation
chart.select('g.y').style('display', 'none');
// its a closure so you can also access other chart variable available in the closure scope
moveChart.filter(chart.filter());
});
TODO move to compat
Current width of the chart.
To explicitly set width, please set width as part of the chart configuration.
If not set explicitly the size will be as per the anchor HTML element subject to a minimum as set in minWidth. In that case it will keep automatically resizing as well.
Execute the callback without transitions.
Internally it sets transitionDuration to 0 and restores it after
the callback().
mandatory
Get or set the x scale. The x scale can be any d3 d3.scale or ordinal scale
// set x to a linear scale
chart.x(d3.scaleLinear().domain([-2500, 2500]))
// set x to a time scale to generate histogram
chart.x(d3.scaleTime().domain([new Date(1985, 0, 1), new Date(2012, 11, 31)]))
Set or get the x axis label. If setting the label, you may optionally include additional padding to the margin to make room for the label. By default the padded is set to 12 to accommodate the text height.
Optional padding: numberGet or set the y scale. The y scale is typically automatically determined by the chart implementation.
Set or get the y axis label. If setting the label, you may optionally include additional padding to the margin to make room for the label. By default the padding is set to 12 to accommodate the text height.
Optional padding: numberSet the domain by determining the min and max values as retrieved by .colorAccessor over the chart's dataset.
This is useful only for certain type of color scales.
In particular it will not work with ordinalColors.
Filter the chart by the given parameter, or return the current filter if no input parameter is given.
Starting version 5, filtering is provided by DataProvider.
Clear all filters associated with this chart. The same effect can be achieved by calling chart.filter(null).
Returns all current filters. This method does not perform defensive cloning of the internal filter array before returning, therefore any modification of the returned array will effect the chart's internal filter storage.
Starting version 5, filtering is provided by DataProvider.
Zoom this chart to focus on the given range. The given range should be an array containing only
2 elements ([start, end]) defining a range in the x domain. If the range is not given or set
to null, then the zoom will be reset. _For focus to work elasticX has to be turned off;
otherwise focus will be ignored.
To avoid ping-pong volley of events between a pair of range and focus charts please set
noRaiseEvents to true. In that case it will update this chart but will not fire zoom event
and not try to update back the associated range chart.
If you are calling it manually - typically you will leave it to false (the default).
Starting with v5, this method is unlikely to be invoked directly.
A chart that needs to be focused should have autoFocus set.
Such charts will focus when a filter is applied.
A mouseZoomable chart focuses itself when zoomed.
chart.focus([5, 10]);
// reset focus
chart.focus(null);
Returns true if the chart is using ordinal xUnits (UnitsOrdinal, or false otherwise. Most charts behave differently with ordinal data and use the result of this method to trigger the appropriate logic.
All dc chart instance supports the following listeners. Supports the following events:
renderlet - This listener function will be invoked after transitions after redraw and render. Replaces the
deprecated renderlet method.pretransition - Like .on('renderlet', ...) but the event is fired before transitions start.preRender - This listener function will be invoked before chart rendering.postRender - This listener function will be invoked after chart finish rendering including
all renderlets' logic.preRedraw - This listener function will be invoked before chart redrawing.postRedraw - This listener function will be invoked after chart finish redrawing
including all renderlets' logic.filtered - This listener function will be invoked after a filter is applied, added or removed.zoomed - This listener function will be invoked after a zoom is triggered..on('renderlet', function(chart, filter){...})
.on('pretransition', function(chart, filter){...})
.on('preRender', function(chart){...})
.on('postRender', function(chart){...})
.on('preRedraw', function(chart){...})
.on('postRedraw', function(chart){...})
.on('filtered', function(chart, filter){...})
.on('zoomed', function(chart, filter){...})
Replace the chart filter. This is equivalent to calling chart.filter(null).filter(filter)
but more efficient because the filter is only applied once.
Starting version 5, filtering is provided by DataProvider.
When changing the domain of the x or y scale, it is necessary to tell the chart to recalculate
and redraw the axes. (.rescale() is called automatically when the x or y scale is replaced
with .x() or .y(), and has
no effect on elastic scales.)
Get or set if the chart is currently resizing.
Execute d3 single selection in the chart's scope using the given selector and return the d3 selection.
This function is not chainable since it does not return a chart instance; however the d3 selection result can be chained to d3 function calls.
This is typically used in augmenting/modifying a chart.
TODO link to example
// Has the same effect as d3.select('#chart-id').select(selector)
chart.select(selector)
CSS selector string
Execute in scope d3 selectAll using the given selector and return d3 selection result.
This function is not chainable since it does not return a chart instance; however the d3 selection result can be chained to d3 function calls.
This is typically used in augmenting/modifying a chart.
TODO link to example
// Has the same effect as d3.select('#chart-id').selectAll(selector)
chart.selectAll(selector)
CSS selector string
Turn on optional control elements within the root element. dc currently supports the following html control elements.
Set or get the x axis used by a particular coordinate grid chart instance. This function is most useful when x axis customization is required. The x axis in dc.js is an instance of a d3 bottom axis object; therefore it supports any valid d3 axisBottom manipulation.
Caution: The x axis is usually generated internally by dc; resetting it may cause
unexpected results. Note also that when used as a getter, this function is not chainable:
it returns the axis, not the chart,
so attempting to call chart functions after calling .xAxis() will fail.
// customize x axis tick format
chart.xAxis().tickFormat(function(v) {return v + '%';});
// customize x axis tick values
chart.xAxis().tickValues([0, 100, 200, 300]);
Returns the number of units displayed on the x axis. If the x axis is ordinal (xUnits is
UnitsOrdinal), this is the number of items in the domain of the x scale. Otherwise, the
x unit count is calculated using the xUnits function.
Set or get the y axis used by the coordinate grid chart instance. This function is most useful
when y axis customization is required. Depending on useRightYAxis the y axis in dc.js is an instance of
either d3.axisLeft or
d3.axisRight; therefore it supports any
valid d3 axis manipulation.
Caution: The y axis is usually generated internally by dc; resetting it may cause
unexpected results. Note also that when used as a getter, this function is not chainable: it
returns the axis, not the chart,
so attempting to call chart functions after calling .yAxis() will fail.
In addition, depending on whether you are going to use the axis on left or right
you need to appropriately pass d3.axisLeft
or d3.axisRight
// customize y axis tick format
chart.yAxis().tickFormat(function(v) {return v + '%';});
// customize y axis tick values
chart.yAxis().tickValues([0, 100, 200, 300]);
Set the root SVGElement to either be an existing chart's root; or any valid d3 single selector specifying a dom block element such as a div; or a dom element or d3 selection.
This is internally managed. Invoking it directly may have unintended consequences.
Get or set the brush. Brush must be an instance of d3 brushes https://github.com/d3/d3-brush/blob/master/README.md You will use this only if you are writing a new chart type that supports brushing.
Caution: dc creates and manages brushes internally. Go through and understand the source code if you want to pass a new brush object. Even if you are only using the getter, the brush object may not behave the way you expect.
Retrieve the svg group for the chart body.
Return charts data, typically group.all(). Some charts override this method.
The derived classes may even use different return type.
Return charts data, typically group.all(). Some charts override this method.
The derived classes may even use different return type.
Protected expireExpire the internal chart cache. dc charts cache some data internally on a per chart basis to speed up rendering and avoid unnecessary calculation; however it might be useful to clear the cache if you have changed state which will affect rendering. For example, if you invoke crossfilter.add function or reset group or dimension after rendering, it is a good idea to clear the cache to make sure charts are rendered properly.
TODO determine if it can be removed, does not seem to be used
Get or set the root g element. This method is usually used to retrieve the g element in order to overlay custom svg drawing programatically. Caution: The root g element is usually generated by dc.js internals, and resetting it might produce unpredictable result.
List of items that will show as legends. The charts implement this method.
This function is passed to d3 as the onClick handler for each chart. The default behavior is to filter on the clicked datum (passed to the callback) and redraw the chart group.
This function can be replaced in order to change the click behavior (but first look at
const oldHandler = chart.onClick;
chart.onClick = function(datum) {
// use datum.
}
Optional i: numberProtected onSet chart options using a configuration object. Each key in the object will cause the method of the same name to be called with the value to set that attribute for the chart. TODO: With concept of conf, this is less relevant now, consider moving it to compat.
chart.options({dimension: myDimension, group: myGroup});
Returns the root element where a chart resides. Usually it will be the parent div element where the SVGElement was created.
Resetting the root element on a chart outside of dc internals may have unexpected consequences.
Returns the top SVGElement for this specific chart.
Usually generating an SVG Element is handled handled by dc internally. The BubbleOverlay, however, needs an SVG Element to be passed explicitly.
Resetting the SVGElement on a chart outside of dc internals may have unexpected consequences.
Generated using TypeDoc
Coordinate Grid is an abstract base chart designed to support a number of coordinate grid based concrete chart types, e.g. bar chart, line chart, and bubble chart.