Cluster control
When do you use it?
Add a control to activate clustering for a given field or set of selectors via a list of labels, buttons or a dropdown menu.
Basic Editor
To create a cluster control, follow these steps:
In the menu that opens up, click on the first dropdown and change the value to "Cluster elements".
Use the other dropdowns to customize the look and location of your controls.
Click Save at the bottom to save your changes.
To add multiple controls, repeat steps 1-4 for each control.
Advanced Editor
Cluster by field:
Cluster using custom selectors:
Supported properties
by
is the field you'd like to use for clustering wrapped in double quotes. If you don't includeby: field
you need to list out each option - see "supported children" guidance below.as
controls how the control is presented. Do you want a list of labels, buttons, or a dropdown for activating clustering?labels
show options as a list of clickable labelsbuttons
show options as a group of buttonsdropdown
show options as dropdown
multiple
controls whether more than one value can be selected at a timetrue
allow multiple values to be selectedfalse
only allow one value to be selected at a time
placeholder
the text to display when nothing is selected (foras: dropdown
only)summary
override the summary that's shown for the current selection (foras: dropdown
). The summary will be shown regardless of what's selected so there's no need to useplaceholder
in this case.default
defines which field values should be selected by default (forby: "field"
only). Useselect-all
to select everything by default.
Check out our controls reference to see the full list of properties and values recognized by the cluster control.
Supported children
If you want to use custom selectors to build clustering options, you'll need to list each option out separately. The options are defined by option
blocks nested within the control and each option
supports the following properties:
label
the text to display for that optionvalue
advanced cluster rule to cluster bydefault
true
value is selected by defaultfalse
value is unselected by default
Last updated