Skip to content

Latest commit

 

History

History
133 lines (86 loc) · 9.88 KB

fields.md

File metadata and controls

133 lines (86 loc) · 9.88 KB

Fields

Fields allow you to save additional data about the elements, connections and loops in your map. Create whatever fields you need and modify the settings to enable things like checklists, prompts, currencies, and much more.

Core fields

Kumu comes with a set of core fields. Putting data in all of these fields isn't necessary, but they get special visual treatment in profiles and have special functionality, so it's great to use them when you can!

Label

Use the Label field to give names to elements, connections, and loops. Your element and loop labels will appear on the map by default, and connection labels can be shown on the map as well, using the label-visibility property in the Advanced Editor.

Type

Use the type field to categorize elements and connections. Common element types include person, project, and company. Common connection types include personal, business, and family.

Description

The description field is designed to hold longer-form content that describes an item. Descriptions can include multiple paragraphs, and even multimedia content. You can use Markdown to format your text and widgets to add multimedia content.

Tags

The tags field is designed to hold multiple values that each describe your item in a different way. For example, a connection between a person and a non-profit might have "Strong relationship", "Board Member", "Donor", and "Advocate" all stored as separate values in the Tags field, adding rich detail to that person's relationship with the non-profit.

In the profile, tags appear under the description, and hovering your cursor over a tag will showcase other items with that same tag.

Image

Include an image URL or upload an image from your computer, and Kumu will display it on the map and in the profile. Learn more from our full guide on images.

URL

Add any link to the URL, and the link will open when the element, connection, or loop is double-clicked.

Email

Add an email and Kumu will automatically include their gravatar on the map and in the profile. Gravatars can be a huge time saver when working with social network data!

ID

Add a unique ID to each element and connection when you want to have fine-tuned control over Kumu's decision to create or update items during a spreadsheet import. To learn more about this, check out our guide on avoiding duplicate data.

Add a custom field

To add a custom field, select an element or connection and then click the +New Field button in the sidebar. You'll be prompted to name the field and then enter a value for the element or connection you selected.

By default, new fields are set to accept only one value and not prompt users with suggested values. While this is an easy way to get started adding values, you may have times where you want people to pick from a list of defined values (level of influence: high, medium or low) or multiple values from a list (skills: project management, web development, leadership, public speaking). In those cases, you can customize your field—keep reading to learn how!

Field's can't be named YES, NO, ON, OFF, TRUE, or FALSE. Uppercase and lowercase versions of these words will cause errors elsewhere in Kumu.

Customize a field

To customize the settings for a given field, click on an element, and click the field in the element's profile.

Customizing a field

A dropdown will appear with the following options:

  • Name - change the name of your field
  • Type - string, text, URL, email, number, currency
  • Limit - one value OR none (one or more values)
  • Prompt - none, autocomplete, or list
  • Category - for grouping fields in sections on the profile
  • Visibility - public OR private (whether or not viewers can see a given field)
  • Clustering - whether to allow clustering by this field
  • More - access settings, relevance, or delete the field

Let's look at a few of these options in more depth:

Field type

Below are the choices for the field format and guidance on when to use each:

  • String - This is the default value and used when entering simple, short pieces of text
  • Text - Used for longer text fields like notes, addresses, and anywhere you want to use Markdown formatting
  • URL - Used for website addresses
  • Email - Used for email addresses
  • Number - Used for numerical values that aren't currencies or dates
  • Currency - Used for financial values to be displayed with standard currency format ($)
  • Date - Used for dates, like February 14th (Kumu's birthday!)

Field prompt

Field prompt is managed by clicking "more" and then "settings" in the dropdown. Below are the choices for the field prompt and guidance on when to use each:

  • None - Use when you'd like to turn off any prompts for field values
  • Autocomplete - Use when you'd like a tag-like interface for prompting values that match the current input
  • List - Use when you want to pick from a list of defined values

<iframe width="560" height="315" src="https://www.youtube.com/embed/Y-HZbKc3VRs" frameborder="0" allowfullscreen></iframe>

Field category

By default, all fields are ordered alphabetically based on the name of the field. You can also group fields by assigning them a category. For example, you may want to have all financial information (FY 2012 Investment, FY 2013 Investment and Cumulative Investment) under the category "Financials". You can create multiple categories and each will be ordered alphabetically.

We reserve a few category names that we give special treatment to:

  • General - This is the default. Fields in this category will live at the top of the field section and won't have an explicit category label.
  • Footnotes - This category is meant for things like attribution and citing your sources. Fields in this category will always be listed at the bottom of the profile.
  • Metrics - This category holds any of the data you create using Kumu's Metrics tool.

Field relevance

By default, all fields are shown in the profiles of all elements, connections, and loops while you're editing the map. Even if a field has a blank value, it will still show up in the profile.

But, in each profile, Kumu will automatically hide all blank fields in the following cases:

  • When someone is viewing a presentation
  • When someone is viewing a shared/embedded map
  • When someone is viewing the source project, but they don't have edit access

If you'd rather hide irrelevant fields while you're editing the map, you can use field relevance in your project settings. Click the menu in the top left of your map and then click "fields". Scroll down and you'll see a "relevance" section. To edit which fields should be included for each of the element, connection, and loop types in your project, click edit, uncheck the relevant fields, and click "Done" at the bottom of the field list.

field relevance

If you'd like to limit the fields that are shown, simply click edit and then uncheck the field you'd like to hide in the profile for a given type. Label, type, description, and tags are always shown for all types regardless of what you enter. Above is an example of customizing the profile of elements with type of "Company" to only show Image, Website, URL and Attribution.

Field ordering

You can also use the field relevance menu to change the order fields are listed in the profile. By default all fields are listed alphabetically (and optionally broken into sections if you've assigned categories). The order of fields is unique to each element or connection type.

To change the order, click edit and then simply drag the fields to reorder them. When you are finished, click "Done" and you'll see the new order reflected in the profile.

Deleting a field

If you've created a field and want to delete it and all corresponding values, click on the label of the field in any profile and then go to more -> delete. Alternatively, you can use the menu in the upper left corner to go to the field settings page (choose fields). This will delete the field and any values assigned for any content in your project.

Deleting field values

Occasionally you may want to delete the prompted choices for a given field, or the options that show up in your legend or in a control. To do this, you need to delete the underlying field value. This process is different depending on the field's prompt.

For fields that have their prompt set to "Autocomplete" or "None" (this includes the Tags field), you can only delete the field value by removing it from every element, connection, and loop in the project, including the trash.

For all other fields (including Element Type, Connection Type, and Loop Type), follow these steps:

  1. Click the menu in the upper left of your map and choose FIELDS
  2. Click on the field you want to edit
  3. Find the value you want to delete. Then, click the delete button next to the value to delete it.
  4. Scroll down and click SAVE to save your changes
  5. Refresh the page

After you follow these steps, the field value(s) you deleted will no longer show up in prompted lists, in legends, or in controls.

edit this page