Skip to content

Commit bbef38d

Browse files
Update README.md
1 parent 22e6d93 commit bbef38d

File tree

1 file changed

+44
-10
lines changed

1 file changed

+44
-10
lines changed

README.md

Lines changed: 44 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -60,39 +60,73 @@ https://nora-soderlund.com/articles/visualizing-potential-solar-panel-placements
6060
## References
6161

6262
### Building Insights
63-
#### `findClosestBuildingInsights(apiKeyOrProxyUrl: string | URL, query: FindClosestBuildingInsightsParameters): Promise<BuildingInsights>`
63+
#### findClosestBuildingInsights
64+
```ts
65+
findClosestBuildingInsights(apiKeyOrProxyUrl: string | URL, query: FindClosestBuildingInsightsParameters): Promise<BuildingInsights>
66+
```
6467
Returns a [BuildingInsights](https://github.com/nora-soderlund/google-maps-solar-api/blob/main/src/types/BuildingInsights.ts) object or throws a generic Error if the request failed.
6568

6669
See [buildingInsights.findClosest](https://developers.google.com/maps/documentation/solar/reference/rest/v1/buildingInsights/findClosest) on the Solar API reference.
6770

71+
---
72+
6873
### Data Layers
69-
#### `getDataLayers(apiKeyOrProxyUrl: string | URL, query: GetDataLayersParameters): Promise<DataLayers>`
74+
#### getDataLayers
75+
```ts
76+
getDataLayers(apiKeyOrProxyUrl: string | URL, query: GetDataLayersParameters): Promise<DataLayers>
77+
```
7078
Returns a [DataLayers](https://github.com/nora-soderlund/google-maps-solar-api/blob/main/src/types/DataLayers.ts) object or throws a generic Error if the request failed.
7179

7280
See [dataLayers.get](https://developers.google.com/maps/documentation/solar/reference/rest/v1/dataLayers/get) on the Solar API reference.
7381

82+
---
83+
7484
#### `getGeoTiff(apiKeyOrProxyUrl: string | URL, url: string): Promise<ArrayBuffer>`
7585
Returns a raw [ArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer) object of the GeoTIFF file or throws a generic Error if the request failed.
7686

7787
See [geoTiff.get](https://developers.google.com/maps/documentation/solar/reference/rest/v1/geoTiff/get) on the Solar API reference.
7888

89+
---
90+
7991
### Helpers
80-
#### `getDataLayersForBounds(bounds: LatLngBox, pixelSizeMeters: number, paddingMeters: number = 0): DataLayerBounds`
92+
#### getDataLayersForBounds
93+
```ts
94+
getDataLayersForBounds(bounds: LatLngBox, pixelSizeMeters: number, paddingMeters: number = 0): DataLayerBounds
95+
```
8196
Used for getting a connected area coverage. Does not perform any asynchronous requests. Returns a [DataLayerBounds](#datalayerbounds) object.
8297

83-
#### `DataLayerBounds`
84-
##### `dataLayerView: DataLayerView;`
98+
---
99+
100+
#### DataLayerBounds
101+
```ts
102+
dataLayerView: DataLayerView;
103+
```
85104
The highest supported data layer view, for radius meters over 175m, the DataLayerView in the request must not include monthly flux or hourly shade.
86105

87-
##### `tiles: LatLng[];`
106+
##### tiles
107+
```ts
108+
tiles: LatLng[];
109+
```
88110
The tiles that make up the generated bounds, use with `radiusMetersPerTile`
89111

90-
##### `radiusMetersPerTile: number;`
112+
##### radiusMetersPerTile
113+
```ts
114+
radiusMetersPerTile: number;
115+
```
91116
The radius in meters for each tile.
92117

93-
##### `bounds: LatLngBox;`
118+
##### bounds
119+
```ts
120+
bounds: LatLngBox;
121+
```
94122
The generated bounds for the new tiles.
95123

96-
##### `horizontalTiles: number;`
97-
##### `verticalTiles: number;`
124+
##### horizontalTiles
125+
```ts
126+
horizontalTiles: number;
127+
```
128+
##### verticalTiles
129+
```ts
130+
verticalTiles: number;
131+
```
98132
The horizontal and vertical tiles count.

0 commit comments

Comments
 (0)