Class HeatMap

A heat map is matrix that represents the values of two dimensions of data using colors.

Hierarchy

Constructors

  • Create a Heat Map

    TODO update example

    Example

    // create a heat map under #chart-container1 element using the default global chart group
    const heatMap1 = new HeatMap('#chart-container1');
    // create a heat map under #chart-container2 element using chart group A
    const heatMap2 = new HeatMap('#chart-container2', 'chartGroupA');

    Parameters

    Returns HeatMap

Properties

Standard Methods

  • Returns HeatMap

  • Returns HeatMap

  • 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.

    Returns IChartGroup

  • Parameters

    Returns HeatMap

  • 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.

    Returns ColorAccessor

  • Parameters

    Returns any

  • 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.

    Returns string[]

  • Parameters

    • domain: string[]

    Returns any

  • 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
    

    Returns AbstractColorHelper

  • Parameters

    Returns any

  • 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.

    See

    Parameters

    Returns any

  • TODO add details

    Returns CFSimpleAdapter

  • Parameters

    • dataProvider: any

    Returns HeatMap

  • Returns any

  • Parameters

    • filter: any

    Returns HeatMap

  • Current 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.

    See

    Returns number

  • 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.

    Example

    chart.legend(new Legend().x(400).y(10).itemHeight(13).gap(5))
    

    Returns any

  • Parameters

    • legend: any

    Returns HeatMap

  • Convenience method to set the color scale to an Hcl interpolated linear scale with range r.

    Parameters

    • r: [string, string]

    Returns any

  • Get or set the margins for a particular coordinate grid chart instance. The margins is stored as an associative Javascript array.

    Example

    let leftMargin = chart.margins().left; // 30 by default
    chart.margins().left = 50;
    leftMargin = chart.margins().left; // now 50

    Returns Margins

  • Parameters

    Returns HeatMap

  • 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.

    Returns HeatMap

  • 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

    See

    Returns HeatMap

  • 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.

    Returns HeatMap

  • 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

    See

    Returns HeatMap

  • 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.

    Deprecated

    chart.renderlet has been deprecated. Please use chart.on("renderlet.", renderletFunction)

    Example

    // 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

    Parameters

    • renderletFunction: any

    Returns HeatMap

  • 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.

    See

    Returns number

  • Execute the callback without transitions. Internally it sets transitionDuration to 0 and restores it after the callback().

    Parameters

    • callback: any

    Returns void

Intermediate Methods

  • Returns the DOM id for the chart's anchored location.

    Returns string

  • Set 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.

    Returns any

  • Returns the internal numeric ID of the chart.

    Returns string

  • Effective height of the chart excluding margins (in pixels).

    Returns number

  • Effective width of the chart excluding margins (in pixels).

    Returns number

  • Clear all filters associated with this chart. The same effect can be achieved by calling chart.filter(null).

    Returns HeatMap

  • 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.

    See

    filters.

    Returns any[]

  • Check whether any active filter or a specific filter is associated with particular chart instance. This function is not chainable.

    Starting version 5, filtering is provided by DataProvider.

    See

    hasFilter.

    Parameters

    • Optional filter: any

    Returns boolean

  • 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.

    See

    d3.dispatch.on

    Example

    .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){...})

    Parameters

    • event: any
    • listener: any

    Returns HeatMap

  • 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.

    See

    resetFilters.

    Parameters

    • filter: any

    Returns HeatMap

  • 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

    See

    d3.select

    Example

    // Has the same effect as d3.select('#chart-id').select(selector)
    chart.select(selector)

    Type Parameters

    • DescElement extends BaseType

    Parameters

    • sel: any

      CSS selector string

    Returns any

  • 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

    See

    d3.selectAll

    Example

    // Has the same effect as d3.select('#chart-id').selectAll(selector)
    chart.selectAll(selector)

    Type Parameters

    • DescElement extends BaseType

    • OldDatum

    Parameters

    • sel: any

      CSS selector string

    Returns any

  • Turn off optional control elements within the root element.

    See

    turnOnControls

    Returns HeatMap

  • Turn on optional control elements within the root element. dc currently supports the following html control elements.

    • root.selectAll('.reset') - elements are turned on if the chart has an active filter. This type of control element is usually used to store a reset link to allow user to reset filter on a certain chart. This element will be turned off automatically if the filter is cleared.
    • root.selectAll('.filter') elements are turned on if the chart has an active filter. The text content of this element is then replaced with the current filter value using the filter printer function. This type of element will be turned off automatically if the filter is cleared.

    See

    turnOffControls

    Returns HeatMap

Ninja Methods

  • 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.

    Returns string | Element

  • Parameters

    • parent: any

    Returns HeatMap

  • Return charts data, typically group.all(). Some charts override this method. The derived classes may even use different return type.

    Returns any

  • Return charts data, typically group.all(). Some charts override this method. The derived classes may even use different return type.

    Returns CFGrouping[]

  • An opportunity to cleanup.

    Returns void

  • Expire 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

    Returns HeatMap

  • Handle the actual resizing of the chart if the size needs to change based on bounding rectangle.

    Parameters

    Returns void

  • List of items that will show as legends. The charts implement this method.

    Returns LegendItem[]

  • 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

    Example

    const oldHandler = chart.onClick;
    chart.onClick = function(datum) {
    // use datum.
    }

    Parameters

    • datum: any
    • Optional i: number

    Returns void

  • This is called to determine size of the chart based on the bounding rectangle. The default implementation ensures that the chart is at least as big as the minimums defined by minWidth and minHeight.

    Parameters

    Returns SizeT

  • Set 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.

    Example

    chart.options({dimension: myDimension, group: myGroup});
    

    Parameters

    • opts: any

    Returns HeatMap

  • 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.

    See

    HTMLElement

    Returns Selection<Element, any, any, any>

  • Parameters

    • rootElement: Selection<Element, any, any, any>

    Returns HeatMap

  • 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.

    See

    SVGElement

    Returns Selection<SVGElement, any, any, any>

  • Parameters

    • svgElement: any

    Returns HeatMap

Generated using TypeDoc