Controls
Last updated
Last updated
Controls allow you to customize how people interact with your maps by adding buttons, dropdowns or toggles to your map. You can also use them to overlay metrics, images, text and more on! Interactive controls can be used to transform the current view's setting too, such as filter, focus, and clustering.
Want to dive a little deeper into controls? Check out our Taking Control of Kumu webinar
Use the dropdown menus in the controls builder to set up your control, then, when you're done, click the back arrow to return to the main screen, and click SAVE.
Want to remove unneeded controls? You can use the remove unneeded controls section of this guide to help troubleshoot.
To unlock the full set of flexible controls features, you can use the Advanced Editor. Here's an example of what controls look like in the Advanced Editor:
In general, controls are defined with the @controls block, grouped into regions, and customized using properties. You can add multiple controls to a region, and even override or move Kumu's built-in controls. Here's the general syntax that shows how multiple regions can be used, and how multiple controls can be added to the same region:
Adding a custom control to your map starts by picking where you want to place the control. Controls can be assigned to one of six regions on the map:
top
top-left
top-right
bottom
bottom-left
bottom-right
After you set the region, you can choose what type of control you are adding. Here are the available control types:
title: Title control
text: Text control
label: Label control
showcase: Showcase control
filter: Filter control
Focus: Focus control
cluster: Cluster control
tagged-timeline: Tagged-timeline control
color-legend: Color-legend control
image: Image control
sna-dashboard: Social Network Analysis Dashboard control
view-toggle: View toggle control
Controls are customized using properties, and each control understands a slightly different set of properties. In the example below, by is a property of the showcase control that accepts a field name (wrapped in quotes).
For a full list of the properties that each control understands, read the individual control guides (linked above), or check out the controls reference.
Looking to change the order of the controls in your map? Have a look at this guide.
Sometimes, controls need to work with complex lists of options. Since these would be overwhelming to define in a single line, the items are included as children of the control instead, and follow a similar syntax to the controls themselves.
In the example below, we call the option blocks the "children" of the showcase control, and each child includes its own set of properties.
You can read through the individual control guides (linked above) to see which controls accept children and which properties their children understand.
By default, controls are each stored on their own line, and they each have their own set of properties. However, if you want to display a group of controls on one line (for example, along the top of your map), and assign a few common properties and values (for example, font-size: 16) to all of them, you can use groups.
To group controls, use the following group syntax:
The properties that get set underneath group will apply to all controls nested inside the group. And before you ask—yes, it's possible to nest groups inside of other groups as well!
When you're adding controls through the Basic Editor, you might sometimes add a duplicate control by accident, or add a control that says "No values found for [some field name]". You can remove controls through the Basic Editor and the Advanced Editor.
Basic Editor
When hovering over an existing control, click on the edit pencil to edit your existing control, or click on the trash icon to delete it.
Advanced Editor
If you don't want any controls or "No values found for [some field name]" messages on your map, simply delete the entire @controls block, then click "Save" at the bottom of the editor.
If you have some controls in there that you would like to preserve, you'll first need to learn the basics of how to read @controls code, so that you can tell which controls you want to delete and which you want to keep.
If you want to delete all controls in a certain region of your map, then delete all the code saying top, or top-left, or bottom etc. Delete the whole block to delete all the controls in that region.
If you want to delete just one control, locate it in the list of your controls and delete that whole block. You can recognize a control block by the fact that the first line is filter, or showcase, or cluster, or focus.
You can learn more about reading @controls code in our full guide on controls. Of course you can always send us an email at support@kumu.io to help out!
All of Kumu's built-in controls (search, zoom buttons, settings buttons, the legend) are handled by the same platform that custom controls are built on. That means you can move the built-in controls around, omit ones you don't need, or even reset the built-in controls and start from scratch.
Although you won't see it in your Advanced Editor, here's the default @controls code working behind the scenes:
You can omit individual controls by including the region in your @controls block, without the control inside of it. For example, if you wanted to keep the search bar, but omit all other built-in controls, you could use:
Note that if you add controls to a region in your code, but don't explicitly include the default control, it will be hidden. For example, this code will hide the zoom-toolbar, settings-toolbar, and focus-toolbar:
If you want to quickly start from scratch without any of Kumu's built-in controls, you can use reset: true.
You can use the Basic Editor to add a few simple types of controls to your map. Click the settings icon to open the editor, then click Add custom control. Kumu will open up the controls builder, with a few options pre-selected:
Click the settings icon on the right to open the Basic Editor, then scroll down to "Add custom control". You'll see all existing controls listed out below.
Open up the Advanced Editor (click Settings and then choose Switch to Advanced Editor at the bottom). Unless you have added partial views, there will be a block of code right at the top starting with @controls.
