Widgets
Last updated
Last updated
We've built a flexible widget framework to give superpowers to the Map Overview and the Description field in profiles.
With widgets, you can do the following:
To use widgets, start editing the Map Overview, or the Description of an element, connection, or loop, and type double square brackets [[]]. What you put inside the double square brackets depends on which widget you're using—you can read the rest of this article to learn more about each option.
The list widget allows you to create lists of elements, connections, and loops inside the Map Overview or a Description.
For a basic list, just type list/ inside your double square brackets, and then type elements, connections, or loops depending on what you want to list.
All the items in the list are links—you can hover over a link to showcase an item on the map, or you can click a link to jump to the profile for that item.
Basic lists can also be sorted by any field in your profiles. To do so, add ?sort=field-name after elements, connections, or loops, and replace field-name with a slug of the field name you want to sort by.
Add &desc=true to the end if you want to sort in descending order:
To create a list that is more specific that "all elements", for example, you can type list and a selector in double quotes.
Having trouble writing the right selector for your use case? Feel free to email support!
Normally, it would be okay to write a selector with double quotes, e.g. ["influence"="high"]. But inside the list widget, you need to write it with single quotes instead: ['influence'='high'].
'influence' and 'high' are enclosed in single quotes, and the entire selector is enclosed in double quotes.
If you want to list all of an element's connections in it's profile, we wrote a more detailed article on how to achieve that.
These more specific lists, like basic lists, can also be sorted by any field in your profiles. To do so, add ?sort=field-name after list and before the selector, and replace field-name with a slug of the field name you want to sort by.
Add &desc=true to the end if you want to sort in descending order:
Kumu's showcase actually has three different "modes" to affect how it works:
normal mode showcases the selection plus any connections between the showcased elements (default)
loose mode showcases the selection plus neighboring elements
strict mode showcases only the selection itself, nothing else
By default, hovering over an item in the list widget will showcase that item in normal mode. You can override this default behavior by adding ?mode=loose or ?mode=strict.
For basic lists, add that modifier at the very end:
For more specific lists, add the modifier after the word list:
To list all the values of a particular field, type list inside your double square brackets, followed by the field name in double quotes.
Simply include the field name in quotes in the standard list format.
When you hover over a field value in the list, Kumu will showcase all elements, connections, and loops that have that field value in their profile.
To embed a Vimeo video, type vimeo/ inside the double square brackets, followed by the ID if the video you'd like to include:
Optionally, you can change the aspect ratio from hd (the default) to sd:
You can also add a descriptive title:
To embed a YouTube video, type youtube/ inside the double square brackets, followed by the ID if the video you'd like to include.
You can find the ID for a given YouTube video within the URL of the video. Just grab the portion after the ?v= part of the URL.
Optionally, you can change the aspect ratio from hd (the default) to sd:
Note: When embedding a Youtube video, make sure to use the full URL (e.g. https://www.youtube.com/watch?v=VzNdrLLlJIU), not the shortened URL (e.g. https://youtu.be/VzNdrLLlJIU), as the shortened URL will make the embed fail.
To embed audio from Soundcloud, type soundcloud/ inside your double square brackets, followed by the ID of the audio file:
To embed documents from Scribd, type scribd/ inside your double square brackets, followed by the ID of the document:
The Scribd widget supports a start_page option that lets you define which page the embedded document should show first.
To set the option, add a ? after the document ID, then type start_page=, and the page number you want to set.
To embed a slideshow from Slideshare, type slideshare/ inside your double square brackets, followed by the ID of the slideshow:
Optionally, you can change the aspect ratio from sd (the default) to hd:
You can also add a descriptive title:
To embed a slideshow from Speaker Deck, type speakerdeck/ inside your double square brackets, followed by the ID of the slideshow:
Optionally, you can change the aspect ratio from sd (the default) to hd:
You can also add a descriptive title:
Need any other widgets? Send us an email!
