highlight - APEXlang Reference

`highlight`

Parent: savedReport

Direct Properties:

Property	Type	Required	Default Value	Details
`name`	`string`	Yes		data type=`string`; maxLen=40

Property Groups:

condition

Property	Type	Required	Default Value	Details
`type`	`enum`	Yes	`column`	data type=`string`; lov=`STATIC` Valid values: `column` `rowSearch`
`search`	`string`	Yes		data type=`string`; maxLen=4000 Applies when`type = rowSearch`
`column`	`reference`	Yes		data type=`reference`; lov=`COMPONENT`; references=`column` Applies when`type = column`
`operator`	`enum`	Yes	`equals`	data type=`string`; lov=`STATIC` Valid values: `equals` `notEquals` `greaterThan` `greaterThanOrEquals` `lessThan` `lessThanOrEquals` `isEmpty` `isNotEmpty` `in` `notIn` `between` `notBetween` `contains` `doesNotContain` `startsWith` `doesNotStartWith` `matchesRegexp` `inTheLast` `notInTheLast` `inTheNext` `notInTheNext` Applies when`type = column`
`value`	`string`	Yes		data type=`string`; maxLen=4000 Applies when`type = column`
`from`	`string`	Yes		data type=`string`; maxLen=1900 Applies when`type = column and operator in (between)type = column and operator in (notBetween)`
`to`	`string`	Yes		data type=`string`; maxLen=1900 Applies when`type = column and operator in (between)type = column and operator in (notBetween)`
`value`	`number`	Yes		data type=`number`; maxLen=22 Applies when`type = column and operator in (inTheLast)type = column and operator in (notInTheLast)type = column and operator in (inTheNext)type = column and operator in (notInTheNext)`
`unit`	`enum`	Yes		data type=`string`; lov=`STATIC` Valid values: `min` `hours` `days` `weeks` `months` `years` Applies when`type = column and operator in (inTheLast)type = column and operator in (notInTheLast)type = column and operator in (inTheNext)type = column and operator in (notInTheNext)`
`caseSensitive`	`boolean`	Yes	`false`	data type=`boolean` Applies when`type = rowSearchtype = column and operator in (contains)type = column and operator in (doesNotContain)type = column and operator in (startsWith)type = column and operator in (doesNotStartWith)type = column and operator in (matchesRegexp)`

condition {
  type: column
  search: value
  column: @component
  operator: equals
  value: value
  from: value
  to: value
  unit: min
  caseSensitive: false
}

highlight

Property	Type	Required	Default Value	Details
`type`	`enum`	Yes	`row`	data type=`string`; lov=`STATIC` Valid values: `row` `cell`
`column`	`reference`	Yes		data type=`reference`; lov=`COMPONENT`; references=`column` Applies when`type = cell`

highlight {
  type: row
  column: @component
}

colors

Property	Type	Required	Default Value	Details
`background`	`string`	No		data type=`string`; maxLen=30
`text`	`string`	No		data type=`string`; maxLen=30

colors {
  background: value
  text: value
}

execution

Property	Type	Required	Default Value	Details
`sequence`	`number`	Yes		data type=`number`; maxLen=22

execution {
  sequence: 42
}

advanced

Property	Type	Required	Default Value	Details
`staticId`	`string`	Yes		data type=`string`; maxLen=255
`enabled`	`boolean`	Yes	`true`	data type=`boolean`

advanced {
  staticId: value
  enabled: false
}

APEXlang Example

highlight sample (
    name: value
    condition {
        type: column
        search: value
        column: @component
        operator: equals
        value: value
        from: value
        to: value
        unit: min
        caseSensitive: false
    }
    highlight {
        type: row
        column: @component
    }
    colors {
        background: value
        text: value
    }
    execution {
        sequence: 42
    }
    advanced {
        staticId: value
        enabled: false
    }
)