Skip to content

mapping

Index

Fields

obj RangeMap

fn RangeMap.withOptions

RangeMap.withOptions(value)

PARAMETERS:

  • value (object)

Range to match against and the result to apply when the value is within the range

fn RangeMap.withOptionsMixin

RangeMap.withOptionsMixin(value)

PARAMETERS:

  • value (object)

Range to match against and the result to apply when the value is within the range

fn RangeMap.withType

RangeMap.withType()

obj RangeMap.options

fn RangeMap.options.withFrom
RangeMap.options.withFrom(value)

PARAMETERS:

  • value (number)

Min value of the range. It can be null which means -Infinity

fn RangeMap.options.withResult
RangeMap.options.withResult(value)

PARAMETERS:

  • value (object)

Result used as replacement with text and color when the value matches

fn RangeMap.options.withResultMixin
RangeMap.options.withResultMixin(value)

PARAMETERS:

  • value (object)

Result used as replacement with text and color when the value matches

fn RangeMap.options.withTo
RangeMap.options.withTo(value)

PARAMETERS:

  • value (number)

Max value of the range. It can be null which means +Infinity

obj RangeMap.options.result
fn RangeMap.options.result.withColor
RangeMap.options.result.withColor(value)

PARAMETERS:

  • value (string)

Text to use when the value matches

fn RangeMap.options.result.withIcon
RangeMap.options.result.withIcon(value)

PARAMETERS:

  • value (string)

Icon to display when the value matches. Only specific visualizations.

fn RangeMap.options.result.withIndex
RangeMap.options.result.withIndex(value)

PARAMETERS:

  • value (integer)

Position in the mapping array. Only used internally.

fn RangeMap.options.result.withText
RangeMap.options.result.withText(value)

PARAMETERS:

  • value (string)

Text to display when the value matches

obj RegexMap

fn RegexMap.withOptions

RegexMap.withOptions(value)

PARAMETERS:

  • value (object)

Regular expression to match against and the result to apply when the value matches the regex

fn RegexMap.withOptionsMixin

RegexMap.withOptionsMixin(value)

PARAMETERS:

  • value (object)

Regular expression to match against and the result to apply when the value matches the regex

fn RegexMap.withType

RegexMap.withType()

obj RegexMap.options

fn RegexMap.options.withPattern
RegexMap.options.withPattern(value)

PARAMETERS:

  • value (string)

Regular expression to match against

fn RegexMap.options.withResult
RegexMap.options.withResult(value)

PARAMETERS:

  • value (object)

Result used as replacement with text and color when the value matches

fn RegexMap.options.withResultMixin
RegexMap.options.withResultMixin(value)

PARAMETERS:

  • value (object)

Result used as replacement with text and color when the value matches

obj RegexMap.options.result
fn RegexMap.options.result.withColor
RegexMap.options.result.withColor(value)

PARAMETERS:

  • value (string)

Text to use when the value matches

fn RegexMap.options.result.withIcon
RegexMap.options.result.withIcon(value)

PARAMETERS:

  • value (string)

Icon to display when the value matches. Only specific visualizations.

fn RegexMap.options.result.withIndex
RegexMap.options.result.withIndex(value)

PARAMETERS:

  • value (integer)

Position in the mapping array. Only used internally.

fn RegexMap.options.result.withText
RegexMap.options.result.withText(value)

PARAMETERS:

  • value (string)

Text to display when the value matches

obj SpecialValueMap

fn SpecialValueMap.withOptions

SpecialValueMap.withOptions(value)

PARAMETERS:

  • value (object)

fn SpecialValueMap.withOptionsMixin

SpecialValueMap.withOptionsMixin(value)

PARAMETERS:

  • value (object)

fn SpecialValueMap.withType

SpecialValueMap.withType()

obj SpecialValueMap.options

fn SpecialValueMap.options.withMatch
SpecialValueMap.options.withMatch(value)

PARAMETERS:

  • value (string)
    • valid values: "true", "false", "null", "nan", "null+nan", "empty"

Special value types supported by the SpecialValueMap

fn SpecialValueMap.options.withResult
SpecialValueMap.options.withResult(value)

PARAMETERS:

  • value (object)

Result used as replacement with text and color when the value matches

fn SpecialValueMap.options.withResultMixin
SpecialValueMap.options.withResultMixin(value)

PARAMETERS:

  • value (object)

Result used as replacement with text and color when the value matches

obj SpecialValueMap.options.result
fn SpecialValueMap.options.result.withColor
SpecialValueMap.options.result.withColor(value)

PARAMETERS:

  • value (string)

Text to use when the value matches

fn SpecialValueMap.options.result.withIcon
SpecialValueMap.options.result.withIcon(value)

PARAMETERS:

  • value (string)

Icon to display when the value matches. Only specific visualizations.

fn SpecialValueMap.options.result.withIndex
SpecialValueMap.options.result.withIndex(value)

PARAMETERS:

  • value (integer)

Position in the mapping array. Only used internally.

fn SpecialValueMap.options.result.withText
SpecialValueMap.options.result.withText(value)

PARAMETERS:

  • value (string)

Text to display when the value matches

obj ValueMap

fn ValueMap.withOptions

ValueMap.withOptions(value)

PARAMETERS:

  • value (object)

Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } }

fn ValueMap.withOptionsMixin

ValueMap.withOptionsMixin(value)

PARAMETERS:

  • value (object)

Map with : ValueMappingResult. For example: { "10": { text: "Perfection!", color: "green" } }

fn ValueMap.withType

ValueMap.withType()