brandxtech/frontend
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

added explanation of squared parameter to fieldBounds function in the field model

Browse source
This commit is contained in:
csawatzky 2025-08-28 10:54:26 -06:00
parent b3a8a3b25f
commit 1588905a04
1 changed files with 2 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

3
src/models/Field.ts
View file

@ -158,7 +158,8 @@ export class Field {
/** /**
* Returns a LngLatBounds object containing the southwest and northeast corners of a box to contain the field, spacing can also be provided * Returns a LngLatBounds object containing the southwest and northeast corners of a box to contain the field, spacing can also be provided
* to pad the sides of the bounding area * to pad the sides of the bounding area
* @param spacing - an optional paramater that will expand the bounding area by the given long lat amount * @param spacing number(optional) - an optional paramater that will expand the bounding area by the given long lat amount
* @param squared boolean(optional) - when true will adjust the bounds by extending the narrower edge to match the wider edge
* @returns LngLatBounds - an object containing the southwest and northeast coordinates of a bounding box * @returns LngLatBounds - an object containing the southwest and northeast coordinates of a bounding box
*/ */
public fieldBounds(spacing?: number, squared?: boolean): LngLatBounds { public fieldBounds(spacing?: number, squared?: boolean): LngLatBounds {