account for padding in getBounds

[andrewharvey]

Launch Checklist

• briefly describe the changes in this PR

This change proposes to alter map.getBounds(), when a global map padding is set, to return the inset bounds rather than the outset bounds (current behaviour).

This probably needs some discussion, not sure if it's considered a breaking change or a bug fix, however by making this the new default it ensures that:

1. box zoom interaction ensures that all the area within the selected box is visible within the inset area (should address boxZoom with padding #9056)
2. getBounds followed by fitBounds ensures the map view doesn't change (should address getBounds value is wrong when I set fitBounds with padding #10169)

My rationale is once you've set your global map padding to account for UI elements then all bounds refer to the inset bounds for consistency.

We could consider adding an option to getBounds/fitBounds to specify if the bounds should be for the inset or outset padded area, as I can see times when a dev would like to specify this.

• include before/after visuals or gifs if this PR includes visual changes

before

getBounds:

setBounds:

after:

getBounds/setBounds:

• write tests for all new functionality

added one unit test to confirm that getBounds returns the inset when padding is set

• document any changes to public APIs
  I've updated the docs for getBounds/fitBounds to specify it's for the inset when padding is set, however I can see especially with fitBounds how someone reading the docs could get confused between the two different kinds of padding (map.setPadding and map.fitBounds padding option), not sure how to improve that.

• post benchmark scores

• manually test the debug page
  yes, I added a new debug page

• apply changelog label ('bug', 'feature', 'docs', etc) or use the label 'skip changelog'
  feature or bug? Possibly considered a breaking change.

• add an entry inside this element for inclusion in the mapbox-gl-js changelog: <changelog>Changed map.getBounds() to return the inset bounds when a map padding is set</changelog>

[mourner]

Personally I think this makes a lot of sense, and is more of a bug fix than breaking behavior. Padding behavior will be much less confusing with this change. Thanks a lot for working on this!

[mourner]

@andrewharvey the render test failures are unrelated — need a rebase on latest main to fix.

[mourner]

👍