Reference documentation and code samples for the Google Cloud Chronicle V1 Client class Series.
Generated from protobuf message google.cloud.chronicle.v1.DashboardChart.Visualization.Series
Namespace
Google \ Cloud \ Chronicle \ V1 \ DashboardChart \ Visualization
Methods
__construct
| Parameters |
| Name |
Description |
data |
array
Optional. Data for populating the Message object.
|
↳ series_type |
int
|
↳ series_name |
string
user specified series label
|
↳ show_symbol |
bool
|
↳ show_background |
bool
|
↳ stack |
string
|
↳ series_stack_strategy |
int
|
↳ encode |
Series\Encode
|
↳ label |
string
|
↳ field |
string
|
↳ data_label |
Series\DataLabel
Optional. Data label config for a series. Displays data vaule in the chart
|
↳ radius |
string[]
Optional. Used to make a pie chart into a douhnut chart
|
↳ item_style |
Series\ItemStyle
Optional. Custom styling for chart
|
↳ series_unique_value |
string
Optional. Series unique value from the query result
|
↳ area_style |
Series\AreaStyle
Optional. Custom styling for area chart
|
↳ item_colors |
Series\ItemColors
Optional. Field to be saved for retrieving slice colors for the chart
|
↳ gauge_config |
Series\GaugeConfig
Optional. Field to be saved for retrieving gauge config for gauge chart
|
↳ metric_trend_config |
Series\MetricTrendConfig
Optional. Fields to capture trend config for metric charts
|
getSeriesType
Generated from protobuf field .google.cloud.chronicle.v1.SeriesType series_type = 8;
| Returns |
| Type |
Description |
int |
|
setSeriesType
Generated from protobuf field .google.cloud.chronicle.v1.SeriesType series_type = 8;
| Parameter |
| Name |
Description |
var |
int
|
| Returns |
| Type |
Description |
$this |
|
getSeriesName
user specified series label
| Returns |
| Type |
Description |
string |
|
setSeriesName
user specified series label
| Parameter |
| Name |
Description |
var |
string
|
| Returns |
| Type |
Description |
$this |
|
getShowSymbol
Generated from protobuf field bool show_symbol = 4;
| Returns |
| Type |
Description |
bool |
|
setShowSymbol
Generated from protobuf field bool show_symbol = 4;
| Parameter |
| Name |
Description |
var |
bool
|
| Returns |
| Type |
Description |
$this |
|
getShowBackground
Generated from protobuf field bool show_background = 5;
| Returns |
| Type |
Description |
bool |
|
setShowBackground
Generated from protobuf field bool show_background = 5;
| Parameter |
| Name |
Description |
var |
bool
|
| Returns |
| Type |
Description |
$this |
|
getStack
Generated from protobuf field string stack = 6;
| Returns |
| Type |
Description |
string |
|
setStack
Generated from protobuf field string stack = 6;
| Parameter |
| Name |
Description |
var |
string
|
| Returns |
| Type |
Description |
$this |
|
getSeriesStackStrategy
Generated from protobuf field .google.cloud.chronicle.v1.SeriesStackStrategy series_stack_strategy = 9;
| Returns |
| Type |
Description |
int |
|
setSeriesStackStrategy
Generated from protobuf field .google.cloud.chronicle.v1.SeriesStackStrategy series_stack_strategy = 9;
| Parameter |
| Name |
Description |
var |
int
|
| Returns |
| Type |
Description |
$this |
|
getEncode
Generated from protobuf field .google.cloud.chronicle.v1.DashboardChart.Visualization.Series.Encode encode = 10;
hasEncode
clearEncode
setEncode
Generated from protobuf field .google.cloud.chronicle.v1.DashboardChart.Visualization.Series.Encode encode = 10;
| Returns |
| Type |
Description |
$this |
|
getLabel
Generated from protobuf field string label = 11;
| Returns |
| Type |
Description |
string |
|
setLabel
Generated from protobuf field string label = 11;
| Parameter |
| Name |
Description |
var |
string
|
| Returns |
| Type |
Description |
$this |
|
getField
Generated from protobuf field string field = 12;
| Returns |
| Type |
Description |
string |
|
setField
Generated from protobuf field string field = 12;
| Parameter |
| Name |
Description |
var |
string
|
| Returns |
| Type |
Description |
$this |
|
getDataLabel
Optional. Data label config for a series.
Displays data vaule in the chart
hasDataLabel
clearDataLabel
setDataLabel
Optional. Data label config for a series.
Displays data vaule in the chart
| Returns |
| Type |
Description |
$this |
|
getRadius
Optional. Used to make a pie chart into a douhnut chart
| Returns |
| Type |
Description |
Google\Protobuf\RepeatedField<string> |
|
setRadius
Optional. Used to make a pie chart into a douhnut chart
| Parameter |
| Name |
Description |
var |
string[]
|
| Returns |
| Type |
Description |
$this |
|
getItemStyle
Optional. Custom styling for chart
hasItemStyle
clearItemStyle
setItemStyle
Optional. Custom styling for chart
| Returns |
| Type |
Description |
$this |
|
getSeriesUniqueValue
Optional. Series unique value from the query result
| Returns |
| Type |
Description |
string |
|
setSeriesUniqueValue
Optional. Series unique value from the query result
| Parameter |
| Name |
Description |
var |
string
|
| Returns |
| Type |
Description |
$this |
|
getAreaStyle
Optional. Custom styling for area chart
hasAreaStyle
clearAreaStyle
setAreaStyle
Optional. Custom styling for area chart
| Returns |
| Type |
Description |
$this |
|
getItemColors
Optional. Field to be saved for retrieving slice colors for the chart
hasItemColors
clearItemColors
setItemColors
Optional. Field to be saved for retrieving slice colors for the chart
| Returns |
| Type |
Description |
$this |
|
getGaugeConfig
Optional. Field to be saved for retrieving gauge config for gauge chart
hasGaugeConfig
clearGaugeConfig
setGaugeConfig
Optional. Field to be saved for retrieving gauge config for gauge chart
| Returns |
| Type |
Description |
$this |
|
getMetricTrendConfig
Optional. Fields to capture trend config for metric charts
hasMetricTrendConfig
clearMetricTrendConfig
setMetricTrendConfig
Optional. Fields to capture trend config for metric charts
| Returns |
| Type |
Description |
$this |
|
