Rename method and make it appear in the API docs

This commit is contained in:
Andreas Hocevar
2017-12-01 17:01:26 +01:00
parent 343a4085a0
commit 8a9f32fa09
3 changed files with 12 additions and 4 deletions

View File

@@ -2,4 +2,8 @@ goog.provide('ol.style');
goog.require('ol.style.IconImageCache');
/**
* The {@link ol.style.IconImageCache} for {@link ol.style.Icon} images.
* @api
*/
ol.style.iconImageCache = new ol.style.IconImageCache();

View File

@@ -4,6 +4,7 @@ goog.require('ol.color');
/**
* Singleton class. Available through {@link ol.style.iconImageCache}.
* @constructor
*/
ol.style.IconImageCache = function() {
@@ -93,10 +94,13 @@ ol.style.IconImageCache.prototype.set = function(src, crossOrigin, color, iconIm
/**
* Set cache max size.
* Set the cache size of the icon cache. Default is `32`. Change this value when
* your map uses more than 32 different icon images and you are not caching icon
* styles on the application level.
* @param {number} maxCacheSize Cache max size.
* @api
*/
ol.style.IconImageCache.prototype.setMaxCacheSize = function(maxCacheSize) {
ol.style.IconImageCache.prototype.setSize = function(maxCacheSize) {
this.maxCacheSize_ = maxCacheSize;
this.expire();
};