Skip to content

table

grafonnet.panel.table

Subpackages

Index

Fields

fn new

new(title)

PARAMETERS:

  • title (string)

Creates a new table panel with a title.

obj fieldConfig

obj fieldConfig.defaults

obj fieldConfig.defaults.custom
fn fieldConfig.defaults.custom.withAlign
fieldConfig.defaults.custom.withAlign(value="auto")

PARAMETERS:

  • value (string)
    • default value: "auto"
    • valid values: "auto", "left", "right", "center"

TODO -- should not be table specific! TODO docs

fn fieldConfig.defaults.custom.withCellOptions
fieldConfig.defaults.custom.withCellOptions(value)

PARAMETERS:

  • value (object)

Table cell options. Each cell has a display mode and other potential options for that display.

fn fieldConfig.defaults.custom.withCellOptionsMixin
fieldConfig.defaults.custom.withCellOptionsMixin(value)

PARAMETERS:

  • value (object)

Table cell options. Each cell has a display mode and other potential options for that display.

fn fieldConfig.defaults.custom.withDisplayMode
fieldConfig.defaults.custom.withDisplayMode(value)

PARAMETERS:

  • value (string)
    • valid values: "auto", "color-text", "color-background", "color-background-solid", "gradient-gauge", "lcd-gauge", "json-view", "basic", "image", "gauge", "sparkline", "data-links", "custom"

Internally, this is the "type" of cell that's being displayed in the table such as colored text, JSON, gauge, etc. The color-background-solid, gradient-gauge, and lcd-gauge modes are deprecated in favor of new cell subOptions

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

PARAMETERS:

  • value (boolean)
    • default value: true
