Represents a BuildingInsights.
Package
@googlemaps/solarConstructors
(constructor)(properties)
constructor(properties?: google.maps.solar.v1.IBuildingInsights);Constructs a new BuildingInsights.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBuildingInsights
Properties to set |
Properties
administrativeArea
public administrativeArea: string;BuildingInsights administrativeArea.
boundingBox
public boundingBox?: (google.maps.solar.v1.ILatLngBox|null);BuildingInsights boundingBox.
center
public center?: (google.type.ILatLng|null);BuildingInsights center.
imageryDate
public imageryDate?: (google.type.IDate|null);BuildingInsights imageryDate.
imageryProcessedDate
public imageryProcessedDate?: (google.type.IDate|null);BuildingInsights imageryProcessedDate.
imageryQuality
public imageryQuality: (google.maps.solar.v1.ImageryQuality|keyof typeof google.maps.solar.v1.ImageryQuality);BuildingInsights imageryQuality.
name
public name: string;BuildingInsights name.
postalCode
public postalCode: string;BuildingInsights postalCode.
regionCode
public regionCode: string;BuildingInsights regionCode.
solarPotential
public solarPotential?: (google.maps.solar.v1.ISolarPotential|null);BuildingInsights solarPotential.
statisticalArea
public statisticalArea: string;BuildingInsights statisticalArea.
Methods
create(properties)
public static create(properties?: google.maps.solar.v1.IBuildingInsights): google.maps.solar.v1.BuildingInsights;Creates a new BuildingInsights instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBuildingInsights
Properties to set |
| Returns | |
|---|---|
| Type | Description |
BuildingInsights |
BuildingInsights instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.maps.solar.v1.BuildingInsights;Decodes a BuildingInsights 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 |
BuildingInsights |
BuildingInsights |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.maps.solar.v1.BuildingInsights;Decodes a BuildingInsights message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
BuildingInsights |
BuildingInsights |
encode(message, writer)
public static encode(message: google.maps.solar.v1.IBuildingInsights, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified BuildingInsights message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IBuildingInsights
BuildingInsights 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.IBuildingInsights, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified BuildingInsights message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IBuildingInsights
BuildingInsights 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.BuildingInsights;Creates a BuildingInsights 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 |
BuildingInsights |
BuildingInsights |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for BuildingInsights
| 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 BuildingInsights to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.maps.solar.v1.BuildingInsights, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a BuildingInsights message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
BuildingInsights
BuildingInsights |
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 BuildingInsights message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|