The map field.

Properties

Title	Map Field
Description	Field for objects with key/value pairs that share the same schema for values.
JSON Schema Type(s)	object
Field Type	map
Base Field Type	array

Schema

Property	Type	Default	Description
default	any		The default value to be assigned for this property. If the data for the field is empty or not provided, this default value will be plugged in for you. Specify a default value when you want to pre-populate the field's value ahead of time.
dependencies	array		List of property dependencies.
description	string		Detailed description of the property.
disallow	array		List of disallowed values for the property.
format	string		Data format of the property.
items	object		Schema for array items.
maxItems	number		Maximum number of items.
minItems	number		Minimum number of items.
readonly	boolean		Indicates that the field is read-only. A read-only field cannot have it's value changed. Read-only fields render in a grayed-out or disabled control. If the field is rendered using a view with the displayReadonly attribute set to false, the read-only field will not appear.
required	boolean		Indicates whether the field's value is required. If set to true, the field must take on a valid value and cannnot be left empty or unassigned.
title	string		Short description of the property.
type	string	object	Data type of the property.
uniqueItems	boolean		Item values should be unique if true.

Options

Property	Type	Default	Description
actionbar	object
actionbarStyle	string	top	The kind of actionbar to render for each item in the array. Either 'top', 'bottom', 'left', or 'right'.
animate	boolean	true	Up and down transitions will be animated
collapsed	boolean		Field set is initially collapsed if true.
collapsible	boolean		Field set is collapsible if true.
disabled	boolean		Field will be disabled if true.
dragAndDrop	boolean		If true, drag and drop is enabled for array items.
fieldClass	string		Specifies one or more CSS classes that should be applied to the dom element for this field once it is rendered. Supports a single value, comma-delimited values, space-delimited values or values passed in as an array.
focus	checkbox	true	If true, the initial focus for the form will be set to the first child element (usually the first field in the form). If a field name or path is provided, then the specified child field will receive focus. For example, you might set focus to 'name' (selecting the 'name' field) or you might set it to 'client/name' which picks the 'name' field on the 'client' object.
form	object		Options for rendering the FORM tag.
helper	string		Field help message.
helpers	array		An array of field help messages. Each message will be displayed on it's own line.
helpersPosition	string	below	Defines the placement location of the helper text relative to the control (either 'above' or 'below')
hidden	boolean		Field will be hidden if true.
hideInitValidationError	boolean		Hide initial validation errors if true.
hideToolbarWithChildren	boolean	true	Indicates whether to hide the top toolbar when child elements are available.
id	string		Unique field id. Auto-generated if not provided.
label	string		Field label.
lazyLoading	boolean		Child fields will only be rendered when the fieldset is expanded if this option is set true.
legendStyle	string	button	Field set legend style.
optionLabels	array		An array of string labels for items in the enum array
readonly	boolean		Field will be readonly if true.
showMessages	boolean	true	Display validation messages if true.
toolbar	object
toolbarPosition	string	top	Location of the top-level toolbar to render for the array field. Either 'top' or 'bottom'.
toolbarSticky	boolean		If true, the array item toolbar will always be enabled. If false, the toolbar is always disabled. If undefined or null, the toolbar will appear when hovered over.
toolbarStyle	string	button	The kind of top-level toolbar to render for the array field. Either 'button' or 'link'.
type	string	map	Field type.
validate	boolean	true	Field validation is required if true.
view	string		Allows for this field to be rendered with a different view (such as 'display' or 'create')

Example 1

Map field for user profiles. A map field allows you express unique key IDs for an associative array object. Click on the "view" button to show the resulting JSON.

Example 2

Here is an example where we hide the _key field.

Example 3

Map field rendered in display-only mode.

Example 4: Map Validation

This example shows an object with an empty _key property. As a result, the form renders with a validation error. If a non-empty key is filled in, the form validates just fine.