Merge pull request #1185 from fredj/coord_format

Add ol.coordinate.format function

src/ol/coordinate.exports

@@ -1,4 +1,5 @@
 @exportSymbol ol.coordinate.createStringXY
+@exportSymbol ol.coordinate.format
 @exportSymbol ol.coordinate.toStringHDMS
 @exportSymbol ol.coordinate.toStringXY
 @exportSymbol ol.coordinate.fromProjectedArray

src/ol/coordinate.js

@@ -43,18 +43,19 @@ ol.coordinate.add = function(coordinate, delta) {
 
 
 /**
- * @param {number=} opt_precision Precision.
+ * @param {number=} opt_fractionDigits The number of digits to include
+ *    after the decimal point. Default is `0`.
  * @return {ol.CoordinateFormatType} Coordinate format.
  * @todo stability experimental
  */
-ol.coordinate.createStringXY = function(opt_precision) {
+ol.coordinate.createStringXY = function(opt_fractionDigits) {
   return (
       /**
        * @param {ol.Coordinate|undefined} coordinate Coordinate.
        * @return {string} String XY.
        */
       function(coordinate) {
-        return ol.coordinate.toStringXY(coordinate, opt_precision);
+        return ol.coordinate.toStringXY(coordinate, opt_fractionDigits);
       });
 };
 
@@ -75,6 +76,26 @@ ol.coordinate.degreesToStringHDMS_ = function(degrees, hemispheres) {
 };
 
 
+/**
+ * @param {ol.Coordinate|undefined} coordinate Coordinate.
+ * @param {string} template A template string with `{x}` and `{y}` placeholders
+ *     that will be replaced by first and second coordinate values.
+ * @param {number=} opt_fractionDigits The number of digits to include
+ *    after the decimal point. Default is `0`.
+ * @return {string} Formated coordinate.
+ * @todo stability experimental
+ */
+ol.coordinate.format = function(coordinate, template, opt_fractionDigits) {
+  if (goog.isDef(coordinate)) {
+    return template
+      .replace('{x}', coordinate[0].toFixed(opt_fractionDigits))
+      .replace('{y}', coordinate[1].toFixed(opt_fractionDigits));
+  } else {
+    return '';
+  }
+};
+
+
 /**
  * @param {ol.Coordinate} coordinate Coordinate.
  * @param {number} angle Angle.
@@ -132,18 +153,13 @@ ol.coordinate.toStringHDMS = function(coordinate) {
 
 /**
  * @param {ol.Coordinate|undefined} coordinate Coordinate.
- * @param {number=} opt_precision Precision.
+ * @param {number=} opt_fractionDigits The number of digits to include
+ *    after the decimal point. Default is `0`.
  * @return {string} XY.
  * @todo stability experimental
  */
-ol.coordinate.toStringXY = function(coordinate, opt_precision) {
+ol.coordinate.toStringXY = function(coordinate, opt_fractionDigits) {
-  if (goog.isDef(coordinate)) {
+  return ol.coordinate.format(coordinate, '{x}, {y}', opt_fractionDigits);
-    var precision = opt_precision || 0;
-    return coordinate[0].toFixed(precision) + ', ' +
-        coordinate[1].toFixed(precision);
-  } else {
-    return '';
-  }
 };