diff --git a/src/ol/style/fillstyle.js b/src/ol/style/fillstyle.js index ea17853918..6714445868 100644 --- a/src/ol/style/fillstyle.js +++ b/src/ol/style/fillstyle.js @@ -32,10 +32,7 @@ ol.style.Fill.prototype.getColor = function() { /** - * Set the color. When this style is used as a layer, feature or ImageVector - * source style, call `changed()` on the layer, feature or ImageVector source - * for the change to take effect. When used as a FeatureOverlay style, call - * `render()` on the map. + * Set the color. * * @param {ol.Color|string} color Color. * @api diff --git a/src/ol/style/imagestyle.js b/src/ol/style/imagestyle.js index 443f5f92ec..2f57b34337 100644 --- a/src/ol/style/imagestyle.js +++ b/src/ol/style/imagestyle.js @@ -151,10 +151,7 @@ ol.style.Image.prototype.getSize = goog.abstractMethod; /** - * Set the opacity. When this style is used as a layer, feature or ImageVector - * source style, call `changed()` on the layer, feature or ImageVector source - * for the change to take effect. When used as a FeatureOverlay style, call - * `render()` on the map. + * Set the opacity. * * @param {number} opacity Opacity. */ @@ -164,10 +161,7 @@ ol.style.Image.prototype.setOpacity = function(opacity) { /** - * Set whether to rotate the style with the view. When this style is used as a - * layer, feature or ImageVector source style, call `changed()` on the layer, - * feature or ImageVector source for the change to take effect. When used as a - * FeatureOverlay style, call `render()` on the map. + * Set whether to rotate the style with the view. * * @param {boolean} rotateWithView Rotate with map. */ @@ -177,10 +171,7 @@ ol.style.Image.prototype.setRotateWithView = function(rotateWithView) { /** - * Set the rotation. When this style is used as a layer, feature or ImageVector - * source style, call `changed()` on the layer, feature or ImageVector source - * for the change to take effect. When used as a FeatureOverlay style, call - * `render()` on the map. + * Set the rotation. * * @param {number} rotation Rotation. * @api @@ -191,10 +182,7 @@ ol.style.Image.prototype.setRotation = function(rotation) { /** - * Set the scale. When this style is used as a layer, feature or ImageVector - * source style, call `changed()` on the layer, feature or ImageVector source - * for the change to take effect. When used as a FeatureOverlay style, call - * `render()` on the map. + * Set the scale. * * @param {number} scale Scale. * @api @@ -205,10 +193,7 @@ ol.style.Image.prototype.setScale = function(scale) { /** - * Set whether to snap the image to the closest pixel. When this style is used - * as a layer, feature or ImageVector source style, call `changed()` on the - * layer, feature or ImageVector source for the change to take effect. When used - * as a FeatureOverlay style, call `render()` on the map. + * Set whether to snap the image to the closest pixel. * * @param {boolean} snapToPixel Snap to pixel? */ diff --git a/src/ol/style/strokestyle.js b/src/ol/style/strokestyle.js index eeb58776ba..15e99bf260 100644 --- a/src/ol/style/strokestyle.js +++ b/src/ol/style/strokestyle.js @@ -110,10 +110,7 @@ ol.style.Stroke.prototype.getWidth = function() { /** - * Set the color. When this style is used as a layer, feature or ImageVector - * source style, call `changed()` on the layer, feature or ImageVector source - * for the change to take effect. When used as a FeatureOverlay style, call - * `render()` on the map. + * Set the color. * * @param {ol.Color|string} color Color. * @api @@ -124,10 +121,7 @@ ol.style.Stroke.prototype.setColor = function(color) { /** - * Set the line cap. When this style is used as a layer, feature or ImageVector - * source style, call `changed()` on the layer, feature or ImageVector source - * for the change to take effect. When used as a FeatureOverlay style, call - * `render()` on the map. + * Set the line cap. * * @param {string|undefined} lineCap Line cap. * @api @@ -138,10 +132,7 @@ ol.style.Stroke.prototype.setLineCap = function(lineCap) { /** - * Set the line dash. When this style is used as a layer, feature or ImageVector - * source style, call `changed()` on the layer, feature or ImageVector source - * for the change to take effect. When used as a FeatureOverlay style, call - * `render()` on the map. + * Set the line dash. * * @param {Array.} lineDash Line dash. * @api @@ -152,10 +143,7 @@ ol.style.Stroke.prototype.setLineDash = function(lineDash) { /** - * Set the line join. When this style is used as a layer, feature or ImageVector - * source style, call `changed()` on the layer, feature or ImageVector source - * for the change to take effect. When used as a FeatureOverlay style, call - * `render()` on the map. + * Set the line join. * * @param {string|undefined} lineJoin Line join. * @api @@ -166,10 +154,7 @@ ol.style.Stroke.prototype.setLineJoin = function(lineJoin) { /** - * Set the miter limit. When this style is used as a layer, feature or - * ImageVector source style, call `changed()` on the layer, feature or - * ImageVector source for the change to take effect. When used as a - * FeatureOverlay style, call `render()` on the map. + * Set the miter limit. * * @param {number|undefined} miterLimit Miter limit. * @api @@ -180,10 +165,7 @@ ol.style.Stroke.prototype.setMiterLimit = function(miterLimit) { /** - * Set the width. When this style is used as a layer, feature or ImageVector - * source style, call `changed()` on the layer, feature or ImageVector source - * for the change to take effect. When used as a FeatureOverlay style, call - * `render()` on the map. + * Set the width. * * @param {number|undefined} width Width. * @api diff --git a/src/ol/style/style.js b/src/ol/style/style.js index 653e2818b8..ad45b198c4 100644 --- a/src/ol/style/style.js +++ b/src/ol/style/style.js @@ -12,7 +12,9 @@ goog.require('ol.style.Stroke'); /** * @classdesc - * Container for vector feature rendering styles. + * Container for vector feature rendering styles. Any changes made to the style + * or its children through `set*()` methods will not take effect until the + * feature, layer or FeatureOverlay that uses the style is re-rendered. * * @constructor * @param {olx.style.StyleOptions=} opt_options Style options. @@ -101,10 +103,7 @@ ol.style.Style.prototype.getZIndex = function() { /** - * Set the zIndex. When this style is used as a layer, feature or ImageVector - * source style, call `changed()` on the layer, feature or ImageVector source - * for the change to take effect. When used as a FeatureOverlay style, call - * `render()` on the map. + * Set the zIndex. * * @param {number|undefined} zIndex ZIndex. * @api diff --git a/src/ol/style/textstyle.js b/src/ol/style/textstyle.js index a95fcc2291..df849d9650 100644 --- a/src/ol/style/textstyle.js +++ b/src/ol/style/textstyle.js @@ -165,10 +165,7 @@ ol.style.Text.prototype.getTextBaseline = function() { /** - * Set the font. When this style is used as a layer, feature or ImageVector - * source style, call `changed()` on the layer, feature or ImageVector source - * for the change to take effect. When used as a FeatureOverlay style, call - * `render()` on the map. + * Set the font. * * @param {string|undefined} font Font. * @api @@ -179,10 +176,7 @@ ol.style.Text.prototype.setFont = function(font) { /** - * Set the x offset. When this style is used as a layer, feature or ImageVector - * source style, call `changed()` on the layer, feature or ImageVector source - * for the change to take effect. When used as a FeatureOverlay style, call - * `render()` on the map. + * Set the x offset. * * @param {number} offsetX Horizontal text offset. */ @@ -192,10 +186,7 @@ ol.style.Text.prototype.setOffsetX = function(offsetX) { /** - * Set the y offset. When this style is used as a layer, feature or ImageVector - * source style, call `changed()` on the layer, feature or ImageVector source - * for the change to take effect. When used as a FeatureOverlay style, call - * `render()` on the map. + * Set the y offset. * * @param {number} offsetY Vertical text offset. */ @@ -205,10 +196,7 @@ ol.style.Text.prototype.setOffsetY = function(offsetY) { /** - * Set the fill. When this style is used as a layer, feature or ImageVector - * source style, call `changed()` on the layer, feature or ImageVector source - * for the change to take effect. When used as a FeatureOverlay style, call - * `render()` on the map. + * Set the fill. * * @param {ol.style.Fill} fill Fill style. * @api @@ -219,10 +207,7 @@ ol.style.Text.prototype.setFill = function(fill) { /** - * Set the rotation. When this style is used as a layer, feature or ImageVector - * source style, call `changed()` on the layer, feature or ImageVector source - * for the change to take effect. When used as a FeatureOverlay style, call - * `render()` on the map. + * Set the rotation. * * @param {number|undefined} rotation Rotation. * @api @@ -233,10 +218,7 @@ ol.style.Text.prototype.setRotation = function(rotation) { /** - * Set the scale. When this style is used as a layer, feature or ImageVector - * source style, call `changed()` on the layer, feature or ImageVector source - * for the change to take effect. When used as a FeatureOverlay style, call - * `render()` on the map. + * Set the scale. * * @param {number|undefined} scale Scale. * @api @@ -247,10 +229,7 @@ ol.style.Text.prototype.setScale = function(scale) { /** - * Set the stroke. When this style is used as a layer, feature or ImageVector - * source style, call `changed()` on the layer, feature or ImageVector source - * for the change to take effect. When used as a FeatureOverlay style, call - * `render()` on the map. + * Set the stroke. * * @param {ol.style.Stroke} stroke Stroke style. * @api @@ -261,10 +240,7 @@ ol.style.Text.prototype.setStroke = function(stroke) { /** - * Set the text. When this style is used as a layer, feature or ImageVector - * source style, call `changed()` on the layer, feature or ImageVector source - * for the change to take effect. When used as a FeatureOverlay style, call - * `render()` on the map. + * Set the text. * * @param {string|undefined} text Text. * @api @@ -275,10 +251,7 @@ ol.style.Text.prototype.setText = function(text) { /** - * Set the text alignment. When this style is used as a layer, feature or - * ImageVector source style, call `changed()` on the layer, feature or - * ImageVector source for the change to take effect. When used as a - * FeatureOverlay style, call `render()` on the map. + * Set the text alignment. * * @param {string|undefined} textAlign Text align. * @api @@ -289,10 +262,7 @@ ol.style.Text.prototype.setTextAlign = function(textAlign) { /** - * Set the text baseline. When this style is used as a layer, feature or - * ImageVector source style, call `changed()` on the layer, feature or - * ImageVector source for the change to take effect. When used as a - * FeatureOverlay style, call `render()` on the map. + * Set the text baseline. * * @param {string|undefined} textBaseline Text baseline. * @api