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

Was this helpful?

Edit on GitHub
  1. Overview
  2. Advanced Editor hub

@settings reference

PreviousAdvanced Editor hubNext@controls reference

Last updated 23 days ago

Was this helpful?

In the , the @settings block can be used to tweak default settings and add all kinds of powerful features to your view.

The @settings block supports all decoration properties listed in the , as long as you prefix each property with one of the following:

  • *- if you want to apply the rule to all items

  • element- to apply the rule to elements only

  • connection- to apply the rule to connections only

  • loop- to apply the rule to loops only

But, @settings also supports its own list of exclusive properties. The table below lists all properties that can be used exclusively inside an @settings block, describes their effect on the view, and lists valid values for each property (when there are multiple valid values, we've listed them as separate snippets of inline code).

There are just few more things you should know about the valid values listed below:

Where you see...
You can use...

selector

color

Any CSS web color or hex color code

number

Any number

'field name'

element type

Any text/string value

All values are unitless.

Supported properties

Property
Description
Possible values

attenuation

Determines whether elements and connections maintain their size relative to the background map (available for the Geo template only)

on off

background-color

Sets the canvas' background color

color

background-opacity

Sets the opacity of items outside of a showcased selection

0..1

bridge

element-selector

cluster

'field name'element-selector by 'field name'element-selector by 'field name' as 'element type'

culling

Determines whether elements and connections are hidden when the reader zooms in very close

on off

focus

selector out number

font-cutoff

Sets the minimum font size at which labels will display when the map is zoomed out. Set to 0 to always display labels, regardless of zoom level.

number

foreground-opacity

Sets the opacity of showcased items

geo-location

Sets the field that will be used to geo-locate elements

'field name'

geo-style

Sets the style of the geo map

auto streets satellite

ignore

selector

ignore-orphans

true false

image-cutoff

Sets the minimum zoom level at which images will display when the map is zoomed out. Set to 0 to always display images, regardless of zoom level.

include

selector

layout

Sets the layout type

force static scatter

layout-bounds-xmax

Sets a maximum x coordinate that grid and guide lines can extend to

number

layout-bounds-xmin

Sets a minimum x coordinate that grid and guide lines can extend to

number

layout-bounds-ymax

Sets a maximum y coordinate that grid and guide lines can extend to

number

layout-bounds-ymin

Sets a minimum y coordinate that grid and guide lines can extend to

number

layout-gravity

Sets the gravity for the force-directed layout

number

layout-grid

Determines whether a grid will be shown

on off

layout-grid-color

Sets the color of the grid

color

layout-grid-offset

Sets the space between grid lines

number

layout-grid-width

Sets the thickness of grid lines

number

layout-guide-color

Sets the color of guide lines

color

layout-guide-width

Sets the thickness of guide lines

number

layout-guides

Sets the x or y coordinate for each guide line, or the origin and radius of a circle

x(number)y(number)circle(x, y, r)circle(r)

layout-particle-charge

Sets the particle charge for the force-directed layout

number

layout-preset

Chooses a preset version of the force-directed layout

auto dense hairball

layout-spring-length

Sets the spring length for the force-directed layout

number

layout-spring-strength

Sets the spring strength for the force-directed layout

number

layout-x

Sets the field used to determine elements' x coordinate in the scatter layout

'field name'

layout-x-multiplier

Sets a number that will be multiplied by each elements layout-x field to determine their final x coordinate

number

layout-y

Sets the field used to determine elements' x coordinate in the scatter layout

'field name'

layout-y-multiplier

Sets a number that will be multiplied by each elements layout-y field to determine their final y coordinate

number

notification-color

color

profile

Controls whether or not profiles can be opened

on off

quality

Sets the render quality

fast best

radar

Determines whether a radar will be shown

on off

radar-axes

Sets the labels for radar axes

Axis 1, Axis 2, Axis 3...

radar-font-color

Sets the color of radar labels

color

radar-font-family

Sets the font family of radar labels

family-namegeneric-family

radar-font-size

Sets the font size for radar labels

number

radar-ring-color

Sets the color between radar rings

color

radar-ring-opacity

Sets the opacity of radar rings

0..1

radar-ring-size

Sets the distance between radar rings

number

radar-ring-size-inner

Sets the radius of the inner radar ring

number

radar-rings

Sets the labels for radar rings

Ring 1, Ring 2, Ring 3...

renderer

Chooses which rendered will be used

canvaswebgl

scale-max

Sets the maximum allowed zoom level

number

scale-min

Sets the minimum allowed zoom level

number

selection-color

Sets the color of the ring that appears around selected elements

color

showcase

selector

template

Chooses a template

causal-loopcustomgeosnastakeholderstock-and-flowsystemssystems-leverage

theme

Sets the view's overall theme

light dark

Any

The name of any of your , wrapped in single or double quotes

Activates bridging. See the for more information.

Activates clustering. See the for more information.

Activates focus. See the for more information.

Ignores a selection. See the for more information.

Hides any orphans (elements that have no connections). See the for more information.

Includes a selection. See the for more information.

Sets the color of asterisks created by

Activates showcase. See the for more information.

number between 0..1
number between 0..1
selector
fields
bridge guide
cluster guide
focus guide
filter guide
filter guide
filter guide
Issues
showcase guide
property reference
Advanced Editor