Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add a zoomAndCenter method #1360

Merged
merged 1 commit into from
Jan 7, 2025
Merged

feat: Add a zoomAndCenter method #1360

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 50 additions & 12 deletions src/map.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -409,11 +409,13 @@ var map = function (arg) {
* option when determining the new view.
* @param {boolean} [ignoreClampBounds] If `true`, ignore the clampBounds
* option when determining the new view.
* @param {boolean} [noTrigger] If truthy, do not trigger a pan or zoom
* event. If 'pan', only trigger the zoom event.
* @returns {number|this}
* @fires geo.event.zoom
* @fires geo.event.pan
*/
this.zoom = function (val, origin, ignoreDiscreteZoom, ignoreClampBounds) {
this.zoom = function (val, origin, ignoreDiscreteZoom, ignoreClampBounds, noTrigger) {
if (val === undefined) {
return m_zoom;
}
Expand Down Expand Up @@ -442,19 +444,49 @@ var map = function (arg) {
zoomLevel: m_zoom,
screenPosition: origin ? origin.map : undefined
};
m_this.geoTrigger(geo_event.zoom, evt);
if (!noTrigger || noTrigger === 'pan') {
m_this.geoTrigger(geo_event.zoom, evt);
}

if (aroundPoint) {
var shifted = m_this.gcsToDisplay(origin.mapgcs || origin.geo,
origin.mapgcs ? null : undefined);
m_this.pan({x: origin.map.x - shifted.x, y: origin.map.y - shifted.y},
ignoreDiscreteZoom, true);
ignoreDiscreteZoom, true, noTrigger);
} else {
m_this.pan({x: 0, y: 0}, ignoreDiscreteZoom, ignoreClampBounds);
m_this.pan({x: 0, y: 0}, ignoreDiscreteZoom, ignoreClampBounds, noTrigger);
}
return m_this;
};

/**
* Set zoom level and center of the map.
*
* @param {number} zoom The new zoom level to set.
* @param {geo.geoPosition} center The new center of the
* @param {string|geo.transform|null} [gcs] `undefined` to use the interface
* gcs, `null` to use the map gcs, or any other transform. The center is
* converted from this gcs to the map projection.
* @param {geo.geoPosition} origin.geo The gcs coordinates of the zoom
* center.
* @param {geo.screenPosition} origin.map The display coordinates of the zoom
* center.
* @param {boolean} [ignoreDiscreteZoom] If `true`, ignore the discreteZoom
* option when determining the new view.
* @param {boolean} [ignoreClampBounds] If `true`, ignore the clampBounds
* option when determining the new view.
* @param {boolean} [noTrigger] If truthy, do not trigger a pan or zoom
* event.
* @returns {this}
* @fires geo.event.zoom
* @fires geo.event.pan
*/
this.zoomAndCenter = function (zoom, center, gcs, ignoreDiscreteZoom, ignoreClampBounds, noTrigger) {
this.zoom(zoom, undefined, ignoreDiscreteZoom, ignoreClampBounds, noTrigger || 'pan');
this.center(center, gcs, ignoreDiscreteZoom, ignoreClampBounds, noTrigger);
return this;
};

/**
* Pan the map by a number of display pixels.
*
Expand All @@ -468,10 +500,11 @@ var map = function (arg) {
* view. When `'limited'`, the `clampBoundsX` and `clampBoundsY` options
* are selectively enforced so that the map will not end up more out of
* bounds than its current state.
* @param {boolean} [noTrigger] If truthy, do not trigger a pan event.
* @returns {this}
* @fires geo.event.pan
*/
this.pan = function (delta, ignoreDiscreteZoom, ignoreClampBounds) {
this.pan = function (delta, ignoreDiscreteZoom, ignoreClampBounds, noTrigger) {
var evt = {
screenDelta: delta
};
Expand Down Expand Up @@ -510,7 +543,9 @@ var map = function (arg) {
y: m_height / 2
});

m_this.geoTrigger(geo_event.pan, evt);
if (!noTrigger) {
m_this.geoTrigger(geo_event.pan, evt);
}

m_this.modified();
return m_this;
Expand Down Expand Up @@ -575,7 +610,7 @@ var map = function (arg) {
/**
* Get or set the center of the map in the given geographic coordinates.
*
* @param {geo.geoPosition} coordinates If specified, the new center of the
* @param {geo.geoPosition} [coordinates] If specified, the new center of the
* map.
* @param {string|geo.transform|null} [gcs] `undefined` to use the interface
* gcs, `null` to use the map gcs, or any other transform. If setting the
Expand All @@ -588,10 +623,11 @@ var map = function (arg) {
* view. When `'limited'`, the `clampBoundsX` and `clampBoundsY` options
* are selectively enforced so that the map will not end up more out of
* bounds than its current state.
* @param {boolean} [noTrigger] If truthy, do not trigger a pan event.
* @returns {geo.geoPosition|this}
* @fires geo.event.pan
*/
this.center = function (coordinates, gcs, ignoreDiscreteZoom, ignoreClampBounds) {
this.center = function (coordinates, gcs, ignoreDiscreteZoom, ignoreClampBounds, noTrigger) {
var center;
if (coordinates === undefined) {
center = Object.assign({}, m_this.worldToGcs(m_center, gcs));
Expand All @@ -606,9 +642,11 @@ var map = function (arg) {
ignoreClampBounds), m_rotation);
m_this.modified();
// trigger a pan event
m_this.geoTrigger(geo_event.pan, {
screenDelta: {x: 0, y: 0}
});
if (!noTrigger) {
m_this.geoTrigger(geo_event.pan, {
screenDelta: {x: 0, y: 0}
});
}
return m_this;
};

Expand Down Expand Up @@ -1383,7 +1421,7 @@ var map = function (arg) {

// This might have consequences in terms of bounds/zoom clamping.
// What behavior do we expect from this method in that case?
m_this.zoom(nav.zoom);
m_this.zoom(nav.zoom, undefined, undefined, undefined, 'pan');
m_this.center(nav.center, null);
}

Expand Down
10 changes: 10 additions & 0 deletions tests/cases/map.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -421,6 +421,16 @@ describe('geo.core.map', function () {
m = createMap({autoshareRenderer: 'more'});
expect(m.autoshareRenderer()).toBe('more');
});
it('zoomAndCenter and center', function () {
var m = createMap(undefined, {width: '500px', height: '500px'});
expect(m.zoom()).toBe(4);
m.zoomAndCenter(3.5, {x: 4, y: 2});
expect(m.zoom()).toBe(3.5);
expect(closeToEqual(m.center(), {x: 4, y: 2, z: 0})).toBe(true);
m.center({x: 0, y: 0});
expect(m.zoom()).toBe(3.5);
expect(closeToEqual(m.center(), {x: 0, y: 0, z: 0})).toBe(true);
});
});

describe('Public utility methods', function () {
Expand Down
Loading