Class protos.google.maps.solar.v1.SolarPanelConfig (0.1.0)

Represents a SolarPanelConfig.

Package

@googlemaps/solar

Constructors

(constructor)(properties)

constructor(properties?: google.maps.solar.v1.ISolarPanelConfig);

Constructs a new SolarPanelConfig.

Parameter
Name Description
properties ISolarPanelConfig

Properties to set

Properties

panelsCount

public panelsCount: number;

SolarPanelConfig panelsCount.

roofSegmentSummaries

public roofSegmentSummaries: google.maps.solar.v1.IRoofSegmentSummary[];

SolarPanelConfig roofSegmentSummaries.

yearlyEnergyDcKwh

public yearlyEnergyDcKwh: number;

SolarPanelConfig yearlyEnergyDcKwh.

Methods

create(properties)

public static create(properties?: google.maps.solar.v1.ISolarPanelConfig): google.maps.solar.v1.SolarPanelConfig;

Creates a new SolarPanelConfig instance using the specified properties.

Parameter
Name Description
properties ISolarPanelConfig

Properties to set

Returns
Type Description
SolarPanelConfig

SolarPanelConfig instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.maps.solar.v1.SolarPanelConfig;

Decodes a SolarPanelConfig message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
SolarPanelConfig

SolarPanelConfig

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.maps.solar.v1.SolarPanelConfig;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
SolarPanelConfig

SolarPanelConfig

encode(message, writer)

public static encode(message: google.maps.solar.v1.ISolarPanelConfig, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified SolarPanelConfig message. Does not implicitly messages.

Parameters
Name Description
message ISolarPanelConfig

SolarPanelConfig 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.maps.solar.v1.ISolarPanelConfig, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ISolarPanelConfig

SolarPanelConfig 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.maps.solar.v1.SolarPanelConfig;

Creates a SolarPanelConfig 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
SolarPanelConfig

SolarPanelConfig

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for SolarPanelConfig

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 SolarPanelConfig to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message SolarPanelConfig

SolarPanelConfig

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 SolarPanelConfig message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not