Movatterモバイル変換

js/ui/popup.js

`Popup(options, options.closeButton, options.closeOnClick)`

Creates a popup component

parameter	type	description
options	`Object`
options.closeButton	`Boolean`
options.closeOnClick	`Boolean`

Examples

var tooltip =new mapboxgl.Popup()  .setLatLng(map.unproject(e.point))  .setHTML("<h1>Hello World!</h1>")  .addTo(map);

js/ui/popup.js

`setText(text)`

Popuplate a popup element with text only content

parameter	type	description
text	`string`

Returns

Popup :

this

js/ui/popup.js

`setHTML(html)`

Popuplate a popup element with HTML content

parameter	type	description
html	`string`

Returns

Popup :

this

js/ui/popup.js

`setLatLng(latlng)`

Set the coordinates of a popup element to a map

parameter	type	description
latlng	`LatLng`

Returns

Popup :

this

js/ui/popup.js

`remove`

Removes the popup from the map

Returns

Popup :

this

Examples

var popup =new mapboxgl.Popup().addTo(map);popup.remove();

js/ui/popup.js

`getLatLng`

Get the current coordinates of popup element relative to map

Returns

LatLng

js/ui/popup.js

`addTo(map)`

Attaches the popup to a map

parameter	type	description
map	`Map`

Returns

Popup :

this

js/ui/map.js

`Map(options, options.container)`

Creates a map instance.

parameter	type	description
options	`Object`
options.container	`String`	HTML element to initialize the map in (or element id as string)

js/ui/easings.js

`zoomTo(zoom, animOptions)`

Zooms to a certain zoom level with easing.

parameter	type	description
zoom	`Number`
animOptions

Returns

this

js/ui/easings.js

`zoomOut(animOptions)`

Zoom out by 1 level

parameter	type	description
animOptions

Returns

this

js/ui/easings.js

`zoomIn(animOptions)`

Zoom in by 1 level

parameter	type	description
animOptions

Returns

this

js/ui/map.js

`update(updateStyle)`

Update this map's style and re-render the map.

parameter	type	description
updateStyle	`Object`	new style

Returns

Map :

this

js/ui/easings.js

`stop`

Stop current animation

Returns

this

js/ui/map.js

`setView(center, zoom, bearing, pitch)`

Sets a map position

parameter	type	description
center	`Array`	Latitude and longitude (passed as`[lat, lng]`)
zoom	`number`	Map zoom level
bearing	`number`	Map rotation bearing in degrees counter-clockwise from north
pitch	`number`	The angle at which the camera is looking at the ground

Returns

Map :

this

js/ui/map.js

`setZoom(zoom)`

Sets a map zoom

parameter	type	description
zoom	`number`	Map zoom level

Returns

Map :

this

js/ui/map.js

`unproject(point)`

Get geographical coordinates given pixel coordinates

parameter	type	description
point	Array<`number`>	[x, y] pixel coordinates

Returns

LatLng

js/ui/map.js

`setLayoutProperty(layer, name, value)`

Set the value of a layout property in a given style layer.

parameter	type	description
layer	`string`	ID of a layer
name	`string`	name of a layout property
value	Any	value for the layout propery; must have the type appropriate for the property as defined in theStyle Specification

Returns

Map :

this

js/ui/map.js

`setBearing(bearing)`

Sets a map rotation

parameter	type	description
bearing	`number`	Map rotation bearing in degrees counter-clockwise from north

Returns

Map :

this

js/ui/map.js

`setPaintProperty(layer, name, value, [klass])`

Set the value of a paint property in a given style layer.

parameter	type	description
layer	`string`	ID of a layer
name	`string`	name of a paint property
value	Any	value for the paint propery; must have the type appropriate for the property as defined in theStyle Specification
klass	`[string]`	optional class specifier for the property

Returns

Map :

this

js/ui/map.js

`setCenter(center)`

Sets a map location

parameter	type	description
center	`Array`	Latitude and longitude (passed as`[lat, lng]`)

Returns

Map :

this

js/ui/map.js

`setFilter(layer, filter)`

Set the filter for a given style layer.

parameter	type	description
layer	`string`	ID of a layer
filter	`Array`	filter specification, as defined in theStyle Specification

Returns

Map :

this

js/ui/map.js

`setClasses(klasses, options)`

Helper method to add more than one class

parameter	type	description
klasses	Array<`string`>	An array of class names
options	`styleOptions`

Returns

Map :

this

js/ui/easings.js

`rotateTo(bearing, animOptions)`

Rotate bearing by a certain number of degrees with easing

parameter	type	description
bearing	`Number`
animOptions

Returns

this

js/ui/map.js

`setStyle(style)`

Replaces the map's style object

parameter	type	description
style	`Object`	A style object formatted as JSON

Returns

Map :

this

js/ui/map.js

`removeSource(id)`

Remove an existing source from the map style.

parameter	type	description
id	`string`	ID of the source to remove

Returns

Map :

this

js/ui/map.js

`getSource(id)`

Return the style source object with the givenid.

