Last updated

API / geotoolkit / scene / shapes / tiledshape / TiledShape / TiledShape

Namespace: TiledShape

tiledshape.TiledShape.TiledShape

Table of contents

Namespaces
Type Aliases

Contents

Type Aliases

CommonManagerOptions

Ƭ CommonManagerOptions<TFormatResult>: Object

object with parameters

Type parameters

NameType
TFormatResultextends object = ImageData

Type declaration

NameTypeDescription
asynctimeout?numbertime to wait for loading tiles (for async rendering)
base64?booleanSet to true if server provide base64 encoded string instead of raw image
capacity?numberNumber of tiles stored in cache (0 - endless capacity)
errimgsrc?stringsource for error image (it will be rendered if tile is not available)
formatter?Formatter<TFormatResult>Instance of tile formatter
httpservice?AbstractHttpServicehttp service to make any HTTP request
maxnumreq?numberMaximum number of requests that can be sent at the same time
timeout?numbertimeout of next request, if server isn't available
tries?numbertries of downloading image, if server isn't available

DelayCallback

Ƭ DelayCallback: (data: ImageData) => number

Type declaration

▸ (data): number

Need to delay request callback

Parameters
Name Type
dataImageData
Returns

number


EventMap

Ƭ EventMap: EventMap & { FirstTileLoading: null ; LastTileRendered: { tilescancelling?: Record<string, number> ; tilesloading?: Record<string, number> ; tilesrendering?: Record<string, number> ; time?: number } ; TileCancelled: { modelarea: Rect ; time: number } ; TileLoaded: { modelarea: Rect ; time: number } ; TileLoading: { modelarea: Rect } ; TileRendered: { modelarea: Rect ; time: number } ; TileRendering: { modelarea: Rect } }


Formatter

Ƭ Formatter<TLoaderFormat>: (data: ImageData) => TLoaderFormat | string

Type parameters

NameType
TLoaderFormatextends object = ImageData

Type declaration

▸ (data): TLoaderFormat | string

Parameters
Name Type
dataImageData
Returns

TLoaderFormat | string


ImageCallback

Ƭ ImageCallback<TLoaderFormat>: (data: ImageLoadData<TLoaderFormat>, callback: ImageLoadedCallback) => Promise<any> | Cancel | void

Type parameters

NameType
TLoaderFormatextends object = ImageData

Type declaration

▸ (data, callback): Promise<any> | Cancel | void

Image loader callback

Parameters
Name Type
dataImageLoadData<TLoaderFormat>
callbackImageLoadedCallback
Returns

Promise<any> | Cancel | void


ImageData

Ƭ ImageData: Object

data of image

Type declaration

NameTypeDescription
deviceareaRectTile rect in device coordinates
devicetilerect?Rect-
i?number-
id?number | stringid of image
j?number-
options?any-
tilerectRectmodel area of image
transformedmodelrectRectImage rect in device coordinates
z?number-

ImageLoadData

Ƭ ImageLoadData<TLoaderFormat>: Partial<TLoaderFormat> & { cancel?: Cancel ; url?: string }

data

Type parameters

NameType
TLoaderFormatextends object = ImageData

ImageLoadedCallback

Ƭ ImageLoadedCallback: (error?: ErrorCodes | { code: ErrorCodes } | Error | string | null, response?: any) => void

Type declaration

▸ (error?, response?): void

Callback as result of image loaded. it can have error if loading is fail

Parameters
Name Type
Optional errorErrorCodes | { code: ErrorCodes } | Error | string | null
Optional responseany
Returns

void


OSMManagerOptions

Ƭ OSMManagerOptions<TFormatResult>: CommonManagerOptions<TFormatResult> & { extendedrenderingborders?: number ; maxlod?: number ; minlod?: number ; tileh?: number ; tilew?: number }

object with parameters

Type parameters

NameType
TFormatResultextends object = ImageData

Options

Ƭ Options<TFormatResult>: Options & ReceiverOptions<TFormatResult> & TileManagerOptions<TFormatResult> | Options<TFormatResult> | OSMManagerOptions<TFormatResult> & { delaycallback?: DelayCallback ; imageloader?: ImageCallback<TFormatResult> }

object with parameters

Type parameters

NameType
TFormatResultextends object = ImageData

ReceiverOptions

Ƭ ReceiverOptions<TFormatResult>: Object

object with parameters

Type parameters

NameType
TFormatResultextends object = ImageData

Type declaration

NameTypeDescription
cancellationstrategy?AbstractCancellationStrategystrategy for cancelling of requests
delaycallback?DelayCallbackdelay callback
errimgsrc?stringsource for error image (it will be rendered if tile is not available)
formatter?Formatter<TFormatResult>Instance of tile formatter
httpservice?AbstractHttpServicehttp service to make any HTTP request
imageloader?ImageCallback<TFormatResult>image loader callback
loadertype?LoaderTypetype for tile loader
maxnumreq?numberMaximum number of requests that can be sent at the same time
timeout?numbertimeout of next request, if server isn't available
tries?numbertries of downloading image, if server isn't available

TileManagerOptions

Ƭ TileManagerOptions<TFormatResult>: CommonManagerOptions<TFormatResult> & { extendedrenderingborders?: number ; freezeupdate?: boolean ; isconsttiles?: boolean ; tileh?: number ; tilew?: number }

Type parameters

NameType
TFormatResultextends object = ImageData