Scriptable Reports

Type Definitions

CSSColor

A CSS color.
Type:
  • String
Examples
"red"
"#FF0000"
"rgb(255, 0, 0)"
"rgba(255, 0, 0, 0.8)"

CSSLength

A CSS length.
Type:
  • String
Examples
"16px"
"2.5in"

DataStoreDataType

A data store data type
Type:
  • Number | String

JSON

A JSON object.
Type:
  • Object
Example
{
	"Name1" : "Value",
	"Name2" : 7,
	"Name3" : [
		"A",
		"B",
		"C"
	]
}

Parameter

JSON structure to represent a simple parameter.
Example
{
  "parameter": "countries",
  "values": [
    {
      "use": "[a].[b].[c]",
      "display": "Canada"
    },
    {
      "use": "[d].[e].[f]",
      "display": "United States"
    }
  ]
}

Promise

A Q Promise instance.
Type:
  • Object

RangeParameter

JSON structure to represent a range parameter.
Example
{
  "parameter": "dates",
  "values": [
    {
      "start": {
        "use": "2007-01-01",
        "display": "January 1, 2007"
      },
      "end": {
        "use": "2007-12-31",
        "display": "December 31, 2007"
      }
    }
  ]
}