Merge pull request #3135 from tsauerwein/control-label

Make changing the label of ZoomToExtent/FullScreen control consistent
This commit is contained in:
Tobias Sauerwein
2015-01-29 15:03:53 +01:00
7 changed files with 136 additions and 71 deletions

View File

@@ -806,8 +806,8 @@ olx.control;
* collapsible: (boolean|undefined),
* collapsed: (boolean|undefined),
* tipLabel: (string|undefined),
* label: (string|undefined),
* collapseLabel: (string|undefined),
* label: (string|Node|undefined),
* collapseLabel: (string|Node|undefined),
* render: (function(ol.MapEvent)|undefined),
* target: (Element|undefined)}}
* @api
@@ -859,15 +859,17 @@ olx.control.AttributionOptions.prototype.tipLabel;
/**
* Text label to use for the collapsed attributions button. Default is `i`
* @type {string|undefined}
* Text label to use for the collapsed attributions button. Default is `i`.
* Instead of text, also a Node (e.g. a `span` element) can be used.
* @type {string|Node|undefined}
* @api
*/
olx.control.AttributionOptions.prototype.label;
/**
* Text label to use for the expanded attributions button. Default is `»`
* @type {string|undefined}
* Text label to use for the expanded attributions button. Default is `»`.
* Instead of text, also a Node (e.g. a `span` element) can be used.
* @type {string|Node|undefined}
* @api
*/
olx.control.AttributionOptions.prototype.collapseLabel;
@@ -980,6 +982,8 @@ olx.control.DefaultsOptions.prototype.zoomOptions;
/**
* @typedef {{className: (string|undefined),
* label: (string|Node|undefined),
* labelActive: (string|Node|undefined),
* tipLabel: (string|undefined),
* keys: (boolean|undefined),
* target: (Element|undefined)}}
@@ -996,6 +1000,25 @@ olx.control.FullScreenOptions;
olx.control.FullScreenOptions.prototype.className;
/**
* Text label to use for the button. Default is `\u2194` (an arrow).
* Instead of text, also a Node (e.g. a `span` element) can be used.
* @type {string|Node|undefined}
* @api
*/
olx.control.FullScreenOptions.prototype.label;
/**
* Text label to use for the button when full-screen is active.
* Default is `\u00d7` (a cross).
* Instead of text, also a Node (e.g. a `span` element) can be used.
* @type {string|Node|undefined}
* @api
*/
olx.control.FullScreenOptions.prototype.labelActive;
/**
* Text label to use for the button tip. Default is `Toggle full-screen`
* @type {string|undefined}
@@ -1083,9 +1106,9 @@ olx.control.MousePositionOptions.prototype.undefinedHTML;
/**
* @typedef {{collapsed: (boolean|undefined),
* collapseLabel: (string|undefined),
* collapseLabel: (string|Node|undefined),
* collapsible: (boolean|undefined),
* label: (string|undefined),
* label: (string|Node|undefined),
* layers: (Array.<ol.layer.Layer>|ol.Collection|undefined),
* render: (function(ol.MapEvent)|undefined),
* target: (Element|undefined),
@@ -1105,8 +1128,9 @@ olx.control.OverviewMapOptions.prototype.collapsed;
/**
* Text label to use for the expanded overviewmap button. Default is `«`
* @type {string|undefined}
* Text label to use for the expanded overviewmap button. Default is `«`.
* Instead of text, also a Node (e.g. a `span` element) can be used.
* @type {string|Node|undefined}
* @api
*/
olx.control.OverviewMapOptions.prototype.collapseLabel;
@@ -1121,8 +1145,9 @@ olx.control.OverviewMapOptions.prototype.collapsible;
/**
* Text label to use for the collapsed overviewmap button. Default is `»`
* @type {string|undefined}
* Text label to use for the collapsed overviewmap button. Default is `»`.
* Instead of text, also a Node (e.g. a `span` element) can be used.
* @type {string|Node|undefined}
* @api
*/
olx.control.OverviewMapOptions.prototype.label;
@@ -1218,7 +1243,7 @@ olx.control.ScaleLineOptions.prototype.units;
/**
* @typedef {{duration: (number|undefined),
* className: (string|undefined),
* label: (string|undefined),
* label: (string|Node|undefined),
* tipLabel: (string|undefined),
* target: (Element|undefined),
* render: (function(ol.MapEvent)|undefined),
@@ -1237,8 +1262,9 @@ olx.control.RotateOptions.prototype.className;
/**
* Text label to use for the rotate button. Default is `⇧`
* @type {string|undefined}
* Text label to use for the rotate button. Default is `⇧`.
* Instead of text, also a Node (e.g. a `span` element) can be used.
* @type {string|Node|undefined}
* @api stable
*/
olx.control.RotateOptions.prototype.label;
@@ -1288,8 +1314,8 @@ olx.control.RotateOptions.prototype.target;
/**
* @typedef {{duration: (number|undefined),
* className: (string|undefined),
* zoomInLabel: (string|undefined),
* zoomOutLabel: (string|undefined),
* zoomInLabel: (string|Node|undefined),
* zoomOutLabel: (string|Node|undefined),
* zoomInTipLabel: (string|undefined),
* zoomOutTipLabel: (string|undefined),
* delta: (number|undefined),
@@ -1316,16 +1342,18 @@ olx.control.ZoomOptions.prototype.className;
/**
* Text label to use for the zoom-in button. Default is `+`
* @type {string|undefined}
* Text label to use for the zoom-in button. Default is `+`.
* Instead of text, also a Node (e.g. a `span` element) can be used.
* @type {string|Node|undefined}
* @api stable
*/
olx.control.ZoomOptions.prototype.zoomInLabel;
/**
* Text label to use for the zoom-out button. Default is `-`
* @type {string|undefined}
* Text label to use for the zoom-out button. Default is `-`.
* Instead of text, also a Node (e.g. a `span` element) can be used.
* @type {string|Node|undefined}
* @api stable
*/
olx.control.ZoomOptions.prototype.zoomOutLabel;
@@ -1409,6 +1437,7 @@ olx.control.ZoomSliderOptions.prototype.render;
/**
* @typedef {{className: (string|undefined),
* target: (Element|undefined),
* label: (string|Node|undefined),
* tipLabel: (string|undefined),
* extent: (ol.Extent|undefined)}}
* @api stable
@@ -1432,6 +1461,15 @@ olx.control.ZoomToExtentOptions.prototype.className;
olx.control.ZoomToExtentOptions.prototype.target;
/**
* Text label to use for the button. Default is `E`.
* Instead of text, also a Node (e.g. a `span` element) can be used.
* @type {string|Node|undefined}
* @api stable
*/
olx.control.ZoomToExtentOptions.prototype.label;
/**
* Text label to use for the button tip. Default is `Zoom to extent`
* @type {string|undefined}