mapserver.github.io/mapcache/services.html at master · MapServer/mapserver.github.io

History

584 lines (535 loc) · 43.2 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

<!DOCTYPE html>

<head>

<title>Supported Tile Services — MapServer 8.6.1 documentation</title>

</head><body>

<tr>

</td>

<a href="../index.html" title="Home">Home</a> |

<a href="../products.html" title="Products (MapServer core, MapCache, TinyOWS">Products</a> |

<a href="https://github.com/mapserver/mapserver/issues/" title="Issue Tracker (MapServer core)">Issue Tracker</a> |

<a href="../community/service_providers.html" title="Professional Service Providers">Service Providers</a> |

<a href="../faq.html" title="Frequently Asked Questions">FAQ</a> |

<a href="https://fosstodon.org/@mapserver" title="Mastodon" target="_blank">Mastodon</a> |

<a href="../download.html" title="Download Source or Binaries">Download </a> |

</a>

</td>

</tr>

<tr>

</td>

</tr>

</table>

<h3>Navigation</h3>

<ul>

<a href="../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="seed.html" title="Seeder"

accesskey="N">next</a> |</li>

<a href="config.html" title="Configuration File"

accesskey="P">previous</a> |</li>

<li class="nav-item nav-item-1"><a href="../documentation.html" >MapServer 8.6.1 Documentation</a> »</li>

<li class="nav-item nav-item-2"><a href="index.html" accesskey="U">MapCache 1.14.1</a> »</li>

<li class="nav-item nav-item-this"><a href="">Supported Tile Services</a></li>

</ul>

</div>

<h1>Supported Tile Services<a class="headerlink" href="#supported-tile-services" title="Link to this heading">¶</a></h1>

<dt class="field-odd">Author:</dt>

<dd class="field-odd">Thomas Bonfort

</dd>

<dt class="field-even">Contact:</dt>

<dd class="field-even">tbonfort at terriscope.fr

</dd>

<dt class="field-odd">Author:</dt>

<dd class="field-odd">Stephen Woodbridge

</dd>

</dl>

MapCache has the ability to serve tiles using a variety of different

request protocols and tile-naming conventions. This document describes

these. The various services must be turned on in the mapcache.xml file for

MapCache to respond to these specific requests.

All services are available on the demo interface, from which you are highly

encouraged to copy/paste the JavaScript code to get started when creating

your own pages accessing the MapCache tiles.

The following notation is used on this page and refers to object names in the

mapcache.xml configuration file.

<li><tileset_name> - name of a configured tileset</li>

<li><grid_name> - name of explicitly or implicitly defined grid</li>

<li><quadkey> - specific to the Virtual Earth tile service</li>

<li><z> - zoom level in zxy naming scheme</li>

<li><y> - row number in zxy naming scheme</li>

<li><x> - column number in zxy naming scheme</li>

</ul>

</div></blockquote>

<h2>TMS Service<a class="headerlink" href="#tms-service" title="Link to this heading">¶</a></h2>

The TMS service uses a z/x/y tile naming scheme where:

<li>z is the zoom level</li>

<li>x is the column number</li>

<li>y is the row number</li>

</ul>

</div></blockquote>

To activate the TMS service, add these lines to the mapcache.xml configuration

file:

</pre></div>

</div>

A “capabilities” document can be fetched via:

</pre></div>

</div>

Tiles are requested using this scheme:

<div class="highlight-default notranslate"><div class="highlight"><pre>http://myhost.com/mapcache/tms/1.0.0/<tileset_name>@<grid_name>/<z>/<x>/<y>.png

</pre></div>

</div>

For EPSG:3857, EPSG:900913, or GoogleMapsCompatible grids, with cell = [z/x/y]:

z0:

<div class="highlight-default notranslate"><div class="highlight"><pre>[0/0/0]

</pre></div>

</div>

z1:

<div class="highlight-default notranslate"><div class="highlight"><pre>[1/0/0][1/1/0]

[1/0/1][1/1/1]

</pre></div>

</div>

z2:

<div class="highlight-default notranslate"><div class="highlight"><pre>[2/0/0][2/1/0][2/2/0][2/3/0]

[2/0/1][2/1/1][2/2/1][2/3/1]

[2/0/2]...

[2/0/3]...

</pre></div>

</div>

etc…

For EPSG:4326 or WGS84 grids:

Note

The OGC WMTS specification rather absurdly requires the GoogleCRS84Quad

WellKnownScaleset to have a level 0 whose extent is -180,-180,180,180. The

default “WGS84” MapCache grid honors this, which may cause some

incompatibilities with software that expects level 0 to be 2x1 tiles with

