Kumu
  • Getting started
    • Welcome
    • Kumu 101
    • First steps
    • Quick tips
    • Webinars
  • Overview
    • Kumu's architecture
    • Accounts and workspaces
    • Kumu.io and Kumu Enterprise
    • Billing
    • User interfaces
      • Dashboard
      • Settings
      • Map editor
      • View editors
      • Quick Actions
    • Collaborating and sharing
    • Actions and permissions
    • Security
    • Advanced Editor hub
      • @settings reference
      • @controls reference
      • Color reference
      • Property reference
      • Selector reference
  • DISCIPLINES
    • SNA / Network Mapping
    • Systems mapping
    • Systems Practice workbook
  • Guides
    • Activity feed
    • Add-ons
      • Disqus
    • Bridge
    • Cluster
    • Controls
      • Cluster control
      • Color-legend control
      • Filter control
      • Focus control
      • Image control
      • Label control
      • Showcase control
      • SNA-dashboard control
      • Tagged-timeline control
      • Text Control
      • Title Control
      • View toggle control
    • Decorations
      • Direct decorations
      • Data-driven decorations
      • Flags
      • Icons
      • Images
      • Label templates
      • Popovers
    • Default view settings
    • Export
    • Fields
      • Computed fields
    • Filter
    • Focus
    • Forking
    • Grids & Guides
    • Import
      • Structure your data for Kumu
      • Excel / CSV
      • Google Sheets
      • JSON / Blueprints
    • Imported views
    • Layouts
      • Fixed
      • Force-directed
      • Remove overlap
      • Scatter
      • Snap-to
    • Legends
    • Licensing
    • Lightbox
    • Loops
    • Metrics
    • Two-factor authentication
    • Pro workspaces
      • Archiving projects
      • Discussions
    • Partial views
    • Presentations
    • Profiles
      • Markdown
    • Project admin
    • Selectors
    • Shapes
    • Share and embed maps
    • Shortcuts
    • Showcase
    • Slugs
    • Table
    • Templates
      • Geo template
    • URLs
    • Views
    • Widgets
  • About Kumu
    • What is Kumu?
    • How does it work?
    • Where can I get help?
  • Enterprise
    • About enterprise
    • Getting started with VMWare
    • Upgrading
    • Configuration
    • Creating user accounts
    • SSH Access
    • Single sign-on
    • Backing up enterprise data
    • Restoring enterprise data
    • Command line utilities
    • Changelog
  • Frequently Asked Questions
    • Does Kumu have a public API?
    • Does Kumu make use of AI?
    • How do I add annotations?
    • How do I add anchors to my map description?
    • How do I add arrows to my connections?
    • How do I add documents to profiles?
    • How do I add more than one element with the same label?
    • How do I add text dropdowns to my map overview?
    • How do I adjust arrow size?
    • How do I avoid duplicating data?
    • How do I change connection curvature?
    • How do I change font color?
    • How do I change font size?
    • How do I change the default for currency fields?
    • How do I change the length or strength of connections?
    • How do I change the order of control options?
    • How do I change the position of my element labels?
    • How do I cite Kumu?
    • How do I collapse duplicate connections?
    • How do I copy a map to another project?
    • How do I control label size while scaling element size?
    • How do I control text wrapping?
    • How do I convert a project from private to public?
    • How do I convert a project from public to private?
    • How do I create dynamic on/off toggles for my map?
    • How do I customize link text in popovers?
    • How do I customize the order of my legend?
    • How do I delete a project, map, or view?
    • How do I delete data from my project?
    • How do I downgrade my subscription?
    • How do I edit virtual elements?
    • How do I get rid of duplicates?
    • How do I hide elements without connections?
    • How do I hide images from the map but keep them in the profile?
    • How do I hide labels on my map?
    • How do I hide the settings button?
    • How do I keep elements from moving?
    • How do I list an element's connections in its profile?
    • How do I make elements transparent?
    • How do I make sense of my receipt?
    • How do I open a sub-system when clicking on an element?
    • How do I remove the Opposite entry from my legend?
    • How do I remove unneeded controls?
    • How do I remove unwanted legend entries?
    • How do I rename my map/view?
    • How do I restructure my adjacency matrix?
    • How do I save my changes in Kumu?
    • How do I select options by default in my control?
    • How do I set a minimum or maximum zoom level for my map?
    • How do I show the Settings button?
    • How do I size elements based on number of connections?
    • How do I transfer a project?
    • How do I update my credit card information?
    • How much data can my Kumu project handle?
    • How do my readers switch between maps and views?
    • My data won't import. What can I do?
    • My Kumu embed is not working. What can I do?
    • My map disappeared. How do I bring it back?
    • My PDF won't export. What can I do?
    • What pricing plans does Kumu have?
    • Where can I find my invoices?
    • Where can I find example Kumu projects?
