Skip to content

Documentation / @geoverse/core-ol / SuperMapRestOptions

Interface: SuperMapRestOptions

Defined in: packages/core-ol/src/sources/supermapRest.ts:10

Extends

  • Options

Properties

attributions?

ts
optional attributions?: AttributionLike;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/TileImage.d.ts:11

Attributions.

Inherited from

ts
TileImageOptions.attributions

attributionsCollapsible?

ts
optional attributionsCollapsible?: boolean;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/TileImage.d.ts:15

Attributions are collapsible.

Inherited from

ts
TileImageOptions.attributionsCollapsible

cacheEnabled?

ts
optional cacheEnabled?: boolean;

Defined in: packages/core-ol/src/sources/supermapRest.ts:23


cacheSize?

ts
optional cacheSize?: number;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/TileImage.d.ts:19

Deprecated. Use the cacheSize option on the layer instead.

Inherited from

ts
TileImageOptions.cacheSize

crossOrigin?

ts
optional crossOrigin?: string | null;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/TileImage.d.ts:25

The crossOrigin attribute for loaded images. Note that you must provide a crossOrigin value 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.

Inherited from

ts
TileImageOptions.crossOrigin

extent?

ts
optional extent?: Extent;

Defined in: packages/core-ol/src/sources/supermapRest.ts:18

数据范围


format?

ts
optional format?: string;

Defined in: packages/core-ol/src/sources/supermapRest.ts:14

瓦片格式,默认 png


interpolate?

ts
optional interpolate?: boolean;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/TileImage.d.ts:34

Use interpolated values when resampling. By default, linear interpolation is used when resampling. Set to false to use the nearest neighbor instead.

Inherited from

ts
TileImageOptions.interpolate

key?

ts
optional key?: string;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/TileImage.d.ts:103

Optional tile key for proper cache fetching

Inherited from

ts
TileImageOptions.key

layersID?

ts
optional layersID?: string | number;

Defined in: packages/core-ol/src/sources/supermapRest.ts:25


overlapDisplayed?

ts
optional overlapDisplayed?: boolean;

Defined in: packages/core-ol/src/sources/supermapRest.ts:26


overlapDisplayedOptions?

ts
optional overlapDisplayedOptions?: {
  toString: string;
};

Defined in: packages/core-ol/src/sources/supermapRest.ts:27

toString()

ts
toString(): string;
Returns

string


prjCoordSys?

ts
optional prjCoordSys?: object;

Defined in: packages/core-ol/src/sources/supermapRest.ts:24


projection?

ts
optional projection?: ProjectionLike;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/TileImage.d.ts:38

Projection. Default is the view projection.

Inherited from

ts
TileImageOptions.projection

redirect?

ts
optional redirect?: boolean;

Defined in: packages/core-ol/src/sources/supermapRest.ts:21


referrerPolicy?

ts
optional referrerPolicy?: ReferrerPolicy;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/TileImage.d.ts:29

The referrerPolicy property for loaded images.

Inherited from

ts
TileImageOptions.referrerPolicy

reprojectionErrorThreshold?

ts
optional reprojectionErrorThreshold?: number;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/TileImage.d.ts:43

Maximum allowed reprojection error (in pixels). Higher values can increase reprojection performance, but decrease precision.

Inherited from

ts
TileImageOptions.reprojectionErrorThreshold

serverType?

ts
optional serverType?: string;

Defined in: packages/core-ol/src/sources/supermapRest.ts:16

服务类型,默认 ISERVER


sourceUrl?

ts
optional sourceUrl?: string;

Defined in: packages/core-ol/src/sources/supermapRest.ts:12

iServer 服务地址(…/rest/maps/{mapName})


state?

ts
optional state?: State;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/TileImage.d.ts:47

Source state.

Inherited from

ts
TileImageOptions.state

tileClass?

ts
optional tileClass?: typeof ImageTile;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/TileImage.d.ts:52

Class used to instantiate image tiles. Default is module :ol/ImageTile~ImageTile.

Inherited from

ts
TileImageOptions.tileClass

tileGrid?

ts
optional tileGrid?: TileGrid;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/TileImage.d.ts:56

Tile grid.

Inherited from

ts
TileImageOptions.tileGrid

tileLoadFunction?

ts
optional tileLoadFunction?: LoadFunction;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/TileImage.d.ts:65

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

js
function(imageTile, src) {
imageTile.getImage().src = src;
};

Inherited from

ts
TileImageOptions.tileLoadFunction

tilePixelRatio?

ts
optional tilePixelRatio?: number;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/TileImage.d.ts:72

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.

Inherited from

ts
TileImageOptions.tilePixelRatio

tileProxy?

ts
optional tileProxy?: string;

Defined in: packages/core-ol/src/sources/supermapRest.ts:20

瓦片代理前缀


tileUrlFunction?

ts
optional tileUrlFunction?: UrlFunction;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/TileImage.d.ts:77

Deprecated. Use an ImageTile source and provide a function for the url option instead.

Inherited from

ts
TileImageOptions.tileUrlFunction

tileversion?

ts
optional tileversion?: string;

Defined in: packages/core-ol/src/sources/supermapRest.ts:28


transition?

ts
optional transition?: number;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/TileImage.d.ts:99

Duration of the opacity transition for rendering. To disable the opacity transition, pass transition: 0.

Inherited from

ts
TileImageOptions.transition

transparent?

ts
optional transparent?: boolean;

Defined in: packages/core-ol/src/sources/supermapRest.ts:22


url?

ts
optional url?: string;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/TileImage.d.ts:83

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.

Inherited from

ts
TileImageOptions.url

urls?

ts
optional urls?: string[];

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/TileImage.d.ts:87

An array of URL templates.

Inherited from

ts
TileImageOptions.urls

wrapX?

ts
optional wrapX?: boolean;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/TileImage.d.ts:94

Whether to wrap the world horizontally. The default, 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.

Inherited from

ts
TileImageOptions.wrapX

zDirection?

ts
optional zDirection?: number | NearestDirectionFunction;

Defined in: node_modules/.pnpm/ol@10.9.0/node_modules/ol/source/TileImage.d.ts:108

Choose whether to use tiles with a higher or lower zoom level when between integer zoom levels. See module :ol/tilegrid/TileGrid~TileGrid#getZForResolution.

Inherited from

ts
TileImageOptions.zDirection