Skip to content

Case sensitive arc rest #1

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

Open
rhodges wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Case sensitive arc rest #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b72077b
fix ImageArcGISRest and TileArcGISRest to support modern case sensiti…
rhodges May 1, 2026
46b400e
updating tests to match case-sensitive ArcREST query fields
rhodges May 1, 2026
b5083f9
updating case in comments to match updates from PR
rhodges May 1, 2026
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
6 changes: 3 additions & 3 deletions src/ol/source/ImageArcGISRest.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ import {createLoader} from './arcgisRest.js';
* @property {boolean} [interpolate=true] Use interpolated values when resampling. By default,
* linear interpolation is used when resampling. Set to false to use the nearest neighbor instead.
* @property {Object<string,*>} [params] ArcGIS Rest parameters. This field is optional. Service
* defaults will be used for any fields not specified. `FORMAT` is `PNG32` by default. `F` is
* `IMAGE` by default. `TRANSPARENT` is `true` by default. `BBOX`, `SIZE`, `BBOXSR`, and `IMAGESR`
* will be set dynamically. Set `LAYERS` to override the default service layer visibility. See
* defaults will be used for any fields not specified. `format` is `png32` by default. `f` is
* `image` by default. `transparent` is `true` by default. `bbox`, `size`, `bboxSR`, and `imageSR`
* will be set dynamically. Set `layers` to override the default service layer visibility. See
* https://developers.arcgis.com/rest/services-reference/export-map.htm
* for further reference.
* @property {import("../proj.js").ProjectionLike} [projection] Projection. Default is the view projection.
Expand Down
12 changes: 6 additions & 6 deletions src/ol/source/TileArcGISRest.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ import {getRequestUrl} from './arcgisRest.js';
* @property {boolean} [interpolate=true] Use interpolated values when resampling. By default,
* linear interpolation is used when resampling. Set to false to use the nearest neighbor instead.
* @property {Object<string,*>} [params] ArcGIS Rest parameters. This field is optional. Service defaults will be
* used for any fields not specified. `FORMAT` is `PNG32` by default. `F` is `IMAGE` by
* default. `TRANSPARENT` is `true` by default. `BBOX`, `SIZE`, `BBOXSR`,
* and `IMAGESR` will be set dynamically. Set `LAYERS` to
* used for any fields not specified. `format` is `png32` by default. `f` is `image` by
* default. `transparent` is `true` by default. `bbox`, `size`, `bboxSR`,
* and `imageSR` will be set dynamically. Set `layers` to
* override the default service layer visibility. See
* https://developers.arcgis.com/rest/services-reference/export-map.htm
* for further reference.
Expand Down Expand Up @@ -236,9 +236,9 @@ class TileArcGISRest extends TileImage {

// Apply default params and override with user specified values.
const baseParams = {
'F': 'image',
'FORMAT': 'PNG32',
'TRANSPARENT': true,
'f': 'image',
'format': 'png32',
'transparent': true,
};
Object.assign(baseParams, this.params_);
Comment on lines 237 to 243

Expand Down
24 changes: 12 additions & 12 deletions src/ol/source/arcgisRest.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,12 @@ export function getRequestUrl(
round(getHeight(extent) / imageResolution, DECIMALS),
];

params['SIZE'] = imageSize[0] + ',' + imageSize[1];
params['BBOX'] = extent.join(',');
params['BBOXSR'] = srid;
params['IMAGESR'] = srid;
params['DPI'] = Math.round(
params['DPI'] ? params['DPI'] * pixelRatio : 90 * pixelRatio,
params['size'] = imageSize[0] + ',' + imageSize[1];
params['bbox'] = extent.join(',');
params['bboxSR'] = srid;
params['imageSR'] = srid;
params['dpi'] = Math.round(
params['dpi'] ? params['dpi'] * pixelRatio : 90 * pixelRatio,
);
Comment on lines +45 to 51

const modifiedUrl = baseUrl
Expand All @@ -65,9 +65,9 @@ export function getRequestUrl(
* @property {boolean} [hidpi=true] Use the `ol/Map#pixelRatio` value when requesting the image from
* the remote server.
* @property {Object<string,*>} [params] ArcGIS Rest parameters. This field is optional. Service
* defaults will be used for any fields not specified. `FORMAT` is `PNG32` by default. `F` is
* `IMAGE` by default. `TRANSPARENT` is `true` by default. `BBOX`, `SIZE`, `BBOXSR`, and `IMAGESR`
* will be set dynamically. Set `LAYERS` to override the default service layer visibility. See
* defaults will be used for any fields not specified. `format` is `png32` by default. `f` is
* `image` by default. `transparent` is `true` by default. `bbox`, `size`, `bboxSR`, and `imageSR`
* will be set dynamically. Set `layers` to override the default service layer visibility. See
* https://developers.arcgis.com/rest/services-reference/export-map.htm
* for further reference.
* @property {import("../proj.js").ProjectionLike} [projection] Projection. Default is 'EPSG:3857'.
Expand Down Expand Up @@ -99,9 +99,9 @@ export function createLoader(options) {
pixelRatio = options.hidpi ? pixelRatio : 1;

const params = {
'F': 'image',
'FORMAT': 'PNG32',
'TRANSPARENT': true,
'f': 'image',
'format': 'png32',
'transparent': true,
};
Object.assign(params, options.params);

Comment on lines 101 to 107
Expand Down
34 changes: 17 additions & 17 deletions test/browser/spec/ol/source/ImageArcGISRest.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,15 @@ describe('ol/source/ImageArcGISRest', function () {
expect(uri.pathname).to.be('/MapServer/export');

const queryData = uri.searchParams;
expect(queryData.get('SIZE')).to.be('150,16');
expect(queryData.get('BBOX')).to.be('-9.5,0.7,5.5,2.3');
expect(queryData.get('FORMAT')).to.be('PNG32');
expect(queryData.get('IMAGESR')).to.be('3857');
expect(queryData.get('BBOXSR')).to.be('3857');
expect(queryData.get('TRANSPARENT')).to.be('true');
expect(queryData.get('size')).to.be('150,16');
expect(queryData.get('bbox')).to.be('-9.5,0.7,5.5,2.3');
expect(queryData.get('format')).to.be('png32');
expect(queryData.get('imageSR')).to.be('3857');
expect(queryData.get('bboxSR')).to.be('3857');
expect(queryData.get('transparent')).to.be('true');
});

it('returns a non floating point DPI value', function () {
it('returns a non floating point dpi value', function () {
const source = new ImageArcGISRest(options);
const image = source.getImage(
[3, 2, -7, 1.12],
Expand All @@ -69,7 +69,7 @@ describe('ol/source/ImageArcGISRest', function () {
image.load();
const uri = new URL(image.getImage().src);
const queryData = uri.searchParams;
expect(queryData.get('DPI')).to.be('91');
expect(queryData.get('dpi')).to.be('91');
});

it('returns a image with the expected URL for ImageServer', function () {
Expand All @@ -87,16 +87,16 @@ describe('ol/source/ImageArcGISRest', function () {
expect(uri.hostname).to.be(window.location.hostname);
expect(uri.pathname).to.be('/ImageServer/exportImage');
const queryData = uri.searchParams;
expect(queryData.get('BBOX')).to.be('-9.5,0.7,5.5,2.3');
expect(queryData.get('FORMAT')).to.be('PNG32');
expect(queryData.get('IMAGESR')).to.be('3857');
expect(queryData.get('BBOXSR')).to.be('3857');
expect(queryData.get('TRANSPARENT')).to.be('true');
expect(queryData.get('bbox')).to.be('-9.5,0.7,5.5,2.3');
expect(queryData.get('format')).to.be('png32');
expect(queryData.get('imageSR')).to.be('3857');
expect(queryData.get('bboxSR')).to.be('3857');
expect(queryData.get('transparent')).to.be('true');
});

it('allows various parameters to be overridden', function () {
options.params.FORMAT = 'png';
options.params.TRANSPARENT = false;
options.params.format = 'png';
options.params.transparent = false;
const source = new ImageArcGISRest(options);
const image = source.getImage(
[3, 2, -3, 1],
Expand All @@ -107,8 +107,8 @@ describe('ol/source/ImageArcGISRest', function () {
image.load();
const uri = new URL(image.getImage().src);
const queryData = uri.searchParams;
expect(queryData.get('FORMAT')).to.be('png');
expect(queryData.get('TRANSPARENT')).to.be('false');
expect(queryData.get('format')).to.be('png');
expect(queryData.get('transparent')).to.be('false');
});

it('allows adding rest option', function () {
Expand Down
60 changes: 30 additions & 30 deletions test/browser/spec/ol/source/TileArcGISRest.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,34 +21,34 @@ describe('ol/source/TileArcGISRest', function () {
expect(uri.hostname).to.be('example.com');
expect(uri.pathname).to.be('/MapServer/export');
const queryData = uri.searchParams;
const bbox = queryData.get('BBOX').split(',').map(parseFloat);
const bbox = queryData.get('bbox').split(',').map(parseFloat);
expect(bbox[0]).roughlyEqual(-10018754.171394622, 1e-9);
expect(bbox[1]).roughlyEqual(-15028131.257091936, 1e-9);
expect(bbox[2]).roughlyEqual(-5009377.085697311, 1e-9);
expect(bbox[3]).roughlyEqual(-10018754.171394624, 1e-9);
expect(queryData.get('FORMAT')).to.be('PNG32');
expect(queryData.get('SIZE')).to.be('256,256');
expect(queryData.get('IMAGESR')).to.be('3857');
expect(queryData.get('BBOXSR')).to.be('3857');
expect(queryData.get('TRANSPARENT')).to.be('true');
expect(queryData.get('format')).to.be('png32');
expect(queryData.get('size')).to.be('256,256');
expect(queryData.get('imageSR')).to.be('3857');
expect(queryData.get('bboxSR')).to.be('3857');
expect(queryData.get('transparent')).to.be('true');
});

it('returns a non floating point DPI value', function () {
it('returns a non floating point dpi value', function () {
const source = new TileArcGISRest(options);
const tile = source.getTile(3, 2, 6, 1.12, getProjection('EPSG:3857'));
const uri = new URL(tile.src_);
const queryData = uri.searchParams;
expect(queryData.get('DPI')).to.be('101');
expect(queryData.get('dpi')).to.be('101');
});

it('takes DPI from params if specified', function () {
options.params.DPI = 96;
it('takes dpi from params if specified', function () {
options.params.dpi = 96;
const source = new TileArcGISRest(options);
const tile = source.getTile(3, 2, 6, 1.12, getProjection('EPSG:3857'));
const uri = new URL(tile.src_);
const queryData = uri.searchParams;
expect(queryData.get('DPI')).to.be('108');
delete options.params.DPI;
expect(queryData.get('dpi')).to.be('108');
delete options.params.dpi;
});

it('returns a tile with the expected URL with url list', function () {
Expand All @@ -65,16 +65,16 @@ describe('ol/source/TileArcGISRest', function () {
expect(uri.hostname).to.match(/test[12]\.com/);
expect(uri.pathname).to.be('/MapServer/export');
const queryData = uri.searchParams;
const bbox = queryData.get('BBOX').split(',').map(parseFloat);
const bbox = queryData.get('bbox').split(',').map(parseFloat);
expect(bbox[0]).roughlyEqual(-10018754.171394622, 1e-9);
expect(bbox[1]).roughlyEqual(-15028131.257091936, 1e-9);
expect(bbox[2]).roughlyEqual(-5009377.085697311, 1e-9);
expect(bbox[3]).roughlyEqual(-10018754.171394624, 1e-9);
expect(queryData.get('FORMAT')).to.be('PNG32');
expect(queryData.get('SIZE')).to.be('256,256');
expect(queryData.get('IMAGESR')).to.be('3857');
expect(queryData.get('BBOXSR')).to.be('3857');
expect(queryData.get('TRANSPARENT')).to.be('true');
expect(queryData.get('format')).to.be('png32');
expect(queryData.get('size')).to.be('256,256');
expect(queryData.get('imageSR')).to.be('3857');
expect(queryData.get('bboxSR')).to.be('3857');
expect(queryData.get('transparent')).to.be('true');
});

it('returns a tile with the expected URL for ImageServer', function () {
Expand All @@ -87,36 +87,36 @@ describe('ol/source/TileArcGISRest', function () {
expect(uri.hostname).to.be('example.com');
expect(uri.pathname).to.be('/ImageServer/exportImage');
const queryData = uri.searchParams;
const bbox = queryData.get('BBOX').split(',').map(parseFloat);
const bbox = queryData.get('bbox').split(',').map(parseFloat);
expect(bbox[0]).roughlyEqual(-10018754.171394622, 1e-9);
expect(bbox[1]).roughlyEqual(-15028131.257091936, 1e-9);
expect(bbox[2]).roughlyEqual(-5009377.085697311, 1e-9);
expect(bbox[3]).roughlyEqual(-10018754.171394624, 1e-9);
expect(queryData.get('FORMAT')).to.be('PNG32');
expect(queryData.get('SIZE')).to.be('256,256');
expect(queryData.get('IMAGESR')).to.be('3857');
expect(queryData.get('BBOXSR')).to.be('3857');
expect(queryData.get('TRANSPARENT')).to.be('true');
expect(queryData.get('format')).to.be('png32');
expect(queryData.get('size')).to.be('256,256');
expect(queryData.get('imageSR')).to.be('3857');
expect(queryData.get('bboxSR')).to.be('3857');
expect(queryData.get('transparent')).to.be('true');
});

it('allows various parameters to be overridden', function () {
options.params.FORMAT = 'png';
options.params.TRANSPARENT = false;
options.params.format = 'png';
options.params.transparent = false;
const source = new TileArcGISRest(options);
const tile = source.getTile(3, 2, 2, 1, getProjection('EPSG:4326'));
const uri = new URL(tile.src_);
const queryData = uri.searchParams;
expect(queryData.get('FORMAT')).to.be('png');
expect(queryData.get('TRANSPARENT')).to.be('false');
expect(queryData.get('format')).to.be('png');
expect(queryData.get('transparent')).to.be('false');
});

it('allows adding rest option', function () {
options.params.LAYERS = 'show:1,3,4';
options.params.layers = 'show:1,3,4';
const source = new TileArcGISRest(options);
const tile = source.getTile(3, 2, 2, 1, getProjection('EPSG:4326'));
const uri = new URL(tile.src_);
const queryData = uri.searchParams;
expect(queryData.get('LAYERS')).to.be('show:1,3,4');
expect(queryData.get('layers')).to.be('show:1,3,4');
});
});

Expand Down