Skip to content

librarypanel

grafonnet.librarypanel

Subpackages

Index

Fields

fn withDescription

withDescription(value)

PARAMETERS:

  • value (string)

Panel description

fn withFolderUid

withFolderUid(value)

PARAMETERS:

  • value (string)

Folder UID

fn withMeta

withMeta(value)

PARAMETERS:

  • value (object)

Object storage metadata

fn withMetaMixin

withMetaMixin(value)

PARAMETERS:

  • value (object)

Object storage metadata

fn withModel

withModel(value)

PARAMETERS:

  • value (object)

TODO: should be the same panel schema defined in dashboard Typescript: Omit;

fn withModelMixin

withModelMixin(value)

PARAMETERS:

  • value (object)

TODO: should be the same panel schema defined in dashboard Typescript: Omit;

fn withName

withName(value)

PARAMETERS:

  • value (string)

Panel name (also saved in the model)

fn withSchemaVersion

withSchemaVersion(value)

PARAMETERS:

  • value (integer)

Dashboard version when this was saved (zero if unknown)

fn withType

withType(value)

PARAMETERS:

  • value (string)

The panel type (from inside the model)

fn withUid

withUid(value)

PARAMETERS:

  • value (string)

Library element UID

fn withVersion

withVersion(value)

PARAMETERS:

  • value (integer)

panel version, incremented each time the dashboard is updated.

obj meta

fn meta.withConnectedDashboards

meta.withConnectedDashboards(value)

PARAMETERS:

  • value (integer)

fn meta.withCreated

meta.withCreated(value)

PARAMETERS:

  • value (string)

fn meta.withCreatedBy

meta.withCreatedBy(value)

PARAMETERS:

  • value (object)

fn meta.withCreatedByMixin

meta.withCreatedByMixin(value)

PARAMETERS:

  • value (object)

fn meta.withFolderName

meta.withFolderName(value)

PARAMETERS:

  • value (string)

fn meta.withFolderUid

meta.withFolderUid(value)

PARAMETERS:

  • value (string)

fn meta.withUpdated

meta.withUpdated(value)

PARAMETERS:

  • value (string)

fn meta.withUpdatedBy

meta.withUpdatedBy(value)

PARAMETERS:

  • value (object)

fn meta.withUpdatedByMixin

meta.withUpdatedByMixin(value)

PARAMETERS:

  • value (object)

obj meta.createdBy

fn meta.createdBy.withAvatarUrl
meta.createdBy.withAvatarUrl(value)

PARAMETERS:

  • value (string)
fn meta.createdBy.withId
meta.createdBy.withId(value)

PARAMETERS:

  • value (integer)
fn meta.createdBy.withName
meta.createdBy.withName(value)

PARAMETERS:

  • value (string)

obj meta.updatedBy

fn meta.updatedBy.withAvatarUrl
meta.updatedBy.withAvatarUrl(value)

PARAMETERS:

  • value (string)
fn meta.updatedBy.withId
meta.updatedBy.withId(value)

PARAMETERS:

  • value (integer)
fn meta.updatedBy.withName
meta.updatedBy.withName(value)

PARAMETERS:

  • value (string)

obj model

fn model.withCacheTimeout

model.withCacheTimeout(value)

PARAMETERS:

  • value (string)

Sets panel queries cache timeout.

fn model.withDatasource

model.withDatasource(value)

PARAMETERS:

  • value (object)

Ref to a DataSource instance

fn model.withDatasourceMixin

model.withDatasourceMixin(value)

PARAMETERS:

  • value (object)

Ref to a DataSource instance

fn model.withDescription

model.withDescription(value)

PARAMETERS:

  • value (string)

Panel description.

fn model.withFieldConfig

model.withFieldConfig(value)

PARAMETERS:

  • value (object)

The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results. Each column within this structure is called a field. A field can represent a single time series or table column. Field options allow you to change how the data is displayed in your visualizations.

fn model.withFieldConfigMixin

model.withFieldConfigMixin(value)

PARAMETERS:

  • value (object)

The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results. Each column within this structure is called a field. A field can represent a single time series or table column. Field options allow you to change how the data is displayed in your visualizations.

fn model.withHideTimeOverride