parameter	type	description
id	`string`	source ID

Returns

Object

js/ui/map.js

`project(latlng)`

Get pixel coordinates (relative to map container) given a geographical location

parameter	type	description
latlng	`LatLng`

Returns

Object :

x andy coordinates

js/ui/map.js

`hasClass(klass)`

Check whether a style class is active

parameter	type	description
klass	`string`	Name of style class

Returns

boolean

js/ui/map.js

`removeLayer(id)`

Remove the layer with the givenid from the map. Any layers which refer to thespecified layer via aref property are also removed.

parameter	type	description
id	`string`

Returns

Map :

this

js/ui/map.js

`removeClass(klass, options)`

Removes a style class from a map

parameter	type	description
klass	`string`	name of style class
options	`styleOptions`

Returns

Map :

this

js/ui/map.js

`getPitch`

Get the current angle in degrees

Returns

number

js/ui/map.js

`getPaintProperty(layer, name, [klass])`

Get the value of a paint property in a given style layer.

parameter	type	description
layer	`string`	ID of a layer
name	`string`	name of a paint property
klass	`[string]`	optional class specifier for the property

Returns

Any :

value for the paint propery

js/ui/map.js

`getZoom`

Get the current zoom

Returns

number

js/ui/easings.js

`panBy(offset, animOptions)`

Pan by a certain number of pixels

parameter	type	description
offset	`Array`	[x, y]
animOptions

Returns

this

js/ui/map.js

`loaded`

Is this map fully loaded? If the style isn't loadedor it has a change to the sources or style that isn'tpropagated to its style, return false.

Returns

boolean :

whether the map is loaded

js/ui/map.js

`render`

Call when a (re-)render of the map is required, e.g. when theuser panned or zoomed,f or new data is available.

Returns

Map :

this

js/ui/map.js

`remove`

Destroys the map's underlying resources, including web workers.

Returns

Map :

this

js/ui/easings.js

`panTo(latlng, animOptions)`

Pan to a certain location with easing

parameter	type	description
latlng	`Object`	a`LatLng` object
animOptions

Returns

this

js/ui/easings.js

`resetNorth(animOptions)`

Sets map bearing to 0 (north) with easing

parameter	type	description
animOptions

Returns

this

js/ui/map.js

`resize`

Detect the map's new width and height and resize it.

Returns

Map :

this

js/ui/easings.js

`fitBounds(bounds, options)`

Zoom to contain certain geographical bounds

parameter	type	description
bounds	`Array`	[[minLat, minLng], [maxLat, maxLng]]
options	`Object`

js/ui/easings.js

`easeTo(latlng, zoom, bearing, pitch, animOptions)`

Easing animation to a specified location/zoom/bearing

parameter	type	description
latlng	`Object`	a`LatLng` object
zoom	`Number`
bearing	`Number`
pitch	`Number`
animOptions

Returns

this

js/ui/easings.js

`flyTo(latlng, zoom, bearing, options)`

Flying animation to a specified location/zoom/bearing with automatic curve

parameter	type	description
latlng	`Object`	a`LatLng` object
zoom	`Number`
bearing	`Number`
options	`Object`

js/ui/map.js

`getCenter`

Get the current view geographical point

Returns

LatLng

js/ui/map.js

`getBearing`

Get the current bearing in degrees

Returns

number

js/ui/map.js

`getClasses`

Return an array of the current active style classes

Returns

boolean

js/ui/map.js

`getBounds`

Get the map's geographical bounds

Returns

LatLngBounds

js/ui/map.js

`featuresAt(point, params)`

Get all features at a point ([x, y])

parameter	type	description
point	Array<`number`>	[x, y] pixel coordinates
params	`Object`

js/ui/map.js

`getFilter(layer)`

Get the filter for a given style layer.

parameter	type	description
layer	`string`	ID of a layer

Returns

Array :

filter specification, as defined in theStyle Specification

js/ui/map.js

`getLayoutProperty(layer, name, [klass])`

Get the value of a layout property in a given style layer.

parameter	type	description
layer	`string`	ID of a layer
name	`string`	name of a layout property
klass	`[string]`	optional class specifier for the property

Returns

Any :

value for the layout propery

js/ui/map.js

`getContainer`

Get the Map's container as an HTML element

Returns

HTMLElement :

container

js/ui/map.js

`getCanvas`

Get the Map's canvas as an HTML canvas

Returns

HTMLElement :

canvas

js/ui/map.js

`setPitch(pitch)`

Sets a map angle

parameter	type	description
pitch	`number`	The angle at which the camera is looking at the ground

Returns

Map :

this

js/ui/map.js

`addClass`

js/ui/map.js

`addClass(klass, options)`

Adds a style class to a map

parameter	type	description
klass	`string`	name of style class
options	`styleOptions`

Returns

Map :

this

js/ui/map.js

`addSource(id, source)`

Add a source to the map style.

parameter	type	description
id	`string`	ID of the source. Must not be used by any existing source.
source	`Object`	source specification, following theMapbox GL Style Reference