Powered by GitBook
On this page
  • Static controls
  • Interactive controls

Was this helpful?

Edit on GitHub
  1. Overview
  2. Advanced Editor hub

@controls reference

Previous@settings referenceNextColor reference

Last updated 1 month ago

Was this helpful?

While it's possible to , using the is the only way to unlock the full flexibility of controls. This guide lists each property that can be used in the Advanced Editor, each possible value the properties can accept, and which @controls can recognize the properties and values.

There are two reference tables in this guide—the first lists properties for static controls (nothing happens when map readers click on these controls), and the second lists properties for interactive controls (map readers can interact with the map by clicking on these controls).

All values are unitless.

If you find a property or a value that's not documented here, !

.

Static controls

Property
Description
Valid Values
Legend
Image
Label
Text
Title
SNA Dashboard

background-color

Defines background color of control

color

color

Defines color of control's text

color

font-family

Defines font family of control's text

family-name generic-family

font-size

Defines size of control's text

number

font-style

Defines style of control's text

normal italic

font-weight

Defines weight of control's text

number

height

Defines height of control

number

margin

Defines space between the control and other controls on the map

number

metrics

Defines which metrics will be included in the dashboard

element-count connection-count density reciprocity diameter average-degree average-path-length

opacity

Defines opacity of the control

0..1

padding

Defines space between the control's border and its contents

number

src

Defines the source of the image

url

text-align

Defines alignment of text within the control

center left right

value

Any plain text string. Markdown and some HTML allowed.

string

width

Defines width of control

number

Interactive controls

Property
Description
Valid Values
Filter
Showcase
Focus
Cluster
Tagged Timeline
View Toggle

as

Defines how the control is presented

labels buttons dots dropdown

background-color

Defines background color of control

color

by

Defines the field to filter, showcase, or cluster by

''Field Name'

color

Defines color of control's text (labels, placeholders, and summaries only)

color

default

Defines which options should be selected by default

none show-all select all ''field value 1', 'field value 2',...

except

Allows you to remove field values from the available choices

''field value 1', 'field value 2',...

font-family

Defines font family of control's text (labels, placeholders, and summaries only)

family-name generic-family

font-size

Defines size of control's text (labels, placeholders, and summaries only)

number

font-style

Defines style of control's text (labels, placeholders, and summaries only)

normal italic

font-weight

Defines weight of control's text (labels, placeholders, and summaries only)

number

height

Defines height of control

number

label

Adds a label above the control

'My Label'

margin

Defines space between the control and other controls on the map

number

mode

Controls how the selection is showcased. normal is the default and showcases the selection plus any connections between the showcased elements. loose showcases the selection plus neighboring elements. strict only showcases the selection itself.

normal loose strict

multiple

Controls whether more than one option can be selected at a time

true false match-all

only

Allows you to explicitly define which field values should be included as available choices

''field value 1', 'field value 2',...

opacity

Defines opacity of the control

0..1

options

Allows you to explicitly define which options should be included as available choices

''partial-view-1', 'partial-view-2',...

out

Defines the level of connections you'd like to see (out 1: first-degree only, out 2: first- and second-degree, etc.)

number

padding

Defines space between the control's border and its contents

number

placeholder

The text to display when nothing is selected (for as: dropdown only)

string

range

Defines the years that should be included

year..year

summary

Summarizes the options that have been selected (for as: dropdown only)

string

target

Defines which items will be affected by the control

selector

width

Defines width of control

number

let us know
Jump to the reference for interactive controls
Advanced Editor
build controls using the Basic Editor