Reference documentation and code samples for the Google Cloud Chronicle V1 Client class Visualization.
Visualization config for a chart.
https://echarts.apache.org/en/option.html#series
Generated from protobuf message google.cloud.chronicle.v1.DashboardChart.Visualization
Namespace
Google \ Cloud \ Chronicle \ V1 \ DashboardChartMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ x_axes |
array<Visualization\Axis>
|
↳ y_axes |
array<Visualization\Axis>
|
↳ series |
array<Visualization\Series>
|
↳ tooltip |
Visualization\Tooltip
|
↳ legends |
array<Visualization\Legend>
|
↳ column_defs |
array<Visualization\ColumnDef>
Column Definition to represent chart as a table. |
↳ table_config |
Visualization\TableConfig
Optional. Configuration for table appearance. |
↳ button |
Google\Cloud\Chronicle\V1\Button
Button config for a chart if tileType is TILE_TYPE_BUTTON. |
↳ markdown |
Google\Cloud\Chronicle\V1\Markdown
Optional. Markdown config for a chart if tileType is TILE_TYPE_MARKDOWN. |
↳ series_column |
string[]
Optional. Selected column for series |
↳ grouping_type |
string
Optional. Selected grouping type for series |
↳ google_maps_config |
Visualization\GoogleMapsConfig
Optional. Google Maps config for a chart if type is GOOGLE MAPS. |
↳ threshold_coloring_enabled |
bool
Optional. Whether threshold coloring is enabled for the chart. If it's enabled, the chart will be colored based on the values stored in VisualMap below. |
↳ visual_maps |
array<Visualization\VisualMap>
Optional. Visual maps for the chart. |
getXAxes
Generated from protobuf field repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.Axis x_axes = 7;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<Visualization\Axis> |
|
setXAxes
Generated from protobuf field repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.Axis x_axes = 7;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Visualization\Axis>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getYAxes
Generated from protobuf field repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.Axis y_axes = 8;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<Visualization\Axis> |
|
setYAxes
Generated from protobuf field repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.Axis y_axes = 8;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Visualization\Axis>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSeries
Generated from protobuf field repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.Series series = 3;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<Visualization\Series> |
|
setSeries
Generated from protobuf field repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.Series series = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Visualization\Series>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTooltip
Generated from protobuf field .google.cloud.chronicle.v1.DashboardChart.Visualization.Tooltip tooltip = 4;
| Returns | |
|---|---|
| Type | Description |
Visualization\Tooltip|null |
|
hasTooltip
clearTooltip
setTooltip
Generated from protobuf field .google.cloud.chronicle.v1.DashboardChart.Visualization.Tooltip tooltip = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
Visualization\Tooltip
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLegends
Generated from protobuf field repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.Legend legends = 9;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<Visualization\Legend> |
|
setLegends
Generated from protobuf field repeated .google.cloud.chronicle.v1.DashboardChart.Visualization.Legend legends = 9;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Visualization\Legend>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getColumnDefs
Column Definition to represent chart as a table.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<Visualization\ColumnDef> |
|
setColumnDefs
Column Definition to represent chart as a table.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Visualization\ColumnDef>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTableConfig
Optional. Configuration for table appearance.
| Returns | |
|---|---|
| Type | Description |
Visualization\TableConfig|null |
|
hasTableConfig
clearTableConfig
setTableConfig
Optional. Configuration for table appearance.
| Parameter | |
|---|---|
| Name | Description |
var |
Visualization\TableConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getButton
Button config for a chart if tileType is TILE_TYPE_BUTTON.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Chronicle\V1\Button|null |
|
hasButton
clearButton
setButton
Button config for a chart if tileType is TILE_TYPE_BUTTON.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Chronicle\V1\Button
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMarkdown
Optional. Markdown config for a chart if tileType is TILE_TYPE_MARKDOWN.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Chronicle\V1\Markdown|null |
|
hasMarkdown
clearMarkdown
setMarkdown
Optional. Markdown config for a chart if tileType is TILE_TYPE_MARKDOWN.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Chronicle\V1\Markdown
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSeriesColumn
Optional. Selected column for series
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setSeriesColumn
Optional. Selected column for series
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGroupingType
Optional. Selected grouping type for series
| Returns | |
|---|---|
| Type | Description |
string |
|
setGroupingType
Optional. Selected grouping type for series
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGoogleMapsConfig
Optional. Google Maps config for a chart if type is GOOGLE MAPS.
| Returns | |
|---|---|
| Type | Description |
Visualization\GoogleMapsConfig|null |
|
hasGoogleMapsConfig
clearGoogleMapsConfig
setGoogleMapsConfig
Optional. Google Maps config for a chart if type is GOOGLE MAPS.
| Parameter | |
|---|---|
| Name | Description |
var |
Visualization\GoogleMapsConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getThresholdColoringEnabled
Optional. Whether threshold coloring is enabled for the chart. If it's enabled, the chart will be colored based on the values stored in VisualMap below.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setThresholdColoringEnabled
Optional. Whether threshold coloring is enabled for the chart. If it's enabled, the chart will be colored based on the values stored in VisualMap below.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVisualMaps
Optional. Visual maps for the chart.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<Visualization\VisualMap> |
|
setVisualMaps
Optional. Visual maps for the chart.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Visualization\VisualMap>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|