extent -180,-90,180,90

</div>

z0:

</pre></div>

</div>

z1:

</pre></div>

</div>

z2:

</pre></div>

</div>

etc.

</section>

<h2>KML Service<a class="headerlink" href="#kml-service" title="Link to this heading">¶</a></h2>

The KML service produces <a class="reference external" href="https://developers.google.com/kml/documentation/kml_21tutorial?csw=1#superoverlays">Super-Overlays</a>

for tilesets that are aligned to the WGS84 / EPSG:4326 grids. A Super-Overlay

is a KML file that links to an image URL, and to a set of other KML URLs

corresponding to neighboring resolutions. The KML service uses a z/x/y tile

naming scheme where:

<li>z is the zoom level</li>

<li>x is the column number</li>

<li>y is the row number</li>

</ul>

</div></blockquote>

Note

For the KML service to be functional, the TMS service must also be activated, as

the KML super-overlays link to images using this spec.

</div>

To activate the KML service, add these lines to the mapcache.xml configuration

file:

</pre></div>

</div>

Tiles are requested using this scheme:

<div class="highlight-default notranslate"><div class="highlight"><pre>http://myhost.com/mapcache/kml/<tileset_name>@<grid_name>/<z>/<x>/<y>.kml

</pre></div>

</div>

</section>

<h2>OGC WMTS Service<a class="headerlink" href="#ogc-wmts-service" title="Link to this heading">¶</a></h2>

To activate the WMTS service, add these lines to the mapcache.xml configuration

file:

</pre></div>

</div>

This service follows the standard OGC WMTS requests and supports both the

classical OGC-style key-value-pair encoded and REST-style requests.

<div class="highlight-default notranslate"><div class="highlight"><pre>http://myhost.com/mapcache/wmts?SERVICE=WMTS&VERSION=1.0.0&...

http://myhost.com/mapcache/wmts/1.0.0/....

</pre></div>

</div>

The capabilities are obtained through:

<div class="highlight-default notranslate"><div class="highlight"><pre>http://myhost.com/mapcache/wmts?service=wmts&request=getcapabilities&version=1.0.0

http://myhost.com/mapcache/wmts/1.0.0/WMTSCapabilities.xml

</pre></div>

</div>

See also

<a class="reference internal" href="featureinfo.html#mapcache-featureinfo">FeatureInfo Requests</a>

</div>

See also

<a class="reference internal" href="dimensions.html#mapcache-dimensions">Tileset Dimensions</a>

</div>

</section>

<h2>OGC WMS Service<a class="headerlink" href="#ogc-wms-service" title="Link to this heading">¶</a></h2>

MapCache responds to WMS version 1.1.1 requests, and has limited support for

version 1.3.0 ones.

</pre></div>

</div>

Note

Note that the WMS service is a little different than the

other MapCache services, as it listens on the root of the configured instance

