Add custom properties to your project to track metrics and values that are not included in the Giraffe defaults.
Add a Custom property
Click the + add property in the properties palette or usage editor.
Start typing the name of the property you want.
If the property does not exist, you will be prompted to create it.
Click "create" to start.
Custom Property Settings
All custom properties share a few of the same settings.
Name & Label
Each property has a "name" and a "label."
Name = the hardcoded key. It is recommended to create this in camelCase.
Label = the text that is shown in the UI. Use any case for this.
The name cannot be edited after the property is saved. The label can be updated any time.
Description
The description is text that helps others understand the purpose of the property.
It displays as a tooltip (mouseover text) in the properties palette form, and also as subtext in the + add property search menu.
Default Value
The default value is the property value that is applied automatically when the property is added to a geometry or usage.
Number and Text properties need a default value. The default value cannot be null. A default value is optional for the other property types.
Custom Property Types
Use the Input type dropdown to select which type of property you would like to create.
Multi Select is available for geometry properties, such as properties you add from the properties palette. It does not appear in the Input type list when you create a property in the usage editor.
Number
Enter a property name, label, and description.
Select a default value.
Set the minimum and maximum range
This sets a cap on what number values are accepted in the property value.
Leave either or both fields blank for unlimited range
Set the step value
this is how much the number will increase or decrease when users scrub or step the number property.
Set the precision
this is the number of decimal places the number should round to.
Set a prefix
this is alphanumeric text that helps define the value. IE
$for currency.
Set a suffix
this is alphanumeric text that helps define the value. IE
m²for an area measure.
Text
Enter a property name, label, and description.
Select a default value.
If no default value is desired, you can use
n/a
Toggle
Enter a property name, label, and description.
Select the default value - off or on.
Select
Enter a property name, label, and description.
Click Add Option to add another value to the dropdown
Input a value, label, and color for each option
Click the up/down arrows to move the order of options in the dropdown list
Click the bin to delete an option from the list
Select a default value, if desired
Multi Select
Set it up the same way as a Select property.
Select one or more default values, if desired.
Date
Enter a property name, label, and description.
Select a default value, if desired.
Text Area
Enter a property name, label, and description.
Select a default value, if desired.
Using Custom Properties
Custom properties appear in the Analytics category of the properties palette, sorted alphabetically.
You can edit the property values just as you would for built-in properties.
Once a property is added to the project, it will appear in the list whenever you click + add property.
If the property is part of a template project, it will be included in any new projects created from that template.
Call a custom property in Analytics
Use a custom property in a measure to add it to your Analytics report. A custom property does not appear as a line item in the Analytics app until a calculation uses it.
Only Number properties can be used in a measure. Text, Toggle, Select, Multi Select, Date, and Text Area properties are not available as measure components.
Create a calculation and add your Number property as a component. The measure then shows as a line item in your Analytics report, calculated across every geometry with that property.
The Analytics category in the properties palette is where custom properties are listed. It is separate from the Analytics app, which only shows measures.