series:facet

Description

To render information in facets use the Series Facet tag, has to be nested within a Chart Display tag.

You can use the response attribute to load the data from the response or alternatively you can add a platform and this will get only the data the series needs to be renedered. You will also need to include the query directly on this tag if you wish for the user to be able to filter using the data of this series or alternatively add the query to the Chart Display tag.

For detail on how to change the color and background color see the demo below, for more detail on what you can change and set using CSS see here.

Usage

as element:
<series:facet
       response="{object}"
       platform="{string}"
       name="{string}"
       type="{string}"
       [title="{string}"]
       [show-marker="{string}"]
       [number-to-show="{number}"]
       [action="{string}"]
       [query="{object}"]
       [date-format="{string}"]
       [measure="{string}"]
       [selected-by-default="{boolean}"]
       [select="{string}"]>
</series:facet>

Directive info

  • This directive creates new scope.

Parameters

Param Type Details
response object

A response object (please include either a response or a platform not both!).

platform string

The name of the platform to get the data from (please include either a response or a platform not both!).

name string

Name of facet.

type string

Chart type

title
(optional)
string

The title of the series that appears in the legend and tooltip.

show-marker
(optional)
string

Whether to show marker or not.

number-to-show
(optional)
number

Number of filters to render on the graph.

action
(optional)
string

The page/action to which clicking the chart should be submitted. By default the action points to the current page.

query
(optional)
object

The search query from which to build links.

date-format
(optional)
string

How to format the date. See date format filter for valid formats.

measure
(optional)
string

What fact to use as an alternative to count as quantiative value for a filter.

selected-by-default
(optional)
boolean

Whether this series should be shown when the chart:display is using select-series="true" mode. Default: true.

select
(optional)
string

How the data should be filtered when clicking on a part of the chart, a valid query must be present.


Valid values:-
  • false

    User selects a filter by clicking the value;

    (default)
  • multiselect

    Supports selecting multiple filters that get combined with an 'OR'.

  • multiselect-instant

    Supports selecting multiple filters that get combined with an 'OR', filters will be applied automatically.

Example

Source