Source: formats/kml/styles/KmlBalloonStyle.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.     './KmlSubStyle',
  31.     '../util/KmlNodeTransformers'
  32. ], function (
  33.     KmlElements,
  34.     KmlSubStyle,
  35.     NodeTransformers
  36. ) {
  37.     "use strict";
  38.     /**
  39.      * Constructs an KmlBalloonStyle. Applications usually don't call this constructor. It is called by {@link KmlFile}
  40.      * as objects from KmlFile are read. This object is already concrete implementation.
  41.      * @alias KmlBalloonStyle
  42.      * @classdesc Contains the data associated with BalloonStyle node
  43.      * @param options {Object}
  44.      * @param options.objectNode {Node} Node representing BalloonStyle
  45.      * @constructor
  46.      * @throws {ArgumentError} If the node is null or undefined
  47.      * @see https://developers.google.com/kml/documentation/kmlreference#balloonstyle
  48.      * @augments KmlSubStyle
  49.      */
  50.     var KmlBalloonStyle = function (options) {
  51.         KmlSubStyle.call(this, options);
  52.     };
  54.     KmlBalloonStyle.prototype = Object.create(KmlSubStyle.prototype);
  56.     Object.defineProperties(KmlBalloonStyle.prototype, {
  57.         /**
  58.          * Represents background color of the balloon. It expects hexadecimal notation without #.
  59.          * @memberof KmlBalloonStyle.prototype
  60.          * @readonly
  61.          * @type {String}
  62.          */
  63.         kmlBgColor: {
  64.             get: function(){
  65.                 return this._factory.specific(this, {name: 'bgColor', transformer: NodeTransformers.string});
  66.             }
  67.         },
  69.         /**
  70.          * Represents color of the text in the balloon. It expects hexadecimal notation without #.
  71.          * @memberof KmlBalloonStyle.prototype
  72.          * @readonly
  73.          * @type {String}
  74.          */
  75.         kmlTextColor: {
  76.             get: function() {
  77.                 return this._factory.specific(this, {name: 'textColor', transformer: NodeTransformers.string});
  78.             }
  79.         },
  81.         /**
  82.          * Text which should be displayed in the balloon, otherwise feature name and description is displayed.
  83.          * @memberof KmlBalloonStyle.prototype
  84.          * @readonly
  85.          * @type {String}
  86.          */
  87.         kmlText: {
  88.             get: function(){
  89.                 return this._factory.specific(this, {name: 'text', transformer: NodeTransformers.string});
  90.             }
  91.         },
  93.         /**
  94.          * Either display or hide. When hide don't show the balloon at all.
  95.          * @memberof KmlBalloonStyle.prototype
  96.          * @readonly
  97.          * @type {String}
  98.          */
  99.         kmlDisplayMode: {
  100.             get: function() {
  101.                 return this._factory.specific(this, {name: 'displayMode', transformer: NodeTransformers.string});
  102.             }
  103.         }
  104.     });
  106.     KmlBalloonStyle.update = function(){
  108.     };
  110.     /**
  111.      * @inheritDoc
  112.      */
  113.     KmlBalloonStyle.prototype.getTagNames = function() {
  114.         return ['BalloonStyle'];
  115.     };
  117.     KmlElements.addKey(KmlBalloonStyle.prototype.getTagNames()[0], KmlBalloonStyle);
  119.     return KmlBalloonStyle;
  120. });