Multidimension Facets

Multi-Dimension facets and Hierarchical2D facets are different from the other facet types. They do not apply directly to expressions, but use the categories generated by two or more other facets (any type, virtual or not, but one-dimensional only) to create its own categories.

This page discusses:

See Also
About facets
Create Facets

Multi-Dimension Facets

A MultiDimensionFacet takes the categories generated by N single-dimension facets, and generates a grid, with one facet per dimension as shown in the figure below. Each cell of the grid contains the number of documents and aggregation values that have a given category for each of the N one-dimension facets.

Here is an example with N=2 (two dimensions):

<CategoryFacet id="location" root="Top/loc"/>
<CategoryFacet id="date" root="Top/date"/>
<MultiDimensionFacet id="multi" virtualRoot="Top/multi">
  <MultiFacetDimension id="location"/>
  <MultiFacetDimension id="date"/>
</MultiDimensionFacet>

Which generates the following:

Example of Multidimension Facet

Important: When one of the two single-dimension facets used to build a Hierarchical 2D facet has no values (for example, when value facet F1 has /a/b/c categories, and value facet F2 has no categories), the Hierarchical 2D facet does not display any categories. To bypass this behavior, you can create default values for the empty facet. To do so, go to Data Model > Classes and for the empty category facet, enter the required value in the Default value field.

Hierarchical2D Facets

A Hierarchical2DFacets creates a two-dimension (or matrix) hierarchy of categories. They enable the calculating of pivot tables. They are based on two single-dimension facets for the two axes.

For example, if you have a country category and a sales index field, you can define:

  • a category facet on country

  • a ranged facet on the sales

  • a Hierarchical2D facet on the previous two, which calculates a matrix of sales per country

For example, let us consider a Hierarchical2DFacet, hier2d, that references facets id1 and id2.

id1 generates:

Top/root1/A/x
Top/root1/A/y
Top/root1/B/z

id2 generates:

Top/root2/C/r
Top/root2/D/x
Top/root2/E/t

The documents have the following categories:

doc1: Top/root1/A/x, Top/root1/B/z, Top/root2/D/x
doc2: Top/root1/A/x, Top/root2/D/t
doc3: Top/root1/A/x, Top/root2/D/t
doc4: Top/root1/A/y, Top/root2/C/r
doc5: Top/root1/A/y, Top/root2/D/x, Top/root2/C/r
doc6: Top/root1/B/z, Top/root2/C/r
doc7: Top/root1/B/z, Top/root2/C/r
doc8: Top/root1/B/z, Top/root2/D/t
doc9: Top/root1/B/z, Top/root2/E/u
doc10: Top/root1/B/z, Top/root2/E/u
doc11: Top/root1/B/z, Top/root2/E/u
doc12: Top/root1/B/z, Top/root2/E/u
doc13: Top/root1/B/z, Top/root2/E/u

Therefore hier2d generates the following 2D hierarchy:

Example of Hierarchical2D Facet

Important: When one of the two single-dimension facets used to build a Hierarchical facet has no values (for example, when value facet F1 has /a/b/c categories, and value facet F2 has no categories), the Hierarchical facet does not display any categories. To bypass this behavior, you must create default values for the empty facet. To do so, you can either use the Data Model > Classes > Default value field or use a Data Processing > Document Processors > Value Selector processor with a Does not exist condition to indicate that the given meta is empty .

Displaying Multidimension Facets in Mashup UI

Mashup Builder includes several widgets that support Multi-Dimension and Hierarchical2D facets, such as:

  • 2D Table

  • Stacked Column Chart

  • Mutable Chart

  • Timeline

For more information, see the Widget Reference.