fn fieldConfig.defaults.custom.withHidden
fieldConfig.defaults.custom.withHidden(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true

?? default is missing or false ??

fn fieldConfig.defaults.custom.withHideHeader
fieldConfig.defaults.custom.withHideHeader(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true

Hides any header for a column, useful for columns that show some static content or buttons.

fn fieldConfig.defaults.custom.withInspect
fieldConfig.defaults.custom.withInspect(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true
fn fieldConfig.defaults.custom.withMinWidth
fieldConfig.defaults.custom.withMinWidth(value)

PARAMETERS:

  • value (number)
fn fieldConfig.defaults.custom.withWidth
fieldConfig.defaults.custom.withWidth(value)

PARAMETERS:

  • value (number)
obj fieldConfig.defaults.custom.cellOptions
# fn fieldConfig.defaults.custom.cellOptions.withTableAutoCellOptions
fieldConfig.defaults.custom.cellOptions.withTableAutoCellOptions(value)

PARAMETERS:

  • value (object)

Auto mode table cell options

# fn fieldConfig.defaults.custom.cellOptions.withTableAutoCellOptionsMixin
fieldConfig.defaults.custom.cellOptions.withTableAutoCellOptionsMixin(value)

PARAMETERS:

  • value (object)

Auto mode table cell options

# fn fieldConfig.defaults.custom.cellOptions.withTableBarGaugeCellOptions
fieldConfig.defaults.custom.cellOptions.withTableBarGaugeCellOptions(value)

PARAMETERS:

  • value (object)

Gauge cell options

# fn fieldConfig.defaults.custom.cellOptions.withTableBarGaugeCellOptionsMixin
fieldConfig.defaults.custom.cellOptions.withTableBarGaugeCellOptionsMixin(value)

PARAMETERS:

  • value (object)

Gauge cell options

# fn fieldConfig.defaults.custom.cellOptions.withTableColorTextCellOptions
fieldConfig.defaults.custom.cellOptions.withTableColorTextCellOptions(value)

PARAMETERS:

  • value (object)

Colored text cell options

# fn fieldConfig.defaults.custom.cellOptions.withTableColorTextCellOptionsMixin
fieldConfig.defaults.custom.cellOptions.withTableColorTextCellOptionsMixin(value)

PARAMETERS:

  • value (object)

Colored text cell options

# fn fieldConfig.defaults.custom.cellOptions.withTableColoredBackgroundCellOptions
fieldConfig.defaults.custom.cellOptions.withTableColoredBackgroundCellOptions(value)

PARAMETERS:

  • value (object)

Colored background cell options

# fn fieldConfig.defaults.custom.cellOptions.withTableColoredBackgroundCellOptionsMixin
fieldConfig.defaults.custom.cellOptions.withTableColoredBackgroundCellOptionsMixin(value)

PARAMETERS:

  • value (object)

Colored background cell options

# fn fieldConfig.defaults.custom.cellOptions.withTableDataLinksCellOptions
fieldConfig.defaults.custom.cellOptions.withTableDataLinksCellOptions(value)

PARAMETERS:

  • value (object)

Show data links in the cell

# fn fieldConfig.defaults.custom.cellOptions.withTableDataLinksCellOptionsMixin
fieldConfig.defaults.custom.cellOptions.withTableDataLinksCellOptionsMixin(value)

PARAMETERS:

  • value (object)

Show data links in the cell

# fn fieldConfig.defaults.custom.cellOptions.withTableImageCellOptions
fieldConfig.defaults.custom.cellOptions.withTableImageCellOptions(value)

PARAMETERS:

  • value (object)

Json view cell options

# fn fieldConfig.defaults.custom.cellOptions.withTableImageCellOptionsMixin
fieldConfig.defaults.custom.cellOptions.withTableImageCellOptionsMixin(value)

PARAMETERS:

  • value (object)

Json view cell options

# fn fieldConfig.defaults.custom.cellOptions.withTableJsonViewCellOptions
fieldConfig.defaults.custom.cellOptions.withTableJsonViewCellOptions(value)

PARAMETERS:

  • value (object)

Json view cell options

# fn fieldConfig.defaults.custom.cellOptions.withTableJsonViewCellOptionsMixin
fieldConfig.defaults.custom.cellOptions.withTableJsonViewCellOptionsMixin(value)

PARAMETERS:

  • value (object)

Json view cell options

# fn fieldConfig.defaults.custom.cellOptions.withTableSparklineCellOptions
fieldConfig.defaults.custom.cellOptions.withTableSparklineCellOptions(value)

PARAMETERS:

  • value (object)

Sparkline cell options

# fn fieldConfig.defaults.custom.cellOptions.withTableSparklineCellOptionsMixin
fieldConfig.defaults.custom.cellOptions.withTableSparklineCellOptionsMixin(value)

PARAMETERS:

  • value (object)

Sparkline cell options

# obj fieldConfig.defaults.custom.cellOptions.TableAutoCellOptions
## fn fieldConfig.defaults.custom.cellOptions.TableAutoCellOptions.withType
fieldConfig.defaults.custom.cellOptions.TableAutoCellOptions.withType()
## fn fieldConfig.defaults.custom.cellOptions.TableAutoCellOptions.withWrapText
fieldConfig.defaults.custom.cellOptions.TableAutoCellOptions.withWrapText(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true
# obj fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions
## fn fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withMode
fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withMode(value)

PARAMETERS:

  • value (string)
    • valid values: "basic", "lcd", "gradient"

Enum expressing the possible display modes for the bar gauge component of Grafana UI

## fn fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withType
fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withType()
## fn fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withValueDisplayMode
fieldConfig.defaults.custom.cellOptions.TableBarGaugeCellOptions.withValueDisplayMode(value)

PARAMETERS:

  • value (string)
    • valid values: "color", "text", "hidden"

Allows for the table cell gauge display type to set the gauge mode.

# obj fieldConfig.defaults.custom.cellOptions.TableColorTextCellOptions
## fn fieldConfig.defaults.custom.cellOptions.TableColorTextCellOptions.withType
fieldConfig.defaults.custom.cellOptions.TableColorTextCellOptions.withType()
## fn fieldConfig.defaults.custom.cellOptions.TableColorTextCellOptions.withWrapText
fieldConfig.defaults.custom.cellOptions.TableColorTextCellOptions.withWrapText(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true
# obj fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions
## fn fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withApplyToRow
fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withApplyToRow(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true
## fn fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withMode
fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withMode(value)

PARAMETERS:

  • value (string)
    • valid values: "basic", "gradient"

Display mode to the "Colored Background" display mode for table cells. Either displays a solid color (basic mode) or a gradient.

## fn fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withType
fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withType()
## fn fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withWrapText
fieldConfig.defaults.custom.cellOptions.TableColoredBackgroundCellOptions.withWrapText(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true
# obj fieldConfig.defaults.custom.cellOptions.TableDataLinksCellOptions
## fn fieldConfig.defaults.custom.cellOptions.TableDataLinksCellOptions.withType
fieldConfig.defaults.custom.cellOptions.TableDataLinksCellOptions.withType()
# obj fieldConfig.defaults.custom.cellOptions.TableImageCellOptions
## fn fieldConfig.defaults.custom.cellOptions.TableImageCellOptions.withType
fieldConfig.defaults.custom.cellOptions.TableImageCellOptions.withType()
# obj fieldConfig.defaults.custom.cellOptions.TableJsonViewCellOptions
## fn fieldConfig.defaults.custom.cellOptions.TableJsonViewCellOptions.withType
fieldConfig.defaults.custom.cellOptions.TableJsonViewCellOptions.withType()
# obj fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions
## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisBorderShow
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisBorderShow(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true
## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisCenteredZero
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisCenteredZero(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true
## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisColorMode
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisColorMode(value)

PARAMETERS:

  • value (string)
    • valid values: "text", "series"

TODO docs

## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisGridShow
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisGridShow(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true
## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisLabel
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisLabel(value)

PARAMETERS:

  • value (string)
## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisPlacement
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisPlacement(value)

PARAMETERS:

  • value (string)
    • valid values: "auto", "top", "right", "bottom", "left", "hidden"

TODO docs

## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisSoftMax
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisSoftMax(value)

PARAMETERS:

  • value (number)
## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisSoftMin
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisSoftMin(value)

PARAMETERS:

  • value (number)
## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisWidth
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withAxisWidth(value)

PARAMETERS:

  • value (number)
## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withBarAlignment
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withBarAlignment(value)

PARAMETERS:

  • value (string)
    • valid values: -1, 0, 1

TODO docs

## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withBarMaxWidth
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withBarMaxWidth(value)

PARAMETERS:

  • value (number)
## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withBarWidthFactor
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withBarWidthFactor(value)

PARAMETERS:

  • value (number)
## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withDrawStyle
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withDrawStyle(value)

PARAMETERS:

  • value (string)
    • valid values: "line", "bars", "points"

TODO docs

## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withFillBelowTo
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withFillBelowTo(value)

PARAMETERS:

  • value (string)
## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withFillColor
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withFillColor(value)

PARAMETERS:

  • value (string)
## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withFillOpacity
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withFillOpacity(value)

PARAMETERS:

  • value (number)
## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withGradientMode
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withGradientMode(value)

PARAMETERS:

  • value (string)
    • valid values: "none", "opacity", "hue", "scheme"

TODO docs

## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withHideFrom
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withHideFrom(value)

PARAMETERS:

  • value (object)

TODO docs

## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withHideFromMixin
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withHideFromMixin(value)

PARAMETERS:

  • value (object)

TODO docs

## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withHideValue
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withHideValue(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true
## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withInsertNulls
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withInsertNulls(value)

PARAMETERS:

  • value (boolean,number)
## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withInsertNullsMixin
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withInsertNullsMixin(value)

PARAMETERS:

  • value (boolean,number)
## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineColor
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineColor(value)

PARAMETERS:

  • value (string)
## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineInterpolation
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineInterpolation(value)

PARAMETERS:

  • value (string)
    • valid values: "linear", "smooth", "stepBefore", "stepAfter"

TODO docs

## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineStyle
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineStyle(value)

PARAMETERS:

  • value (object)

TODO docs

## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineStyleMixin
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineStyleMixin(value)

PARAMETERS:

  • value (object)

TODO docs

## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineWidth
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withLineWidth(value)

PARAMETERS:

  • value (number)
## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withPointColor
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withPointColor(value)

PARAMETERS:

  • value (string)
## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withPointSize
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withPointSize(value)

PARAMETERS:

  • value (number)
## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withPointSymbol
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withPointSymbol(value)

PARAMETERS:

  • value (string)
## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withScaleDistribution
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withScaleDistribution(value)

PARAMETERS:

  • value (object)

TODO docs

## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withScaleDistributionMixin
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withScaleDistributionMixin(value)

PARAMETERS:

  • value (object)

TODO docs

## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withShowPoints
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withShowPoints(value)

PARAMETERS:

  • value (string)
    • valid values: "auto", "never", "always"

TODO docs

## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withSpanNulls
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withSpanNulls(value)

PARAMETERS:

  • value (boolean,number)

Indicate if null values should be treated as gaps or connected. When the value is a number, it represents the maximum delta in the X axis that should be considered connected. For timeseries, this is milliseconds

## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withSpanNullsMixin
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withSpanNullsMixin(value)

PARAMETERS:

  • value (boolean,number)

Indicate if null values should be treated as gaps or connected. When the value is a number, it represents the maximum delta in the X axis that should be considered connected. For timeseries, this is milliseconds

## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withStacking
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withStacking(value)

PARAMETERS:

  • value (object)

TODO docs

## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withStackingMixin
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withStackingMixin(value)

PARAMETERS:

  • value (object)

TODO docs

## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withThresholdsStyle
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withThresholdsStyle(value)

PARAMETERS:

  • value (object)

TODO docs

## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withThresholdsStyleMixin
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withThresholdsStyleMixin(value)

PARAMETERS:

  • value (object)

TODO docs

## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withTransform
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withTransform(value)

PARAMETERS:

  • value (string)
    • valid values: "constant", "negative-Y"

TODO docs

## fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withType
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.withType()
## obj fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom
### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom.withLegend
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom.withLegend(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true
### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom.withTooltip
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom.withTooltip(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true
### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom.withViz
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.hideFrom.withViz(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true
## obj fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle
### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle.withDash
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle.withDash(value)

PARAMETERS:

  • value (array)
### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle.withDashMixin
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle.withDashMixin(value)

PARAMETERS:

  • value (array)
### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle.withFill
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.lineStyle.withFill(value)

PARAMETERS:

  • value (string)
    • valid values: "solid", "dash", "dot", "square"
## obj fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution
### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution.withLinearThreshold
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution.withLinearThreshold(value)

PARAMETERS:

  • value (number)
### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution.withLog
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution.withLog(value)

PARAMETERS:

  • value (number)
### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution.withType
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.scaleDistribution.withType(value)

PARAMETERS:

  • value (string)
    • valid values: "linear", "log", "ordinal", "symlog"

TODO docs

## obj fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.stacking
### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.stacking.withGroup
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.stacking.withGroup(value)

PARAMETERS:

  • value (string)
### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.stacking.withMode
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.stacking.withMode(value)

PARAMETERS:

  • value (string)
    • valid values: "none", "normal", "percent"

TODO docs

## obj fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.thresholdsStyle
### fn fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.thresholdsStyle.withMode
fieldConfig.defaults.custom.cellOptions.TableSparklineCellOptions.thresholdsStyle.withMode(value)

PARAMETERS:

  • value (string)
    • valid values: "off", "line", "dashed", "area", "line+area", "dashed+area", "series"

TODO docs

obj libraryPanel

fn libraryPanel.withName

libraryPanel.withName(value)

PARAMETERS:

  • value (string)

Library panel name

fn libraryPanel.withUid

libraryPanel.withUid(value)

PARAMETERS:

  • value (string)

Library panel uid

obj options

fn options.withCellHeight

options.withCellHeight(value="sm")

PARAMETERS:

  • value (string)
    • default value: "sm"
    • valid values: "sm", "md", "lg", "auto"

Height of a table cell

fn options.withFooter

options.withFooter(value={"countRows": false,"reducer": null,"show": false})

PARAMETERS:

  • value (object)
    • default value: {"countRows": false,"reducer": null,"show": false}

Footer options

fn options.withFooterMixin

options.withFooterMixin(value={"countRows": false,"reducer": null,"show": false})

PARAMETERS:

  • value (object)
    • default value: {"countRows": false,"reducer": null,"show": false}

Footer options

fn options.withFrameIndex

options.withFrameIndex(value=0)

PARAMETERS:

  • value (number)
    • default value: 0

Represents the index of the selected frame

fn options.withShowHeader

options.withShowHeader(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true

Controls whether the panel should show the header

fn options.withShowTypeIcons

options.withShowTypeIcons(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true

Controls whether the header should show icons for the column types

fn options.withSortBy

options.withSortBy(value)

PARAMETERS:

  • value (array)

Used to control row sorting

fn options.withSortByMixin

options.withSortByMixin(value)

PARAMETERS:

  • value (array)

Used to control row sorting

obj options.footer

fn options.footer.withCountRows
options.footer.withCountRows(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true
fn options.footer.withEnablePagination
options.footer.withEnablePagination(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true
fn options.footer.withFields
options.footer.withFields(value)

PARAMETERS:

  • value (array)
fn options.footer.withFieldsMixin
options.footer.withFieldsMixin(value)

PARAMETERS:

  • value (array)
fn options.footer.withReducer
options.footer.withReducer(value)

PARAMETERS:

  • value (array)

actually 1 value

fn options.footer.withReducerMixin
options.footer.withReducerMixin(value)

PARAMETERS:

  • value (array)

actually 1 value

fn options.footer.withShow
options.footer.withShow(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true

obj panelOptions

fn panelOptions.withDescription

panelOptions.withDescription(value)

PARAMETERS:

  • value (string)

Panel description.

fn panelOptions.withGridPos

panelOptions.withGridPos(h="null", w="null", x="null", y="null")

PARAMETERS:

  • h (number)
    • default value: "null"
  • w (number)
    • default value: "null"
  • x (number)
    • default value: "null"
  • y (number)
    • default value: "null"

withGridPos configures the height, width and xy coordinates of the panel. Also see grafonnet.util.grid for helper functions to calculate these fields.

All arguments default to null, which means they will remain unchanged or unset.

panelOptions.withLinks(value)

PARAMETERS:

  • value (array)

Panel links.

fn panelOptions.withLinksMixin

panelOptions.withLinksMixin(value)

PARAMETERS:

  • value (array)

Panel links.

fn panelOptions.withMaxPerRow

panelOptions.withMaxPerRow(value)

PARAMETERS:

  • value (number)

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

fn panelOptions.withRepeat

panelOptions.withRepeat(value)

PARAMETERS:

  • value (string)

Name of template variable to repeat for.

fn panelOptions.withRepeatDirection

panelOptions.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 panelOptions.withTitle

panelOptions.withTitle(value)

PARAMETERS:

  • value (string)

Panel title.

fn panelOptions.withTransparent

panelOptions.withTransparent(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true

Whether to display the panel without a background.

obj queryOptions

fn queryOptions.withDatasource

queryOptions.withDatasource(type, uid)

PARAMETERS:

  • type (string)
  • uid (string)

withDatasource sets the datasource for all queries in a panel.

The default datasource for a panel is set to 'Mixed datasource' so panels can be datasource agnostic, which is a lot more interesting from a reusability standpoint. Note that this requires query targets to explicitly set datasource for the same reason.

fn queryOptions.withDatasourceMixin

queryOptions.withDatasourceMixin(value)

PARAMETERS:

  • value (object)

Ref to a DataSource instance

fn queryOptions.withHideTimeOverride

queryOptions.withHideTimeOverride(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true

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

fn queryOptions.withInterval

queryOptions.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

fn queryOptions.withMaxDataPoints

queryOptions.withMaxDataPoints(value)

PARAMETERS:

  • value (number)

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

fn queryOptions.withQueryCachingTTL

queryOptions.withQueryCachingTTL(value)

PARAMETERS:

  • value (number)

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

fn queryOptions.withTargets

queryOptions.withTargets(value)

PARAMETERS:

  • value (array)

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

fn queryOptions.withTargetsMixin

queryOptions.withTargetsMixin(value)

PARAMETERS:

  • value (array)

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

fn queryOptions.withTimeFrom

queryOptions.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 queryOptions.withTimeShift

queryOptions.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 queryOptions.withTransformations

queryOptions.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 queryOptions.withTransformationsMixin

queryOptions.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.

obj standardOptions

fn standardOptions.withDecimals

standardOptions.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 standardOptions.withDisplayName

standardOptions.withDisplayName(value)

PARAMETERS:

  • value (string)

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

fn standardOptions.withFilterable

standardOptions.withFilterable(value=true)

PARAMETERS:

  • value (boolean)
    • default value: true

True if data source field supports ad-hoc filters

standardOptions.withLinks(value)

PARAMETERS:

  • value (array)

The behavior when clicking on a result

fn standardOptions.withLinksMixin

standardOptions.withLinksMixin(value)

PARAMETERS:

  • value (array)

The behavior when clicking on a result

fn standardOptions.withMappings

standardOptions.withMappings(value)

PARAMETERS:

  • value (array)

Convert input values into a display string

fn standardOptions.withMappingsMixin

standardOptions.withMappingsMixin(value)

PARAMETERS:

  • value (array)

Convert input values into a display string

fn standardOptions.withMax

standardOptions.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 standardOptions.withMin

standardOptions.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 standardOptions.withNoValue

standardOptions.withNoValue(value)

PARAMETERS:

  • value (string)

Alternative to empty string

fn standardOptions.withOverrides

standardOptions.withOverrides(value)

PARAMETERS:

  • value (array)

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

fn standardOptions.withOverridesMixin

standardOptions.withOverridesMixin(value)

PARAMETERS:

  • value (array)

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

fn standardOptions.withPath

standardOptions.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 standardOptions.withUnit

standardOptions.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.

obj standardOptions.color

fn standardOptions.color.withFixedColor
standardOptions.color.withFixedColor(value)

PARAMETERS:

  • value (string)

The fixed color value for fixed or shades color modes.

fn standardOptions.color.withMode
standardOptions.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 standardOptions.color.withSeriesBy
standardOptions.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 standardOptions.thresholds

fn standardOptions.thresholds.withMode
standardOptions.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 standardOptions.thresholds.withSteps
standardOptions.thresholds.withSteps(value)

PARAMETERS:

  • value (array)

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

fn standardOptions.thresholds.withStepsMixin
standardOptions.thresholds.withStepsMixin(value)

PARAMETERS:

  • value (array)

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