Represents a Widget.
Package
@google-cloud/monitoring-dashboards!Constructors
(constructor)(properties)
constructor(properties?: google.monitoring.dashboard.v1.IWidget);
Constructs a new Widget.
Type | Name | Description |
---|---|---|
IWidget | properties |
Properties to set |
Properties
blank
public blank?: (google.protobuf.IEmpty|null);
Widget blank.
Type | Description |
---|---|
(google.protobuf.IEmpty|null) |
content
public content?: ("xyChart"|"scorecard"|"text"|"blank");
Widget content.
Type | Description |
---|---|
("xyChart"|"scorecard"|"text"|"blank") |
scorecard
public scorecard?: (google.monitoring.dashboard.v1.IScorecard|null);
Widget scorecard.
Type | Description |
---|---|
(google.monitoring.dashboard.v1.IScorecard|null) |
text
public text?: (google.monitoring.dashboard.v1.IText|null);
Widget text.
Type | Description |
---|---|
(google.monitoring.dashboard.v1.IText|null) |
title
public title: string;
Widget title.
Type | Description |
---|---|
string |
xyChart
public xyChart?: (google.monitoring.dashboard.v1.IXyChart|null);
Widget xyChart.
Type | Description |
---|---|
(google.monitoring.dashboard.v1.IXyChart|null) |
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.
Type | Name | Description |
---|---|---|
IWidget | properties |
Properties to set |
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.
Type | Name | Description |
---|---|---|
($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
number | length |
Message length if known beforehand |
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.
Type | Name | Description |
---|---|---|
($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
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.
Type | Name | Description |
---|---|---|
IWidget | message |
Widget message or plain object to encode |
$protobuf.Writer | writer |
Writer to encode to |
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.
Type | Name | Description |
---|---|---|
IWidget | message |
Widget message or plain object to encode |
$protobuf.Writer | writer |
Writer to encode to |
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.
Type | Name | Description |
---|---|---|
{ [k: string]: any } | object |
Plain object |
Type | Description |
---|---|
google.monitoring.dashboard.v1.Widget | Widget |
toJSON()
public toJSON(): { [k: string]: any };
Converts this Widget to JSON.
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.
Type | Name | Description |
---|---|---|
google.monitoring.dashboard.v1.Widget | message |
Widget |
$protobuf.IConversionOptions | options |
Conversion options |
Type | Description |
---|---|
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies a Widget message.
Type | Name | Description |
---|---|---|
{ [k: string]: any } | message |
Plain object to verify |
Type | Description |
---|---|
(string|null) |
|