CachingConfiguration

constructor()

Creates a default CachingConfiguration.

Important: This is a Public Preview API. It may be changed or removed at any time.


constructor(storageConfiguration: CacheStorageConfiguration = DEFAULT_CACHE_STORAGE_CONFIGURATION, maxMemorySize: Memory = DEFAULT_CACHE_MEMORY_MAX_SIZE)

Creates a new CachingConfiguration.

Parameters

storageConfiguration

Persistent cache storage configuration. CacheStorageConfiguration configures path and maximum disk size of the persistent cache storage. If the parameter is omitted, the default persistent cache storage configuration is used.

maxMemorySize

Size limit for the in-memory tile store. The parameter defaults to DEFAULT_CACHE_MEMORY_MAX_SIZE. It behaves like a soft limit, ensuring that essential data is preserved in memory, even if it surpasses the specified limit. A very small limit may lead to increased disk reading, as tiles are promptly removed from memory once they are no longer immediately required. An excessively high limit may result in tiles occupying a significant amount of memory over an extended period.


constructor(cacheMemoryMaxSize: Memory = DEFAULT_CACHE_MEMORY_MAX_SIZE, cacheStorageConfiguration: CacheStorageConfiguration? = DEFAULT_CACHE_STORAGE_CONFIGURATION, tileRefreshPeriod: Duration = DEFAULT_TILE_REFRESH_PERIOD)

Creates a new CachingConfiguration. Important: This is a Public Preview API. It may be changed or removed at any time.

Parameters

cacheMemoryMaxSize

Size limit for the in-memory tile store. The parameter defaults to DEFAULT_CACHE_MEMORY_MAX_SIZE. It behaves like a soft limit, ensuring that essential data is preserved in memory, even if it surpasses the specified limit. A very small limit may lead to increased disk reading, as tiles are promptly removed from memory once they are no longer immediately required. An excessively high limit may result in tiles occupying a significant amount of memory over an extended period.

cacheStorageConfiguration

Persistent cache storage configuration. CacheStorageConfiguration configures path and maximum disk size of the persistent cache storage. If the parameter is omitted, the default persistent cache storage configuration is used. If the parameter is set to null, persistent cache storage is NOT used.

tileRefreshPeriod

The period after which a downloaded tile is considered stale and automatically triggers a refresh when accessed. The parameter defaults to DEFAULT_TILE_REFRESH_PERIOD. WARNING: This parameter has effect only with the NdsLiveFeature feature toggle enabled.


constructor(cacheMemoryMaxSize: Memory = DEFAULT_CACHE_MEMORY_MAX_SIZE, cacheStorageConfiguration: CacheStorageConfiguration? = DEFAULT_CACHE_STORAGE_CONFIGURATION)

Deprecated

This will be removed 6 months after the next release.

Replace with

CachingConfiguration(storageConfiguration, maxMemorySize)

Creates a new CachingConfiguration.