diff --git a/src/ol/style/fillstyle.js b/src/ol/style/fillstyle.js index 1825110453..ea17853918 100644 --- a/src/ol/style/fillstyle.js +++ b/src/ol/style/fillstyle.js @@ -32,8 +32,10 @@ ol.style.Fill.prototype.getColor = function() { /** - * Set the color. Call `setStyle()` or `dispatchChangeEvent()` on feature, layer - * or feature overlay for changes to take effect. + * 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. * * @param {ol.Color|string} color Color. * @api diff --git a/src/ol/style/imagestyle.js b/src/ol/style/imagestyle.js index 48b7eb22ba..443f5f92ec 100644 --- a/src/ol/style/imagestyle.js +++ b/src/ol/style/imagestyle.js @@ -151,8 +151,10 @@ ol.style.Image.prototype.getSize = goog.abstractMethod; /** - * Set the zIndex. Call `setStyle()` or `dispatchChangeEvent()` on feature, - * layer or feature overlay for changes to take effect. + * 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. * * @param {number} opacity Opacity. */ @@ -162,9 +164,10 @@ ol.style.Image.prototype.setOpacity = function(opacity) { /** - * Set whether to rotate the style with the view. Call `setStyle()` or - * `dispatchChangeEvent()` on feature, layer or feature overlay for changes to - * take effect. + * 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. * * @param {boolean} rotateWithView Rotate with map. */ @@ -174,8 +177,10 @@ ol.style.Image.prototype.setRotateWithView = function(rotateWithView) { /** - * Set the rotation. Call `setStyle()` or `dispatchChangeEvent()` on feature, - * layer or feature overlay for changes to take effect. + * 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. * * @param {number} rotation Rotation. * @api @@ -186,8 +191,10 @@ ol.style.Image.prototype.setRotation = function(rotation) { /** - * Set the scale. Call `setStyle()` or `dispatchChangeEvent()` on feature, layer - * or feature overlay for changes to take effect. + * 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. * * @param {number} scale Scale. * @api @@ -198,9 +205,10 @@ ol.style.Image.prototype.setScale = function(scale) { /** - * Set whether to snap the image to the closest pixel. Call `setStyle()` or - * `dispatchChangeEvent()` on feature, layer or feature overlay for changes to - * take effect. + * 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. * * @param {boolean} snapToPixel Snap to pixel? */ diff --git a/src/ol/style/strokestyle.js b/src/ol/style/strokestyle.js index 3740f77e5b..eeb58776ba 100644 --- a/src/ol/style/strokestyle.js +++ b/src/ol/style/strokestyle.js @@ -110,8 +110,10 @@ ol.style.Stroke.prototype.getWidth = function() { /** - * Set the color. Call `setStyle()` or `dispatchChangeEvent()` on feature, layer - * or feature overlay for changes to take effect. + * 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. * * @param {ol.Color|string} color Color. * @api @@ -122,8 +124,10 @@ ol.style.Stroke.prototype.setColor = function(color) { /** - * Set the line cap. Call `setStyle()` or `dispatchChangeEvent()` on feature, - * layer or feature overlay for changes to take effect. + * 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. * * @param {string|undefined} lineCap Line cap. * @api @@ -134,8 +138,10 @@ ol.style.Stroke.prototype.setLineCap = function(lineCap) { /** - * Set the line dash. Call `setStyle()` or `dispatchChangeEvent()` on feature, - * layer or feature overlay for changes to take effect. + * 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. * * @param {Array.} lineDash Line dash. * @api @@ -146,8 +152,10 @@ ol.style.Stroke.prototype.setLineDash = function(lineDash) { /** - * Set the line join. Call `setStyle()` or `dispatchChangeEvent()` on feature, - * layer or feature overlay for changes to take effect. + * 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. * * @param {string|undefined} lineJoin Line join. * @api @@ -158,8 +166,10 @@ ol.style.Stroke.prototype.setLineJoin = function(lineJoin) { /** - * Set the miter limit. Call `setStyle()` or `dispatchChangeEvent()` on feature, - * layer or feature overlay for changes to take effect. + * 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. * * @param {number|undefined} miterLimit Miter limit. * @api @@ -170,8 +180,10 @@ ol.style.Stroke.prototype.setMiterLimit = function(miterLimit) { /** - * Set the width. Call `setStyle()` or `dispatchChangeEvent()` on feature, layer - * or feature overlay for changes to take effect. + * 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. * * @param {number|undefined} width Width. * @api diff --git a/src/ol/style/style.js b/src/ol/style/style.js index 40cadb6f33..653e2818b8 100644 --- a/src/ol/style/style.js +++ b/src/ol/style/style.js @@ -101,8 +101,10 @@ ol.style.Style.prototype.getZIndex = function() { /** - * Set the zIndex. Call `setStyle()` or `dispatchChangeEvent()` on feature, - * layer or feature overlay for changes to take effect. + * 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. * * @param {number|undefined} zIndex ZIndex. * @api diff --git a/src/ol/style/textstyle.js b/src/ol/style/textstyle.js index 54adbdb001..a95fcc2291 100644 --- a/src/ol/style/textstyle.js +++ b/src/ol/style/textstyle.js @@ -165,8 +165,10 @@ ol.style.Text.prototype.getTextBaseline = function() { /** - * Set the font. Call `setStyle()` or `dispatchChangeEvent()` on feature, layer - * or feature overlay for changes to take effect. + * 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. * * @param {string|undefined} font Font. * @api @@ -177,8 +179,10 @@ ol.style.Text.prototype.setFont = function(font) { /** - * Set the x offset. Call `setStyle()` or `dispatchChangeEvent()` on feature, - * layer or feature overlay for changes to take effect. + * 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. * * @param {number} offsetX Horizontal text offset. */ @@ -188,8 +192,10 @@ ol.style.Text.prototype.setOffsetX = function(offsetX) { /** - * Set the y offset. Call `setStyle()` or `dispatchChangeEvent()` on feature, - * layer or feature overlay for changes to take effect. + * 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. * * @param {number} offsetY Vertical text offset. */ @@ -199,8 +205,10 @@ ol.style.Text.prototype.setOffsetY = function(offsetY) { /** - * Set the fill. Call `setStyle()` or `dispatchChangeEvent()` on feature, layer - * or feature overlay for changes to take effect. + * 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. * * @param {ol.style.Fill} fill Fill style. * @api @@ -211,8 +219,10 @@ ol.style.Text.prototype.setFill = function(fill) { /** - * Set the rotation. Call `setStyle()` or `dispatchChangeEvent()` on feature, - * layer or feature overlay for changes to take effect. + * 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. * * @param {number|undefined} rotation Rotation. * @api @@ -223,8 +233,10 @@ ol.style.Text.prototype.setRotation = function(rotation) { /** - * Set the scale. Call `setStyle()` or `dispatchChangeEvent()` on feature, layer - * or feature overlay for changes to take effect. + * 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. * * @param {number|undefined} scale Scale. * @api @@ -235,8 +247,10 @@ ol.style.Text.prototype.setScale = function(scale) { /** - * Set the stroke. Call `setStyle()` or `dispatchChangeEvent()` on feature, - * layer or feature overlay for changes to take effect. + * 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. * * @param {ol.style.Stroke} stroke Stroke style. * @api @@ -247,8 +261,10 @@ ol.style.Text.prototype.setStroke = function(stroke) { /** - * Set the text. Call `setStyle()` or `dispatchChangeEvent()` on feature, layer - * or feature overlay for changes to take effect. + * 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. * * @param {string|undefined} text Text. * @api @@ -259,8 +275,10 @@ ol.style.Text.prototype.setText = function(text) { /** - * Set the text alignment. Call `setStyle()` or `dispatchChangeEvent()` on - * feature, layer or feature overlay for changes to take effect. + * 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. * * @param {string|undefined} textAlign Text align. * @api @@ -271,8 +289,10 @@ ol.style.Text.prototype.setTextAlign = function(textAlign) { /** - * Set the text baseline. Call `setStyle()` or `dispatchChangeEvent()` on - * feature, layer or feature overlay for changes to take effect. + * 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. * * @param {string|undefined} textBaseline Text baseline. * @api