Source: formats/kml/util/KmlNetworkLinkControl.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. 	'../KmlAbstractView',
  30. 	'../KmlElements',
  31. 	'../KmlObject',
  32. 	'./KmlNodeTransformers',
  33. 	'./KmlUpdate'
  34. ], function (KmlAbstractView,
  35. 			 KmlElements,
  36. 			 KmlObject,
  37. 			 NodeTransformers,
  38. 			 Update) {
  39. 	/**
  40. 	 * Controls the behavior of files fetched by a <NetworkLink>. It is direct descendant of kml and there should always
  41.      * be maximum one per document.
  42. 	 * @alias KmlNetworkLinkControl
  43. 	 * @constructor
  44. 	 * @augments KmlObject
  45. 	 */
  46. 	var KmlNetworkLinkControl = function(options) {
  47. 		KmlObject.call(this, options);
  48. 	};
  50. 	KmlNetworkLinkControl.prototype = Object.create(KmlObject.prototype);
  52. 	Object.defineProperties(KmlNetworkLinkControl.prototype, {
  53. 		/**
  54. 		 * Specified in seconds, <minRefreshPeriod> is the minimum allowed time between fetches of the file. This
  55. 		 * parameter allows servers to throttle fetches of a particular file and to tailor refresh rates to the expected
  56. 		 * rate of change to the data. For example, a user might set a link refresh to 5 seconds, but you could set your
  57. 		 * minimum refresh period to 3600 to limit refresh updates to once every hour.
  58. 		 * @memberof KmlNetworkLinkControl.prototype
  59. 		 * @readonly
  60. 		 * @type {Number}
  61. 		 */
  62. 		minRefreshPeriod: {
  63. 			get: function() {
  64. 				return this._factory.specific(this, {name: 'minRefreshPeriod', transformer: NodeTransformers.number});
  65. 			}
  66. 		},
  68. 		/**
  69. 		 * Specified in seconds, <maxSessionLength> is the maximum amount of time for which the client NetworkLink can
  70.          * remain connected. The default value of -1 indicates not to terminate the session explicitly.
  71. 		 * @memberof KmlNetworkLinkControl.prototype
  72. 		 * @readonly
  73. 		 * @type {Number}
  74. 		 */
  75. 		maxSessionLength: {
  76. 			get: function() {
  77. 				return this._factory.specific(this, {name: 'maxSessionLength', transformer: NodeTransformers.number});
  78. 			}
  79. 		},
  81. 		/**
  82. 		 * Use this element to append a string to the URL query on the next refresh of the network link. You can use
  83.          * this data in your script to provide more intelligent handling on the server side, including version querying
  84.          * and conditional file delivery.
  85. 		 * @memberof KmlNetworkLinkControl.prototype
  86. 		 * @readonly
  87. 		 * @type {String}
  88. 		 */
  89. 		cookie: {
  90. 			get: function() {
  91. 				return this._factory.specific(this, {name: 'cookie', transformer: NodeTransformers.string});
  92. 			}
  93. 		},
  95. 		/**
  96. 		 * You can deliver a pop-up message, such as usage guidelines for your network link. The message appears when
  97.          * the network link is first loaded into Google Earth, or when it is changed in the network link control.
  98. 		 * @memberof KmlNetworkLinkControl.prototype
  99. 		 * @readonly
  100. 		 * @type {String}
  101. 		 */
  102. 		message: {
  103. 			get: function() {
  104. 				return this._factory.specific(this, {name: 'message', transformer: NodeTransformers.string});
  105. 			}
  106. 		},
  108. 		/**
  109. 		 * You can control the name of the network link from the server, so that changes made to the name on the client
  110.          * side are overridden by the server.
  111. 		 * @memberof KmlNetworkLinkControl.prototype
  112. 		 * @readonly
  113. 		 * @type {String}
  114. 		 */
  115. 		linkName: {
  116. 			get: function() {
  117. 				return this._factory.specific(this, {name: 'linkName', transformer: NodeTransformers.string});
  118. 			}
  119. 		},
  121. 		/**
  122. 		 * You can control the description of the network link from the server, so that changes made to the description
  123.          * on the client side are overridden by the server.You can control the description of the network link from the
  124.          * server, so that changes made to the description on the client side are overridden by the server.
  125. 		 * @memberof KmlNetworkLinkControl.prototype
  126. 		 * @readonly
  127. 		 * @type {String}
  128. 		 */
  129. 		linkDescription: {
  130. 			get: function() {
  131. 				return this._factory.specific(this, {name: 'linkDescription', transformer: NodeTransformers.string});
  132. 			}
  133. 		},
  135. 		/**
  136. 		 * You can control the snippet for the network link from the server, so that changes made to the snippet on the
  137.          * client side are overridden by the server. <linkSnippet> has a maxLines attribute, an integer that specifies
  138.          * the maximum number of lines to display.
  139. 		 * @memberof KmlNetworkLinkControl.prototype
  140. 		 * @readonly
  141. 		 * @type {String}
  142. 		 */
  143. 		linkSnippet: {
  144. 			get: function() {
  145. 				return this._factory.specific(this, {name: 'linkSnippet', transformer: NodeTransformers.string});
  146. 			}
  147. 		},
  149. 		/**
  150. 		 * You can specify a date/time at which the link should be refreshed. This specification takes effect only if
  151.          * the <refreshMode> in <Link> has a value of onExpire. See <refreshMode>
  152. 		 * @memberof KmlNetworkLinkControl.prototype
  153. 		 * @readonly
  154. 		 * @type {Date}
  155. 		 */
  156. 		expires: {
  157. 			get: function() {
  158. 				return this._factory.specific(this, {name: 'expires', transformer: NodeTransformers.date});
  159. 			}
  160. 		},
  162. 		/**
  163. 		 * With <Update>, you can specify any number of Change, Create, and Delete tags for a .kml file or .kmz archive
  164.          * that has previously been loaded with a network link. See <Update>.
  165. 		 * @memberof KmlNetworkLinkControl.prototype
  166. 		 * @readonly
  167. 		 * @type {Update}
  168. 		 */
  169. 		Update: {
  170. 			get: function() {
  171. 				return this._factory.any(this, {
  172. 					name: Update.prototype.getTagNames()
  173. 				});
  174. 			}
  175. 		},
  177. 		/**
  178. 		 * Either Camera or LookAt which will be used to fly to the location whenever the
  179. 		 * @memberof KmlNetworkLinkControl.prototype
  180. 		 * @readonly
  181. 		 * @type {AbstractView}
  182. 		 */
  183. 		AbstractView: {
  184. 			get: function() {
  185. 				return this._factory.any(this, {
  186. 					name: KmlAbstractView.prototype.getTagNames()
  187. 				});
  188. 			}
  189. 		}
  190. 	});
  192. 	/**
  193. 	 * @inheritDoc
  194. 	 */
  195. 	KmlNetworkLinkControl.prototype.getTagNames = function() {
  196. 		return ['NetworkLinkControl'];
  197. 	};
  199. 	KmlElements.addKey(KmlNetworkLinkControl.prototype.getTagNames()[0], KmlNetworkLinkControl);
  201. 	return KmlNetworkLinkControl;
  202. });