Skip to content

Commit 66d0cfd

Browse files
committed
[update]ol modulecategory review by xjj
1 parent 0629ff4 commit 66d0cfd

Some content is hidden

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

49 files changed

+187
-143
lines changed

src/common/control/TimeControlBase.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import {Events} from '../commontypes/Events';
77
* @class TimeControlBase
88
* @deprecatedclass SuperMap.TimeControlBase
99
* @classdesc 时间控制基类。
10+
* @modulecategory Control
1011
* @category Control
1112
* @param {Object} options - 可选参数。
1213
* @param {number} [options.speed=1] - 速度。不能小于 0,(每帧渲染的数据之间的间隔为1),设置越大速度越快。

src/common/control/TimeFlowControl.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import {TimeControlBase} from './TimeControlBase';
1010
* @classdesc 时间管理类。此类只负责时间上的控制,具体执行的操作需要用户在初始化时的回调函数内部进行实现。
1111
* 如设置起始时间为 1000,结束时间是 2000,步长设置为 1,
1212
* 那么表示按照每次1年(可以通过 setSpeed 进行修改)的变化从公元 1000 年开始到公元 2000 年为止,默认每 1 秒会变化 1 次(通过 setFrequency 修改)
13+
* @modulecategory Control
1314
* @extends {TimeControlBase}
1415
* @param {function} callback - 每次刷新回调函数。具体的效果需要用户在此回调函数里面实现。
1516
* @param {Object} options - 可选参数。

src/common/style/ThemeStyle.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import {Util} from '../commontypes/Util';
77
* @class ThemeStyle
88
* @deprecatedclass SuperMap.ThemeStyle
99
* @classdesc 客户端专题图风格类。
10+
* @modulecategory Overlay
1011
* @category Visualization Theme
1112
* @param {Object} options - 可选参数。
1213
* @param {boolean} [options.fill=true] - 是否填充,不需要填充则设置为 false。如果 fill 与 stroke 同时为 false,将按 fill 与 stroke 的默认值渲染图层。

src/openlayers/control/ChangeTileVersion.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import Control from 'ol/control/Control';
99
* @aliasclass control.ChangeTileVersion
1010
* @category Control
1111
* @classdesc 版本切换控件(目前仅支持 IE10 及以上)暂时不支持自定义位置。
12+
* @modulecategory Control
1213
* @extends {ol.control.Control}
1314
* @param {Object} options -参数。
1415
* @param {string} [options.title='switch tile version'] - 提示信息。

src/openlayers/control/Logo.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import Control from 'ol/control/Control';
99
* @aliasclass control.Logo
1010
* @category Control
1111
* @classdesc Logo控件。默认不显示,需手动添加控件。
12+
* @modulecategory Control
1213
* @extends {ol.control.Control}
1314
* @example
1415
* var control = new Logo();

src/openlayers/control/ScaleLine.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ import AssertionError from 'ol/AssertionError';
1616
* <p style="color: #ce4844">Notice</p>
1717
* <p style="font-size: 13px">该功能继承 {@link ol.control.ScaleLine },与 {@link ol.control.ScaleLine } 功能完全相同。仅为修复 `openlayers` v4.6.5 版本中 WGS84 等地理坐标系比例尺数值错误的问题。
1818
* </div>
19+
* @modulecategory Control
1920
* @extends {ol.control.ScaleLine}
2021
* @param {Object} options -参数。
2122
* @param {string} [options.className='ol-scale-line'] - CSS Class name.。

src/openlayers/mapping/BaiduMap.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import { Util } from '../core/Util';
1111
* @browsernamespace ol.source
1212
* @category ThirdPartyMap
1313
* @classdesc 百度地图图层源。
14+
* @modulecategory Mapping
1415
* @param {Object} opt_options - 参数。
1516
* @param {string} [opt_options.url='http://online1.map.bdimg.com/onlinelabel/?qt=tile&x={x}&y={y}&z={z}&styles={styles}&udt=20170408'] - 服务地址。
1617
* @param {string} [opt_options.tileProxy] - 代理地址。

src/openlayers/mapping/ImageSuperMapRest.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ import { containsExtent, getCenter, getHeight, getWidth, getForViewAndSize } fro
1717
* @browsernamespace ol.source
1818
* @category iServer Map Tile
1919
* @classdesc SuperMap iServer Image 图层源。
20+
* @modulecategory Mapping
2021
* @param {Object} options - 参数。
2122
* @param {string} options.url - 地图服务地址,例如: http://{ip}:{port}/iserver/services/map-world/rest/maps/World。
2223
* @param {ServerType} [options.serverType=SuperMap.ServerType.ISERVER] - 服务类型 ISERVER|IPORTAL|ONLINE。

src/openlayers/mapping/SuperMapCloud.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import XYZ from 'ol/source/XYZ';
99
* @browsernamespace ol.source
1010
* @category ThirdPartyMap
1111
* @classdesc 超图云地图图层源。
12+
* @modulecategory Mapping
1213
* @param {Object} opt_options - 参数。
1314
* @param {string} [opt_options.url='http://t2.dituhui.com/FileService/image?map={mapName}&type={type}&x={x}&y={y}&z={z}'] - 服务地址。
1415
* @param {string} [opt_options.tileProxy] - 代理地址。

src/openlayers/mapping/Tianditu.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import WMTSTileGrid from 'ol/tilegrid/WMTS';
1010
* @browsernamespace ol.source
1111
* @category ThirdPartyMap
1212
* @classdesc 天地图图层源。
13+
* @modulecategory Mapping
1314
* @param {Object} opt_options - 参数。
1415
* @param {string} [opt_options.url='http://t{0-7}.tianditu.gov.cn/{layer}_{proj}/wmts?'] - 服务地址。
1516
* @param {string} opt_options.key - 天地图服务密钥。详见{@link http://lbs.tianditu.gov.cn/server/MapService.html}

0 commit comments

Comments
 (0)