PropertyInfo interface

Species details of how a property is to be displayed.

Properties

dateFormat

If the property is a date object, these options specify how it should be formatted when displayed. Uses Date.toLocaleString. If not specified, will fallback to the popup templates date format setting.

hideLabel

Specifies if the label of this property should be hidden and the content should span both columns of the table. Default: false

hyperlinkFormat

Format options for hyperlink strings.

label

The label to display for this property. If not specified, will fallback to the property name.

numberFormat

If the property is a number, these options specify how it should be formatted when displayed. Uses Number.toLocaleString. If not specified, will fallback to the popup templates number format setting.

propertyPath

The path to the property with each sub-property separated with a forward slash "/", for example "property/subproperty1/subproperty2. Array indices can be added as subproperties as well, for example "property/0"

Property Details

dateFormat

If the property is a date object, these options specify how it should be formatted when displayed. Uses Date.toLocaleString. If not specified, will fallback to the popup templates date format setting.

dateFormat?: DateTimeFormatOptions

Property Value

DateTimeFormatOptions

hideLabel

Specifies if the label of this property should be hidden and the content should span both columns of the table. Default: false

hideLabel?: boolean

Property Value

boolean

hyperlinkFormat

Format options for hyperlink strings.

hyperlinkFormat?: HyperLinkFormatOptions

Property Value

label

The label to display for this property. If not specified, will fallback to the property name.

label?: string

Property Value

string

numberFormat

If the property is a number, these options specify how it should be formatted when displayed. Uses Number.toLocaleString. If not specified, will fallback to the popup templates number format setting.

numberFormat?: NumberFormatOptions

Property Value

NumberFormatOptions

propertyPath

The path to the property with each sub-property separated with a forward slash "/", for example "property/subproperty1/subproperty2. Array indices can be added as subproperties as well, for example "property/0"

propertyPath: string

Property Value

string