Skip to content

Commit fd70ab1

Browse files
zhurczhurc
committed
整理common下API注释
1 parent d7b7863 commit fd70ab1

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+458
-408
lines changed

‎dist/iclient9-leaflet.js

Lines changed: 140 additions & 116 deletions
Large diffs are not rendered by default.

‎dist/iclient9-mapboxgl.js

Lines changed: 37 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -5542,10 +5542,10 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
55425542

55435543
function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
55445544

5545-
/** * @class SuperMap.ServerGeometry * @description 服务端几何对象类。 * 该类描述几何对象（矢量）的特征数据（坐标点对、几何对象的类型等）。 * 基于服务端的空间分析、空间关系运算、查询等 GIS 服务功能使用服务端几何对象。 */
5545+
/** * @private * @class SuperMap.ServerGeometry * @description 服务端几何对象类。 * 该类描述几何对象（矢量）的特征数据（坐标点对、几何对象的类型等）。 * 基于服务端的空间分析、空间关系运算、查询等 GIS 服务功能使用服务端几何对象。 */
55465546
var ServerGeometry = function () {
55475547

5548-
/** * Constructor: SuperMap.ServerGeometry * 服务端几何对象类构造函数。 * * Parameters: * options - {Object} 参数。 * * Allowed options properties: * id - {String} 服务端几何对象唯一标识符。 * style - {<SuperMap.ServerStyle>} 服务端几何对象的风格。 * parts - {Array(Number)} 服务端几何对象中各个子对象所包含的节点个数。 * points - {Array(<Point>)} 组成几何对象的节点的坐标对数组。 * type - {<SuperMap.GeometryType>} 几何对象的类型。 */
5548+
/* * Constructor: SuperMap.ServerGeometry * 服务端几何对象类构造函数。 * * Parameters: * options - {Object} 参数。 * * Allowed options properties: * id - {String} 服务端几何对象唯一标识符。 * style - {<SuperMap.ServerStyle>} 服务端几何对象的风格。 * parts - {Array(Number)} 服务端几何对象中各个子对象所包含的节点个数。 * points - {Array(<Point>)} 组成几何对象的节点的坐标对数组。 * type - {<SuperMap.GeometryType>} 几何对象的类型。 */
55495549

55505550
/** * APIProperty: type * {<SuperMap.GeometryType>} 几何对象的类型(GeometryType)。 */
55515551

@@ -6077,7 +6077,6 @@ var ServerGeometry = function () {
60776077

60786078
exports.default = ServerGeometry;
60796079

6080-
60816080
_SuperMap2.default.ServerGeometry = ServerGeometry;
60826081

60836082
/***/ }),
@@ -35233,26 +35232,15 @@ function _possibleConstructorReturn(self, call) { if (!self) { throw new Referen
3523335232
function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function, not " + typeof superClass); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, enumerable: false, writable: true, configurable: true } }); if (superClass) Object.setPrototypeOf ? Object.setPrototypeOf(subClass, superClass) : subClass.__proto__ = superClass; }
3523435233

3523535234
/**
35236-
* Class: SuperMap.Format.WKT
35237-
* 用于读写常见文本的类。通过 <SuperMap.Format.WKT> 构造器来创建一个新
35235+
* @class SuperMap.Format.WKT
35236+
* @classdesc 用于读写常见文本的类。通过 <SuperMap.Format.WKT> 构造器来创建一个新
3523835237
* 的实例。
35239-
*
35240-
* Inherits from:
35241-
* - <SuperMap.Format>
35238+
* @extends SuperMap.Format
35239+
* @param options - {Object} 可选的选项对象，其属性将被设置到实例。option具体配置项继承自{@link SuperMap.Format}
3524235240
*/
3524335241
var WKT = function (_Format) {
3524435242
_inherits(WKT, _Format);
3524535243

35246-
/**
35247-
* Constructor: SuperMap.Format.WKT
35248-
* 创建一个新的WKT解析器。
35249-
*
35250-
* Parameters:
35251-
* options - {Object} 可选的选项对象，其属性将被设置到实例。
35252-
*
35253-
* Returns:
35254-
* {<SuperMap.Format.WKT>} 新的WKT解析器。
35255-
*/
3525635244
function WKT(options) {
3525735245
_classCallCheck(this, WKT);
3525835246

@@ -35262,7 +35250,7 @@ var WKT = function (_Format) {
3526235250
/**
3526335251
* Return a space delimited string of point coordinates.
3526435252
* @param {SuperMap.Geometry.Point} point
35265-
* @returns {String} A string of coordinates representing the point
35253+
* @returns {String} A string of coordinates representing the point
3526635254
*/
3526735255
'point': function point(_point) {
3526835256
return _point.x + ' ' + _point.y;
@@ -35271,7 +35259,7 @@ var WKT = function (_Format) {
3527135259
/**
3527235260
* Return a comma delimited string of point coordinates from a multipoint.
3527335261
* @param {SuperMap.Geometry.MultiPoint} multipoint
35274-
* @returns {String} A string of point coordinate strings representing
35262+
* @returns {String} A string of point coordinate strings representing
3527535263
* the multipoint
3527635264
*/
3527735265
'multipoint': function multipoint(_multipoint) {
@@ -35286,7 +35274,7 @@ var WKT = function (_Format) {
3528635274
/**
3528735275
* Return a comma delimited string of point coordinates from a line.
3528835276
* @param {SuperMap.Geometry.LineString} linestring
35289-
* @returns {String} A string of point coordinate strings representing
35277+
* @returns {String} A string of point coordinate strings representing
3529035278
* the linestring
3529135279
*/
3529235280
'linestring': function linestring(_linestring) {
@@ -35301,7 +35289,7 @@ var WKT = function (_Format) {
3530135289
/**
3530235290
* Return a comma delimited string of linestring strings from a multilinestring.
3530335291
* @param {SuperMap.Geometry.MultiLineString} multilinestring
35304-
* @returns {String} A string of of linestring strings representing
35292+
* @returns {String} A string of of linestring strings representing
3530535293
* the multilinestring
3530635294
*/
3530735295
'multilinestring': function multilinestring(_multilinestring) {
@@ -35316,7 +35304,7 @@ var WKT = function (_Format) {
3531635304
/**
3531735305
* Return a comma delimited string of linear ring arrays from a polygon.
3531835306
* @param {SuperMap.Geometry.Polygon} polygon
35319-
* @returns {String} An array of linear ring arrays representing the polygon
35307+
* @returns {String} An array of linear ring arrays representing the polygon
3532035308
*/
3532135309
'polygon': function polygon(_polygon) {
3532235310
var array = [];
@@ -35330,7 +35318,7 @@ var WKT = function (_Format) {
3533035318
/**
3533135319
* Return an array of polygon arrays from a multipolygon.
3533235320
* @param {SuperMap.Geometry.MultiPolygon} multipolygon
35333-
* @returns {String} An array of polygon arrays representing
35321+
* @returns {String} An array of polygon arrays representing
3533435322
* the multipolygon
3533535323
*/
3533635324
'multipolygon': function multipolygon(_multipolygon) {
@@ -35345,7 +35333,7 @@ var WKT = function (_Format) {
3534535333
/**
3534635334
* Return the WKT portion between 'GEOMETRYCOLLECTION(' and ')' for an <SuperMap.Geometry.Collection>
3534735335
* @param {SuperMap.Geometry.Collection} collection
35348-
* @returns {String} internal WKT representation of the collection
35336+
* @returns {String} internal WKT representation of the collection
3534935337
*/
3535035338
'collection': function collection(_collection) {
3535135339
var array = [];
@@ -35359,7 +35347,7 @@ var WKT = function (_Format) {
3535935347
/**
3536035348
* Return point feature given a point WKT fragment.
3536135349
* @param {String} str A WKT fragment representing the point
35362-
* @returns {SuperMap.Feature.Vector} A point feature
35350+
* @returns {SuperMap.Feature.Vector} A point feature
3536335351
* @private
3536435352
*/
3536535353
'point': function point(str) {
@@ -35370,7 +35358,7 @@ var WKT = function (_Format) {
3537035358
/**
3537135359
* Return a multipoint feature given a multipoint WKT fragment.
3537235360
* @param {String} A WKT fragment representing the multipoint
35373-
* @returns {SuperMap.Feature.Vector} A multipoint feature
35361+
* @returns {SuperMap.Feature.Vector} A multipoint feature
3537435362
* @private
3537535363
*/
3537635364
'multipoint': function multipoint(str) {
@@ -35387,7 +35375,7 @@ var WKT = function (_Format) {
3538735375
/**
3538835376
* Return a linestring feature given a linestring WKT fragment.
3538935377
* @param {String} A WKT fragment representing the linestring
35390-
* @returns {SuperMap.Feature.Vector} A linestring feature
35378+
* @returns {SuperMap.Feature.Vector} A linestring feature
3539135379
* @private
3539235380
*/
3539335381
'linestring': function linestring(str) {
@@ -35402,7 +35390,7 @@ var WKT = function (_Format) {
3540235390
/**
3540335391
* Return a multilinestring feature given a multilinestring WKT fragment.
3540435392
* @param {String} A WKT fragment representing the multilinestring
35405-
* @returns {SuperMap.Feature.Vector} A multilinestring feature
35393+
* @returns {SuperMap.Feature.Vector} A multilinestring feature
3540635394
* @private
3540735395
*/
3540835396
'multilinestring': function multilinestring(str) {
@@ -35419,7 +35407,7 @@ var WKT = function (_Format) {
3541935407
/**
3542035408
* Return a polygon feature given a polygon WKT fragment.
3542135409
* @param {String} A WKT fragment representing the polygon
35422-
* @returns {SuperMap.Feature.Vector} A polygon feature
35410+
* @returns {SuperMap.Feature.Vector} A polygon feature
3542335411
* @private
3542435412
*/
3542535413
'polygon': function polygon(str) {
@@ -35438,7 +35426,7 @@ var WKT = function (_Format) {
3543835426
/**
3543935427
* Return a multipolygon feature given a multipolygon WKT fragment.
3544035428
* @param {String} A WKT fragment representing the multipolygon
35441-
* @returns {SuperMap.Feature.Vector} A multipolygon feature
35429+
* @returns {SuperMap.Feature.Vector} A multipolygon feature
3544235430
* @private
3544335431
*/
3544435432
'multipolygon': function multipolygon(str) {
@@ -35455,7 +35443,7 @@ var WKT = function (_Format) {
3545535443
/**
3545635444
* Return an array of features given a geometrycollection WKT fragment.
3545735445
* @param {String} A WKT fragment representing the geometrycollection
35458-
* @returns {Array} An array of SuperMap.Feature.Vector
35446+
* @returns {Array} An array of SuperMap.Feature.Vector
3545935447
* @private
3546035448
*/
3546135449
'geometrycollection': function geometrycollection(str) {
@@ -35483,17 +35471,13 @@ var WKT = function (_Format) {
3548335471
}
3548435472

3548535473
/**
35486-
* Method: read
35487-
* Deserialize a WKT string and return a vector feature or an
35474+
* @function SuperMap.Format.WKT.prototype.read
35475+
* @description Deserialize a WKT string and return a vector feature or an
3548835476
* array of vector features. Supports WKT for POINT, MULTIPOINT,
3548935477
* LINESTRING, MULTILINESTRING, POLYGON, MULTIPOLYGON, and
3549035478
* GEOMETRYCOLLECTION.
35491-
*
35492-
* Parameters:
35493-
* wkt - {String} A WKT string
35494-
*
35495-
* Returns:
35496-
* {SuperMap.Feature.Vector|Array} A feature or array of features for
35479+
* @param wkt - {string} A WKT string
35480+
* @returns {SuperMap.Feature.Vector|Array} A feature or array of features for
3549735481
* GEOMETRYCOLLECTION WKT.
3549835482
*/
3549935483

@@ -35525,15 +35509,10 @@ var WKT = function (_Format) {
3552535509
}
3552635510

3552735511
/**
35528-
* Method: write
35529-
* Serialize a feature or array of features into a WKT string.
35530-
*
35531-
* Parameters:
35532-
* features - {SuperMap.Feature.Vector|Array} A feature or array of
35533-
* features
35534-
*
35535-
* Returns:
35536-
* {String} The WKT string representation of the input geometries
35512+
* @function SuperMap.Format.WKT.prototype.write
35513+
* @description Serialize a feature or array of features into a WKT string.
35514+
* @param features - {SuperMap.Feature.Vector|Array} A feature or array of features
35515+
* @returns {string} The WKT string representation of the input geometries
3553735516
*/
3553835517

3553935518
}, {
@@ -35565,14 +35544,10 @@ var WKT = function (_Format) {
3556535544
}
3556635545

3556735546
/**
35568-
* Method: extractGeometry
35569-
* Entry point to construct the WKT for a single Geometry object.
35570-
*
35571-
* Parameters:
35572-
* geometry - {<SuperMap.Geometry.Geometry>}
35573-
*
35574-
* Returns:
35575-
* {String} A WKT string of representing the geometry
35547+
* @function SuperMap.Format.WKT.prototype.extractGeometry
35548+
* @description Entry point to construct the WKT for a single Geometry object.
35549+
* @param geometry - {SuperMap.Geometry}
35550+
* @returns {string} A WKT string of representing the geometry
3557635551
*/
3557735552

3557835553
}, {
@@ -35592,13 +35567,15 @@ var WKT = function (_Format) {
3559235567
}
3559335568

3559435569
/**
35595-
* Object with properties corresponding to the geometry types.
35570+
* @private
35571+
* @description Object with properties corresponding to the geometry types.
3559635572
* Property values are functions that do the actual data extraction.
3559735573
*/
3559835574

3559935575

3560035576
/**
35601-
* Object with properties corresponding to the geometry types.
35577+
* @private
35578+
* @description Object with properties corresponding to the geometry types.
3560235579
* Property values are functions that do the actual parsing.
3560335580
*/
3560435581

@@ -46615,7 +46592,7 @@ var ThemeGridRangeItem = function () {
4661546592

4661646593

4661746594
/**
46618-
* @member @member SuperMap.ThemeGridRangeItem.prototype.color -{SuperMap.ServerColor}
46595+
* @member SuperMap.ThemeGridRangeItem.prototype.color -{SuperMap.ServerColor}
4661946596
* @description 栅格分段专题图中每一个分段专题图子项的对应的颜色。
4662046597
*/
4662146598
function ThemeGridRangeItem(options) {

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy