Represents a Widget.
Package
@google-cloud/monitoring-dashboardsConstructors
(constructor)(properties)
constructor(properties?: google.monitoring.dashboard.v1.IWidget);Constructs a new Widget.
| Parameter | |
|---|---|
| Name | Description |
properties |
IWidget
Properties to set |
Properties
alertChart
public alertChart?: (google.monitoring.dashboard.v1.IAlertChart|null);Widget alertChart.
blank
public blank?: (google.protobuf.IEmpty|null);Widget blank.
collapsibleGroup
public collapsibleGroup?: (google.monitoring.dashboard.v1.ICollapsibleGroup|null);Widget collapsibleGroup.
content
public content?: ("xyChart"|"scorecard"|"text"|"blank"|"alertChart"|"timeSeriesTable"|"collapsibleGroup"|"logsPanel");Widget content.
logsPanel
public logsPanel?: (google.monitoring.dashboard.v1.ILogsPanel|null);Widget logsPanel.
scorecard
public scorecard?: (google.monitoring.dashboard.v1.IScorecard|null);Widget scorecard.
text
public text?: (google.monitoring.dashboard.v1.IText|null);Widget text.
timeSeriesTable
public timeSeriesTable?: (google.monitoring.dashboard.v1.ITimeSeriesTable|null);Widget timeSeriesTable.
title
public title: string;Widget title.
xyChart
public xyChart?: (google.monitoring.dashboard.v1.IXyChart|null);Widget xyChart.
Methods
create(properties)
public static create(properties?: google.monitoring.dashboard.v1.IWidget): google.monitoring.dashboard.v1.Widget;Creates a new Widget instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IWidget
Properties to set |
| Returns | |
|---|---|
| Type | Description |
google.monitoring.dashboard.v1.Widget | Widget instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.monitoring.dashboard.v1.Widget;Decodes a Widget message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
google.monitoring.dashboard.v1.Widget | Widget |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.monitoring.dashboard.v1.Widget;Decodes a Widget message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
google.monitoring.dashboard.v1.Widget | Widget |
encode(message, writer)
public static encode(message: google.monitoring.dashboard.v1.IWidget, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Widget message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IWidget
Widget message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.monitoring.dashboard.v1.IWidget, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Widget message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IWidget
Widget message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.monitoring.dashboard.v1.Widget;Creates a Widget message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
google.monitoring.dashboard.v1.Widget | Widget |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Widget
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this Widget to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.monitoring.dashboard.v1.Widget, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Widget message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
google.monitoring.dashboard.v1.Widget
Widget |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a Widget message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|