All documentation
  • API Reference for older versions
  • collapseCell

    collapseCell(axisName: string, tuple: string[], measureName: string)

    [starting from version 2.9.6]

    Collapses a specific node on the grid and charts.

    Parameters

    Parameter/TypeDescription
    axisName
    String
    The node's axis: rows ("rows") or columns ("columns").
    tuple
    String[]
    Unique names of field members that identify the node.
    measureName
    String
    optional Unique name of a measure for which the node should be collapsed. Use this property when:
    • The slice has several measures.
    • The node is nested in measures.
    If the measureName is not specified, the node will be collapsed for all measures in the slice.

    Examples

    1) Collapse a specific node:

    pivot.collapseCell("rows", ["Accessories", "Canada"]);

    See the full code on JSFiddle.

    2) Collapse a specific node for a specific measure:

    pivot.collapseCell("rows", ["Canada"], "Price");

    See also

    expandCell
    collapseData
    collapseAllData