Mapspace API Reference

Namespace: source

Mapspace.ortho. source

This is the namespace that contains specific ortho sources to be viewed in a Mapspace.ortho.Viewer.

Source:
mapspace-ortho/source/bu.ortho.source.jsdoc

Classes

TileImage
WMTS

Type Definitions

TileImageOptions

Options for Mapspace.ortho.source.TileImage.

Properties:
Name Type Description
attributions ol.AttributionLike | undefined

Attributions.
cacheSize number | undefined

Cache size. Default is 2048.
crossOrigin string | null | undefined

The crossOrigin attribute for loaded images. Note that you must provide a crossOrigin value if you are using the WebGL renderer or if you want to access pixel data with the Canvas renderer. See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
logo string | olx.LogoOptions | undefined

Logo.
opaque boolean | undefined

Whether the layer is opaque.
projection ol.ProjectionLike

Projection.
reprojectionErrorThreshold number | undefined

Maximum allowed reprojection error (in pixels). Default is 0.5. Higher values can increase reprojection performance, but decrease precision.
state ol.source.State | undefined

Source state.
tileClass function | undefined

Class used to instantiate image tiles. Default is ol.ImageTile.
tileGrid ol.tilegrid.TileGrid | undefined

Tile grid.
tileLoadFunction ol.TileLoadFunctionType | undefined

Optional function to load a tile given a URL. The default is

function(imageTile, src) {
  imageTile.getImage().src = src;
};
tilePixelRatio number | undefined

The pixel ratio used by the tile service. For example, if the tile service advertizes 256px by 256px tiles but actually sends 512px by 512px images (for retina/hidpi devices) then tilePixelRatio should be set to 2. Default is 1.
tileUrlFunction ol.TileUrlFunctionType | undefined

Optional function to get tile URL given a tile coordinate and the projection.
url string | undefined

URL template. Must include {x}, {y} or {-y}, and {z} placeholders. A {?-?} template pattern, for example subdomain{a-f}.domain.com, may be used instead of defining each one separately in the urls option.
urls Array.<string> | undefined

An array of URL templates.
wrapX boolean | undefined

Whether to wrap the world horizontally. The default, undefined, is to request out-of-bounds tiles from the server. When set to false, only one world will be rendered. When set to true, tiles will be requested for one world only, but they will be wrapped horizontally to render multiple worlds.
imagerySet string | undefined

Type of imagery.
autoSwitchLayer boolean | undefined

If auto switcher this source when rotation changes.
Source:
mapspace-ortho/typedefs.js

WMTSEventType

Event types for a ol.ortho.source.WMTS.

Name Value Description
Mapspace.ortho.source.WMTSEventType.CAPABILITIESLOADED capabilitiesloaded The capabilities request has ended
Mapspace.ortho.source.WMTSEventType.OPTIONSCHANGED optionschanged The URL params have changed
Source:
mapspace-ortho/enums.js

WMTSOptions

Options for Mapspace.ortho.source.WMTS.

Properties:
Name Type Description
attributions ol.AttributionLike | undefined

Attributions.
cacheSize number | undefined

Cache size. Default is 2048.
crossOrigin string | null | undefined

The crossOrigin attribute for loaded images. Note that you must provide a crossOrigin value if you are using the WebGL renderer or if you want to access pixel data with the Canvas renderer. See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
logo string | olx.LogoOptions | undefined

Logo.
tileGrid ol.tilegrid.WMTS

Tile grid.
projection ol.ProjectionLike

Projection.
reprojectionErrorThreshold number | undefined

Maximum allowed reprojection error (in pixels). Default is 0.5. Higher values can increase reprojection performance, but decrease precision.
requestEncoding ol.source.WMTSRequestEncoding | string | undefined

Request encoding. Default is KVP.
layer string

Layer name as advertised in the WMTS capabilities.
style string

Style name as advertised in the WMTS capabilities.
tileClass function | undefined

Class used to instantiate image tiles. Default is ol.ImageTile.
tilePixelRatio number | undefined

The pixel ratio used by the tile service. For example, if the tile service advertizes 256px by 256px tiles but actually sends 512px by 512px images (for retina/hidpi devices) then tilePixelRatio should be set to 2. Default is 1.
version string | undefined

WMTS version. Default is 1.0.0.
format string | undefined

Image format. Default is image/jpeg.
matrixSet string

Matrix set.
dimensions Object | undefined

Additional "dimensions" for tile requests. This is an object with properties named like the advertised WMTS dimensions.
url string | undefined

URL template. Must include {x}, {y} or {-y}, and {z} placeholders. A {?-?} template pattern, for example subdomain{a-f}.domain.com, may be used instead of defining each one separately in the urls option.
tileLoadFunction ol.TileLoadFunctionType | undefined

Optional function to load a tile given a URL. The default is

function(imageTile, src) {
  imageTile.getImage().src = src;
};
urls Array.<string> | undefined

An array of URL templates.
wrapX boolean | undefined

Whether to wrap the world horizontally. The default, undefined, is to request out-of-bounds tiles from the server. When set to false, only one world will be rendered. When set to true, tiles will be requested for one world only, but they will be wrapped horizontally to render multiple worlds.
userLayerName string | undefined

Name of the user layer currently loaded in this source, if any.
serverLayer string | undefined

The server layer is each collection of related data that is stored in Mapspace servers. This attribute is parametrized in the URL requests as a BASELAYER param.
serverTime string | undefined

This time is the filter to add to current time filter in the viewer. Both time filters are merged.
serverExtent ol.geom.Polygon | undefined

The server extent is a Polygon geometry that defines the limit of the server layer. Tiles should not be requested outside this extent. If not defined then all the tiles can be requested.
overlay string | undefined

Overlay name.
time string | undefined

This time is the filter from the viewer that will be merged with the serverTime.
autoSwitchLayer boolean | undefined

If auto switcher this source when rotation changes.
preCachedLevels number | undefined

Number of zoom levels that should be pre cached each time the capabilities response returns. If no defined then none zoom level will be pre-cached.
Source:
mapspace-ortho/typedefs.js