Returns

Map :

this

js/ui/map.js

`addLayer(layer, [before])`

Add a layer to the map style. The layer will be inserted before the layer withIDbefore, or appended ifbefore is omitted.

parameter	type	description
layer	`Layer`
before	`[string]`	ID of an existing layer to insert before

Returns

Map :

this

js/source/geojson_source.js

`GeoJSONSource`

Create a GeoJSON data source instance given an options object

js/source/geojson_source.js

`setData(data)`

Update source geojson data and rerender map

parameter	type	description
data	`Object` or`String`	A GeoJSON data object or URL to it. The latter is preferable in case of large GeoJSON files.

js/ui/control/control.js

`Control`

A base class for map-related interface elements.

js/ui/control/control.js

`remove`

Remove this control from the map it has been added to.

Returns

Control :

this

js/ui/control/control.js

`addTo(map)`

Add this control to the map, returning the control itselffor chaining. This will insert the control's DOM element intothe map's DOM element if the control has aposition specified.

parameter	type	description
map	`Map`

Returns

Control :

this

ExtendsControljs/ui/control/attribution.js

`Attribution`

Creates an attribution control

Examples

map.addControl(new mapboxgl.Attribution());

js/geo/lat_lng.js

`LatLng(lat, lng)`

Create a latitude, longitude object from a given latitude and longitude pair in degrees.

parameter	type	description
lat	`number`	latitude
lng	`number`	longitude

Examples

var latlng =new mapboxgl.LatLng(37.76, -122.44);

js/geo/lat_lng.js

`wrap`

Return a newLatLng object whose longitude is wrapped to the range (-180, 180).

Returns

LatLng :

wrapped LatLng object

js/geo/lat_lng.js

`convert(input)`

Convert an array to aLatLng object, or return an existingLatLng objectunchanged.

parameter	type	description
input	Array<`number`> or`LatLng`	`input` to convert

Returns

LatLng :

LatLng object or original input

js/util/evented.js

`Evented`

Methods mixed in to other classes for event capabilities.

js/util/evented.js

`listens`

Check if an event is registered to a type

Returns

Boolean :

Returns true if the object listens to an event of a particular type

js/util/evented.js

`once(type, listener)`

Call a function once when an event has fired

parameter	type	description
type	`String`	Event type.
listener	`Function`	Function to be called once when the event is fired

js/util/evented.js

`off`

Remove a event listener

js/util/evented.js

`on(type, listener)`

Subscribe to a specified event with a listener function the latter gets the data object that was passed tofire and additionallytarget andtype properties

parameter	type	description
type	`String`	Event type
listener	`Function`	Function to be called when the event is fired

js/util/evented.js

`fire(type)`

Fire event of a given string type with the given data object

parameter	type	description
type	`String`	The event name

js/geo/lat_lng_bounds.js

`LatLngBounds(sw, ne)`

Creates a bounding box from the given pair of points. If parameteres are omitted, anull bounding box is created.

parameter	type	description
sw	`LatLng`	southwest
ne	`LatLng`	northeast

Examples

var sw =new mapboxgl.LatLng(0,0);var ne =new mapboxgl.LatLng(10, -10);var bounds =new mapboxgl.LatLngBounds(sw, ne);

js/geo/lat_lng_bounds.js

`getSouthWest`

Get southwest corner

Returns

LatLng :

southwest

js/geo/lat_lng_bounds.js

`getSouth`

Get south edge latitude

Returns

number :

south

js/geo/lat_lng_bounds.js

`getNorthEast`

Get northeast corner

Returns

LatLng :

northeast

js/geo/lat_lng_bounds.js

`getNorthWest`

Get northwest corner

Returns

LatLng :

northwest

js/geo/lat_lng_bounds.js

`getSouthEast`

Get southeast corner

Returns

LatLng :

southeast

js/geo/lat_lng_bounds.js

`getWest`

Get west edge longitude

Returns

number :

west

js/geo/lat_lng_bounds.js

`extend(obj)`

Extend the bounds to include a given LatLng or LatLngBounds.

parameter	type	description
obj	`LatLng` or`LatLngBounds`	object to extend to

Returns

LatLngBounds :

this

js/geo/lat_lng_bounds.js

`getCenter`

Get the point equidistant from this box's corners

Returns

LatLng :

centerpoint

js/geo/lat_lng_bounds.js

`getEast`

Get east edge longitude

Returns

number :

east

js/geo/lat_lng_bounds.js

`getNorth`

Get north edge latitude

Returns

number :

north

js/source/video_source.js

parameter	type	description
lat	`Number`

js/util/browser/browser.js

`supported(options)`

Test whether the basic JavaScript and DOM features required for Mapbox GL are present.

parameter	type	description
options	`Object`

/Users/tmcw/src/mapbox-gl-js

`window`

mapboxgl is a A WebGL JavaScript interactive maps library that can renderMapbox vector tiles.

js/geo/transform.js

`lngX(lon)`

lat/lon <-> absolute pixel coords conversion

parameter	type	description
lon	`Number`