Skip to content

Commit d3a3a10

Browse files
Update Maps JavaScript API typings for 3.56.10
PiperOrigin-RevId: 628560334
1 parent 5cd1cf9 commit d3a3a10

File tree

1 file changed

+115
-19
lines changed

1 file changed

+115
-19
lines changed

index.d.ts

Lines changed: 115 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3459,6 +3459,12 @@ declare namespace google.maps {
34593459
* initialized then the result is <code>undefined</code>.
34603460
*/
34613461
getHeading(): number | undefined;
3462+
/**
3463+
* Returns whether heading interactions are enabled. This option is only in
3464+
* effect when the map is a vector map. If not set in code, then the cloud
3465+
* configuration for the map ID will be used (if available).
3466+
*/
3467+
getHeadingInteractionEnabled(): boolean | null;
34623468
/**
34633469
* Informs the caller of the current capabilities available to the map based
34643470
* on the Map ID that was provided.
@@ -3492,6 +3498,12 @@ declare namespace google.maps {
34923498
* <code>setTilt</code>. See <code>setTilt</code> for details.
34933499
*/
34943500
getTilt(): number | undefined;
3501+
/**
3502+
* Returns whether tilt interactions are enabled. This option is only in
3503+
* effect when the map is a vector map. If not set in code, then the cloud
3504+
* configuration for the map ID will be used (if available).
3505+
*/
3506+
getTiltInteractionEnabled(): boolean | null;
34953507
/**
34963508
* Returns the zoom of the map. If the zoom has not been set then the result
34973509
* is <code>undefined</code>.
@@ -3559,8 +3571,18 @@ declare namespace google.maps {
35593571
* imagery.
35603572
*/
35613573
setHeading(heading: number): void;
3574+
/**
3575+
* Sets whether heading interactions are enabled. This option is only in
3576+
* effect when the map is a vector map. If not set in code, then the cloud
3577+
* configuration for the map ID will be used (if available).
3578+
*/
3579+
setHeadingInteractionEnabled(headingInteractionEnabled: boolean): void;
35623580
setMapTypeId(mapTypeId: string): void;
35633581
setOptions(options: google.maps.MapOptions | null): void;
3582+
/**
3583+
* Sets the current RenderingType of the map.
3584+
*/
3585+
setRenderingType(renderingType: google.maps.RenderingType): void;
35643586
/**
35653587
* Binds a <code>StreetViewPanorama</code> to the map. This panorama
35663588
* overrides the default <code>StreetViewPanorama</code>, allowing the map
@@ -3571,9 +3593,9 @@ declare namespace google.maps {
35713593
setStreetView(panorama: google.maps.StreetViewPanorama | null): void;
35723594
/**
35733595
* For vector maps, sets the angle of incidence of the map. The allowed
3574-
* values are restricted depending on the zoom level of the map. For raster
3575-
* maps, controls the automatic switching behavior for the angle of
3576-
* incidence of the map. The only allowed values are <code>0</code> and
3596+
* values are restricted depending on the zoom level of the map. <br><br>
3597+
* For raster maps, controls the automatic switching behavior for the angle
3598+
* of incidence of the map. The only allowed values are <code>0</code> and
35773599
* <code>45</code>. <code>setTilt(0)</code> causes the map to always use a
35783600
* 0&deg; overhead view regardless of the zoom level and viewport.
35793601
* <code>setTilt(45)</code> causes the tilt angle to automatically switch to
@@ -3589,6 +3611,12 @@ declare namespace google.maps {
35893611
* unpredictable effects.
35903612
*/
35913613
setTilt(tilt: number): void;
3614+
/**
3615+
* Sets whether tilt interactions are enabled. This option is only in effect
3616+
* when the map is a vector map. If not set in code, then the cloud
3617+
* configuration for the map ID will be used (if available).
3618+
*/
3619+
setTiltInteractionEnabled(tiltInteractionEnabled: boolean): void;
35923620
/**
35933621
* Sets the zoom of the map.
35943622
* @param zoom Larger zoom values correspond to a higher resolution.
@@ -3719,19 +3747,49 @@ declare namespace google.maps {
37193747
* The center latitude/longitude of the map.
37203748
*/
37213749
center: google.maps.LatLng | google.maps.LatLngLiteral | null;
3750+
/**
3751+
* Whether the map should allow user control of the camera heading
3752+
* (rotation). This option is only in effect when the map is a vector map.
3753+
* If not set in code, then the cloud configuration for the map ID will be
3754+
* used (if available).
3755+
* @defaultValue <code>false</code>
3756+
*/
3757+
headingInteractionDisabled: boolean | null;
37223758
/**
37233759
* A reference to the {@link google.maps.Map} that the MapElement uses
37243760
* internally.
37253761
*/
37263762
innerMap: google.maps.Map;
37273763
/**
3728-
* The Map ID of the map. See the <a
3729-
* href="https://developers.google.com/maps/documentation/get-map-id">Map ID
3730-
* documentation</a> for more information.
3764+
* The <a
3765+
* href="https://developers.google.com/maps/documentation/get-map-id">Map
3766+
* ID</a> of the map. This parameter cannot be set or changed after a map is
3767+
* instantiated. {@link google.maps.Map.DEMO_MAP_ID} can be used to try out
3768+
* features that require a map ID but which do not require cloud enablement.
37313769
*/
37323770
mapId: string | null;
37333771
/**
3734-
* The zoom level of the map.
3772+
* Whether the map should be a raster or vector map. This parameter cannot
3773+
* be set or changed after a map is instantiated. If not set, then the cloud
3774+
* configuration for the map ID will determine the rendering type (if
3775+
* available). Please note that vector maps may not be available for all
3776+
* devices and browsers and the map will fall back to a raster map as
3777+
* needed.
3778+
* @defaultValue {@link google.maps.RenderingType.VECTOR}
3779+
*/
3780+
renderingType: google.maps.RenderingType | null;
3781+
/**
3782+
* Whether the map should allow user control of the camera tilt. This option
3783+
* is only in effect when the map is a vector map. If not set in code, then
3784+
* the cloud configuration for the map ID will be used (if available).
3785+
* @defaultValue <code>false</code>
3786+
*/
3787+
tiltInteractionDisabled: boolean | null;
3788+
/**
3789+
* The zoom level of the map. Valid zoom values are numbers from zero up to
3790+
* the supported <a
3791+
* href="https://developers.google.com/maps/documentation/javascript/maxzoom">maximum
3792+
* zoom level</a>. Larger zoom values correspond to a higher resolution.
37353793
*/
37363794
zoom: number | null;
37373795
}
@@ -3743,21 +3801,27 @@ declare namespace google.maps {
37433801
*/
37443802
export interface MapElementOptions {
37453803
/**
3746-
* The initial Map center.
3804+
* See {@link google.maps.MapElement.center}.
37473805
*/
37483806
center?: google.maps.LatLng | google.maps.LatLngLiteral | null;
37493807
/**
3750-
* The <a
3751-
* href="https://developers.google.com/maps/documentation/get-map-id">Map
3752-
* ID</a> of the map. This parameter cannot be set or changed after a map is
3753-
* instantiated.
3808+
* See {@link google.maps.MapElement.headingInteractionDisabled}.
3809+
*/
3810+
headingInteractionDisabled?: boolean | null;
3811+
/**
3812+
* See {@link google.maps.MapElement.mapId}.
37543813
*/
37553814
mapId?: string | null;
37563815
/**
3757-
* The initial Map zoom level. Valid zoom values are numbers from zero up to
3758-
* the supported <a
3759-
* href="https://developers.google.com/maps/documentation/javascript/maxzoom">maximum
3760-
* zoom level</a>. Larger zoom values correspond to a higher resolution.
3816+
* See {@link google.maps.MapElement.renderingType}.
3817+
*/
3818+
renderingType?: google.maps.RenderingType | null;
3819+
/**
3820+
* See {@link google.maps.MapElement.tiltInteractionDisabled}.
3821+
*/
3822+
tiltInteractionDisabled?: boolean | null;
3823+
/**
3824+
* See {@link google.maps.MapElement.zoom}.
37613825
*/
37623826
zoom?: number | null;
37633827
}
@@ -3885,6 +3949,14 @@ declare namespace google.maps {
38853949
* angle for which imagery is available.
38863950
*/
38873951
heading?: number | null;
3952+
/**
3953+
* Whether the map should allow user control of the camera heading
3954+
* (rotation). This option is only in effect when the map is a vector map.
3955+
* If not set in code, then the cloud configuration for the map ID will be
3956+
* used (if available).
3957+
* @defaultValue <code>false</code>
3958+
*/
3959+
headingInteractionEnabled?: boolean | null;
38883960
/**
38893961
* Whether the map should allow fractional zoom levels. Listen to
38903962
* <code>isfractionalzoomenabled_changed</code> to know when the default has
@@ -3902,7 +3974,8 @@ declare namespace google.maps {
39023974
* The <a
39033975
* href="https://developers.google.com/maps/documentation/get-map-id">Map
39043976
* ID</a> of the map. This parameter cannot be set or changed after a map is
3905-
* instantiated.
3977+
* instantiated. {@link google.maps.Map.DEMO_MAP_ID} can be used to try out
3978+
* features that require a map ID but which do not require cloud enablement.
39063979
*/
39073980
mapId?: string | null;
39083981
/**
@@ -3949,6 +4022,16 @@ declare namespace google.maps {
39494022
* @deprecated The Pan control is deprecated as of September 2015.
39504023
*/
39514024
panControlOptions?: google.maps.PanControlOptions | null;
4025+
/**
4026+
* Whether the map should be a raster or vector map. This parameter cannot
4027+
* be set or changed after a map is instantiated. If not set, then the cloud
4028+
* configuration for the map ID will determine the rendering type (if
4029+
* available). Please note that vector maps may not be available for all
4030+
* devices and browsers and the map will fall back to a raster map as
4031+
* needed.
4032+
* @defaultValue {@link google.maps.RenderingType.RASTER}
4033+
*/
4034+
renderingType?: google.maps.RenderingType | null;
39524035
/**
39534036
* Defines a boundary that restricts the area of the map accessible to
39544037
* users. When set, a user can only pan and zoom while the camera view stays
@@ -4000,7 +4083,10 @@ declare namespace google.maps {
40004083
/**
40014084
* Styles to apply to each of the default map types. Note that for
40024085
* <code>satellite</code>/<code>hybrid</code> and <code>terrain</code>
4003-
* modes, these styles will only apply to labels and geometry.
4086+
* modes, these styles will only apply to labels and geometry. This feature
4087+
* is not available when using a map ID, or when using vector maps (use <a
4088+
* href="https://developers.google.com/maps/documentation/cloud-customization">cloud-based
4089+
* maps styling</a> instead).
40044090
*/
40054091
styles?: google.maps.MapTypeStyle[] | null;
40064092
/**
@@ -4022,6 +4108,13 @@ declare namespace google.maps {
40224108
* yield unpredictable effects.
40234109
*/
40244110
tilt?: number | null;
4111+
/**
4112+
* Whether the map should allow user control of the camera tilt. This option
4113+
* is only in effect when the map is a vector map. If not set in code, then
4114+
* the cloud configuration for the map ID will be used (if available).
4115+
* @defaultValue <code>false</code>
4116+
*/
4117+
tiltInteractionEnabled?: boolean | null;
40254118
/**
40264119
* The initial Map zoom level. Valid zoom values are numbers from zero up to
40274120
* the supported <a
@@ -7165,7 +7258,10 @@ declare namespace google.maps {
71657258
* after removing. The <code>onDraw()</code> method will then be called
71667259
* whenever a map property changes that could change the position of the
71677260
* element, such as zoom, center, or map type. WebGLOverlayView may only be
7168-
* added to a vector map having a {@link google.maps.MapOptions.mapId}.
7261+
* added to a vector map having a {@link google.maps.MapOptions.mapId}
7262+
* (including maps set to the {@link google.maps.RenderingType.VECTOR} {@link
7263+
* google.maps.MapOptions.renderingType} and using {@link
7264+
* google.maps.Map.DEMO_MAP_ID} as the {@link google.maps.MapOptions.mapId}).
71697265
*
71707266
* Access by calling `const {WebGLOverlayView} = await
71717267
* google.maps.importLibrary("maps")`. See

0 commit comments

Comments
 (0)