Element properties

Advanced options to define and style elements

D1b2f8212194082c4121bd42f516de2c

Updated at October 19th, 2019

The Advanced properties dialog provides options to label an element and define how it calculates data.

By default, Protobi assumes each element corresponds to a data column with the same name as the element's key attribute, and uses that value directly.  But it's possible to override this in many ways.


Attribute Value Description
key String Unique identifier for this element
displayKey String
Label to use in place of key for display 
title String
Text for longer descriptive title
footnote String
Text for footnote
type Choice string|number|date|empty
field String
Name of data column to use as a data source for this element (defaults to key).  If specified, the value is read directly from that data column.
element
Name of an element to use as a data source for this element. If specified, data is interpolated from that element, after applying its coding, transforms, etc.
children String
List of child elements, separated by commas.
string Choice Method
col String Unique identifier of crosstab banner column(s)
split String Delimiter to split values for this element.  For example "," will split a comma-delimited string into a multiple-response array.  
The special value "json" will parse the value as a JSON string.
scale String or number Numeric value or name of data column by which to divide the value of this element.  E.g. 100 will convert fractions between [0,1] to percents [0,100]
denominator String or number
Numeric value or name of data column by which to divide the value of this element.  This can be used to calculate on element as a ratio of another.
weight String or number

Numeric value or name of data column by which to weight the frequency of this element.  
maxVal Number Reference value by which to scale bars for this element. Useful when compacting to means, so that bars can be drawn for means relative to a some value.
showMissing Choice

Whether to show or hide missing values.  Yes means always, No means never, and (default) means use current setting from [NA] button in toolbar
valueFormat String Display format for this element's values using d3 format notation. E.g. "0%" will display fractions like 0.24 as percentages e.g. "24%"





e

Was this article helpful?