instead of on an additional endpoint (i.e. the service replies on

<a class="reference external" href="http://server/mapcache/">http://server/mapcache/</a>? and not on <a class="reference external" href="http://server/mapcache/wms">http://server/mapcache/wms</a>?). This

behavior is required in order to enable <a class="reference internal" href="proxying.html#mapcache-proxying">proxying of unsupported requests</a> while offering a single endpoint for all OGC services.

</div>

Note

MapCache primarily supports version 1.1.1 WMS requests, but has limited

support for the newer version 1.3.0 ones. For 1.3.0 requests,

MapCache will determine which <a class="reference internal" href="config.html#mapcache-grids">grid</a> to use by using

the CRS= parameter instead of the SRS= one, and will correctly honor axis

ordering for the EPSG reference systems that switch the usual x/y ordering

of the BBOX parameter.

</div>

See also

<a class="reference internal" href="featureinfo.html#mapcache-featureinfo">FeatureInfo Requests</a>

</div>

See also

<a class="reference internal" href="dimensions.html#mapcache-dimensions">Tileset Dimensions</a>

</div>

See also

<a class="reference internal" href="tile_assembling.html#mapcache-tile-assembling">Tile Assembling</a>

</div>

WMS requests follow the classical key-value-pair encoded style:

<div class="highlight-default notranslate"><div class="highlight"><pre>http://myhost.com/mapcache?SERVICE=WMS&VERSION=1.1.1&REQUEST=....

</pre></div>

</div>

The capabilities document is returned by:

<div class="highlight-default notranslate"><div class="highlight"><pre>http://myhost.com/mapcache?service=wms&request=getcapabilities

</pre></div>

</div>

<h3>Optional WMS Configuration Options<a class="headerlink" href="#optional-wms-configuration-options" title="Link to this heading">¶</a></h3>

<h4>Untiled GetMap Support<a class="headerlink" href="#untiled-getmap-support" title="Link to this heading">¶</a></h4>

Support for untiled (non WMS-C) GetMap requests can be enabled or disabled:

<!-- full_wms

Configure response to WMS requests that are not aligned to a tileset's grids.

Responding to requests that are not in the SRS of a configured grid is not supported, but

this should never happen as only the supported SRSs are publicized in the capabilities

document.

Allowed values are:

- error: return a 404 error (default)

- assemble: build the full image by assembling the tiles from the cache

- forward: forward the request to the configured source.

-->

<full_wms>assemble</full_wms>

</service>

</pre></div>

</div>

</section>

<h4>GetMap Image Format<a class="headerlink" href="#getmap-image-format" title="Link to this heading">¶</a></h4>

You may explicitly set which image format should be returned to the client for

an untiled WMS request (i.e. whenever the tile data cannot be served directly

from the caches but needs to go through a decompression/recompression phase).

<format allow_client_override="true/false">myjpegformat</format>

</service>

</pre></div>

</div>

If the <cite>allow_client_override</cite> attribute is set to true, then MapCache will honor

the <cite>FORMAT=…</cite> parameter sent by the client. By default MapCache ignores this

parameter and uses its configured image format.

</section>

<h4>Image Resampling Quality<a class="headerlink" href="#image-resampling-quality" title="Link to this heading">¶</a></h4>

<!-- resample mode

Filter applied when resampling tiles for full WMS requests.

Can be either:

- nearest : fastest, poor quality

- bilinear: slower, higher qulity

-->

<resample_mode>bilinear</resample_mode>

</service>

</pre></div>

</div>

</section>

<h2>GoogleMaps XYZ Service<a class="headerlink" href="#googlemaps-xyz-service" title="Link to this heading">¶</a></h2>

</pre></div>

</div>

Prerequisites: Your WMS should be capable of producing images in the

EPSG:900913 or EPSG:3857 SRS, i.e. it should reference the “g” or

“GoogleMapsCompatible” grid.

This is the minimal HTML page that should get you going. The important bits are

in the urlTemplate (for V2) and getTileURL (for V3) variables:

<li>/mapcache is the Apache path where MapCache handles requests.</li>

<li>test@g is the tileset and grid name to use, joined by a ‘@’ - the {Z}/{X}/{Y}

should be left alone.</li>

<li>The final extension should be changed to “jpg” if you are using a JPEG format

with your tileset.</li>

</ul>

<div class="highlight-html notranslate"><div class="highlight"><pre><!DOCTYPE html

PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

<head>

<title>Google/MapServer Tile Example</title>

type="text/javascript"></script>

function load() {

if (GBrowserIsCompatible()) {

var urlTemplate = '/mapcache/gmaps/test@g/{Z}/{X}/{Y}.png';

var myLayer = new GTileLayer(null,0,18,{

tileUrlTemplate:urlTemplate,

isPng:true,

opacity:0.8 });

var map = new GMap2(document.getElementById("map"));

map.addControl(new GLargeMapControl());

map.setCenter(new GLatLng(0, 0), 1);

map.addOverlay(new GTileLayerOverlay(myLayer));

}

}

</script>

</head>

</body>

</html>

</pre></div>

</div>

</section>

The previous JavaScript for the V2 example should be slightly changed to:

<div class="highlight-javascript notranslate"><div class="highlight"><pre>var map = new google.maps.Map("<element-id>", { /*options*/ });

var layerOptions = {

getTileUrl: function(coord, zoom) {

return "/mapcache/gmaps/test@g/" + zoom + "/" + coord.x + "/" + coord.y + ".png";

},

tileSize: new google.maps.Size(256,256) // or whatever

};

map.overlayMapTypes.insertAt(0, new google.maps.ImageMapType(layerOptions));

</pre></div>

</div>

</section>

<h2>Virtual Earth tile service<a class="headerlink" href="#virtual-earth-tile-service" title="Link to this heading">¶</a></h2>

Tiles are organized in one of two different layouts depending on whether they

are using a Spherical Mercator projection, like EPSG:3857 or EPSG:900913, or if

they are using a geographical projection, like EPSG:4326.

Tiles are requested using this scheme:

<div class="highlight-default notranslate"><div class="highlight"><pre>http://myhost.com/mapcache/ve?LAYER=<tileset_name>@<grid_name>&tile=<quadkey>

</pre></div>

</div>

For EPSG:3857, EPSG:900913, or GoogleMapsCompatible grids, <quadkey> are

arranged:

z0:

<div class="highlight-default notranslate"><div class="highlight"><pre>[0]

http://myhost.com/mapcache/ve?LAYER=osm@GoogleMapsCompatible&tile=0

</pre></div>

</div>

z1:

<div class="highlight-default notranslate"><div class="highlight"><pre>[00][01]

[02][03]

http://myhost.com/mapcache/ve?LAYER=osm@GoogleMapsCompatible&tile=00

http://myhost.com/mapcache/ve?LAYER=osm@GoogleMapsCompatible&tile=01

http://myhost.com/mapcache/ve?LAYER=osm@GoogleMapsCompatible&tile=02

http://myhost.com/mapcache/ve?LAYER=osm@GoogleMapsCompatible&tile=03

</pre></div>

</div>

<div class="highlight-default notranslate"><div class="highlight"><pre>etc.

</pre></div>

</div>

For EPSG:4326 or WGS84 grids, <quadkey> are arranged:

z1:

<div class="highlight-default notranslate"><div class="highlight"><pre>[0][1]

http://myhost.com/mapcache/ve?LAYER=osm@WGS84&tile=0

http://myhost.com/mapcache/ve?LAYER=osm@WGS84&tile=1

</pre></div>

</div>

z2:

<div class="highlight-default notranslate"><div class="highlight"><pre>[00][01][10][11]

[02][03][12][13]

http://myhost.com/mapcache/ve?LAYER=osm@WGS84&tile=00

http://myhost.com/mapcache/ve?LAYER=osm@WGS84&tile=01

http://myhost.com/mapcache/ve?LAYER=osm@WGS84&tile=02

http://myhost.com/mapcache/ve?LAYER=osm@WGS84&tile=03

http://myhost.com/mapcache/ve?LAYER=osm@WGS84&tile=10

http://myhost.com/mapcache/ve?LAYER=osm@WGS84&tile=11

http://myhost.com/mapcache/ve?LAYER=osm@WGS84&tile=12

http://myhost.com/mapcache/ve?LAYER=osm@WGS84&tile=13

</pre></div>

</div>

<div class="highlight-default notranslate"><div class="highlight"><pre>etc.

</pre></div>

</div>

</section>

</div>

<h3 id="searchlabel">Quick search</h3>

</form>

</div>

</search>

<a href="../about.html" title="About">About</a>

<a href="../products.html" title="Products">Products</a>

<a href="../community/index.html" title="Community">Community</a>

<a href="../development/index.html" title="Development">Development</a>

<a href="../download.html" title="Downloads">Downloads</a>

<a href="../documentation.html" title="Documentation">Documentation</a>

<a href="https://fosstodon.org/@mapserver" title="Mastodon">Mastodon</a>

<h3>Current Table Of Contents</h3>

<ul>

<li><a class="reference internal" href="#">Supported Tile Services</a><ul>

<li><a class="reference internal" href="#tms-service">TMS Service</a></li>

<li><a class="reference internal" href="#kml-service">KML Service</a></li>

<li><a class="reference internal" href="#ogc-wmts-service">OGC WMTS Service</a></li>

<li><a class="reference internal" href="#ogc-wms-service">OGC WMS Service</a><ul>

<li><a class="reference internal" href="#optional-wms-configuration-options">Optional WMS Configuration Options</a><ul>

<li><a class="reference internal" href="#untiled-getmap-support">Untiled GetMap Support</a></li>

<li><a class="reference internal" href="#getmap-image-format">GetMap Image Format</a></li>

<li><a class="reference internal" href="#image-resampling-quality">Image Resampling Quality</a></li>

</ul>

</li>

</ul>

</li>

<li><a class="reference internal" href="#googlemaps-xyz-service">GoogleMaps XYZ Service</a><ul>

</ul>

</li>

<li><a class="reference internal" href="#virtual-earth-tile-service">Virtual Earth tile service</a></li>

</ul>

</li>

</ul>

</div>

</div>

<h3>Navigation</h3>

<ul>

<a href="../genindex.html" title="General Index"

>index</a></li>

<a href="seed.html" title="Seeder"

>next</a> |</li>

<a href="config.html" title="Configuration File"

>previous</a> |</li>

<li class="nav-item nav-item-1"><a href="../documentation.html" >MapServer 8.6.1 Documentation</a> »</li>

<li class="nav-item nav-item-2"><a href="index.html" >MapCache 1.14.1</a> »</li>

<li class="nav-item nav-item-this"><a href="">Supported Tile Services</a></li>

</ul>

</div>

Last updated on 2026-03-30.

Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.

</div>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

services.html

Latest commit

History

services.html

File metadata and controls