Skip to content

Commit

Permalink
Allow bounds fitting options to be provided for initial bounds.
Browse files Browse the repository at this point in the history
Complements mapbox#5518 by allowing additional options (notably padding) to be
provided for the initial bounds for a map.
  • Loading branch information
elyobo committed Dec 6, 2018
1 parent 7ddbfa2 commit c450be7
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 1 deletion.
3 changes: 2 additions & 1 deletion src/ui/map.js
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,7 @@ const defaultOptions = {
* @param {number} [options.bearing=0] The initial bearing (rotation) of the map, measured in degrees counter-clockwise from north. If `bearing` is not specified in the constructor options, Mapbox GL JS will look for it in the map's style object. If it is not specified in the style, either, it will default to `0`.
* @param {number} [options.pitch=0] The initial pitch (tilt) of the map, measured in degrees away from the plane of the screen (0-60). If `pitch` is not specified in the constructor options, Mapbox GL JS will look for it in the map's style object. If it is not specified in the style, either, it will default to `0`.
* @param {LngLatBoundsLike} [options.bounds] The initial bounds of the map. If `bounds` is specified, it overrides `center` and `zoom` constructor options.
* @param {Object} [options.fitBoundsOptions] A [`fitBounds`](#Map#fitBounds) options object to use when fitting the initial bounds provided above.
* @param {boolean} [options.renderWorldCopies=true] If `true`, multiple copies of the world will be rendered, when zoomed out.
* @param {number} [options.maxTileCacheSize=null] The maximum number of tiles stored in the tile cache for a given source. If omitted, the cache will be dynamically sized based on the current viewport.
* @param {string} [options.localIdeographFontFamily=null] If specified, defines a CSS font-family
Expand Down Expand Up @@ -381,7 +382,7 @@ class Map extends Camera {

if (options.bounds) {
this.resize();
this.fitBounds(options.bounds, { duration: 0 });
this.fitBounds(options.bounds, extend({}, options.fitBoundsOptions, { duration: 0 }));
}
}

Expand Down
18 changes: 18 additions & 0 deletions test/unit/ui/map.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,24 @@ test('Map', (t) => {
t.end();
});

t.test('initial bounds options in constructor options', (t) => {
const bounds = [[-133, 16], [-68, 50]];

const map = (fitBoundsOptions, skipCSSStub) => {
const container = window.document.createElement('div');
Object.defineProperty(container, 'offsetWidth', {value: 512});
Object.defineProperty(container, 'offsetHeight', {value: 512});
return createMap(t, { skipCSSStub, container, bounds, fitBoundsOptions });
};

const unpadded = map(undefined, false);
const padded = map({ padding: 100 }, true);

t.ok(unpadded.getZoom() > padded.getZoom());

t.end();
});

t.test('disables handlers', (t) => {
t.test('disables all handlers', (t) => {
const map = createMap(t, {interactive: false});
Expand Down

0 comments on commit c450be7

Please sign in to comment.