model.withHideTimeOverride(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true

Controls if the timeFrom or timeShift overrides are shown in the panel header

fn model.withInterval

model.withInterval(value)

PARAMETERS:

  • value (string)

The min time interval setting defines a lower limit for the $__interval and $__interval_ms variables. This value must be formatted as a number followed by a valid time identifier like: "40s", "3d", etc. See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options

model.withLinks(value)

PARAMETERS:

  • value (array)

Panel links.

fn model.withLinksMixin

model.withLinksMixin(value)

PARAMETERS:

  • value (array)

Panel links.

fn model.withMaxDataPoints

model.withMaxDataPoints(value)

PARAMETERS:

  • value (number)

The maximum number of data points that the panel queries are retrieving.

fn model.withMaxPerRow

model.withMaxPerRow(value)

PARAMETERS:

  • value (number)

Option for repeated panels that controls max items per row Only relevant for horizontally repeated panels

fn model.withOptions

model.withOptions(value)

PARAMETERS:

  • value (object)

It depends on the panel plugin. They are specified by the Options field in panel plugin schemas.

fn model.withOptionsMixin

model.withOptionsMixin(value)

PARAMETERS:

  • value (object)

It depends on the panel plugin. They are specified by the Options field in panel plugin schemas.

fn model.withPluginVersion

model.withPluginVersion(value)

PARAMETERS:

  • value (string)

The version of the plugin that is used for this panel. This is used to find the plugin to display the panel and to migrate old panel configs.

fn model.withQueryCachingTTL

model.withQueryCachingTTL(value)

PARAMETERS:

  • value (number)

Overrides the data source configured time-to-live for a query cache item in milliseconds

fn model.withRepeat

model.withRepeat(value)

PARAMETERS:

  • value (string)

Name of template variable to repeat for.

fn model.withRepeatDirection

model.withRepeatDirection(value="h")

PARAMETERS:

  • value (string)
    • default value: "h"
    • valid values: "h", "v"

Direction to repeat in if 'repeat' is set. h for horizontal, v for vertical.

fn model.withTargets

model.withTargets(value)

PARAMETERS:

  • value (array)

Depends on the panel plugin. See the plugin documentation for details.

fn model.withTargetsMixin

model.withTargetsMixin(value)

PARAMETERS:

  • value (array)

Depends on the panel plugin. See the plugin documentation for details.

fn model.withTimeFrom

model.withTimeFrom(value)

PARAMETERS:

  • value (string)

Overrides the relative time range for individual panels, which causes them to be different than what is selected in the dashboard time picker in the top-right corner of the dashboard. You can use this to show metrics from different time periods or days on the same dashboard. The value is formatted as time operation like: now-5m (Last 5 minutes), now/d (the day so far), now-5d/d(Last 5 days), now/w (This week so far), now-2y/y (Last 2 years). Note: Panel time overrides have no effect when the dashboard’s time range is absolute. See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options

fn model.withTimeShift

model.withTimeShift(value)

PARAMETERS:

  • value (string)

Overrides the time range for individual panels by shifting its start and end relative to the time picker. For example, you can shift the time range for the panel to be two hours earlier than the dashboard time picker setting 2h. Note: Panel time overrides have no effect when the dashboard’s time range is absolute. See: https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/#query-options

fn model.withTitle

model.withTitle(value)

PARAMETERS:

  • value (string)

Panel title.

fn model.withTransformations

model.withTransformations(value)

PARAMETERS:

  • value (array)

List of transformations that are applied to the panel data before rendering. When there are multiple transformations, Grafana applies them in the order they are listed. Each transformation creates a result set that then passes on to the next transformation in the processing pipeline.

fn model.withTransformationsMixin

model.withTransformationsMixin(value)

PARAMETERS:

  • value (array)

List of transformations that are applied to the panel data before rendering. When there are multiple transformations, Grafana applies them in the order they are listed. Each transformation creates a result set that then passes on to the next transformation in the processing pipeline.

fn model.withTransparent

model.withTransparent(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true

Whether to display the panel without a background.

fn model.withType

model.withType(value)

PARAMETERS:

  • value (string)

The panel plugin type id. This is used to find the plugin to display the panel.

obj model.datasource

fn model.datasource.withType
model.datasource.withType(value)

PARAMETERS:

  • value (string)

The plugin type-id

fn model.datasource.withUid
model.datasource.withUid(value)

PARAMETERS:

  • value (string)

Specific datasource instance

obj model.fieldConfig

fn model.fieldConfig.withDefaults
model.fieldConfig.withDefaults(value)

PARAMETERS:

  • value (object)

The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results. Each column within this structure is called a field. A field can represent a single time series or table column. Field options allow you to change how the data is displayed in your visualizations.

fn model.fieldConfig.withDefaultsMixin
model.fieldConfig.withDefaultsMixin(value)

PARAMETERS:

  • value (object)

The data model used in Grafana, namely the data frame, is a columnar-oriented table structure that unifies both time series and table query results. Each column within this structure is called a field. A field can represent a single time series or table column. Field options allow you to change how the data is displayed in your visualizations.

fn model.fieldConfig.withOverrides
model.fieldConfig.withOverrides(value)

PARAMETERS:

  • value (array)

Overrides are the options applied to specific fields overriding the defaults.

fn model.fieldConfig.withOverridesMixin
model.fieldConfig.withOverridesMixin(value)

PARAMETERS:

  • value (array)

Overrides are the options applied to specific fields overriding the defaults.

obj model.fieldConfig.defaults
fn model.fieldConfig.defaults.withColor
model.fieldConfig.defaults.withColor(value)

PARAMETERS:

  • value (object)

Map a field to a color.

fn model.fieldConfig.defaults.withColorMixin
model.fieldConfig.defaults.withColorMixin(value)

PARAMETERS:

  • value (object)

Map a field to a color.

fn model.fieldConfig.defaults.withCustom
model.fieldConfig.defaults.withCustom(value)

PARAMETERS:

  • value (object)

custom is specified by the FieldConfig field in panel plugin schemas.

fn model.fieldConfig.defaults.withCustomMixin
model.fieldConfig.defaults.withCustomMixin(value)

PARAMETERS:

  • value (object)

custom is specified by the FieldConfig field in panel plugin schemas.

fn model.fieldConfig.defaults.withDecimals
model.fieldConfig.defaults.withDecimals(value)

PARAMETERS:

  • value (number)

Specify the number of decimals Grafana includes in the rendered value. If you leave this field blank, Grafana automatically truncates the number of decimals based on the value. For example 1.1234 will display as 1.12 and 100.456 will display as 100. To display all decimals, set the unit to String.

fn model.fieldConfig.defaults.withDescription
model.fieldConfig.defaults.withDescription(value)

PARAMETERS:

  • value (string)

Human readable field metadata

fn model.fieldConfig.defaults.withDisplayName
model.fieldConfig.defaults.withDisplayName(value)

PARAMETERS:

  • value (string)

The display value for this field. This supports template variables blank is auto

fn model.fieldConfig.defaults.withDisplayNameFromDS
model.fieldConfig.defaults.withDisplayNameFromDS(value)

PARAMETERS:

  • value (string)

This can be used by data sources that return and explicit naming structure for values and labels When this property is configured, this value is used rather than the default naming strategy.

fn model.fieldConfig.defaults.withFilterable
model.fieldConfig.defaults.withFilterable(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true

True if data source field supports ad-hoc filters

model.fieldConfig.defaults.withLinks(value)

PARAMETERS:

  • value (array)

The behavior when clicking on a result

fn model.fieldConfig.defaults.withLinksMixin
model.fieldConfig.defaults.withLinksMixin(value)

PARAMETERS:

  • value (array)

The behavior when clicking on a result

fn model.fieldConfig.defaults.withMappings
model.fieldConfig.defaults.withMappings(value)

PARAMETERS:

  • value (array)

Convert input values into a display string

fn model.fieldConfig.defaults.withMappingsMixin
model.fieldConfig.defaults.withMappingsMixin(value)

PARAMETERS:

  • value (array)

Convert input values into a display string

fn model.fieldConfig.defaults.withMax
model.fieldConfig.defaults.withMax(value)

PARAMETERS:

  • value (number)

The maximum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields.

fn model.fieldConfig.defaults.withMin
model.fieldConfig.defaults.withMin(value)

PARAMETERS:

  • value (number)

The minimum value used in percentage threshold calculations. Leave blank for auto calculation based on all series and fields.

fn model.fieldConfig.defaults.withNoValue
model.fieldConfig.defaults.withNoValue(value)

PARAMETERS:

  • value (string)

Alternative to empty string

fn model.fieldConfig.defaults.withPath
model.fieldConfig.defaults.withPath(value)

PARAMETERS:

  • value (string)

An explicit path to the field in the datasource. When the frame meta includes a path, This will default to `${frame.meta.path}/${field.name}

When defined, this value can be used as an identifier within the datasource scope, and may be used to update the results

fn model.fieldConfig.defaults.withThresholds
model.fieldConfig.defaults.withThresholds(value)

PARAMETERS:

  • value (object)

Thresholds configuration for the panel

fn model.fieldConfig.defaults.withThresholdsMixin
model.fieldConfig.defaults.withThresholdsMixin(value)

PARAMETERS:

  • value (object)

Thresholds configuration for the panel

fn model.fieldConfig.defaults.withUnit
model.fieldConfig.defaults.withUnit(value)

PARAMETERS:

  • value (string)

Unit a field should use. The unit you select is applied to all fields except time. You can use the units ID availables in Grafana or a custom unit. Available units in Grafana: https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/valueFormats/categories.ts As custom unit, you can use the following formats: suffix:<suffix> for custom unit that should go after value. prefix:<prefix> for custom unit that should go before value. time:<format> For custom date time formats type for example time:YYYY-MM-DD. si:<base scale><unit characters> for custom SI units. For example: si: mF. This one is a bit more advanced as you can specify both a unit and the source data scale. So if your source data is represented as milli (thousands of) something prefix the unit with that SI scale character. count:<unit> for a custom count unit. currency:<unit> for custom a currency unit.

fn model.fieldConfig.defaults.withWriteable
model.fieldConfig.defaults.withWriteable(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true

True if data source can write a value to the path. Auth/authz are supported separately

obj model.fieldConfig.defaults.color
# fn model.fieldConfig.defaults.color.withFixedColor
model.fieldConfig.defaults.color.withFixedColor(value)

PARAMETERS:

  • value (string)

The fixed color value for fixed or shades color modes.

# fn model.fieldConfig.defaults.color.withMode
model.fieldConfig.defaults.color.withMode(value)

PARAMETERS:

  • value (string)
    • valid values: "thresholds", "palette-classic", "palette-classic-by-name", "continuous-GrYlRd", "continuous-RdYlGr", "continuous-BlYlRd", "continuous-YlRd", "continuous-BlPu", "continuous-YlBl", "continuous-blues", "continuous-reds", "continuous-greens", "continuous-purples", "fixed", "shades"

Color mode for a field. You can specify a single color, or select a continuous (gradient) color schemes, based on a value. Continuous color interpolates a color using the percentage of a value relative to min and max. Accepted values are: thresholds: From thresholds. Informs Grafana to take the color from the matching threshold palette-classic: Classic palette. Grafana will assign color by looking up a color in a palette by series index. Useful for Graphs and pie charts and other categorical data visualizations palette-classic-by-name: Classic palette (by name). Grafana will assign color by looking up a color in a palette by series name. Useful for Graphs and pie charts and other categorical data visualizations continuous-GrYlRd: ontinuous Green-Yellow-Red palette mode continuous-RdYlGr: Continuous Red-Yellow-Green palette mode continuous-BlYlRd: Continuous Blue-Yellow-Red palette mode continuous-YlRd: Continuous Yellow-Red palette mode continuous-BlPu: Continuous Blue-Purple palette mode continuous-YlBl: Continuous Yellow-Blue palette mode continuous-blues: Continuous Blue palette mode continuous-reds: Continuous Red palette mode continuous-greens: Continuous Green palette mode continuous-purples: Continuous Purple palette mode shades: Shades of a single color. Specify a single color, useful in an override rule. fixed: Fixed color mode. Specify a single color, useful in an override rule.

# fn model.fieldConfig.defaults.color.withSeriesBy
model.fieldConfig.defaults.color.withSeriesBy(value)

PARAMETERS:

  • value (string)
    • valid values: "min", "max", "last"

Defines how to assign a series color from "by value" color schemes. For example for an aggregated data points like a timeseries, the color can be assigned by the min, max or last value.

obj model.fieldConfig.defaults.mappings
# obj model.fieldConfig.defaults.mappings.RangeMap
## fn model.fieldConfig.defaults.mappings.RangeMap.withOptions
model.fieldConfig.defaults.mappings.RangeMap.withOptions(value)

PARAMETERS:

  • value (object)

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

## fn model.fieldConfig.defaults.mappings.RangeMap.withOptionsMixin
model.fieldConfig.defaults.mappings.RangeMap.withOptionsMixin(value)

PARAMETERS:

  • value (object)

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

## fn model.fieldConfig.defaults.mappings.RangeMap.withType
model.fieldConfig.defaults.mappings.RangeMap.withType()
## obj model.fieldConfig.defaults.mappings.RangeMap.options
### fn model.fieldConfig.defaults.mappings.RangeMap.options.withFrom
model.fieldConfig.defaults.mappings.RangeMap.options.withFrom(value)

PARAMETERS:

  • value (number)

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

### fn model.fieldConfig.defaults.mappings.RangeMap.options.withResult
model.fieldConfig.defaults.mappings.RangeMap.options.withResult(value)

PARAMETERS:

  • value (object)

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

### fn model.fieldConfig.defaults.mappings.RangeMap.options.withResultMixin
model.fieldConfig.defaults.mappings.RangeMap.options.withResultMixin(value)

PARAMETERS:

  • value (object)

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

### fn model.fieldConfig.defaults.mappings.RangeMap.options.withTo
model.fieldConfig.defaults.mappings.RangeMap.options.withTo(value)

PARAMETERS:

  • value (number)

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

### obj model.fieldConfig.defaults.mappings.RangeMap.options.result
#### fn model.fieldConfig.defaults.mappings.RangeMap.options.result.withColor
model.fieldConfig.defaults.mappings.RangeMap.options.result.withColor(value)

PARAMETERS:

  • value (string)

Text to use when the value matches

#### fn model.fieldConfig.defaults.mappings.RangeMap.options.result.withIcon
model.fieldConfig.defaults.mappings.RangeMap.options.result.withIcon(value)

PARAMETERS:

  • value (string)

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

#### fn model.fieldConfig.defaults.mappings.RangeMap.options.result.withIndex
model.fieldConfig.defaults.mappings.RangeMap.options.result.withIndex(value)

PARAMETERS:

  • value (integer)

Position in the mapping array. Only used internally.

#### fn model.fieldConfig.defaults.mappings.RangeMap.options.result.withText
model.fieldConfig.defaults.mappings.RangeMap.options.result.withText(value)

PARAMETERS:

  • value (string)

Text to display when the value matches

# obj model.fieldConfig.defaults.mappings.RegexMap
## fn model.fieldConfig.defaults.mappings.RegexMap.withOptions
model.fieldConfig.defaults.mappings.RegexMap.withOptions(value)

PARAMETERS:

  • value (object)

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

## fn model.fieldConfig.defaults.mappings.RegexMap.withOptionsMixin
model.fieldConfig.defaults.mappings.RegexMap.withOptionsMixin(value)

PARAMETERS:

  • value (object)

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

## fn model.fieldConfig.defaults.mappings.RegexMap.withType
model.fieldConfig.defaults.mappings.RegexMap.withType()
## obj model.fieldConfig.defaults.mappings.RegexMap.options
### fn model.fieldConfig.defaults.mappings.RegexMap.options.withPattern
model.fieldConfig.defaults.mappings.RegexMap.options.withPattern(value)

PARAMETERS:

  • value (string)

Regular expression to match against

### fn model.fieldConfig.defaults.mappings.RegexMap.options.withResult
model.fieldConfig.defaults.mappings.RegexMap.options.withResult(value)

PARAMETERS:

  • value (object)

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

### fn model.fieldConfig.defaults.mappings.RegexMap.options.withResultMixin
model.fieldConfig.defaults.mappings.RegexMap.options.withResultMixin(value)

PARAMETERS:

  • value (object)

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

### obj model.fieldConfig.defaults.mappings.RegexMap.options.result
#### fn model.fieldConfig.defaults.mappings.RegexMap.options.result.withColor
model.fieldConfig.defaults.mappings.RegexMap.options.result.withColor(value)

PARAMETERS:

  • value (string)

Text to use when the value matches

#### fn model.fieldConfig.defaults.mappings.RegexMap.options.result.withIcon
model.fieldConfig.defaults.mappings.RegexMap.options.result.withIcon(value)

PARAMETERS:

  • value (string)

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

#### fn model.fieldConfig.defaults.mappings.RegexMap.options.result.withIndex
model.fieldConfig.defaults.mappings.RegexMap.options.result.withIndex(value)

PARAMETERS:

  • value (integer)

Position in the mapping array. Only used internally.

#### fn model.fieldConfig.defaults.mappings.RegexMap.options.result.withText
model.fieldConfig.defaults.mappings.RegexMap.options.result.withText(value)

PARAMETERS:

  • value (string)

Text to display when the value matches

# obj model.fieldConfig.defaults.mappings.SpecialValueMap
## fn model.fieldConfig.defaults.mappings.SpecialValueMap.withOptions
model.fieldConfig.defaults.mappings.SpecialValueMap.withOptions(value)

PARAMETERS:

  • value (object)
## fn model.fieldConfig.defaults.mappings.SpecialValueMap.withOptionsMixin
model.fieldConfig.defaults.mappings.SpecialValueMap.withOptionsMixin(value)

PARAMETERS:

  • value (object)
## fn model.fieldConfig.defaults.mappings.SpecialValueMap.withType
model.fieldConfig.defaults.mappings.SpecialValueMap.withType()
## obj model.fieldConfig.defaults.mappings.SpecialValueMap.options
### fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.withMatch
model.fieldConfig.defaults.mappings.SpecialValueMap.options.withMatch(value)

PARAMETERS:

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

Special value types supported by the SpecialValueMap

### fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.withResult
model.fieldConfig.defaults.mappings.SpecialValueMap.options.withResult(value)

PARAMETERS:

  • value (object)

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

### fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.withResultMixin
model.fieldConfig.defaults.mappings.SpecialValueMap.options.withResultMixin(value)

PARAMETERS:

  • value (object)

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

### obj model.fieldConfig.defaults.mappings.SpecialValueMap.options.result
#### fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withColor
model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withColor(value)

PARAMETERS:

  • value (string)

Text to use when the value matches

#### fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withIcon
model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withIcon(value)

PARAMETERS:

  • value (string)

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

#### fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withIndex
model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withIndex(value)

PARAMETERS:

  • value (integer)

Position in the mapping array. Only used internally.

#### fn model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withText
model.fieldConfig.defaults.mappings.SpecialValueMap.options.result.withText(value)

PARAMETERS:

  • value (string)

Text to display when the value matches

# obj model.fieldConfig.defaults.mappings.ValueMap
## fn model.fieldConfig.defaults.mappings.ValueMap.withOptions
model.fieldConfig.defaults.mappings.ValueMap.withOptions(value)

PARAMETERS:

  • value (object)

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

## fn model.fieldConfig.defaults.mappings.ValueMap.withOptionsMixin
model.fieldConfig.defaults.mappings.ValueMap.withOptionsMixin(value)

PARAMETERS:

  • value (object)

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

## fn model.fieldConfig.defaults.mappings.ValueMap.withType
model.fieldConfig.defaults.mappings.ValueMap.withType()
obj model.fieldConfig.defaults.thresholds
# fn model.fieldConfig.defaults.thresholds.withMode
model.fieldConfig.defaults.thresholds.withMode(value)

PARAMETERS:

  • value (string)
    • valid values: "absolute", "percentage"

Thresholds can either be absolute (specific number) or percentage (relative to min or max, it will be values between 0 and 1).

# fn model.fieldConfig.defaults.thresholds.withSteps
model.fieldConfig.defaults.thresholds.withSteps(value)

PARAMETERS:

  • value (array)

Must be sorted by 'value', first value is always -Infinity

# fn model.fieldConfig.defaults.thresholds.withStepsMixin
model.fieldConfig.defaults.thresholds.withStepsMixin(value)

PARAMETERS:

  • value (array)

Must be sorted by 'value', first value is always -Infinity