Class protos.google.monitoring.dashboard.v1.XyChart

Represents a XyChart.

Package

@google-cloud/monitoring-dashboards

Constructors

(constructor)(properties)

constructor(properties?: google.monitoring.dashboard.v1.IXyChart);

Constructs a new XyChart.

Parameter
NameDescription
properties IXyChart

Properties to set

Properties

chartOptions

public chartOptions?: (google.monitoring.dashboard.v1.IChartOptions|null);

XyChart chartOptions.

dataSets

public dataSets: google.monitoring.dashboard.v1.XyChart.IDataSet[];

XyChart dataSets.

thresholds

public thresholds: google.monitoring.dashboard.v1.IThreshold[];

XyChart thresholds.

timeshiftDuration

public timeshiftDuration?: (google.protobuf.IDuration|null);

XyChart timeshiftDuration.

xAxis

public xAxis?: (google.monitoring.dashboard.v1.XyChart.IAxis|null);

XyChart xAxis.

yAxis

public yAxis?: (google.monitoring.dashboard.v1.XyChart.IAxis|null);

XyChart yAxis.

Methods

create(properties)

public static create(properties?: google.monitoring.dashboard.v1.IXyChart): google.monitoring.dashboard.v1.XyChart;

Creates a new XyChart instance using the specified properties.

Parameter
NameDescription
properties IXyChart

Properties to set

Returns
TypeDescription
google.monitoring.dashboard.v1.XyChart

XyChart instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.monitoring.dashboard.v1.XyChart;

Decodes a XyChart message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.monitoring.dashboard.v1.XyChart

XyChart

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.monitoring.dashboard.v1.XyChart;

Decodes a XyChart message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.monitoring.dashboard.v1.XyChart

XyChart

encode(message, writer)

public static encode(message: google.monitoring.dashboard.v1.IXyChart, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified XyChart message. Does not implicitly messages.

Parameters
NameDescription
message IXyChart

XyChart message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.monitoring.dashboard.v1.IXyChart, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified XyChart message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message IXyChart

XyChart message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.monitoring.dashboard.v1.XyChart;

Creates a XyChart message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.monitoring.dashboard.v1.XyChart

XyChart

toJSON()

public toJSON(): { [k: string]: any };

Converts this XyChart to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.monitoring.dashboard.v1.XyChart, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a XyChart message. Also converts values to other types if specified.

Parameters
NameDescription
message google.monitoring.dashboard.v1.XyChart

XyChart

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a XyChart message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not