REST Resource: projects.locations.instances.dashboardCharts

Resource: DashboardChart

DashboardChart resource. NEXT TAG: 7

JSON representation 
{
  "name": string,
  "display_name": string,
  "description": string,
  "native_dashboard": string,
  "chart_datasource": {
    object (ChartDatasource)
  },
  "visualization": {
    object (Visualization)
  }
}
Fields
name

string

Output only. Name of the dashboardChart.
display_name

string

Required. Display name/Title of the dashboardChart visible to users.
description

string

Optional. Description of the dashboardChart.
native_dashboard

string

Output only. NativeDashboard this chart belongs to.
chart_datasource

object (ChartDatasource)

Required. Query and datasource used in the chart.
visualization

object (Visualization)

ChartDatasource

Datasource of the chart including the query reference and source name.

JSON representation 
{
  "dashboard_query": string,
  "data_sources": [
    enum (DataSource)
  ]
}
Fields
dashboard_query

string

Reference to dashboard query resource used in the chart.
data_sources[]

enum (DataSource)

Name of the datasource used in the chart.

Visualization

Visualization config for a chart. https://echarts.apache.org/en/option.html#series LINT.IfChange

JSON representation 
{
  "x_axes": [
    {
      object (Axis)
    }
  ],
  "y_axes": [
    {
      object (Axis)
    }
  ],
  "series": [
    {
      object (Series)
    }
  ],
  "tooltip": {
    object (Tooltip)
  },
  "legends": [
    {
      object (Legend)
    }
  ],
  "column_defs": [
    {
      object (ColumnDef)
    }
  ]
}
Fields
x_axes[]

object (Axis)
y_axes[]

object (Axis)
series[]

object (Series)
tooltip

object (Tooltip)
legends[]

object (Legend)
column_defs[]

object (ColumnDef)

Column Definition to represent chart as a table.

Axis

JSON representation 
{
  "axis_type": enum (AxisType),
  "display_name": string
}
Fields
axis_type

enum (AxisType)
display_name

string

AxisType

Enums
AXIS_TYPE_UNSPECIFIED
VALUE
CATEGORY
TIME
LOG

Series

JSON representation 
{
  "series_type": enum (SeriesType),
  "series_name": string,
  "show_symbol": boolean,
  "show_background": boolean,
  "stack": string,
  "series_stack_strategy": enum (SeriesStackStrategy),
  "encode": {
    object (Encode)
  },
  "label": string,
  "field": string
}
Fields
series_type

enum (SeriesType)
series_name

string
show_symbol

boolean
show_background

boolean
stack

string
series_stack_strategy

enum (SeriesStackStrategy)
encode

object (Encode)
label

string
field

string

SeriesType

Enums
SERIES_TYPE_UNSPECIFIED
LINE
BAR
PIE
TEXT

SeriesStackStrategy

Enums
SERIES_STACK_STRATEGY_UNSPECIFIED
SAMESIGN
ALL
POSITIVE
NEGATIVE

Encode

JSON representation 
{
  "x": string,
  "y": string,
  "value": string,
  "item_name": string
}
Fields
x

string
y

string
value

string

For some type of series that are not in any coordinate system, like 'pie'
item_name

string

This is useful in charts like 'pie', where data item name can be displayed in legend.

Tooltip

JSON representation 
{
  "show": boolean,
  "tooltip_trigger": enum (ToolTipTrigger)
}
Fields
show

boolean
tooltip_trigger

enum (ToolTipTrigger)

ToolTipTrigger

Enums
TOOLTIP_TRIGGER_UNSPECIFIED
TOOLTIP_TRIGGER_NONE
TOOLTIP_TRIGGER_ITEM
TOOLTIP_TRIGGER_AXIS

Legend

JSON representation 
{
  "id": string,
  "show": boolean,
  "z_level": integer,
  "z": integer,
  "left": integer,
  "top": integer,
  "right": integer,
  "bottom": integer,
  "legend_orient": enum (LegendOrient),
  "legend_align": enum (LegendAlign),
  "padding": [
    integer
  ]
}
Fields
id

string
show

boolean
z_level

integer
z

integer
left

integer
top

integer
right

integer
bottom

integer
legend_orient

enum (LegendOrient)
legend_align

enum (LegendAlign)
padding[]

integer

LegendOrient

Enums
LEGEND_ORIENT_UNSPECIFIED
VERTICAL
HORIZONTAL

LegendAlign

Enums
LEGEND_ALIGN_UNSPECIFIED
AUTO
LEFT
RIGHT

ColumnDef

Column Definition.

JSON representation 
{
  "field": string,
  "header": string
}
Fields
field

string

Field key in data.
header

string

Header name for column.

Methods

batchGet

 Get dashboard charts in batches.

get

 Get a dashboard chart.

list

 List all dashboard charts.