MapRestriction

The MapRestriction object is used to restrict the Google map bounds. It prevents the map from panning or zooming beyond the configured constraints.

This is done by setting Latitude/Longitude bounds.

warning

If a LatLngBounds value is not set then the restriction is not used.

Example usage

const restriction = G.mapRestriction({
    latLngBounds: [
        [40.712, -74.227],
        [40.774, -74.125]
    ]
});

const map = G.map('map', {
    center: [40.7128, -74.0060],
    restriction: restriction,
});

Creating the MapRestriction object

G.mapRestriction(options?: MapRestrictionValue): MapRestriction

There are a few ways to setup the MapRestriction object.

Pass no value.

G.mapRestriction(): MapRestriction

In this case you will need to set the latLngBounds value after you create the object.

const restriction = G.mapRestriction();
restriction.latLngBounds = [{lat: 40.712, lng: -74.227}, {lat: 40.774, lng: -74.124}];

Pass a boolean value to disable the MapRestriction object.

G.mapRestriction(value: boolean): MapRestriction

Parameter	Type	Required	Description
value	boolean	Yes	Whether to enable the MapRestriction object.

If you pass a false value to the mapRestriction method then the restriction value will not be set in the Map options.

const restriction = G.mapRestriction(false);

Pass a LatLngBounds value.

G.mapRestriction(value: LatLngBoundsValue): MapRestriction

Parameter	Type	Required	Description
value	LatLngBoundsValue	Yes	The LatLngBounds value to restrict the map to.

const restriction = G.mapRestriction([
    [40.712, -74.227],
    [40.774, -74.125]
]);

Pass an object of options.

G.mapRestriction(options: MapRestrictionOptions): MapRestriction

Parameter	Type	Required	Description
options	MapRestrictionOptions	Yes	The configuration options.

const mapRestriction = G.mapRestriction({
    latLngBounds: [
        [40.712, -74.227],
        [40.774, -74.125]
    ],
});

Pass an existing MapRestriction object.

G.mapRestriction(value: MapRestriction): MapRestriction

Parameter	Type	Required	Description
value	MapRestriction	Yes	The existing MapRestriction object.

const restriction = G.mapRestriction(existingMapRestrictionObject);

MapRestriction value type

The MapRestrictionValue can be one of the following values:

• boolean
• A LatLngBoundsValue value.
• A MapRestrictionOptions value.
• A MapRestriction object.

MapRestriction options

Type MapRestrictionOptions.

MapRestrictionOptions is an object containing the configuration options for the MapRestriction object.

Option	Type	Default	Description
enabled	boolean	true	Whether the MapRestriction object is enabled.
latLngBounds	LatLngBoundsValue		The value for the LatLngBounds object.
strictBounds	boolean	false	If true, anything outside of the latLngBounds will be hidden when zooming. This can restrict how much the user can zoom out.

Properties

Property	Type	Description
enabled	boolean	Whether the MapRestriction object is enabled.
latLngBounds	LatLngBounds	The LatLngBounds object for the restriction. Any LatLngBoundsValue can be used to set it.
strictBounds	boolean	If true, anything outside of the latLngBounds will be hidden when zooming. This can restrict how much the user can zoom out.

enabled

Get and set whether the MapRestriction object is enabled.

// Get whether the MapRestriction object is enabled
const isEnabled = restriction.enabled;

Set the enabled value.

// Set that the MapRestriction object is disabled
restriction.enabled = false;

// Set that the MapRestriction object is enabled
restriction.enabled = true;

latLngBounds

Get and set the LatLngBounds for the restriction.

info

The LatLngBounds needs to have at least two unique latitude/longitude values, otherwise the restriction is considered invalid.

The value is returned as a LatLngBounds object. If the LatLngBounds value has not been set yet, then undefined is returned.

// Get the existing LatLngBounds value
const bounds = restriction.latLngBounds;

Set the latLngBounds value. Any valid LatLngBoundsValue value can be used.

restriction.latLngBounds = [
    [40.712, -74.227],
    [40.774, -74.125]
];

strictBounds

Get and set whether the bounds are strict.

// Get the value
const strict = restriction.strictBounds;

// Set that the restriction is strict
restriction.strictBounds = true;

// Set that the restriction is not strict
restriction.strictBounds = false;

Methods

disable

disable(): MapRestriction

Disables the MapRestriction object.

If the MapRestriction object is disabled then the restriction value will not be set in the Map options.

restriction.disable();

enable

enable(): MapRestriction

Enables the MapRestriction object.

restriction.enable();

isEnabled

isEnabled(): boolean

Get whether the MapRestriction object is enabled. This is the same as using the enabled property.

if (restriction.isEnabled()) {
    // Do something
}

isValid

isValid(): boolean

Get whether the MapRestriction object is valid. The object is valid if the latLngBounds value has at least two different LatLng values.

if (restriction.isValid()) {
    // Do something
}

setLatLngBounds

setLatLngBounds(value: LatLngBoundsValue): MapRestriction

Set the latLngBounds value.

Parameter	Type	Required	Description
value	LatLngBoundsValue	Yes	The LatLngBounds value.

restriction.setLatLngBounds([
    { lat: 40.712, lng: -74.227 }, 
    { lat: 40.774, lng: -74.124 }
]);

setStrictBounds

setStrictBounds(value: boolean): MapRestriction

Set the strictBounds value.

Parameter	Type	Required	Description
value	boolean	Yes	Whether the bounds are strict.

// Set the bounds as strict
restriction.setStrictBounds(true);
// Set the bounds as not strict
restriction.setStrictBounds(false);

toGoogle

toGoogle(): Promise<google.maps.MapRestriction>

Get the object to use to pass the MapRestriction options to the Google Map instance.

restriction.toGoogle().then((mapRestriction) => {
    // Do something with the mapRestriction value
});