rn_supermap

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: Datasource</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>  <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <div id="main"> <h1 class="page-title">Class: Datasource</h1> <section> <header> <h2>Datasource</h2> </header> <article> <div class="container-overview"> <h4 class="name" id="Datasource"><span class="type-signature"></span>new Datasource<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> 该类管理投影信息、数据源与数据库的连接信息和对其中的数据集的相关操作，如通过已有数据集复制生成新的数据集等。 </div> <h5 class="subsection-title">Properties:</h5> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>EncodeType</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last">数据集存储时的压缩编码方式 NONE | BYTE | INT16 | INT24 | INT32 | LZW | SGL | DCT</td> </tr> <tr> <td class="name"><code>DatasourceEncrytionType</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last">数据集存储时的压缩编码方式 DEFAULT | AES</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Datasource.js.html">Datasource.js</a>, <a href="Datasource.js.html#line15">line 15</a> </li></ul></dd> </dl> </div> <h3 class="subsection-title">Methods</h3> <h4 class="name" id=".containDataset"><span class="type-signature">(static) </span>containDataset<span class="signature">(datasetName)</span><span class="type-signature"> → {Promise.<boolean>}</span></h4> <div class="description"> 检查当前数据源中是否包含指定名称的数据集。 </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>datasetName</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">数据集名称</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Datasource.js.html">Datasource.js</a>, <a href="Datasource.js.html#line165">line 165</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<boolean></span> </dd> </dl> <h4 class="name" id=".copyDataset"><span class="type-signature">(static) </span>copyDataset<span class="signature">(srcDataset, desDatasetName, encodeType)</span><span class="type-signature"> → {Promise.<<a href="Dataset.html">Dataset</a>>}</span></h4> <div class="description"> 用于在相同或不同引擎数据源中复制数据集。 </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>srcDataset</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">要复制的源数据集。</td> </tr> <tr> <td class="name"><code>desDatasetName</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">目标数据集的名称。</td> </tr> <tr> <td class="name"><code>encodeType</code></td> <td class="type"> <span class="param-type">Datasource.EncodeType</span> </td> <td class="description last">数据集的编码方式。</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Datasource.js.html">Datasource.js</a>, <a href="Datasource.js.html#line114">line 114</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<<a href="Dataset.html">Dataset</a>></span> </dd> </dl> <h4 class="name" id=".createDatasetVector"><span class="type-signature">(static) </span>createDatasetVector<span class="signature">(datasetVectorInfo|datasetName, datasetType, encodeType)</span><span class="type-signature"> → {Promise.<<a href="DatasetVector.html">DatasetVector</a>>}</span></h4> <div class="description"> 根据指定的矢量数据集信息来创建矢量数据集。可传入一个datasetVectorInfo类对象，或直接传入数据集名称、数据集类型和编码类型三个参数。 </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>datasetVectorInfo|datasetName</code></td> <td class="type"> <span class="param-type">object</span> | <span class="param-type">string</span> </td> <td class="description last">数据集矢量信息对象</td> </tr> <tr> <td class="name"><code>datasetType</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><a href="Dataset.html">Dataset</a></td> </tr> <tr> <td class="name"><code>encodeType</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last">数据集存储时的压缩编码方式 NONE | BYTE | INT16 | INT24 | INT32 | LZW | SGL | DCT</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Datasource.js.html">Datasource.js</a>, <a href="Datasource.js.html#line87">line 87</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<<a href="DatasetVector.html">DatasetVector</a>></span> </dd> </dl> <h4 class="name" id=".deleteDataset"><span class="type-signature">(static) </span>deleteDataset<span class="signature">(datasetName)</span><span class="type-signature"> → {Promise.<boolean>}</span></h4> <div class="description"> 用于删除指定名称的数据集。 </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>datasetName</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">数据集名称</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Datasource.js.html">Datasource.js</a>, <a href="Datasource.js.html#line180">line 180</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<boolean></span> </dd> </dl> <h4 class="name" id=".getAvailableDatasetName"><span class="type-signature">(static) </span>getAvailableDatasetName<span class="signature">(name)</span><span class="type-signature"> → {Promise.<string>}</span></h4> <div class="description"> 返回一个数据源中未被使用的数据集的名称。 </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">待检测名称</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Datasource.js.html">Datasource.js</a>, <a href="Datasource.js.html#line70">line 70</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<string></span> </dd> </dl> <h4 class="name" id=".getDataset"><span class="type-signature">(static) </span>getDataset<span class="signature">(index|name)</span><span class="type-signature"> → {Promise.<<a href="Dataset.html">Dataset</a>>}</span></h4> <div class="description"> 指定名称或序号来获取数据集。 </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>index|name</code></td> <td class="type"> <span class="param-type">number</span> | <span class="param-type">string</span> </td> <td class="description last">既可以是序号，也可以是数据集名称</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Datasource.js.html">Datasource.js</a>, <a href="Datasource.js.html#line48">line 48</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<<a href="Dataset.html">Dataset</a>></span> </dd> </dl> <h4 class="name" id=".getDatasetCount"><span class="type-signature">(static) </span>getDatasetCount<span class="signature">()</span><span class="type-signature"> → {Promise.<number>}</span></h4> <div class="description"> 返回数据集集合中数据集的个数。 </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Datasource.js.html">Datasource.js</a>, <a href="Datasource.js.html#line194">line 194</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<number></span> </dd> </dl> <h4 class="name" id=".getDatasets"><span class="type-signature">(static) </span>getDatasets<span class="signature">()</span><span class="type-signature"> → {Promise.<Datasets>}</span></h4> <div class="description"> 获取数据集集合。 </div> <dl class="details"> <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>- 已弃用，Datasets类不建议使用，后续版本即将移除此接口</li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Datasource.js.html">Datasource.js</a>, <a href="Datasource.js.html#line29">line 29</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<Datasets></span> </dd> </dl> <h4 class="name" id=".getPrjCoordSys"><span class="type-signature">(static) </span>getPrjCoordSys<span class="signature">()</span><span class="type-signature"> → {Promise.<PrjCoordSys>}</span></h4> <div class="description"> 返回数据源的投影信息。 </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Datasource.js.html">Datasource.js</a>, <a href="Datasource.js.html#line148">line 148</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<PrjCoordSys></span> </dd> </dl> </article> </section> </div> <nav> <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BufferAnalyst.html">BufferAnalyst</a></li><li><a href="BufferAnalystParameter.html">BufferAnalystParameter</a></li><li><a href="DataDownloadService.html">DataDownloadService</a></li><li><a href="Dataset.html">Dataset</a></li><li><a href="DatasetVector.html">DatasetVector</a></li><li><a href="DatasetVectorInfo.html">DatasetVectorInfo</a></li><li><a href="Datasource.html">Datasource</a></li><li><a href="DatasourceConnectionInfo.html">DatasourceConnectionInfo</a></li><li><a href="DataUploadService.html">DataUploadService</a></li><li><a href="Feature.html">Feature</a></li><li><a href="FeatureSet.html">FeatureSet</a></li><li><a href="GeoLine.html">GeoLine</a></li><li><a href="Geometry.html">Geometry</a></li><li><a href="GeoPoint.html">GeoPoint</a></li><li><a href="GeoRegion.html">GeoRegion</a></li><li><a href="GeoStyle.html">GeoStyle</a></li><li><a href="Layer.html">Layer</a></li><li><a href="LayerSetting.html">LayerSetting</a></li><li><a href="LayerSettingVector.html">LayerSettingVector</a></li><li><a href="LocationManager.html">LocationManager</a></li><li><a href="Map.html">Map</a></li><li><a href="MapControl.html">MapControl</a></li><li><a href="MapView.html">MapView</a></li><li><a href="Navigation2.html">Navigation2</a></li><li><a href="OverlayAnalyst.html">OverlayAnalyst</a></li><li><a href="OverlayAnalystParameter.html">OverlayAnalystParameter</a></li><li><a href="Point.html">Point</a></li><li><a href="Point2D.html">Point2D</a></li><li><a href="QueryParameter.html">QueryParameter</a></li><li><a href="QueryService.html">QueryService</a></li><li><a href="Rectangle2D.html">Rectangle2D</a></li><li><a href="Scene.html">Scene</a></li><li><a href="Selection.html">Selection</a></li><li><a href="ServiceBase.html">ServiceBase</a></li><li><a href="ServiceQueryParameter.html">ServiceQueryParameter</a></li><li><a href="Size2D.html">Size2D</a></li><li><a href="Theme.html">Theme</a></li><li><a href="Track.html">Track</a></li><li><a href="TrackingLayer.html">TrackingLayer</a></li><li><a href="TraditionalNavi.html">TraditionalNavi</a></li><li><a href="Workspace.html">Workspace</a></li><li><a href="WorkspaceConnectionInfo.html">WorkspaceConnectionInfo</a></li></ul> </nav> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue Aug 01 2017 16:16:50 GMT+0800 (CST) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>