Source: formats/kml/util/KmlPair.js

  1. /*
  2.  * Copyright 2003-2006, 2009, 2017, 2020 United States Government, as represented
  3.  * by the Administrator of the National Aeronautics and Space Administration.
  4.  * All rights reserved.
  5.  *
  6.  * The NASAWorldWind/WebWorldWind platform is licensed under the Apache License,
  7.  * Version 2.0 (the "License"); you may not use this file except in compliance
  8.  * with the License. You may obtain a copy of the License
  9.  * at http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software distributed
  12.  * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
  13.  * CONDITIONS OF ANY KIND, either express or implied. See the License for the
  14.  * specific language governing permissions and limitations under the License.
  15.  *
  16.  * NASAWorldWind/WebWorldWind also contains the following 3rd party Open Source
  17.  * software:
  18.  *
  19.  *    ES6-Promise – under MIT License
  20.  *    libtess.js – SGI Free Software License B
  21.  *    Proj4 – under MIT License
  22.  *    JSZip – under MIT License
  23.  *
  24.  * A complete listing of 3rd Party software notices and licenses included in
  25.  * WebWorldWind can be found in the WebWorldWind 3rd-party notices and licenses
  26.  * PDF found in code  directory.
  27.  */
  28. define([
  29.     './../KmlElements',
  30.     '../KmlObject',
  31.     '../styles/KmlStyleSelector',
  32.     './KmlNodeTransformers'
  33. ], function (
  34.     KmlElements,
  35.     KmlObject,
  36.     KmlStyleSelector,
  37.     NodeTransformers
  38. ) {
  39.     "use strict";
  41.     /**
  42.      * Constructs a KmlPair. Application usually don't call this constructor. It is called by {@link KmlFile} as
  43.      * Objects from KmlFile are read. It is concrete implementation.
  44.      * @alias KmlPair
  45.      * @constructor
  46.      * @classdesc Contains the data associated with Kml KmlPair
  47.      * @param options {Object}
  48.      * @param options.objectNode {Node} Node representing the Kml KmlPair.
  49.      * @throws {ArgumentError} If either the node is null or undefined.
  50.      * @see https://developers.google.com/kml/documentation/kmlreference#pair
  51.      * @augments KmlObject
  52.      */
  53.     var KmlPair = function (options) {
  54.         KmlObject.call(this, options);
  55.     };
  57.     KmlPair.prototype = Object.create(KmlObject.prototype);
  59.     Object.defineProperties(KmlPair.prototype, {
  60.         /**
  61.          * Identifies the key
  62.          * @memberof KmlPair.prototype
  63.          * @readonly
  64.          * @type {String}
  65.          */
  66.         kmlKey: {
  67.             get: function() {
  68.                 return this._factory.specific(this, {name: 'key', transformer: NodeTransformers.string});
  69.             }
  70.         },
  72.         /**
  73.          * References the style using Url. If part of the same document start with the prefix #
  74.          * @memberof KmlPair.prototype
  75.          * @readonly
  76.          * @type {String}
  77.          */
  78.         kmlStyleUrl: {
  79.             get: function() {
  80.                 return this._factory.specific(this, {name: 'styleUrl', transformer: NodeTransformers.string});
  81.             }
  82.         },
  84.         /**
  85.          * Definition of styles applied to this KmlPair.
  86.          * @memberof KmlPair.prototype
  87.          * @readonly
  88.          * @type {KmlStyle}
  89.          */
  90.         kmlStyleSelector: {
  91.             get: function() {
  92.                 return this._factory.any(this, {
  93.                     name: KmlStyleSelector.prototype.getTagNames()
  94.                 });
  95.             }
  96.         }
  97.     });
  99.     /**
  100.      * @inheritDoc
  101.      */
  102.     KmlPair.prototype.getTagNames = function () {
  103.         return ['Pair'];
  104.     };
  106.     /**
  107.      * @inheritDoc
  108.      */
  109.     KmlPair.prototype.getStyle = function(styleResolver) {
  110.         return styleResolver.handleRemoteStyle(this.kmlStyleUrl, this.kmlStyleSelector);
  111.     };
  113.     KmlElements.addKey(KmlPair.prototype.getTagNames()[0], KmlPair);
  115.     return KmlPair;
  116. });