From 3f198eae093ee583ae178f20ff32855b34ba6c6f Mon Sep 17 00:00:00 2001 From: PanZhiQing Date: Wed, 1 Jan 2025 19:38:33 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=E6=96=87=E6=A1=A3=E4=B8=AD?= =?UTF-8?q?=E7=9A=84=E9=93=BE=E6=8E=A5=EF=BC=8C=E4=BF=AE=E6=AD=A3=E8=B5=84?= =?UTF-8?q?=E6=BA=90=E8=B7=AF=E5=BE=84=E5=92=8C=E5=87=BD=E6=95=B0=E5=AE=9A?= =?UTF-8?q?=E4=B9=89=E6=A0=BC=E5=BC=8F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 323 ----------- docs/.vitepress/config.ts | 17 +- docs/.vitepress/theme/custom.css | 2 +- docs/api/README.md | 96 ---- docs/api/classes/Circle.md | 61 ++- docs/api/classes/Delaunator.md | 120 ++-- docs/api/classes/Evented.md | 80 ++- docs/api/classes/Geometry.md | 94 ++-- docs/api/classes/GeometryCollection.md | 76 ++- docs/api/classes/Grid.md | 202 ++++--- docs/api/classes/LineString.md | 114 ++-- docs/api/classes/MultiLineString.md | 102 ++-- docs/api/classes/MultiPoint.md | 108 ++-- docs/api/classes/MultiPolygon.md | 102 ++-- docs/api/classes/Point.md | 120 ++-- docs/api/classes/Polygon.md | 114 ++-- docs/api/classes/PriorityQueue.md | 38 +- docs/api/classes/QuadTree.md | 103 ++-- docs/api/classes/Queue.md | 44 +- docs/api/classes/Voronoi.md | 55 +- docs/api/enumerations/colorListType.md | 16 +- docs/api/enumerations/stretchType.md | 40 +- docs/api/functions/FFT.md | 14 +- docs/api/functions/FFT2.md | 14 +- docs/api/functions/FFTImag.md | 14 +- docs/api/functions/FFTImag2.md | 14 +- docs/api/functions/FFTReal.md | 14 +- docs/api/functions/FFTReal2.md | 14 +- docs/api/functions/FFTShift.md | 14 +- docs/api/functions/IFFT.md | 14 +- docs/api/functions/IFFT2.md | 14 +- docs/api/functions/IFFTReal.md | 14 +- docs/api/functions/IFFTReal2.md | 14 +- docs/api/functions/K_means.md | 18 +- docs/api/functions/MBR2Plane.md | 14 +- docs/api/functions/Perlin.md | 14 +- docs/api/functions/PointInsidePolygon.md | 14 +- docs/api/functions/PointOutsideMBR.md | 17 +- docs/api/functions/Sin3D.md | 14 +- docs/api/functions/UUID.md | 14 +- docs/api/functions/XY2ColRow.md | 17 +- docs/api/functions/acos.md | 14 +- docs/api/functions/add.md | 14 +- docs/api/functions/adjust_lon.md | 14 +- docs/api/functions/alphaComplex.md | 14 +- docs/api/functions/applyMixins.md | 14 +- docs/api/functions/areaToArea.md | 17 +- docs/api/functions/asin.md | 14 +- docs/api/functions/atan2.md | 14 +- docs/api/functions/bearing.md | 14 +- docs/api/functions/binDrawGrid2d.md | 18 +- docs/api/functions/binarization.md | 17 +- docs/api/functions/binaryColorBand.md | 14 +- docs/api/functions/breadthFirstSearch.md | 14 +- docs/api/functions/calculateArrayShape.md | 14 +- docs/api/functions/calculateMBR.md | 14 +- docs/api/functions/cartesian.md | 14 +- docs/api/functions/cartesianAdd.md | 14 +- docs/api/functions/cartesianAddInPlace.md | 14 +- docs/api/functions/cartesianAngle.md | 14 +- docs/api/functions/cartesianCross.md | 14 +- docs/api/functions/cartesianDot.md | 14 +- docs/api/functions/cartesianNormalize.md | 14 +- .../functions/cartesianNormalizeInPlace.md | 14 +- docs/api/functions/cartesianScale.md | 14 +- docs/api/functions/ccw.md | 17 +- docs/api/functions/ccwRobust.md | 18 +- docs/api/functions/collectionFromFeature.md | 14 +- docs/api/functions/collectionFromGeometry.md | 14 +- docs/api/functions/complateMap.md | 14 +- docs/api/functions/concatEL2DArray.md | 14 +- docs/api/functions/conj.md | 22 +- docs/api/functions/containsMBR.md | 14 +- docs/api/functions/convexHull.md | 14 +- docs/api/functions/cos.md | 14 +- docs/api/functions/createGraph.md | 14 +- docs/api/functions/createGridGraph.md | 17 +- docs/api/functions/cross.md | 14 +- docs/api/functions/cutPolygonByMBR.md | 14 +- docs/api/functions/dampedSin3D.md | 14 +- docs/api/functions/deMaxMin.md | 14 +- docs/api/functions/degToDMS.md | 14 +- docs/api/functions/degreesToRadians.md | 14 +- docs/api/functions/destination.md | 17 +- docs/api/functions/dijkstra.md | 14 +- docs/api/functions/dmsToDeg.md | 18 +- docs/api/functions/dot.md | 14 +- docs/api/functions/drawArrowField.md | 20 +- docs/api/functions/drawCountour.md | 18 +- docs/api/functions/drawGrid2d.md | 20 +- docs/api/functions/drawProgress.md | 18 +- docs/api/functions/drawQTree2d.md | 27 +- docs/api/functions/drawSample.md | 20 +- docs/api/functions/drawSample2.md | 20 +- docs/api/functions/drawText.md | 18 +- docs/api/functions/drawTrueColorGrid2d.md | 20 +- docs/api/functions/emptyObj.md | 14 +- docs/api/functions/equals.md | 17 +- docs/api/functions/equalsMBR.md | 14 +- docs/api/functions/extend.md | 14 +- docs/api/functions/fastFFT2.md | 14 +- docs/api/functions/feature.md | 65 ++- docs/api/functions/fillIndexArray.md | 14 +- docs/api/functions/flattenArray.md | 14 +- docs/api/functions/formatNum.md | 14 +- docs/api/functions/fromFeatureObj.md | 19 +- docs/api/functions/fromGeometryObj.md | 19 +- docs/api/functions/getAngle.md | 14 +- docs/api/functions/getMBRWithAntimeridian.md | 14 +- docs/api/functions/getPointsMBR.md | 14 +- docs/api/functions/gridAstar.md | 17 +- docs/api/functions/gridBreadthFirstSearch.md | 17 +- docs/api/functions/gridDijkstra.md | 17 +- docs/api/functions/gridReconstructPath.md | 17 +- docs/api/functions/haversin.md | 14 +- docs/api/functions/haversine.md | 17 +- docs/api/functions/hist.md | 17 +- docs/api/functions/inCircle.md | 18 +- docs/api/functions/inCircleRobust.md | 18 +- docs/api/functions/intermediatePoint.md | 17 +- docs/api/functions/interpolate.md | 17 +- docs/api/functions/interpolate2.md | 17 +- docs/api/functions/intersection.md | 27 +- docs/api/functions/intersectionPolygon.md | 14 +- docs/api/functions/intersectsMBR.md | 14 +- docs/api/functions/isEPSG3857.md | 14 +- docs/api/functions/isEPSG4326.md | 14 +- docs/api/functions/isFloat.md | 14 +- docs/api/functions/isPotentialGeoObject.md | 14 +- docs/api/functions/iterPolygonEdge.md | 14 +- docs/api/functions/lengthToRadians.md | 14 +- docs/api/functions/mbrToPolygon.md | 14 +- docs/api/functions/mbrToRectangle.md | 14 +- docs/api/functions/merge.md | 14 +- docs/api/functions/mergeArcs.md | 22 +- docs/api/functions/mergeMBR.md | 14 +- docs/api/functions/mergePointMBR.md | 14 +- docs/api/functions/mesh.md | 14 +- docs/api/functions/meshArcs.md | 25 +- docs/api/functions/metersTo.md | 14 +- docs/api/functions/midpoint.md | 14 +- docs/api/functions/neighbors.md | 14 +- docs/api/functions/normalize.md | 14 +- docs/api/functions/object.md | 14 +- docs/api/functions/overlapsMBR.md | 14 +- docs/api/functions/plane2MBR.md | 14 +- docs/api/functions/planeIntersection.md | 27 +- docs/api/functions/planePolygonArea.md | 14 +- docs/api/functions/pointInEdge.md | 17 +- docs/api/functions/pointInMBR.md | 14 +- .../functions/pointInMBRWithAntimeridian.md | 14 +- docs/api/functions/prePointInPolygon.md | 14 +- docs/api/functions/pseudoColorBandFactory.md | 17 +- docs/api/functions/radiansToDegrees.md | 14 +- docs/api/functions/radiansToLength.md | 14 +- docs/api/functions/randomIndexArray.md | 14 +- docs/api/functions/reactGrid2d.md | 19 +- docs/api/functions/reconstructPath.md | 17 +- docs/api/functions/rectangleToMBR.md | 14 +- docs/api/functions/reverse.md | 14 +- docs/api/functions/round.md | 14 +- docs/api/functions/sample.md | 20 +- docs/api/functions/scale.md | 14 +- docs/api/functions/sign.md | 14 +- docs/api/functions/simpleColorBand.md | 17 +- docs/api/functions/simpleColorBandFactory.md | 14 +- docs/api/functions/simplePseudoColorBand.md | 14 +- docs/api/functions/sin.md | 14 +- docs/api/functions/sphereIntersection.md | 18 +- docs/api/functions/spherical.md | 14 +- docs/api/functions/sphericalArea.md | 14 +- .../api/functions/splitMBRWithAntimeridian.md | 14 +- docs/api/functions/sqrt.md | 14 +- docs/api/functions/squareMetersTo.md | 14 +- docs/api/functions/subColumnInEL2DArray.md | 14 +- docs/api/functions/subdivide2QTree.md | 14 +- docs/api/functions/testProgress.md | 14 +- docs/api/functions/throttle.md | 14 +- docs/api/functions/toLineString.md | 14 +- docs/api/functions/toMeters.md | 14 +- docs/api/functions/toMultiPoint.md | 14 +- docs/api/functions/toPoint.md | 40 +- docs/api/functions/toSquareMeters.md | 14 +- docs/api/functions/topology.md | 14 +- docs/api/functions/transform.md | 14 +- docs/api/functions/triangleCenter.md | 18 +- docs/api/functions/trueColorBand.md | 17 +- docs/api/functions/trueColorBandFactory.md | 14 +- docs/api/functions/unitToUnit.md | 17 +- docs/api/functions/untransform.md | 14 +- docs/api/functions/worleyNoise.md | 17 +- docs/api/functions/zebraNoise.md | 18 +- docs/api/globals.md | 248 --------- docs/api/index.md | 256 +++++++++ docs/api/interfaces/CRS.md | 58 +- docs/api/interfaces/GeoJSONFeature.md | 42 +- .../interfaces/GeoJSONFeatureCollection.md | 28 +- docs/api/interfaces/GeoJSONGeometry.md | 22 +- .../interfaces/GeoJSONGeometryCollection.md | 28 +- docs/api/interfaces/GeoJSONLineString.md | 22 +- docs/api/interfaces/GeoJSONMultiLineString.md | 22 +- docs/api/interfaces/GeoJSONMultiPoint.md | 22 +- docs/api/interfaces/GeoJSONMultiPolygon.md | 22 +- docs/api/interfaces/GeoJSONPoint.md | 22 +- docs/api/interfaces/GeoJSONPolygon.md | 22 +- docs/api/interfaces/Graph.md | 40 +- docs/api/interfaces/GridGraph.md | 40 +- docs/api/interfaces/Projection.md | 34 +- docs/api/interfaces/Transform.md | 22 +- docs/api/interfaces/customRange.md | 22 +- docs/api/type-aliases/AreaUnits.md | 21 +- docs/api/type-aliases/Complex.md | 22 +- docs/api/type-aliases/MBR.md | 14 +- docs/api/type-aliases/QTNode.md | 38 +- docs/api/type-aliases/Rectangle.md | 30 +- docs/api/type-aliases/Units.md | 29 +- docs/api/type-aliases/gridValueStrategy.md | 14 +- docs/api/typedoc-sidebar.json | 1 + docs/api/variables/CountourColorList.md | 14 +- docs/api/variables/D2R.md | 14 +- docs/api/variables/EPSG3857.md | 14 +- docs/api/variables/EPSG900913.md | 14 +- docs/api/variables/EPSLN.md | 14 +- docs/api/variables/Earth.md | 14 +- docs/api/variables/R2D.md | 14 +- docs/api/variables/SphericalMercator.md | 14 +- docs/api/variables/areaFactors.md | 14 +- docs/api/variables/earthRadius.md | 14 +- docs/api/variables/factors.md | 14 +- docs/api/variables/factors2.md | 14 +- docs/api/variables/halfPi.md | 14 +- docs/api/variables/pi.md | 14 +- docs/assets/logo.svg | 38 +- docs/documents/index.md | 223 +++++++- docs/index.md | 2 +- package-lock.json | 517 +++++++++++++++++- package.json | 4 +- tsconfig.json | 18 +- 238 files changed, 3800 insertions(+), 3060 deletions(-) delete mode 100644 docs/api/README.md delete mode 100644 docs/api/globals.md create mode 100644 docs/api/index.md create mode 100644 docs/api/typedoc-sidebar.json diff --git a/README.md b/README.md index 44823c4..e805f21 100644 --- a/README.md +++ b/README.md @@ -1,325 +1,2 @@ # RVGeo [home page](https://pzq123456.github.io/RVGeo/) - -[![](https://img.shields.io/npm/v/rvgeo.svg?label=NPM&logo=npm&color=CB3837)](https://www.npmjs.com/package/rvgeo) -[![](https://img.shields.io/npm/dm/rvgeo?label=Downloads&color=CB3837&logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAAsQAAALEBxi1JjQAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAKoSURBVEiJ7ZZLTBNRFIb%2FedDS6UNKVQgZAkJTlJdACoZgGhKj0QSNwUVxIbrRhSaasCJh58atcaExkYXogoRISF2UxJVReYkWK6gTB9KK1bZjBQlMNcz0ujAlJe3QamSl%2F%2B7m3PP995w592aAbRaVy6bqanujycZeSa4TKlGXo2qvKIpStlw2FwOdjnG5zvFnS%2BuMAIDJoci3icHoLQB%2FxwAATDYWBSX5AADOwiZyzaNz3fin%2Bm%2FwDxhojSlTW19xgaXz9ACgqIpr05WkQOWb6dMNDVUHAUBJrP%2BY9S%2FcBpA2vpo3udHpeNx0sqiNrzExFEVQWm8Gq%2FtVsLysIPxeBgB8nFtVfZ7o2MspwZWJo9kiKSwf9Xujs9YSHfY4d2zAAYArYFHRbEEhr4ffK71VgsvHtDiMVmBlZUXRMeaRRd9qZ%2B0RmzXVAAASCsHA5XcLkWC8XQiFlrQ4W37kQCAQlhbXOwd7hVBCIZvg%2FlFpms6nnYFAILwVQ7OCpGKxWMRssIhRUT60r73QCACeawuSbyTWN%2FXkzYts%2BRtTVNfc9ojhOCtREsxaJHhRFMXxZMzvEz163V7H0%2Fuf%2BmhC6KBv7cbMjDCUCrLb7a3GorKbFEurqiwvvX7%2B7PAmp5YO93yPQEhXv5c4yivdmU7jbK0acLY57maKOcor3V39XtIjENLS4Z5PqyApmmHA6jkuE2R6XOjW6ARYPcfRTHrH0wxsNU5wFfarDcXFl7RgmZRnMO0urG3ewiChqgCQZ7HCdX2YB8D%2FjkGqiKqoaQbxr1%2BmPowO8Tv3HzCAYcDtKoEcDQGEgCviEZc%2Bg6hKVrj0aiL%2BfSk2mVynPhV0dVPLeZ3B2ApCkcoTZ4bnHw6cAoCy490Pgp57naBI1p%2BE9TV5bG5m8g4yvEvbop%2BZL%2FJtWVlNhAAAAABJRU5ErkJggg%3D%3D)](https://www.npmjs.com/package/rvgeo) -[![](https://data.jsdelivr.com/v1/package/npm/rvgeo/badge)](https://www.jsdelivr.com/package/npm/rvgeo) -## Usage -### Browser -``` html - -``` -- test: -```js - console.log(rvgeo); -``` -- result: -``` bash -Module -CGUtils: Module { -MBRIntersectMBR: function, PointInsidePolygon: function, PointOutsideMBR: function, calculateMBR: function, cross: function, …} -#... -``` -### npm - -``` bash -npm install rvgeo -``` - -```js -import * as RVGeo from 'rvgeo' -``` - -> - RVGeo (V2.0.0) is now available on [npm](https://www.npmjs.com/package/rvgeo). -> - [more information](https://pzq123456.github.io/RVGeo/) - -## TODO List -- [x] 移动方格法实现等高线绘制 -- [ ] 三维地形渲染（为保持库内容精简，使用原生 WebGL 实现） -- [x] 三通道彩色渲染器（针对多波段遥感数据） -- [ ] 栅格计算操作（卷积、滤波、腐蚀、膨胀等） -- [ ] GeoTIFF 数据读取模块 - ---- - -- [x] Contour drawing based on moving square method -- [ ] 3D terrain rendering (to keep the content of the library concise, use native WebGL implementation) -- [x] Three-channel color renderer (for multi-band remote sensing data) -- [ ] Raster calculation operations (convolution, filtering, erosion, expansion, etc.) -- [ ] GeoTIFF data reading module - -> - 现在可以在 `RVGeo.BMAPDraw` 中访问到百度地图的绘制工具，该工具基于百度地图的绘制工具，但是对于绘制的图形进行了封装，使得其可以与 RVGeo 的其他图形进行交互。 -> - Now you can access the drawing tool of Baidu Map in `RVGeo.BMAPDraw`. The tool is based on the drawing tool of Baidu Map, but the drawn graphics are encapsulated so that they can interact with other graphics of RVGeo. - -## Release Notes -### 2023-11-12 V2.0.7 -> new function for Class Grid : `Grid.fillInvalidValue(bandIndex)`; -> - This function can replace the "invalid value" in given band with the mean value. -> - The so called values are now: -99999, 0. (may the 0 makes no sense and this function will uograde in the future) -- 新增 `RGB` 三通道遥感影像渲染，指定渲染通道对应的波段即可实现真彩色、标准假彩色等遥感影像的渲染。 -- Add `RGB` three-channel remote sensing image rendering, specify the band corresponding to the rendering channel to achieve the rendering of true color, standard false color and other remote sensing images. - -```js -const drawGrid2d = RVGeo.Renderer.drawGrid2d; -const trueColorBandFactory = RVGeo.Colors.trueColorBandFactory; -const drawTrueColorGrid2d2 = RVGeo.Renderer.drawTrueColorGrid2d2; - -let URL = 'exa2.tif'; -let URL2 = 'exa.tif'; -let rect = {x: 512, y: 0, w: 512, h: 512}; -let rect2 = {x: 512, y: 512, w: 512, h: 512}; -getShowTif(URL, rect); -getShowTif(URL2, rect2); - -function getShowTif(URL: string, rect: {x: number, y: number, w: number, h: number}){ -GeoTIFF.fromUrl(URL).then((tif:any) => { - tif.getImage().then((image:any) => { - let width = image.getWidth(); - // let height = image.getHeight(); - image.readRasters().then((rasters:any) => { - let data = [] as number[][][]; - //选择 LadSet8 的 4、3、2 波段 - let bands = [3,2,1]; // 但是索引是从 0 开始的 - bands.forEach((band) => { - data.push(parseData2(rasters[band], width,true,256)); - }); - console.log(data); - let grid = new RVGeo.Coverage.Grid(myMBR1,data); - let myTrueColorBand = trueColorBandFactory(RVGeo.Colors.stretchType.linear); - drawTrueColorGrid2d2(canvas, grid, [0,1,2],rect, myTrueColorBand); - }); - }); -}); -} -``` -- 新增影像直方图，正在测试中，仅供参考。 -```js - const drawSample2 = RVGeo.Renderer.drawSample2; - const drawProgress = RVGeo.Renderer.drawProgress; - const progressBar = {x: 924, y: 1004, w: 100, h: 20}; - drawProgress(canvas,progressBar,0); - - const trueColorBandFactory = RVGeo.Colors.trueColorBandFactory; - const drawTrueColorGrid2d = RVGeo.Renderer.drawTrueColorGrid2d; - - let URL = 'exa2.tif'; - let URL2 = 'exa.tif'; - let rect = {x: 0, y: 0, w: 512, h: 512}; - let rect2 = {x: 0, y: 512, w: 512, h: 512}; - - let rect3r = {x: 512, y: 0, w: 512, h: 170}; - let rect3g = {x: 512, y: 170, w: 512, h: 170}; - let rect3b = {x: 512, y: 340, w: 512, h: 170}; - let rect4r = {x: 512, y: 512, w: 512, h: 170}; - let rect4g = {x: 512, y: 682, w: 512, h: 170}; - let rect4b = {x: 512, y: 852, w: 512, h: 170}; - - getShowTif(URL, rect, [rect3r,rect3g,rect3b]); - getShowTif(URL2, rect2, [rect4r,rect4g,rect4b]); - - -function getShowTif(URL: string, rect: {x: number, y: number, w: number, h: number}, - rect2?: {x: number, y: number, w: number, h: number}[] - ){ - GeoTIFF.fromUrl(URL).then((tif:any) => { - tif.getImage().then((image:any) => { - let width = image.getWidth(); - image.readRasters().then((rasters:any) => { - let data = [] as number[][][]; - // 4、3、2 波段 但是数组的索引是从0开始的 所以是3、2、1 - let bands = [3,2,1]; - bands.forEach((band) => { - data.push(parseData2(rasters[band], width, true, 256)); - }); - let grid = new RVGeo.Coverage.Grid(myMBR1,data); - - grid.fillInvalidValue(0); // 填充无效值 - grid.fillInvalidValue(1); - grid.fillInvalidValue(2); - - let myTrueColorBand = trueColorBandFactory(RVGeo.Colors.stretchType.square); - drawTrueColorGrid2d(canvas, grid, [0,1,2], rect, myTrueColorBand); - drawProgress(canvas,progressBar,50); - if(rect2){ - let styles = [ - {color: "rgba(255,0,0,1)", backgroundColor: "rgba(0,0,0,1)"}, - {color: "rgba(0,255,0,1)", backgroundColor: "rgba(0,0,0,1)"}, - {color: "rgba(0,0,255,1)", backgroundColor: "rgba(0,0,0,1)"} - ] - for(let i = 0; i < rect2.length; i++){ - drawSample2(canvas,rect2[i],grid.getSorted1DArray(i),styles[i]); - } - } - drawProgress(canvas,progressBar,100); - }); - }); - }); -} -``` -### 2023-11-12 V2.0.6 -- 新增影像金字塔（Example14） 图像傅里叶变换（Example15） -- New image pyramid (Example14) image Fourier transform (Example15) -- You can use `RVGeo.Coverage.subdivide2QTree` to get the image pyramid, and use `RVGeo.Renderer.drawQTree2d` to draw the image pyramid. - ```js - const subdivide2QTree = RVGeo.Coverage.subdivide2QTree; - const Grid = RVGeo.Coverage.Grid; - const drawQTree2d = RVGeo.Renderer.drawQTree2d; - const drawGrid2d = RVGeo.Renderer.drawGrid2d; - let mySimpleColorBand = RVGeo.Colors.simpleColorBandFactory(RVGeo.Colors.stretchType.linear); - axios.get('dem.csv').then((res)=>{ - let data = parseData(res.data); - let grid = new Grid(myMBR1,[data]); - let subgrid = subdivide2QTree(grid,10); // 10 为金字塔层数 - drawQTree2d(canvas,{x: 0, y: 0, w: 1024, h: 1024},subgrid,grid,mySimpleColorBand) - drawGrid2d(canvas, data, {x: 1024, y: 0, w: 1024, h: 1024}, grid.getBandStatistics(0), mySimpleColorBand); - }); - ``` -- You can use the following code segment to test 1D FFT and visualize the result. - ``` js - const subdivide2QTree = RVGeo.Coverage.subdivide2QTree; - const Grid = RVGeo.Coverage.Grid; - const drawQTree2d = RVGeo.Renderer.drawQTree2d; - const drawGrid2d = RVGeo.Renderer.drawGrid2d; - let mySimpleColorBand = RVGeo.Colors.simpleColorBandFactory(RVGeo.Colors.stretchType.linear); - axios.get('dem.csv').then((res)=>{ - let data = parseData(res.data); - let grid = new Grid(myMBR1,[data]); - let subgrid = subdivide2QTree(grid,10); - drawQTree2d(canvas,{x: 0, y: 0, w: 1024, h: 1024},subgrid,grid,mySimpleColorBand) - drawGrid2d(canvas, data, {x: 1024, y: 0, w: 1024, h: 1024}, grid.getBandStatistics(0), mySimpleColorBand); - }); - ``` -- You can use the following code segment to test 2D FFT and visualize the result. - ``` js - const subdivide2QTree = RVGeo.Coverage.subdivide2QTree; - const Grid = RVGeo.Coverage.Grid; - const drawQTree2d = RVGeo.Renderer.drawQTree2d; - const drawGrid2d = RVGeo.Renderer.drawGrid2d; - let mySimpleColorBand = RVGeo.Colors.simpleColorBandFactory(RVGeo.Colors.stretchType.linear); - axios.get('dem.csv').then((res)=>{ - let data = parseData(res.data); - let grid = new Grid(myMBR1,[data]); - let subgrid = subdivide2QTree(grid,10); - drawQTree2d(canvas,{x: 0, y: 0, w: 1024, h: 1024},subgrid,grid,mySimpleColorBand) - drawGrid2d(canvas, data, {x: 1024, y: 0, w: 1024, h: 1024}, grid.getBandStatistics(0), mySimpleColorBand); - }); - ``` - - -### 2023-11-4 V2.0.5 -- 新增等值线计算与渲染（基于 Marching Squares 方法） -- Contour calculation and rendering (based on Marching Squares method) -- You can use `RVGeo.Renderer.drawCountour` to draw contour lines, after you get the contour code from `RVGeo.Coverage.Grid.getCoutourCode` -```ts - const drawCountour = RVGeo.Renderer.drawCountour; - - axios.get('dem.csv').then((res)=>{ - let data = parseData(res.data); - let grid = new RVGeo.Coverage.Grid(myMBR1,[data]); - let countour1 = grid.getCoutourCode(0,0.6); - drawCountour(canvas, countour1, {x: 0, y: 0, w: 1024, h: 1024},"red"); - }) -``` - - -### 2023-11-2 V2.0.4 -- 栅格数据新增伪彩色渲染器 -- New pseudocolor renderer for raster data -- 噪声模块新增三维 sin 函数噪声、三维柏林噪声及三维阻尼 sin 函数噪声 -- New 3D sin noise, 3D Perlin noise and 3D damped sin noise in noise module - -## 项目说明 | Project Description -- `main` 分支为稳定（npm 发布）版本，`next` 分支为开发版本。文档及示例网站均基于 `next` 分支。 -- `main` branch is the stable version (npm release), `next` branch is the development version. The documentation and example website are based on the `next` branch. -- `main` 分支不含除了库本身以外的任何文件，`next` 分支包含文档、示例网站、示例代码等。 -- `api reference` https://pzq123456.github.io/RVGeo/ -- `Usage` https://pzq123456.github.io/RVGeo/tutorials/index.html - -## Example -```js -let ps = mockPoints(30, myMBR1); -let mps = new RVGeo.Geometry.MultiPoint(ps); - -function example1(){ // 绘制多点及其重心 - removeAllOverlay(map); - let icon = innerIcon(0); - // console.log(mps.calculateCentroid()); - drawPoint2BLMap(mps.calculateCentroid(), map); - drawMultiPoint2BLMap(mps, map, icon); -} -``` - -## 本包的潜在优势 | Potential Advantages -- 便捷快速地引入基础空间分析算法 -- Conviniently import basic spatial analysis algorithms -- 跨地图服务商的一致性开发体验 -- Consistent development experience across map service providers - -## 总览 | Overview - -![](/DrawIO/module.svg) - -> 图片说明： -> - 虚线框中代表尚未实现（或正在实现）的模块 -> - 模块在纵向存在依赖（一定的）关系，且左侧部分为矢量数据提供支持，右侧为栅格数据 -> - 核心包与插件系统：紫色实线矩形代表 RVGeo 2.0 的核心包，蓝色虚线矩形代表数据 I/O 插件（设计用于解析和生成不同格式的数据），顶部灰色虚线矩形代表渲染引擎 - -### 1. Data I/O Module (working...) -> - 该模块目前尚未正式实现，一些代码片段可以在示例代码中找到。 -- 该模块封装了 `axios` 包用以获取数据，暂时实现了 `GeoJSON` 及 `CSV` 数据格式的读取与转换。该模块一般将数据解析为多维数组（中间格式），并传递给 `Meta` 模块用以产生内置 `Geometry` 或 `Coverage` 对象。 -- 对于 tif 数据，暂时使用 geoTiff.js 库进行解析，且并未封装。 -- GeoJSON 及其他标准数据格式的解析与导出尚在设计中，目前的设计思路是使用 `TypeScript` 中的类来实现 `GeoJSON` 标准，同时提供一些工具函数用以转换为其他格式。 -### 2. Meta Module (working...) -该部分仍在设计中。目前可以使用 Geometry 类自带的构造函数来创建几何对象。 - -### 3. [Geometry Moudle](https://pzq123456.github.io/RVGeo/modules/Geometry.html) -基于 `GeoJSON` 标准，该模块内部维护了对应的几何对象，主要包括： - - `Point` - - `MultiPoint` - - `LineString` - - `MultiLineString` - - `Polygon` - -### 4. [Coverage](https://pzq123456.github.io/RVGeo/modules/Coverage.html) -该模块的数据结构由两部分组成：代表栅格数据的多维数组和代表（矢量）地理覆盖的矩形对象。可通过简单的分割算法将栅格多维数组均匀地分配到地理覆盖矩形的各个格网中。该数据结构可以尽量做到与 `GeoJSON` 中的 `Polygon` 相兼容。 - -### 5. [Unit](https://pzq123456.github.io/RVGeo/modules/Unit.html) -该模块主要用于处理单位换算问题，支持多种单位的互相转换，转换参数以常数的形式记录并提供一些工具函数方便用户进行快速单位换算。 - -### 6. [Reference](https://pzq123456.github.io/RVGeo/modules/Reference.html) -该模块主要用于坐标系转换，目前仅实现了 `WGS84` 与 Web 墨卡托坐标系的互相转换。(epsg:4326 <---> epsg:3857) 也就是（椭）球面坐标系与平面坐标系之间的（部分）相互转换。 - -### 7. [Colors](https://pzq123456.github.io/RVGeo/modules/Colors.html) -该模块的本质是数值到颜色的映射函数，矢量与栅格都要用到。 - -> - 以上就是 RVGeo 的基础模块，这些简单的模块是下一步更加复杂模块的基础。另外，我们也将 `GeoJSON` 的规则使用 `TypeScript` 中的类部分实现，这些基础模块是维持包接口稳定、规范的重要部分。 - -### 8. [Measuration Module](https://pzq123456.github.io/RVGeo/modules/Measuration.html) -量测模块，该模块主要用于距离、面积等参数的量测，属于相对基础的功能（但是又需要依赖几何对象）所以位于第二层级。目前主要提供球面与平面两种坐标系下的数值量测功能接口，一般情况下，认为球面量测较为准确（平面量测受到纬度投影变形的影响），也推荐使用球面量测算法。 - -### 9. [Spatial computing Module](https://pzq123456.github.io/RVGeo/modules/CGUtils.html) -空间计算模块，主要是二维的计算几何，日后也会整合三维几何计算的相关算法。目前仅实现了直线求交及（简单）多边形求交。 - -### 10. (Grid) Statistics Module: `Grid.getBandStatistics(bandIndex: number)` -栅格（格网）统计模块，该模块是进行栅格计算与渲染的基础模块。~~该模块可能会集成在 Grid 类中，视实现情况而定。~~该模块所代表的功能位于栅格类中，并且只提供最简单的统计功能，复杂的统计功能将由其他模块提供。 - -> - 以上是第二层级模块，这些模块为更复杂的功能模块提供了功能基础，同时避免了对底层模块对象的直接操作。 - -### 11. [Delaunay Module](https://pzq123456.github.io/RVGeo/modules/Delaunay.html) -（二维）狄罗妮三角网模块，该模块依赖底层基础模块提供的空间量测与计算能力并为更加复杂的功能模块提供数据结构方面的支持。`Voronoi` 图作为狄罗妮三角网的对偶图也顺带提供。 - -### 12. [Shell Module](https://pzq123456.github.io/RVGeo/modules/Shell.html) -目前实现了凸包算法以及 alpha complex 算法。该模块依赖于 `Delaunay` 模块提供的数据结构。 - -> - 可以使用以下命令克隆该分支代码： -``` bash -git clone --branch next --single-branch https://github.com/pzq123456/RVGeo.git -``` -## 概念及设计 -### 渲染能力 -- 二维 Canvas 上下文：这部分主要用于渲染栅格数据，我们可以将栅格数据渲染好后再通过地图平台的接口绘制到地图上。 -- 三维 WebGL 上下文：这部分尚未实现，计划采用 three.js 来实现，主要用于渲染 DEM 数据及其他三维数据。主要用来实现一些创新功能。 -- 依附现有的 WGS84 地图渲染库（百度地图、高德地图、MapBox等）。 -> - 当前样例功能依附百度地图 \ No newline at end of file diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 1770bb6..f9c4d89 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -1,4 +1,5 @@ -import { defineConfig } from 'vitepress' +import { defineConfig } from 'vitepress'; +import typedocSidebar from "../api/typedoc-sidebar.json"; // https://vitepress.dev/reference/site-config export default defineConfig({ @@ -11,16 +12,15 @@ export default defineConfig({ nav: [ { text: 'Home', link: '/' }, { text: 'Docs', link: '/documents' }, - { text: 'API', link: '/api/globals' } + { text: 'API', link: '/api' } ], sidebar: [ + + { text: 'Docs', link: '/documents' }, { - text: 'Examples', - items: [ - { text: 'Docs', link: '/documents' }, - { text: 'API', link: '/api/globals' } - ] + text: 'API', + items: typedocSidebar, } ], @@ -33,5 +33,8 @@ export default defineConfig({ footer: { copyright: `Released under the MIT License. Copyright © 2022-present pzq123456 ` }, + }, + markdown: { + math: true } }) diff --git a/docs/.vitepress/theme/custom.css b/docs/.vitepress/theme/custom.css index 9395661..ed0cbf4 100644 --- a/docs/.vitepress/theme/custom.css +++ b/docs/.vitepress/theme/custom.css @@ -10,7 +10,7 @@ :root { --vp-home-hero-name-color: transparent; --vp-home-hero-name-background: -webkit-linear-gradient(120deg, #7a27c3 30%, #19aedf); /* 更新为新主题色 */ - --vp-home-hero-image-background-image: linear-gradient(-45deg,rgba(108, 11, 219, 0.41) 50%,rgba(166, 204, 235, 0.54) 50%); /* 更新为新主题色 */ + --vp-home-hero-image-background-image: linear-gradient(-45deg,rgba(108, 11, 219, 0.41) 50%,rgba(51, 91, 239, 0.54) 50%); /* 更新为新主题色 */ --vp-home-hero-image-filter: blur(50px); } diff --git a/docs/api/README.md b/docs/api/README.md deleted file mode 100644 index 749e27b..0000000 --- a/docs/api/README.md +++ /dev/null @@ -1,96 +0,0 @@ -**rvgeo** - -*** - -# RVGeo 2.0.9 改动说明 -- demo: https://pzq123456.github.io/RVGeo/dist/index.html -- docs: this site - -> - 2024.3.28 12:27:00 UTC + 08:00 -该版本调整了项目结构，部分接口发生变化（降级或移除）。 -- 降级：所有方法内指定 unit 单位的功能均不再支持，默认单位为米。在 math 模块下仍保留原来的单位换算方法，可以直接调用。主要目的是维护全局坐标系统一，原先的写法会默认带入 km、m 的混合问题。 -- 重构： - - Geometry 模块的所有代码均已重构，类中接口有部分改动，类继承关系完全改变。 - - 需要注意的是，不再有 toArray 方法，现在可以直接（只读）获取符合 GeoJSON 标准的 coordinates 。具体改动可以参考源代码。 - - toXYArray 方法也都改名为 toXY 。这样做可以更好地统一独立geometry 与 multigeometry 之间的语意。 -- 功能增强： - - Topology 模块直接复制并修改 TopoJSON 代码库（将其由 js 转化为了 TypeScript），现在你可以将 GeoJSON 格式的数据转化为 TopoJSON，并调用一些诸如 merge、mesh 等方法来操纵它。（详细用法请参考 TopoJSON Client） - - Geo 模块：参考 leaflet 为每一种投影及坐标系实现一个 object ，这样可以更好地管理多种坐标系。（当前仍然只有 wgs84 的投影与反投影）这也就意味着，原先的 plane2Wgs84 及其逆方法 Wgs842Plane 被移除。现在你需要指定某一投影实体 object，譬如 `SphereMercator.project()` 或 `SphereMercator.unproject()` 来达到同样的功能。 - -## origonal RVGeo Welcom Page -## Release Notes -### 2023-11-12 V2.0.7 -> new function for Class Grid : `Grid.fillInvalidValue(bandIndex)`; -> - This function can replace the "invalid value" in given band with the mean value. -> - The so called values are now: -99999, 0. (may the 0 makes no sense and this function will uograde in the future) -- 新增 `RGB` 三通道遥感影像渲染，指定渲染通道对应的波段即可实现真彩色、标准假彩色等遥感影像的渲染。 -- Add `RGB` three-channel remote sensing image rendering, specify the band corresponding to the rendering channel to achieve the rendering of true color, standard false color and other remote sensing images. - -- 新增影像直方图，正在测试中，仅供参考。 -### 2023-11-12 V2.0.6 -- 新增影像金字塔（Example14） 图像傅里叶变换（Example15） -- New image pyramid (Example14) image Fourier transform (Example15) -- You can use `RVGeo.Coverage.subdivide2QTree` to get the image pyramid, and use `RVGeo.Renderer.drawQTree2d` to draw the image pyramid. - ```js - const subdivide2QTree = RVGeo.Coverage.subdivide2QTree; - const Grid = RVGeo.Coverage.Grid; - const drawQTree2d = RVGeo.Renderer.drawQTree2d; - const drawGrid2d = RVGeo.Renderer.drawGrid2d; - let mySimpleColorBand = RVGeo.Colors.simpleColorBandFactory(RVGeo.Colors.stretchType.linear); - axios.get('dem.csv').then((res)=>{ - let data = parseData(res.data); - let grid = new Grid(myMBR1,[data]); - let subgrid = subdivide2QTree(grid,10); // 10 为金字塔层数 - drawQTree2d(canvas,{x: 0, y: 0, w: 1024, h: 1024},subgrid,grid,mySimpleColorBand) - drawGrid2d(canvas, data, {x: 1024, y: 0, w: 1024, h: 1024}, grid.getBandStatistics(0), mySimpleColorBand); - }); - ``` -- You can use the following code segment to test 1D FFT and visualize the result. - ``` js - const subdivide2QTree = RVGeo.Coverage.subdivide2QTree; - const Grid = RVGeo.Coverage.Grid; - const drawQTree2d = RVGeo.Renderer.drawQTree2d; - const drawGrid2d = RVGeo.Renderer.drawGrid2d; - let mySimpleColorBand = RVGeo.Colors.simpleColorBandFactory(RVGeo.Colors.stretchType.linear); - axios.get('dem.csv').then((res)=>{ - let data = parseData(res.data); - let grid = new Grid(myMBR1,[data]); - let subgrid = subdivide2QTree(grid,10); - drawQTree2d(canvas,{x: 0, y: 0, w: 1024, h: 1024},subgrid,grid,mySimpleColorBand) - drawGrid2d(canvas, data, {x: 1024, y: 0, w: 1024, h: 1024}, grid.getBandStatistics(0), mySimpleColorBand); - }); - ``` -- You can use the following code segment to test 2D FFT and visualize the result. - ``` js - const subdivide2QTree = RVGeo.Coverage.subdivide2QTree; - const Grid = RVGeo.Coverage.Grid; - const drawQTree2d = RVGeo.Renderer.drawQTree2d; - const drawGrid2d = RVGeo.Renderer.drawGrid2d; - let mySimpleColorBand = RVGeo.Colors.simpleColorBandFactory(RVGeo.Colors.stretchType.linear); - axios.get('dem.csv').then((res)=>{ - let data = parseData(res.data); - let grid = new Grid(myMBR1,[data]); - let subgrid = subdivide2QTree(grid,10); - drawQTree2d(canvas,{x: 0, y: 0, w: 1024, h: 1024},subgrid,grid,mySimpleColorBand) - drawGrid2d(canvas, data, {x: 1024, y: 0, w: 1024, h: 1024}, grid.getBandStatistics(0), mySimpleColorBand); - }); - ``` -### 2023-11-4 V2.0.5 -- 新增等值线计算与渲染（基于 Marching Squares 方法） -- Contour calculation and rendering (based on Marching Squares method) -- You can use `RVGeo.Renderer.drawCountour` to draw contour lines, after you get the contour code from `RVGeo.Coverage.Grid.getCoutourCode` -```ts - const drawCountour = RVGeo.Renderer.drawCountour; - - axios.get('dem.csv').then((res)=>{ - let data = parseData(res.data); - let grid = new RVGeo.Coverage.Grid(myMBR1,[data]); - let countour1 = grid.getCoutourCode(0,0.6); - drawCountour(canvas, countour1, {x: 0, y: 0, w: 1024, h: 1024},"red"); - }) -``` -### 2023-11-2 V2.0.4 -- 栅格数据新增伪彩色渲染器 -- New pseudocolor renderer for raster data -- 噪声模块新增三维 sin 函数噪声、三维柏林噪声及三维阻尼 sin 函数噪声 -- New 3D sin noise, 3D Perlin noise and 3D damped sin noise in noise module diff --git a/docs/api/classes/Circle.md b/docs/api/classes/Circle.md index accb709..15790e4 100644 --- a/docs/api/classes/Circle.md +++ b/docs/api/classes/Circle.md @@ -1,12 +1,8 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / Circle -*** - -[rvgeo](../globals.md) / Circle - -# Class: Circle +# Circle -Defined in: src/geometry/Circle.ts:5 +Defined in: [src/geometry/Circle.ts:5](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Circle.ts#L5) 平面图形：圆形 @@ -14,9 +10,14 @@ Defined in: src/geometry/Circle.ts:5 ### new Circle() -> **new Circle**(`x`, `y`, `r`): [`Circle`](Circle.md) +```ts +new Circle( + x, + y, + r): Circle +``` -Defined in: src/geometry/Circle.ts:17 +Defined in: [src/geometry/Circle.ts:17](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Circle.ts#L17) 构造函数 @@ -48,41 +49,51 @@ Defined in: src/geometry/Circle.ts:17 ### r -> **r**: `number` +```ts +r: number; +``` -Defined in: src/geometry/Circle.ts:8 +Defined in: [src/geometry/Circle.ts:8](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Circle.ts#L8) *** ### rSquared -> **rSquared**: `number` +```ts +rSquared: number; +``` -Defined in: src/geometry/Circle.ts:9 +Defined in: [src/geometry/Circle.ts:9](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Circle.ts#L9) *** ### x -> **x**: `number` +```ts +x: number; +``` -Defined in: src/geometry/Circle.ts:6 +Defined in: [src/geometry/Circle.ts:6](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Circle.ts#L6) *** ### y -> **y**: `number` +```ts +y: number; +``` -Defined in: src/geometry/Circle.ts:7 +Defined in: [src/geometry/Circle.ts:7](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Circle.ts#L7) ## Methods ### contains() -> **contains**(`point`, `threshold`): `boolean` +```ts +contains(point, threshold): boolean +``` -Defined in: src/geometry/Circle.ts:30 +Defined in: [src/geometry/Circle.ts:30](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Circle.ts#L30) 判断点是否在圆内 @@ -110,9 +121,11 @@ Defined in: src/geometry/Circle.ts:30 ### intersects() -> **intersects**(`range`): `boolean` +```ts +intersects(range): boolean +``` -Defined in: src/geometry/Circle.ts:42 +Defined in: [src/geometry/Circle.ts:42](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Circle.ts#L42) （仅平面下保证有效）判断圆是否与 MBR 相交 @@ -134,9 +147,11 @@ MBR ### isCircle() -> `static` **isCircle**(`obj`): `obj is Circle` +```ts +static isCircle(obj): obj is Circle +``` -Defined in: src/geometry/Circle.ts:69 +Defined in: [src/geometry/Circle.ts:69](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Circle.ts#L69) #### Parameters diff --git a/docs/api/classes/Delaunator.md b/docs/api/classes/Delaunator.md index fa5c67d..5eba0f9 100644 --- a/docs/api/classes/Delaunator.md +++ b/docs/api/classes/Delaunator.md @@ -1,20 +1,18 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / Delaunator -*** - -[rvgeo](../globals.md) / Delaunator - -# Class: Delaunator +# Delaunator -Defined in: src/triangulation/Delaunay.ts:16 +Defined in: [src/triangulation/Delaunay.ts:16](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/triangulation/Delaunay.ts#L16) ## Constructors ### new Delaunator() -> **new Delaunator**(`coords`): [`Delaunator`](Delaunator.md) +```ts +new Delaunator(coords): Delaunator +``` -Defined in: src/triangulation/Delaunay.ts:30 +Defined in: [src/triangulation/Delaunay.ts:30](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/triangulation/Delaunay.ts#L30) #### Parameters @@ -30,9 +28,17 @@ Defined in: src/triangulation/Delaunay.ts:30 ### \_addTriangle() -> **\_addTriangle**(`i0`, `i1`, `i2`, `a`, `b`, `c`): `any` +```ts +_addTriangle( + i0, + i1, + i2, + a, + b, + c): any +``` -Defined in: src/triangulation/Delaunay.ts:360 +Defined in: [src/triangulation/Delaunay.ts:360](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/triangulation/Delaunay.ts#L360) #### Parameters @@ -68,9 +74,11 @@ Defined in: src/triangulation/Delaunay.ts:360 ### \_hashKey() -> **\_hashKey**(`x`, `y`): `number` +```ts +_hashKey(x, y): number +``` -Defined in: src/triangulation/Delaunay.ts:265 +Defined in: [src/triangulation/Delaunay.ts:265](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/triangulation/Delaunay.ts#L265) #### Parameters @@ -90,9 +98,11 @@ Defined in: src/triangulation/Delaunay.ts:265 ### \_legalize() -> **\_legalize**(`a`): `number` +```ts +_legalize(a): number +``` -Defined in: src/triangulation/Delaunay.ts:269 +Defined in: [src/triangulation/Delaunay.ts:269](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/triangulation/Delaunay.ts#L269) #### Parameters @@ -108,9 +118,11 @@ Defined in: src/triangulation/Delaunay.ts:269 ### \_link() -> **\_link**(`a`, `b`): `void` +```ts +_link(a, b): void +``` -Defined in: src/triangulation/Delaunay.ts:354 +Defined in: [src/triangulation/Delaunay.ts:354](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/triangulation/Delaunay.ts#L354) #### Parameters @@ -130,9 +142,17 @@ Defined in: src/triangulation/Delaunay.ts:354 ### circumcenter() -> **circumcenter**(`ax`, `ay`, `bx`, `by`, `cx`, `cy`): `object` +```ts +circumcenter( + ax, + ay, + bx, + by, + cx, + cy): object +``` -Defined in: src/triangulation/Delaunay.ts:438 +Defined in: [src/triangulation/Delaunay.ts:438](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/triangulation/Delaunay.ts#L438) #### Parameters @@ -166,19 +186,25 @@ Defined in: src/triangulation/Delaunay.ts:438 ##### x -> **x**: `any` +```ts +x: any; +``` ##### y -> **y**: `any` +```ts +y: any; +``` *** ### getHalfedges() -> **getHalfedges**(): `any` +```ts +getHalfedges(): any +``` -Defined in: src/triangulation/Delaunay.ts:379 +Defined in: [src/triangulation/Delaunay.ts:379](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/triangulation/Delaunay.ts#L379) #### Returns @@ -188,9 +214,11 @@ Defined in: src/triangulation/Delaunay.ts:379 ### getHull() -> **getHull**(): `any` +```ts +getHull(): any +``` -Defined in: src/triangulation/Delaunay.ts:382 +Defined in: [src/triangulation/Delaunay.ts:382](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/triangulation/Delaunay.ts#L382) #### Returns @@ -200,9 +228,11 @@ Defined in: src/triangulation/Delaunay.ts:382 ### getPoints() -> **getPoints**(): `any`[][] +```ts +getPoints(): any[][] +``` -Defined in: src/triangulation/Delaunay.ts:385 +Defined in: [src/triangulation/Delaunay.ts:385](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/triangulation/Delaunay.ts#L385) #### Returns @@ -212,9 +242,11 @@ Defined in: src/triangulation/Delaunay.ts:385 ### getTriangleIndices() -> **getTriangleIndices**(): \[`number`, `number`, `number`\][] +```ts +getTriangleIndices(): [number, number, number][] +``` -Defined in: src/triangulation/Delaunay.ts:403 +Defined in: [src/triangulation/Delaunay.ts:403](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/triangulation/Delaunay.ts#L403) - get the indices of triangles as array of array of 3 elements - 获得三角形的索引，以3个元素的数组的数组的形式 @@ -227,9 +259,11 @@ Defined in: src/triangulation/Delaunay.ts:403 ### getTriangles() -> **getTriangles**(): `any` +```ts +getTriangles(): any +``` -Defined in: src/triangulation/Delaunay.ts:376 +Defined in: [src/triangulation/Delaunay.ts:376](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/triangulation/Delaunay.ts#L376) #### Returns @@ -239,9 +273,11 @@ Defined in: src/triangulation/Delaunay.ts:376 ### update() -> **update**(): `void` +```ts +update(): void +``` -Defined in: src/triangulation/Delaunay.ts:55 +Defined in: [src/triangulation/Delaunay.ts:55](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/triangulation/Delaunay.ts#L55) #### Returns @@ -251,9 +287,14 @@ Defined in: src/triangulation/Delaunay.ts:55 ### circumRadius() -> `static` **circumRadius**(`p1`, `p2`, `p3`): `number` +```ts +static circumRadius( + p1, + p2, + p3): number +``` -Defined in: src/triangulation/Delaunay.ts:422 +Defined in: [src/triangulation/Delaunay.ts:422](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/triangulation/Delaunay.ts#L422) 计算三点外接圆的半径 @@ -279,9 +320,14 @@ Defined in: src/triangulation/Delaunay.ts:422 ### from() -> `static` **from**(`points`, `getX`, `getY`): [`Delaunator`](Delaunator.md) +```ts +static from( + points, + getX, + getY): Delaunator +``` -Defined in: src/triangulation/Delaunay.ts:17 +Defined in: [src/triangulation/Delaunay.ts:17](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/triangulation/Delaunay.ts#L17) #### Parameters diff --git a/docs/api/classes/Evented.md b/docs/api/classes/Evented.md index 5061488..124e9a5 100644 --- a/docs/api/classes/Evented.md +++ b/docs/api/classes/Evented.md @@ -1,12 +1,8 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / Evented -*** - -[rvgeo](../globals.md) / Evented - -# Class: Evented +# Evented -Defined in: src/core/events.ts:30 +Defined in: [src/core/events.ts:30](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/core/events.ts#L30) 事件基础函数（类，默认构造函数） - 维护两个事件监听器队列（同步、异步） @@ -20,7 +16,9 @@ Defined in: src/core/events.ts:30 ### new Evented() -> **new Evented**(): [`Evented`](Evented.md) +```ts +new Evented(): Evented +``` #### Returns @@ -30,9 +28,11 @@ Defined in: src/core/events.ts:30 ### emit() -> **emit**(`type`, `data`?): `this` +```ts +emit(type, data?): this +``` -Defined in: src/core/events.ts:126 +Defined in: [src/core/events.ts:126](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/core/events.ts#L126) 只会触发非异步事件 @@ -54,9 +54,14 @@ Defined in: src/core/events.ts:126 ### emitAsync() -> **emitAsync**(`type`, `mode`, `data`?): `Promise`\<`void`\> +```ts +emitAsync( + type, + mode, +data?): Promise +``` -Defined in: src/core/events.ts:151 +Defined in: [src/core/events.ts:151](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/core/events.ts#L151) 异步触发事件 - parallel: 并行执行（同时执行所有处理函数） @@ -91,9 +96,11 @@ Defined in: src/core/events.ts:151 ### hasListeners() -> **hasListeners**(`type`): `boolean` +```ts +hasListeners(type): boolean +``` -Defined in: src/core/events.ts:182 +Defined in: [src/core/events.ts:182](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/core/events.ts#L182) 判断是否存在指定事件类型的监听器 @@ -115,9 +122,11 @@ Defined in: src/core/events.ts:182 ### listeners() -> **listeners**(`type`): (`Listener` \| `AsyncListener`)[] +```ts +listeners(type): (Listener | AsyncListener)[] +``` -Defined in: src/core/events.ts:173 +Defined in: [src/core/events.ts:173](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/core/events.ts#L173) 获取指定事件类型的监听器 @@ -139,9 +148,14 @@ Defined in: src/core/events.ts:173 ### off() -> **off**(`type`, `fn`?, `context`?): `this` +```ts +off( + type, + fn?, + context?): this +``` -Defined in: src/core/events.ts:65 +Defined in: [src/core/events.ts:65](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/core/events.ts#L65) 移除事件监听 @@ -167,9 +181,14 @@ Defined in: src/core/events.ts:65 ### on() -> **on**(`type`, `fn`, `context`?): `this` +```ts +on( + type, + fn, + context?): this +``` -Defined in: src/core/events.ts:41 +Defined in: [src/core/events.ts:41](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/core/events.ts#L41) 添加事件监听（同步、异步） @@ -203,9 +222,14 @@ Defined in: src/core/events.ts:41 ### once() -> **once**(`type`, `fn`, `context`?): `this` +```ts +once( + type, + fn, + context?): this +``` -Defined in: src/core/events.ts:112 +Defined in: [src/core/events.ts:112](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/core/events.ts#L112) 添加一次性事件监听 @@ -231,9 +255,11 @@ Defined in: src/core/events.ts:112 ### removeAllListeners() -> **removeAllListeners**(): `this` +```ts +removeAllListeners(): this +``` -Defined in: src/core/events.ts:190 +Defined in: [src/core/events.ts:190](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/core/events.ts#L190) 移除所有事件监听 @@ -247,9 +273,11 @@ Defined in: src/core/events.ts:190 ### isAsyncListener() -> `static` **isAsyncListener**(`listener`): `listener is AsyncListener` +```ts +static isAsyncListener(listener): listener is AsyncListener +``` -Defined in: src/core/events.ts:201 +Defined in: [src/core/events.ts:201](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/core/events.ts#L201) 判断是否为异步监听器 diff --git a/docs/api/classes/Geometry.md b/docs/api/classes/Geometry.md index 97be692..2f42b3c 100644 --- a/docs/api/classes/Geometry.md +++ b/docs/api/classes/Geometry.md @@ -1,12 +1,8 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / Geometry -*** - -[rvgeo](../globals.md) / Geometry - -# Class: `abstract` Geometry +# `abstract` Geometry -Defined in: src/geometry/Geometry.ts:30 +Defined in: [src/geometry/Geometry.ts:30](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L30) Geometry for GeoJSON independent Objects including Point, LineString, Polygon - no GeometryCollection @@ -22,9 +18,11 @@ Geometry for GeoJSON independent Objects including Point, LineString, Polygon ### new Geometry() -> **new Geometry**(`coordinates`, `properties`?): [`Geometry`](Geometry.md) +```ts +new Geometry(coordinates, properties?): Geometry +``` -Defined in: src/geometry/Geometry.ts:40 +Defined in: [src/geometry/Geometry.ts:40](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L40) #### Parameters @@ -44,49 +42,61 @@ Defined in: src/geometry/Geometry.ts:40 ### bbox -> **bbox**: [`MBR`](../type-aliases/MBR.md) +```ts +bbox: MBR; +``` -Defined in: src/geometry/Geometry.ts:31 +Defined in: [src/geometry/Geometry.ts:31](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L31) *** ### coordinates -> `readonly` **coordinates**: `any` +```ts +readonly coordinates: any; +``` -Defined in: src/geometry/Geometry.ts:32 +Defined in: [src/geometry/Geometry.ts:32](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L32) *** ### projection -> `readonly` **projection**: [`Projection`](../interfaces/Projection.md) = `SphericalMercator` +```ts +readonly projection: Projection = SphericalMercator; +``` -Defined in: src/geometry/Geometry.ts:34 +Defined in: [src/geometry/Geometry.ts:34](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L34) *** ### properties -> **properties**: `any` +```ts +properties: any; +``` -Defined in: src/geometry/Geometry.ts:33 +Defined in: [src/geometry/Geometry.ts:33](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L33) *** ### fromFeature -> `static` **fromFeature**: `any` +```ts +static fromFeature: any; +``` -Defined in: src/geometry/Geometry.ts:37 +Defined in: [src/geometry/Geometry.ts:37](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L37) *** ### fromGeometry -> `static` **fromGeometry**: `any` +```ts +static fromGeometry: any; +``` -Defined in: src/geometry/Geometry.ts:38 +Defined in: [src/geometry/Geometry.ts:38](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L38) ## Accessors @@ -94,9 +104,11 @@ Defined in: src/geometry/Geometry.ts:38 #### Set Signature -> **set** **Properties**(`properties`): `void` +```ts +set Properties(properties): void +``` -Defined in: src/geometry/Geometry.ts:49 +Defined in: [src/geometry/Geometry.ts:49](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L49) ##### Parameters @@ -112,9 +124,11 @@ Defined in: src/geometry/Geometry.ts:49 ### clone() -> **clone**(): [`Geometry`](Geometry.md) +```ts +clone(): Geometry +``` -Defined in: src/geometry/Geometry.ts:51 +Defined in: [src/geometry/Geometry.ts:51](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L51) #### Returns @@ -124,9 +138,11 @@ Defined in: src/geometry/Geometry.ts:51 ### equals() -> **equals**(`geometry`): `boolean` +```ts +equals(geometry): boolean +``` -Defined in: src/geometry/Geometry.ts:58 +Defined in: [src/geometry/Geometry.ts:58](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L58) #### Parameters @@ -142,9 +158,11 @@ Defined in: src/geometry/Geometry.ts:58 ### toGeoJSON() -> **toGeoJSON**(): [`GeoJSONFeature`](../interfaces/GeoJSONFeature.md) +```ts +toGeoJSON(): GeoJSONFeature +``` -Defined in: src/geometry/Geometry.ts:64 +Defined in: [src/geometry/Geometry.ts:64](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L64) #### Returns @@ -154,9 +172,11 @@ Defined in: src/geometry/Geometry.ts:64 ### toXY() -> **toXY**(): `any` +```ts +toXY(): any +``` -Defined in: src/geometry/Geometry.ts:35 +Defined in: [src/geometry/Geometry.ts:35](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L35) #### Returns @@ -166,9 +186,11 @@ Defined in: src/geometry/Geometry.ts:35 ### updateBBox() -> `abstract` **updateBBox**(): `void` +```ts +abstract updateBBox(): void +``` -Defined in: src/geometry/Geometry.ts:62 +Defined in: [src/geometry/Geometry.ts:62](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L62) #### Returns @@ -178,9 +200,11 @@ Defined in: src/geometry/Geometry.ts:62 ### fromGeoJSON() -> `static` **fromGeoJSON**(`feature`): [`Geometry`](Geometry.md) \| [`GeometryCollection`](GeometryCollection.md) +```ts +static fromGeoJSON(feature): Geometry | GeometryCollection +``` -Defined in: src/geometry/Geometry.ts:82 +Defined in: [src/geometry/Geometry.ts:82](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L82) #### Parameters diff --git a/docs/api/classes/GeometryCollection.md b/docs/api/classes/GeometryCollection.md index e401819..710ed25 100644 --- a/docs/api/classes/GeometryCollection.md +++ b/docs/api/classes/GeometryCollection.md @@ -1,12 +1,8 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / GeometryCollection -*** - -[rvgeo](../globals.md) / GeometryCollection - -# Class: GeometryCollection +# GeometryCollection -Defined in: src/geometry/Geometry.ts:101 +Defined in: [src/geometry/Geometry.ts:101](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L101) ## Extended by @@ -18,9 +14,11 @@ Defined in: src/geometry/Geometry.ts:101 ### new GeometryCollection() -> **new GeometryCollection**(`geometries`, `properties`?): [`GeometryCollection`](GeometryCollection.md) +```ts +new GeometryCollection(geometries, properties?): GeometryCollection +``` -Defined in: src/geometry/Geometry.ts:108 +Defined in: [src/geometry/Geometry.ts:108](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L108) #### Parameters @@ -40,49 +38,61 @@ Defined in: src/geometry/Geometry.ts:108 ### bbox -> **bbox**: [`MBR`](../type-aliases/MBR.md) +```ts +bbox: MBR; +``` -Defined in: src/geometry/Geometry.ts:104 +Defined in: [src/geometry/Geometry.ts:104](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L104) *** ### coordinates -> **coordinates**: `any` +```ts +coordinates: any; +``` -Defined in: src/geometry/Geometry.ts:102 +Defined in: [src/geometry/Geometry.ts:102](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L102) *** ### geometries -> **geometries**: ([`Geometry`](Geometry.md) \| [`GeometryCollection`](GeometryCollection.md))[] = `[]` +```ts +geometries: (Geometry | GeometryCollection)[] = []; +``` -Defined in: src/geometry/Geometry.ts:103 +Defined in: [src/geometry/Geometry.ts:103](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L103) *** ### projection -> **projection**: [`Projection`](../interfaces/Projection.md) = `SphericalMercator` +```ts +projection: Projection = SphericalMercator; +``` -Defined in: src/geometry/Geometry.ts:106 +Defined in: [src/geometry/Geometry.ts:106](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L106) *** ### properties -> **properties**: `any` +```ts +properties: any; +``` -Defined in: src/geometry/Geometry.ts:105 +Defined in: [src/geometry/Geometry.ts:105](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L105) ## Methods ### \_update() -> **\_update**(`geometry`, `index`): `void` +```ts +_update(geometry, index): void +``` -Defined in: src/geometry/Geometry.ts:133 +Defined in: [src/geometry/Geometry.ts:133](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L133) #### Parameters @@ -102,9 +112,11 @@ Defined in: src/geometry/Geometry.ts:133 ### addGeometry() -> **addGeometry**(`geometry`): `void` +```ts +addGeometry(geometry): void +``` -Defined in: src/geometry/Geometry.ts:128 +Defined in: [src/geometry/Geometry.ts:128](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L128) #### Parameters @@ -120,9 +132,11 @@ Defined in: src/geometry/Geometry.ts:128 ### toGeoJSON() -> **toGeoJSON**(): [`GeoJSONFeature`](../interfaces/GeoJSONFeature.md) +```ts +toGeoJSON(): GeoJSONFeature +``` -Defined in: src/geometry/Geometry.ts:138 +Defined in: [src/geometry/Geometry.ts:138](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L138) #### Returns @@ -132,9 +146,11 @@ Defined in: src/geometry/Geometry.ts:138 ### toXY() -> **toXY**(): `any` +```ts +toXY(): any +``` -Defined in: src/geometry/Geometry.ts:119 +Defined in: [src/geometry/Geometry.ts:119](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L119) #### Returns @@ -144,9 +160,11 @@ Defined in: src/geometry/Geometry.ts:119 ### updateBBox() -> **updateBBox**(`geometry`): `void` +```ts +updateBBox(geometry): void +``` -Defined in: src/geometry/Geometry.ts:121 +Defined in: [src/geometry/Geometry.ts:121](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L121) #### Parameters diff --git a/docs/api/classes/Grid.md b/docs/api/classes/Grid.md index d90de86..384d609 100644 --- a/docs/api/classes/Grid.md +++ b/docs/api/classes/Grid.md @@ -1,12 +1,8 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / Grid -*** - -[rvgeo](../globals.md) / Grid - -# Class: Grid +# Grid -Defined in: src/coverage/grid.ts:13 +Defined in: [src/coverage/grid.ts:13](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L13) 网格类（本质是三维数组）: - 三维数组的每一层代表一个波段 @@ -17,9 +13,11 @@ Defined in: src/coverage/grid.ts:13 ### new Grid() -> **new Grid**(`MBR`, `data`): [`Grid`](Grid.md) +```ts +new Grid(MBR, data): Grid +``` -Defined in: src/coverage/grid.ts:22 +Defined in: [src/coverage/grid.ts:22](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L22) #### Parameters @@ -39,69 +37,89 @@ Defined in: src/coverage/grid.ts:22 ### bands -> **bands**: `number` +```ts +bands: number; +``` -Defined in: src/coverage/grid.ts:19 +Defined in: [src/coverage/grid.ts:19](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L19) *** ### cols -> **cols**: `number` +```ts +cols: number; +``` -Defined in: src/coverage/grid.ts:18 +Defined in: [src/coverage/grid.ts:18](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L18) *** ### data -> **data**: `number`[][][] +```ts +data: number[][][]; +``` -Defined in: src/coverage/grid.ts:15 +Defined in: [src/coverage/grid.ts:15](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L15) *** ### MBR -> **MBR**: [`MBR`](../type-aliases/MBR.md) +```ts +MBR: MBR; +``` -Defined in: src/coverage/grid.ts:14 +Defined in: [src/coverage/grid.ts:14](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L14) *** ### rows -> **rows**: `number` +```ts +rows: number; +``` -Defined in: src/coverage/grid.ts:17 +Defined in: [src/coverage/grid.ts:17](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L17) *** ### shape -> **shape**: `number`[] +```ts +shape: number[]; +``` -Defined in: src/coverage/grid.ts:16 +Defined in: [src/coverage/grid.ts:16](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L16) *** ### stasticsCache -> **stasticsCache**: `object`[] = `[]` +```ts +stasticsCache: object[] = []; +``` -Defined in: src/coverage/grid.ts:20 +Defined in: [src/coverage/grid.ts:20](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L20) #### max -> **max**: `number` +```ts +max: number; +``` #### mean -> **mean**: `number` +```ts +mean: number; +``` #### min -> **min**: `number` +```ts +min: number; +``` ## Accessors @@ -109,9 +127,11 @@ Defined in: src/coverage/grid.ts:20 #### Get Signature -> **get** **bandCount**(): `number` +```ts +get bandCount(): number +``` -Defined in: src/coverage/grid.ts:44 +Defined in: [src/coverage/grid.ts:44](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L44) ##### Returns @@ -123,9 +143,11 @@ Defined in: src/coverage/grid.ts:44 #### Get Signature -> **get** **height**(): `number` +```ts +get height(): number +``` -Defined in: src/coverage/grid.ts:40 +Defined in: [src/coverage/grid.ts:40](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L40) ##### Returns @@ -137,9 +159,11 @@ Defined in: src/coverage/grid.ts:40 #### Get Signature -> **get** **width**(): `number` +```ts +get width(): number +``` -Defined in: src/coverage/grid.ts:36 +Defined in: [src/coverage/grid.ts:36](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L36) ##### Returns @@ -151,9 +175,11 @@ Defined in: src/coverage/grid.ts:36 #### Set Signature -> **set** **XYZValue**(`xyzv`): `void` +```ts +set XYZValue(xyzv): void +``` -Defined in: src/coverage/grid.ts:58 +Defined in: [src/coverage/grid.ts:58](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L58) ##### Parameters @@ -169,9 +195,11 @@ Defined in: src/coverage/grid.ts:58 ### binarization() -> **binarization**(`band`, `threshold`): `number`[][] +```ts +binarization(band, threshold): number[][] +``` -Defined in: src/coverage/grid.ts:278 +Defined in: [src/coverage/grid.ts:278](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L278) 二值化网格数据，返回二值化后的网格数据 @@ -197,9 +225,11 @@ Defined in: src/coverage/grid.ts:278 ### ConvertToGridMBR() -> **ConvertToGridMBR**(`MBR`): `null` \| [`MBR`](../type-aliases/MBR.md) +```ts +ConvertToGridMBR(MBR): null | MBR +``` -Defined in: src/coverage/grid.ts:180 +Defined in: [src/coverage/grid.ts:180](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L180) 由外部经纬度坐标获取网格范围，行列号索引表示（只有全部在栅格范围内才会正常得到结果） - 若外部坐标不全部在网格范围内，则返回 null @@ -220,9 +250,11 @@ Defined in: src/coverage/grid.ts:180 ### fillInvalidValue() -> **fillInvalidValue**(`band`): `void` +```ts +fillInvalidValue(band): void +``` -Defined in: src/coverage/grid.ts:121 +Defined in: [src/coverage/grid.ts:121](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L121) 在内部修改网格数据 使用均值替换0等无效值 @@ -242,9 +274,11 @@ Defined in: src/coverage/grid.ts:121 ### getBand() -> **getBand**(`band`): `number`[][] +```ts +getBand(band): number[][] +``` -Defined in: src/coverage/grid.ts:32 +Defined in: [src/coverage/grid.ts:32](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L32) #### Parameters @@ -260,9 +294,11 @@ Defined in: src/coverage/grid.ts:32 ### getBandStatistics() -> **getBandStatistics**(`band`): `object` +```ts +getBandStatistics(band): object +``` -Defined in: src/coverage/grid.ts:245 +Defined in: [src/coverage/grid.ts:245](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L245) 获取指定波段的最大值、最小值、平均值 @@ -280,23 +316,31 @@ Defined in: src/coverage/grid.ts:245 ##### max -> **max**: `number` +```ts +max: number; +``` ##### mean -> **mean**: `number` +```ts +mean: number; +``` ##### min -> **min**: `number` +```ts +min: number; +``` *** ### getCoordByGridCoord() -> **getCoordByGridCoord**(`GridCoord`): \[`number`, `number`\] +```ts +getCoordByGridCoord(GridCoord): [number, number] +``` -Defined in: src/coverage/grid.ts:229 +Defined in: [src/coverage/grid.ts:229](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L229) 由行列号反算经纬度坐标（栅格中心点） @@ -318,9 +362,11 @@ Defined in: src/coverage/grid.ts:229 ### getCoutourCode() -> **getCoutourCode**(`band`, `threshold`): `number`[][] +```ts +getCoutourCode(band, threshold): number[][] +``` -Defined in: src/coverage/grid.ts:299 +Defined in: [src/coverage/grid.ts:299](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L299) the result grid size is [rows - 1, cols - 1], and the render function should move 1/2 grid size to the left and up @@ -342,9 +388,11 @@ the result grid size is [rows - 1, cols - 1], and the render function should mov ### getGridCoord() -> **getGridCoord**(`Point`): `null` \| \[`number`, `number`\] +```ts +getGridCoord(Point): null | [number, number] +``` -Defined in: src/coverage/grid.ts:206 +Defined in: [src/coverage/grid.ts:206](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L206) 计算输入点的网格坐标（整数行列号坐标） @@ -366,9 +414,11 @@ Defined in: src/coverage/grid.ts:206 ### getMean() -> **getMean**(`band`): `number` +```ts +getMean(band): number +``` -Defined in: src/coverage/grid.ts:319 +Defined in: [src/coverage/grid.ts:319](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L319) #### Parameters @@ -384,9 +434,11 @@ Defined in: src/coverage/grid.ts:319 ### getShape() -> **getShape**(): `number`[] +```ts +getShape(): number[] +``` -Defined in: src/coverage/grid.ts:28 +Defined in: [src/coverage/grid.ts:28](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L28) #### Returns @@ -396,9 +448,11 @@ Defined in: src/coverage/grid.ts:28 ### getSorted1DArray() -> **getSorted1DArray**(`band`): `number`[] +```ts +getSorted1DArray(band): number[] +``` -Defined in: src/coverage/grid.ts:330 +Defined in: [src/coverage/grid.ts:330](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L330) #### Parameters @@ -414,9 +468,11 @@ Defined in: src/coverage/grid.ts:330 ### getSubGrid() -> **getSubGrid**(`GridMBR`, `band`): `number`[][][] +```ts +getSubGrid(GridMBR, band): number[][][] +``` -Defined in: src/coverage/grid.ts:93 +Defined in: [src/coverage/grid.ts:93](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L93) 获取指定范围，指定波段的网格数据 - 建议：先使用 `ConvertToGridMBR` 方法获取网格范围，再使用本方法获取网格数据（为简化代码，没有将这两个方法合并） @@ -445,9 +501,11 @@ Defined in: src/coverage/grid.ts:93 ### getSubGridObj() -> **getSubGridObj**(`GridMBR`, `band`): [`Grid`](Grid.md) +```ts +getSubGridObj(GridMBR, band): Grid +``` -Defined in: src/coverage/grid.ts:153 +Defined in: [src/coverage/grid.ts:153](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L153) 与 `getSubGrid` 方法类似，但返回的是一个 Grid 对象 @@ -475,9 +533,11 @@ Defined in: src/coverage/grid.ts:153 ### getXYZValue() -> **getXYZValue**(`xy`, `z`): `number` +```ts +getXYZValue(xy, z): number +``` -Defined in: src/coverage/grid.ts:52 +Defined in: [src/coverage/grid.ts:52](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L52) #### Parameters @@ -497,9 +557,11 @@ Defined in: src/coverage/grid.ts:52 ### setMBR() -> **setMBR**(`MBR`): `void` +```ts +setMBR(MBR): void +``` -Defined in: src/coverage/grid.ts:48 +Defined in: [src/coverage/grid.ts:48](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L48) #### Parameters @@ -515,9 +577,11 @@ Defined in: src/coverage/grid.ts:48 ### fromFillValue() -> `static` **fromFillValue**(`fillVal`, `shape`): [`Grid`](Grid.md) +```ts +static fromFillValue(fillVal, shape): Grid +``` -Defined in: src/coverage/grid.ts:342 +Defined in: [src/coverage/grid.ts:342](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L342) #### Parameters diff --git a/docs/api/classes/LineString.md b/docs/api/classes/LineString.md index 04ac61c..b638b4e 100644 --- a/docs/api/classes/LineString.md +++ b/docs/api/classes/LineString.md @@ -1,12 +1,8 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / LineString -*** - -[rvgeo](../globals.md) / LineString - -# Class: LineString +# LineString -Defined in: src/geometry/LineString.ts:5 +Defined in: [src/geometry/LineString.ts:5](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/LineString.ts#L5) Geometry for GeoJSON independent Objects including Point, LineString, Polygon - no GeometryCollection @@ -20,9 +16,11 @@ Geometry for GeoJSON independent Objects including Point, LineString, Polygon ### new LineString() -> **new LineString**(`coordinates`, `properties`?): [`LineString`](LineString.md) +```ts +new LineString(coordinates, properties?): LineString +``` -Defined in: src/geometry/LineString.ts:7 +Defined in: [src/geometry/LineString.ts:7](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/LineString.ts#L7) #### Parameters @@ -46,9 +44,11 @@ Defined in: src/geometry/LineString.ts:7 ### bbox -> **bbox**: [`MBR`](../type-aliases/MBR.md) +```ts +bbox: MBR; +``` -Defined in: src/geometry/Geometry.ts:31 +Defined in: [src/geometry/Geometry.ts:31](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L31) #### Inherited from @@ -58,9 +58,11 @@ Defined in: src/geometry/Geometry.ts:31 ### coordinates -> `readonly` **coordinates**: `any` +```ts +readonly coordinates: any; +``` -Defined in: src/geometry/Geometry.ts:32 +Defined in: [src/geometry/Geometry.ts:32](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L32) #### Inherited from @@ -70,9 +72,11 @@ Defined in: src/geometry/Geometry.ts:32 ### projection -> `readonly` **projection**: [`Projection`](../interfaces/Projection.md) = `SphericalMercator` +```ts +readonly projection: Projection = SphericalMercator; +``` -Defined in: src/geometry/Geometry.ts:34 +Defined in: [src/geometry/Geometry.ts:34](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L34) #### Inherited from @@ -82,9 +86,11 @@ Defined in: src/geometry/Geometry.ts:34 ### properties -> **properties**: `any` +```ts +properties: any; +``` -Defined in: src/geometry/Geometry.ts:33 +Defined in: [src/geometry/Geometry.ts:33](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L33) #### Inherited from @@ -96,9 +102,11 @@ Defined in: src/geometry/Geometry.ts:33 #### Set Signature -> **set** **Properties**(`properties`): `void` +```ts +set Properties(properties): void +``` -Defined in: src/geometry/Geometry.ts:49 +Defined in: [src/geometry/Geometry.ts:49](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L49) ##### Parameters @@ -118,9 +126,11 @@ Defined in: src/geometry/Geometry.ts:49 ### clone() -> **clone**(): [`Geometry`](Geometry.md) +```ts +clone(): Geometry +``` -Defined in: src/geometry/Geometry.ts:51 +Defined in: [src/geometry/Geometry.ts:51](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L51) #### Returns @@ -134,9 +144,11 @@ Defined in: src/geometry/Geometry.ts:51 ### equals() -> **equals**(`geometry`): `boolean` +```ts +equals(geometry): boolean +``` -Defined in: src/geometry/Geometry.ts:58 +Defined in: [src/geometry/Geometry.ts:58](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L58) #### Parameters @@ -156,9 +168,11 @@ Defined in: src/geometry/Geometry.ts:58 ### toGeoJSON() -> **toGeoJSON**(): [`GeoJSONFeature`](../interfaces/GeoJSONFeature.md) +```ts +toGeoJSON(): GeoJSONFeature +``` -Defined in: src/geometry/Geometry.ts:64 +Defined in: [src/geometry/Geometry.ts:64](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L64) #### Returns @@ -172,9 +186,11 @@ Defined in: src/geometry/Geometry.ts:64 ### toMultiPoint() -> **toMultiPoint**(): [`MultiPoint`](MultiPoint.md) +```ts +toMultiPoint(): MultiPoint +``` -Defined in: src/geometry/LineString.ts:28 +Defined in: [src/geometry/LineString.ts:28](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/LineString.ts#L28) #### Returns @@ -184,9 +200,11 @@ Defined in: src/geometry/LineString.ts:28 ### toXY() -> **toXY**(): \[`number`, `number`\][] +```ts +toXY(): [number, number][] +``` -Defined in: src/geometry/LineString.ts:22 +Defined in: [src/geometry/LineString.ts:22](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/LineString.ts#L22) #### Returns @@ -200,9 +218,11 @@ Defined in: src/geometry/LineString.ts:22 ### updateBBox() -> **updateBBox**(): `void` +```ts +updateBBox(): void +``` -Defined in: src/geometry/LineString.ts:11 +Defined in: [src/geometry/LineString.ts:11](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/LineString.ts#L11) #### Returns @@ -216,9 +236,11 @@ Defined in: src/geometry/LineString.ts:11 ### fromFeature() -> `static` **fromFeature**(`feature`): [`LineString`](LineString.md) +```ts +static fromFeature(feature): LineString +``` -Defined in: src/geometry/LineString.ts:55 +Defined in: [src/geometry/LineString.ts:55](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/LineString.ts#L55) #### Parameters @@ -232,15 +254,19 @@ Defined in: src/geometry/LineString.ts:55 #### Overrides -`Geometry.fromFeature` +```ts +Geometry.fromFeature +``` *** ### fromGeoJSON() -> `static` **fromGeoJSON**(`feature`): [`Geometry`](Geometry.md) \| [`GeometryCollection`](GeometryCollection.md) +```ts +static fromGeoJSON(feature): Geometry | GeometryCollection +``` -Defined in: src/geometry/Geometry.ts:82 +Defined in: [src/geometry/Geometry.ts:82](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L82) #### Parameters @@ -260,9 +286,11 @@ Defined in: src/geometry/Geometry.ts:82 ### fromGeometry() -> `static` **fromGeometry**(`geometry`): [`LineString`](LineString.md) +```ts +static fromGeometry(geometry): LineString +``` -Defined in: src/geometry/LineString.ts:51 +Defined in: [src/geometry/LineString.ts:51](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/LineString.ts#L51) 按照逆时针方向排序点 @@ -278,15 +306,19 @@ Defined in: src/geometry/LineString.ts:51 #### Overrides -`Geometry.fromGeometry` +```ts +Geometry.fromGeometry +``` *** ### isLineString() -> `static` **isLineString**(`lineString`): `lineString is LineString` +```ts +static isLineString(lineString): lineString is LineString +``` -Defined in: src/geometry/LineString.ts:64 +Defined in: [src/geometry/LineString.ts:64](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/LineString.ts#L64) #### Parameters diff --git a/docs/api/classes/MultiLineString.md b/docs/api/classes/MultiLineString.md index 991428c..f53dc05 100644 --- a/docs/api/classes/MultiLineString.md +++ b/docs/api/classes/MultiLineString.md @@ -1,12 +1,8 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / MultiLineString -*** - -[rvgeo](../globals.md) / MultiLineString - -# Class: MultiLineString +# MultiLineString -Defined in: src/geometry/LineString.ts:69 +Defined in: [src/geometry/LineString.ts:69](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/LineString.ts#L69) ## Extends @@ -16,9 +12,11 @@ Defined in: src/geometry/LineString.ts:69 ### new MultiLineString() -> **new MultiLineString**(`geometries`, `properties`?): [`MultiLineString`](MultiLineString.md) +```ts +new MultiLineString(geometries, properties?): MultiLineString +``` -Defined in: src/geometry/LineString.ts:72 +Defined in: [src/geometry/LineString.ts:72](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/LineString.ts#L72) #### Parameters @@ -42,9 +40,11 @@ Defined in: src/geometry/LineString.ts:72 ### bbox -> **bbox**: [`MBR`](../type-aliases/MBR.md) +```ts +bbox: MBR; +``` -Defined in: src/geometry/Geometry.ts:104 +Defined in: [src/geometry/Geometry.ts:104](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L104) #### Inherited from @@ -54,9 +54,11 @@ Defined in: src/geometry/Geometry.ts:104 ### coordinates -> **coordinates**: \[`number`, `number`\][][] +```ts +coordinates: [number, number][][]; +``` -Defined in: src/geometry/LineString.ts:70 +Defined in: [src/geometry/LineString.ts:70](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/LineString.ts#L70) #### Overrides @@ -66,9 +68,11 @@ Defined in: src/geometry/LineString.ts:70 ### geometries -> **geometries**: ([`Geometry`](Geometry.md) \| [`GeometryCollection`](GeometryCollection.md))[] = `[]` +```ts +geometries: (Geometry | GeometryCollection)[] = []; +``` -Defined in: src/geometry/Geometry.ts:103 +Defined in: [src/geometry/Geometry.ts:103](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L103) #### Inherited from @@ -78,9 +82,11 @@ Defined in: src/geometry/Geometry.ts:103 ### projection -> **projection**: [`Projection`](../interfaces/Projection.md) = `SphericalMercator` +```ts +projection: Projection = SphericalMercator; +``` -Defined in: src/geometry/Geometry.ts:106 +Defined in: [src/geometry/Geometry.ts:106](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L106) #### Inherited from @@ -90,9 +96,11 @@ Defined in: src/geometry/Geometry.ts:106 ### properties -> **properties**: `any` +```ts +properties: any; +``` -Defined in: src/geometry/Geometry.ts:105 +Defined in: [src/geometry/Geometry.ts:105](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L105) #### Inherited from @@ -102,9 +110,11 @@ Defined in: src/geometry/Geometry.ts:105 ### \_update() -> **\_update**(`geometry`, `index`): `void` +```ts +_update(geometry, index): void +``` -Defined in: src/geometry/Geometry.ts:133 +Defined in: [src/geometry/Geometry.ts:133](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L133) #### Parameters @@ -122,15 +132,17 @@ Defined in: src/geometry/Geometry.ts:133 #### Inherited from -[`GeometryCollection`](GeometryCollection.md).[`_update`](GeometryCollection.md#_update) +[`GeometryCollection`](GeometryCollection.md).[`_update`](GeometryCollection.md#update) *** ### addGeometry() -> **addGeometry**(`geometry`): `void` +```ts +addGeometry(geometry): void +``` -Defined in: src/geometry/LineString.ts:98 +Defined in: [src/geometry/LineString.ts:98](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/LineString.ts#L98) #### Parameters @@ -150,9 +162,11 @@ Defined in: src/geometry/LineString.ts:98 ### getCoodinates() -> **getCoodinates**(): \[`number`, `number`\][][] +```ts +getCoodinates(): [number, number][][] +``` -Defined in: src/geometry/LineString.ts:85 +Defined in: [src/geometry/LineString.ts:85](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/LineString.ts#L85) #### Returns @@ -162,9 +176,11 @@ Defined in: src/geometry/LineString.ts:85 ### toGeoJSON() -> **toGeoJSON**(): [`GeoJSONFeature`](../interfaces/GeoJSONFeature.md) +```ts +toGeoJSON(): GeoJSONFeature +``` -Defined in: src/geometry/LineString.ts:110 +Defined in: [src/geometry/LineString.ts:110](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/LineString.ts#L110) #### Returns @@ -178,9 +194,11 @@ Defined in: src/geometry/LineString.ts:110 ### toMultiPoint() -> **toMultiPoint**(): [`MultiPoint`](MultiPoint.md) +```ts +toMultiPoint(): MultiPoint +``` -Defined in: src/geometry/LineString.ts:89 +Defined in: [src/geometry/LineString.ts:89](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/LineString.ts#L89) #### Returns @@ -190,9 +208,11 @@ Defined in: src/geometry/LineString.ts:89 ### toXY() -> **toXY**(): \[`number`, `number`\][][] +```ts +toXY(): [number, number][][] +``` -Defined in: src/geometry/LineString.ts:93 +Defined in: [src/geometry/LineString.ts:93](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/LineString.ts#L93) #### Returns @@ -206,9 +226,11 @@ Defined in: src/geometry/LineString.ts:93 ### updateBBox() -> **updateBBox**(`geometry`): `void` +```ts +updateBBox(geometry): void +``` -Defined in: src/geometry/Geometry.ts:121 +Defined in: [src/geometry/Geometry.ts:121](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L121) #### Parameters @@ -228,9 +250,11 @@ Defined in: src/geometry/Geometry.ts:121 ### fromFeature() -> `static` **fromFeature**(`feature`): [`GeometryCollection`](GeometryCollection.md) +```ts +static fromFeature(feature): GeometryCollection +``` -Defined in: src/geometry/LineString.ts:128 +Defined in: [src/geometry/LineString.ts:128](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/LineString.ts#L128) #### Parameters @@ -246,9 +270,11 @@ Defined in: src/geometry/LineString.ts:128 ### fromGeometry() -> `static` **fromGeometry**(`geometry`): [`GeometryCollection`](GeometryCollection.md) +```ts +static fromGeometry(geometry): GeometryCollection +``` -Defined in: src/geometry/LineString.ts:138 +Defined in: [src/geometry/LineString.ts:138](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/LineString.ts#L138) #### Parameters diff --git a/docs/api/classes/MultiPoint.md b/docs/api/classes/MultiPoint.md index 0936006..9ddd22f 100644 --- a/docs/api/classes/MultiPoint.md +++ b/docs/api/classes/MultiPoint.md @@ -1,12 +1,8 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / MultiPoint -*** - -[rvgeo](../globals.md) / MultiPoint - -# Class: MultiPoint +# MultiPoint -Defined in: src/geometry/Point.ts:55 +Defined in: [src/geometry/Point.ts:55](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Point.ts#L55) ## Extends @@ -16,9 +12,11 @@ Defined in: src/geometry/Point.ts:55 ### new MultiPoint() -> **new MultiPoint**(`geometries`, `properties`?): [`MultiPoint`](MultiPoint.md) +```ts +new MultiPoint(geometries, properties?): MultiPoint +``` -Defined in: src/geometry/Point.ts:60 +Defined in: [src/geometry/Point.ts:60](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Point.ts#L60) #### Parameters @@ -42,9 +40,11 @@ Defined in: src/geometry/Point.ts:60 ### bbox -> **bbox**: [`MBR`](../type-aliases/MBR.md) +```ts +bbox: MBR; +``` -Defined in: src/geometry/Geometry.ts:104 +Defined in: [src/geometry/Geometry.ts:104](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L104) #### Inherited from @@ -54,9 +54,11 @@ Defined in: src/geometry/Geometry.ts:104 ### coordinates -> `readonly` **coordinates**: \[`number`, `number`\][] +```ts +readonly coordinates: [number, number][]; +``` -Defined in: src/geometry/Point.ts:59 +Defined in: [src/geometry/Point.ts:59](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Point.ts#L59) #### Overrides @@ -66,9 +68,11 @@ Defined in: src/geometry/Point.ts:59 ### geometries -> **geometries**: ([`Geometry`](Geometry.md) \| [`GeometryCollection`](GeometryCollection.md))[] = `[]` +```ts +geometries: (Geometry | GeometryCollection)[] = []; +``` -Defined in: src/geometry/Geometry.ts:103 +Defined in: [src/geometry/Geometry.ts:103](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L103) #### Inherited from @@ -78,9 +82,11 @@ Defined in: src/geometry/Geometry.ts:103 ### projection -> **projection**: [`Projection`](../interfaces/Projection.md) = `SphericalMercator` +```ts +projection: Projection = SphericalMercator; +``` -Defined in: src/geometry/Geometry.ts:106 +Defined in: [src/geometry/Geometry.ts:106](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L106) #### Inherited from @@ -90,9 +96,11 @@ Defined in: src/geometry/Geometry.ts:106 ### properties -> **properties**: `any` +```ts +properties: any; +``` -Defined in: src/geometry/Geometry.ts:105 +Defined in: [src/geometry/Geometry.ts:105](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L105) #### Inherited from @@ -102,9 +110,11 @@ Defined in: src/geometry/Geometry.ts:105 ### \_update() -> **\_update**(`geometry`, `index`): `void` +```ts +_update(geometry, index): void +``` -Defined in: src/geometry/Geometry.ts:133 +Defined in: [src/geometry/Geometry.ts:133](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L133) #### Parameters @@ -122,15 +132,17 @@ Defined in: src/geometry/Geometry.ts:133 #### Inherited from -[`GeometryCollection`](GeometryCollection.md).[`_update`](GeometryCollection.md#_update) +[`GeometryCollection`](GeometryCollection.md).[`_update`](GeometryCollection.md#update) *** ### addGeometry() -> **addGeometry**(`geometry`): `void` +```ts +addGeometry(geometry): void +``` -Defined in: src/geometry/Point.ts:126 +Defined in: [src/geometry/Point.ts:126](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Point.ts#L126) 将点（类型或数组）、多点类型融合到此 MultiPoint 中 @@ -152,9 +164,11 @@ Defined in: src/geometry/Point.ts:126 ### centroid() -> **centroid**(`values`?): [`Point`](Point.md) +```ts +centroid(values?): Point +``` -Defined in: src/geometry/Point.ts:88 +Defined in: [src/geometry/Point.ts:88](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Point.ts#L88) - 计算多点的重心 - calculate centroid of MultiPoint @@ -181,9 +195,11 @@ https://en.wikipedia.org/wiki/Centroid ### getCoodinates() -> **getCoodinates**(): \[`number`, `number`\][] +```ts +getCoodinates(): [number, number][] +``` -Defined in: src/geometry/Point.ts:77 +Defined in: [src/geometry/Point.ts:77](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Point.ts#L77) #### Returns @@ -193,9 +209,11 @@ Defined in: src/geometry/Point.ts:77 ### toGeoJSON() -> **toGeoJSON**(): [`GeoJSONFeature`](../interfaces/GeoJSONFeature.md) +```ts +toGeoJSON(): GeoJSONFeature +``` -Defined in: src/geometry/Point.ts:142 +Defined in: [src/geometry/Point.ts:142](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Point.ts#L142) #### Returns @@ -209,9 +227,11 @@ Defined in: src/geometry/Point.ts:142 ### toXY() -> **toXY**(): \[`number`, `number`\][] +```ts +toXY(): [number, number][] +``` -Defined in: src/geometry/Point.ts:73 +Defined in: [src/geometry/Point.ts:73](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Point.ts#L73) #### Returns @@ -225,9 +245,11 @@ Defined in: src/geometry/Point.ts:73 ### updateBBox() -> **updateBBox**(`geometry`): `void` +```ts +updateBBox(geometry): void +``` -Defined in: src/geometry/Geometry.ts:121 +Defined in: [src/geometry/Geometry.ts:121](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L121) #### Parameters @@ -247,9 +269,11 @@ Defined in: src/geometry/Geometry.ts:121 ### fromFeature() -> `static` **fromFeature**(`feature`): [`GeometryCollection`](GeometryCollection.md) +```ts +static fromFeature(feature): GeometryCollection +``` -Defined in: src/geometry/Point.ts:168 +Defined in: [src/geometry/Point.ts:168](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Point.ts#L168) #### Parameters @@ -265,9 +289,11 @@ Defined in: src/geometry/Point.ts:168 ### fromGeometry() -> `static` **fromGeometry**(`geometry`): [`GeometryCollection`](GeometryCollection.md) +```ts +static fromGeometry(geometry): GeometryCollection +``` -Defined in: src/geometry/Point.ts:183 +Defined in: [src/geometry/Point.ts:183](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Point.ts#L183) #### Parameters @@ -283,9 +309,11 @@ Defined in: src/geometry/Point.ts:183 ### isMultiPoint() -> `static` **isMultiPoint**(`geometry`): `geometry is MultiPoint` +```ts +static isMultiPoint(geometry): geometry is MultiPoint +``` -Defined in: src/geometry/Point.ts:164 +Defined in: [src/geometry/Point.ts:164](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Point.ts#L164) #### Parameters diff --git a/docs/api/classes/MultiPolygon.md b/docs/api/classes/MultiPolygon.md index d961260..63d0c8c 100644 --- a/docs/api/classes/MultiPolygon.md +++ b/docs/api/classes/MultiPolygon.md @@ -1,12 +1,8 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / MultiPolygon -*** - -[rvgeo](../globals.md) / MultiPolygon - -# Class: MultiPolygon +# MultiPolygon -Defined in: src/geometry/Polygon.ts:52 +Defined in: [src/geometry/Polygon.ts:52](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Polygon.ts#L52) ## Extends @@ -16,9 +12,11 @@ Defined in: src/geometry/Polygon.ts:52 ### new MultiPolygon() -> **new MultiPolygon**(`geometries`, `properties`?): [`MultiPolygon`](MultiPolygon.md) +```ts +new MultiPolygon(geometries, properties?): MultiPolygon +``` -Defined in: src/geometry/Polygon.ts:55 +Defined in: [src/geometry/Polygon.ts:55](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Polygon.ts#L55) #### Parameters @@ -42,9 +40,11 @@ Defined in: src/geometry/Polygon.ts:55 ### bbox -> **bbox**: [`MBR`](../type-aliases/MBR.md) +```ts +bbox: MBR; +``` -Defined in: src/geometry/Geometry.ts:104 +Defined in: [src/geometry/Geometry.ts:104](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L104) #### Inherited from @@ -54,9 +54,11 @@ Defined in: src/geometry/Geometry.ts:104 ### coordinates -> `readonly` **coordinates**: \[`number`, `number`\][][][] +```ts +readonly coordinates: [number, number][][][]; +``` -Defined in: src/geometry/Polygon.ts:53 +Defined in: [src/geometry/Polygon.ts:53](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Polygon.ts#L53) #### Overrides @@ -66,9 +68,11 @@ Defined in: src/geometry/Polygon.ts:53 ### geometries -> **geometries**: ([`Geometry`](Geometry.md) \| [`GeometryCollection`](GeometryCollection.md))[] = `[]` +```ts +geometries: (Geometry | GeometryCollection)[] = []; +``` -Defined in: src/geometry/Geometry.ts:103 +Defined in: [src/geometry/Geometry.ts:103](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L103) #### Inherited from @@ -78,9 +82,11 @@ Defined in: src/geometry/Geometry.ts:103 ### projection -> **projection**: [`Projection`](../interfaces/Projection.md) = `SphericalMercator` +```ts +projection: Projection = SphericalMercator; +``` -Defined in: src/geometry/Geometry.ts:106 +Defined in: [src/geometry/Geometry.ts:106](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L106) #### Inherited from @@ -90,9 +96,11 @@ Defined in: src/geometry/Geometry.ts:106 ### properties -> **properties**: `any` +```ts +properties: any; +``` -Defined in: src/geometry/Geometry.ts:105 +Defined in: [src/geometry/Geometry.ts:105](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L105) #### Inherited from @@ -102,9 +110,11 @@ Defined in: src/geometry/Geometry.ts:105 ### \_update() -> **\_update**(`geometry`, `index`): `void` +```ts +_update(geometry, index): void +``` -Defined in: src/geometry/Geometry.ts:133 +Defined in: [src/geometry/Geometry.ts:133](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L133) #### Parameters @@ -122,15 +132,17 @@ Defined in: src/geometry/Geometry.ts:133 #### Inherited from -[`GeometryCollection`](GeometryCollection.md).[`_update`](GeometryCollection.md#_update) +[`GeometryCollection`](GeometryCollection.md).[`_update`](GeometryCollection.md#update) *** ### addGeometry() -> **addGeometry**(`geometry`): `void` +```ts +addGeometry(geometry): void +``` -Defined in: src/geometry/Polygon.ts:82 +Defined in: [src/geometry/Polygon.ts:82](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Polygon.ts#L82) #### Parameters @@ -150,9 +162,11 @@ Defined in: src/geometry/Polygon.ts:82 ### getCoodinates() -> **getCoodinates**(): \[`number`, `number`\][][][] +```ts +getCoodinates(): [number, number][][][] +``` -Defined in: src/geometry/Polygon.ts:68 +Defined in: [src/geometry/Polygon.ts:68](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Polygon.ts#L68) #### Returns @@ -162,9 +176,11 @@ Defined in: src/geometry/Polygon.ts:68 ### toGeoJSON() -> **toGeoJSON**(): [`GeoJSONFeature`](../interfaces/GeoJSONFeature.md) +```ts +toGeoJSON(): GeoJSONFeature +``` -Defined in: src/geometry/Polygon.ts:94 +Defined in: [src/geometry/Polygon.ts:94](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Polygon.ts#L94) #### Returns @@ -178,9 +194,11 @@ Defined in: src/geometry/Polygon.ts:94 ### toMultiPoint() -> **toMultiPoint**(): [`MultiPoint`](MultiPoint.md) +```ts +toMultiPoint(): MultiPoint +``` -Defined in: src/geometry/Polygon.ts:72 +Defined in: [src/geometry/Polygon.ts:72](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Polygon.ts#L72) #### Returns @@ -190,9 +208,11 @@ Defined in: src/geometry/Polygon.ts:72 ### toXY() -> **toXY**(): \[`number`, `number`\][][][] +```ts +toXY(): [number, number][][][] +``` -Defined in: src/geometry/Polygon.ts:77 +Defined in: [src/geometry/Polygon.ts:77](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Polygon.ts#L77) #### Returns @@ -206,9 +226,11 @@ Defined in: src/geometry/Polygon.ts:77 ### updateBBox() -> **updateBBox**(`geometry`): `void` +```ts +updateBBox(geometry): void +``` -Defined in: src/geometry/Geometry.ts:121 +Defined in: [src/geometry/Geometry.ts:121](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L121) #### Parameters @@ -228,9 +250,11 @@ Defined in: src/geometry/Geometry.ts:121 ### fromFeature() -> `static` **fromFeature**(`feature`): [`GeometryCollection`](GeometryCollection.md) +```ts +static fromFeature(feature): GeometryCollection +``` -Defined in: src/geometry/Polygon.ts:112 +Defined in: [src/geometry/Polygon.ts:112](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Polygon.ts#L112) #### Parameters @@ -246,9 +270,11 @@ Defined in: src/geometry/Polygon.ts:112 ### fromGeometry() -> `static` **fromGeometry**(`geometry`): [`GeometryCollection`](GeometryCollection.md) +```ts +static fromGeometry(geometry): GeometryCollection +``` -Defined in: src/geometry/Polygon.ts:122 +Defined in: [src/geometry/Polygon.ts:122](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Polygon.ts#L122) #### Parameters diff --git a/docs/api/classes/Point.md b/docs/api/classes/Point.md index 45f74ad..d6c4c58 100644 --- a/docs/api/classes/Point.md +++ b/docs/api/classes/Point.md @@ -1,12 +1,8 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / Point -*** - -[rvgeo](../globals.md) / Point - -# Class: Point +# Point -Defined in: src/geometry/Point.ts:10 +Defined in: [src/geometry/Point.ts:10](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Point.ts#L10) Point geometry @@ -18,9 +14,11 @@ Point geometry ### new Point() -> **new Point**(`coordinates`, `properties`?): [`Point`](Point.md) +```ts +new Point(coordinates, properties?): Point +``` -Defined in: src/geometry/Point.ts:19 +Defined in: [src/geometry/Point.ts:19](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Point.ts#L19) #### Parameters @@ -44,9 +42,11 @@ Defined in: src/geometry/Point.ts:19 ### bbox -> **bbox**: [`MBR`](../type-aliases/MBR.md) +```ts +bbox: MBR; +``` -Defined in: src/geometry/Geometry.ts:31 +Defined in: [src/geometry/Geometry.ts:31](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L31) #### Inherited from @@ -56,9 +56,11 @@ Defined in: src/geometry/Geometry.ts:31 ### coordinates -> `readonly` **coordinates**: `any` +```ts +readonly coordinates: any; +``` -Defined in: src/geometry/Geometry.ts:32 +Defined in: [src/geometry/Geometry.ts:32](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L32) #### Inherited from @@ -68,9 +70,11 @@ Defined in: src/geometry/Geometry.ts:32 ### projection -> `readonly` **projection**: [`Projection`](../interfaces/Projection.md) = `SphericalMercator` +```ts +readonly projection: Projection = SphericalMercator; +``` -Defined in: src/geometry/Geometry.ts:34 +Defined in: [src/geometry/Geometry.ts:34](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L34) #### Inherited from @@ -80,9 +84,11 @@ Defined in: src/geometry/Geometry.ts:34 ### properties -> **properties**: `any` +```ts +properties: any; +``` -Defined in: src/geometry/Geometry.ts:33 +Defined in: [src/geometry/Geometry.ts:33](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L33) #### Inherited from @@ -94,9 +100,11 @@ Defined in: src/geometry/Geometry.ts:33 #### Get Signature -> **get** **lat**(): `number` +```ts +get lat(): number +``` -Defined in: src/geometry/Point.ts:15 +Defined in: [src/geometry/Point.ts:15](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Point.ts#L15) ##### Returns @@ -108,9 +116,11 @@ Defined in: src/geometry/Point.ts:15 #### Get Signature -> **get** **lon**(): `number` +```ts +get lon(): number +``` -Defined in: src/geometry/Point.ts:12 +Defined in: [src/geometry/Point.ts:12](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Point.ts#L12) ##### Returns @@ -122,9 +132,11 @@ Defined in: src/geometry/Point.ts:12 #### Set Signature -> **set** **Properties**(`properties`): `void` +```ts +set Properties(properties): void +``` -Defined in: src/geometry/Geometry.ts:49 +Defined in: [src/geometry/Geometry.ts:49](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L49) ##### Parameters @@ -144,9 +156,11 @@ Defined in: src/geometry/Geometry.ts:49 ### clone() -> **clone**(): [`Geometry`](Geometry.md) +```ts +clone(): Geometry +``` -Defined in: src/geometry/Geometry.ts:51 +Defined in: [src/geometry/Geometry.ts:51](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L51) #### Returns @@ -160,9 +174,11 @@ Defined in: src/geometry/Geometry.ts:51 ### equals() -> **equals**(`geometry`): `boolean` +```ts +equals(geometry): boolean +``` -Defined in: src/geometry/Geometry.ts:58 +Defined in: [src/geometry/Geometry.ts:58](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L58) #### Parameters @@ -182,9 +198,11 @@ Defined in: src/geometry/Geometry.ts:58 ### toGeoJSON() -> **toGeoJSON**(): [`GeoJSONFeature`](../interfaces/GeoJSONFeature.md) +```ts +toGeoJSON(): GeoJSONFeature +``` -Defined in: src/geometry/Geometry.ts:64 +Defined in: [src/geometry/Geometry.ts:64](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L64) #### Returns @@ -198,9 +216,11 @@ Defined in: src/geometry/Geometry.ts:64 ### toXY() -> **toXY**(): \[`number`, `number`\] +```ts +toXY(): [number, number] +``` -Defined in: src/geometry/Point.ts:27 +Defined in: [src/geometry/Point.ts:27](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Point.ts#L27) #### Returns @@ -214,9 +234,11 @@ Defined in: src/geometry/Point.ts:27 ### updateBBox() -> **updateBBox**(): `void` +```ts +updateBBox(): void +``` -Defined in: src/geometry/Point.ts:23 +Defined in: [src/geometry/Point.ts:23](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Point.ts#L23) #### Returns @@ -230,9 +252,11 @@ Defined in: src/geometry/Point.ts:23 ### fromFeature() -> `static` **fromFeature**(`feature`): [`Point`](Point.md) +```ts +static fromFeature(feature): Point +``` -Defined in: src/geometry/Point.ts:39 +Defined in: [src/geometry/Point.ts:39](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Point.ts#L39) #### Parameters @@ -246,15 +270,19 @@ Defined in: src/geometry/Point.ts:39 #### Overrides -`Geometry.fromFeature` +```ts +Geometry.fromFeature +``` *** ### fromGeoJSON() -> `static` **fromGeoJSON**(`feature`): [`Geometry`](Geometry.md) \| [`GeometryCollection`](GeometryCollection.md) +```ts +static fromGeoJSON(feature): Geometry | GeometryCollection +``` -Defined in: src/geometry/Geometry.ts:82 +Defined in: [src/geometry/Geometry.ts:82](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L82) #### Parameters @@ -274,9 +302,11 @@ Defined in: src/geometry/Geometry.ts:82 ### fromGeometry() -> `static` **fromGeometry**(`geometry`): [`Point`](Point.md) +```ts +static fromGeometry(geometry): Point +``` -Defined in: src/geometry/Point.ts:35 +Defined in: [src/geometry/Point.ts:35](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Point.ts#L35) #### Parameters @@ -290,15 +320,19 @@ Defined in: src/geometry/Point.ts:35 #### Overrides -`Geometry.fromGeometry` +```ts +Geometry.fromGeometry +``` *** ### isPoint() -> `static` **isPoint**(`geometry`): `geometry is Point` +```ts +static isPoint(geometry): geometry is Point +``` -Defined in: src/geometry/Point.ts:31 +Defined in: [src/geometry/Point.ts:31](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Point.ts#L31) #### Parameters diff --git a/docs/api/classes/Polygon.md b/docs/api/classes/Polygon.md index 5289eca..0d91165 100644 --- a/docs/api/classes/Polygon.md +++ b/docs/api/classes/Polygon.md @@ -1,12 +1,8 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / Polygon -*** - -[rvgeo](../globals.md) / Polygon - -# Class: Polygon +# Polygon -Defined in: src/geometry/Polygon.ts:5 +Defined in: [src/geometry/Polygon.ts:5](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Polygon.ts#L5) Geometry for GeoJSON independent Objects including Point, LineString, Polygon - no GeometryCollection @@ -20,9 +16,11 @@ Geometry for GeoJSON independent Objects including Point, LineString, Polygon ### new Polygon() -> **new Polygon**(`coordinates`, `properties`?): [`Polygon`](Polygon.md) +```ts +new Polygon(coordinates, properties?): Polygon +``` -Defined in: src/geometry/Polygon.ts:7 +Defined in: [src/geometry/Polygon.ts:7](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Polygon.ts#L7) #### Parameters @@ -46,9 +44,11 @@ Defined in: src/geometry/Polygon.ts:7 ### bbox -> **bbox**: [`MBR`](../type-aliases/MBR.md) +```ts +bbox: MBR; +``` -Defined in: src/geometry/Geometry.ts:31 +Defined in: [src/geometry/Geometry.ts:31](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L31) #### Inherited from @@ -58,9 +58,11 @@ Defined in: src/geometry/Geometry.ts:31 ### coordinates -> `readonly` **coordinates**: `any` +```ts +readonly coordinates: any; +``` -Defined in: src/geometry/Geometry.ts:32 +Defined in: [src/geometry/Geometry.ts:32](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L32) #### Inherited from @@ -70,9 +72,11 @@ Defined in: src/geometry/Geometry.ts:32 ### projection -> `readonly` **projection**: [`Projection`](../interfaces/Projection.md) = `SphericalMercator` +```ts +readonly projection: Projection = SphericalMercator; +``` -Defined in: src/geometry/Geometry.ts:34 +Defined in: [src/geometry/Geometry.ts:34](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L34) #### Inherited from @@ -82,9 +86,11 @@ Defined in: src/geometry/Geometry.ts:34 ### properties -> **properties**: `any` +```ts +properties: any; +``` -Defined in: src/geometry/Geometry.ts:33 +Defined in: [src/geometry/Geometry.ts:33](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L33) #### Inherited from @@ -96,9 +102,11 @@ Defined in: src/geometry/Geometry.ts:33 #### Set Signature -> **set** **Properties**(`properties`): `void` +```ts +set Properties(properties): void +``` -Defined in: src/geometry/Geometry.ts:49 +Defined in: [src/geometry/Geometry.ts:49](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L49) ##### Parameters @@ -118,9 +126,11 @@ Defined in: src/geometry/Geometry.ts:49 ### clone() -> **clone**(): [`Geometry`](Geometry.md) +```ts +clone(): Geometry +``` -Defined in: src/geometry/Geometry.ts:51 +Defined in: [src/geometry/Geometry.ts:51](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L51) #### Returns @@ -134,9 +144,11 @@ Defined in: src/geometry/Geometry.ts:51 ### equals() -> **equals**(`geometry`): `boolean` +```ts +equals(geometry): boolean +``` -Defined in: src/geometry/Geometry.ts:58 +Defined in: [src/geometry/Geometry.ts:58](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L58) #### Parameters @@ -156,9 +168,11 @@ Defined in: src/geometry/Geometry.ts:58 ### toGeoJSON() -> **toGeoJSON**(): [`GeoJSONFeature`](../interfaces/GeoJSONFeature.md) +```ts +toGeoJSON(): GeoJSONFeature +``` -Defined in: src/geometry/Geometry.ts:64 +Defined in: [src/geometry/Geometry.ts:64](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L64) #### Returns @@ -172,9 +186,11 @@ Defined in: src/geometry/Geometry.ts:64 ### toMultiPoint() -> **toMultiPoint**(): [`MultiPoint`](MultiPoint.md) +```ts +toMultiPoint(): MultiPoint +``` -Defined in: src/geometry/Polygon.ts:16 +Defined in: [src/geometry/Polygon.ts:16](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Polygon.ts#L16) #### Returns @@ -184,9 +200,11 @@ Defined in: src/geometry/Polygon.ts:16 ### toXY() -> **toXY**(): \[`number`, `number`\][][] +```ts +toXY(): [number, number][][] +``` -Defined in: src/geometry/Polygon.ts:11 +Defined in: [src/geometry/Polygon.ts:11](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Polygon.ts#L11) #### Returns @@ -200,9 +218,11 @@ Defined in: src/geometry/Polygon.ts:11 ### updateBBox() -> **updateBBox**(): `void` +```ts +updateBBox(): void +``` -Defined in: src/geometry/Polygon.ts:20 +Defined in: [src/geometry/Polygon.ts:20](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Polygon.ts#L20) #### Returns @@ -216,9 +236,11 @@ Defined in: src/geometry/Polygon.ts:20 ### fromFeature() -> `static` **fromFeature**(`feature`): [`Polygon`](Polygon.md) +```ts +static fromFeature(feature): Polygon +``` -Defined in: src/geometry/Polygon.ts:41 +Defined in: [src/geometry/Polygon.ts:41](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Polygon.ts#L41) #### Parameters @@ -232,15 +254,19 @@ Defined in: src/geometry/Polygon.ts:41 #### Overrides -`Geometry.fromFeature` +```ts +Geometry.fromFeature +``` *** ### fromGeoJSON() -> `static` **fromGeoJSON**(`feature`): [`Geometry`](Geometry.md) \| [`GeometryCollection`](GeometryCollection.md) +```ts +static fromGeoJSON(feature): Geometry | GeometryCollection +``` -Defined in: src/geometry/Geometry.ts:82 +Defined in: [src/geometry/Geometry.ts:82](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Geometry.ts#L82) #### Parameters @@ -260,9 +286,11 @@ Defined in: src/geometry/Geometry.ts:82 ### fromGeometry() -> `static` **fromGeometry**(`geometry`): [`Polygon`](Polygon.md) +```ts +static fromGeometry(geometry): Polygon +``` -Defined in: src/geometry/Polygon.ts:37 +Defined in: [src/geometry/Polygon.ts:37](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Polygon.ts#L37) #### Parameters @@ -276,15 +304,19 @@ Defined in: src/geometry/Polygon.ts:37 #### Overrides -`Geometry.fromGeometry` +```ts +Geometry.fromGeometry +``` *** ### isPolygon() -> `static` **isPolygon**(`geometry`): `geometry is Polygon` +```ts +static isPolygon(geometry): geometry is Polygon +``` -Defined in: src/geometry/Polygon.ts:33 +Defined in: [src/geometry/Polygon.ts:33](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Polygon.ts#L33) #### Parameters diff --git a/docs/api/classes/PriorityQueue.md b/docs/api/classes/PriorityQueue.md index db90c3c..07eee81 100644 --- a/docs/api/classes/PriorityQueue.md +++ b/docs/api/classes/PriorityQueue.md @@ -1,12 +1,8 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / PriorityQueue -*** - -[rvgeo](../globals.md) / PriorityQueue - -# Class: PriorityQueue\ +# PriorityQueue\ -Defined in: src/net/utils.ts:26 +Defined in: [src/net/utils.ts:26](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/utils.ts#L26) ## Type Parameters @@ -16,7 +12,9 @@ Defined in: src/net/utils.ts:26 ### new PriorityQueue() -> **new PriorityQueue**\<`T`\>(): [`PriorityQueue`](PriorityQueue.md)\<`T`\> +```ts +new PriorityQueue(): PriorityQueue +``` #### Returns @@ -26,9 +24,11 @@ Defined in: src/net/utils.ts:26 ### empty() -> **empty**(): `boolean` +```ts +empty(): boolean +``` -Defined in: src/net/utils.ts:29 +Defined in: [src/net/utils.ts:29](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/utils.ts#L29) #### Returns @@ -38,9 +38,11 @@ Defined in: src/net/utils.ts:29 ### get() -> **get**(): `undefined` \| `T` +```ts +get(): undefined | T +``` -Defined in: src/net/utils.ts:38 +Defined in: [src/net/utils.ts:38](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/utils.ts#L38) #### Returns @@ -50,9 +52,11 @@ Defined in: src/net/utils.ts:38 ### isEmpty() -> **isEmpty**(): `boolean` +```ts +isEmpty(): boolean +``` -Defined in: src/net/utils.ts:42 +Defined in: [src/net/utils.ts:42](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/utils.ts#L42) #### Returns @@ -62,9 +66,11 @@ Defined in: src/net/utils.ts:42 ### put() -> **put**(`item`, `priority`): `void` +```ts +put(item, priority): void +``` -Defined in: src/net/utils.ts:33 +Defined in: [src/net/utils.ts:33](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/utils.ts#L33) #### Parameters diff --git a/docs/api/classes/QuadTree.md b/docs/api/classes/QuadTree.md index 11677e4..a357413 100644 --- a/docs/api/classes/QuadTree.md +++ b/docs/api/classes/QuadTree.md @@ -1,20 +1,21 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / QuadTree -*** - -[rvgeo](../globals.md) / QuadTree - -# Class: QuadTree +# QuadTree -Defined in: src/datastru/quadTree.ts:3 +Defined in: [src/datastru/quadTree.ts:3](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/datastru/quadTree.ts#L3) ## Constructors ### new QuadTree() -> **new QuadTree**(`boundary`, `capacity`, `maxDepth`): [`QuadTree`](QuadTree.md) +```ts +new QuadTree( + boundary, + capacity, + maxDepth): QuadTree +``` -Defined in: src/datastru/quadTree.ts:15 +Defined in: [src/datastru/quadTree.ts:15](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/datastru/quadTree.ts#L15) #### Parameters @@ -38,57 +39,71 @@ Defined in: src/datastru/quadTree.ts:15 ### boundary -> **boundary**: [`MBR`](../type-aliases/MBR.md) +```ts +boundary: MBR; +``` -Defined in: src/datastru/quadTree.ts:5 +Defined in: [src/datastru/quadTree.ts:5](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/datastru/quadTree.ts#L5) *** ### depth -> **depth**: `number` +```ts +depth: number; +``` -Defined in: src/datastru/quadTree.ts:12 +Defined in: [src/datastru/quadTree.ts:12](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/datastru/quadTree.ts#L12) *** ### maxDepth -> **maxDepth**: `number` = `10` +```ts +maxDepth: number = 10; +``` -Defined in: src/datastru/quadTree.ts:13 +Defined in: [src/datastru/quadTree.ts:13](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/datastru/quadTree.ts#L13) *** ### northEast -> **northEast**: `null` \| [`QuadTree`](QuadTree.md) +```ts +northEast: null | QuadTree; +``` -Defined in: src/datastru/quadTree.ts:8 +Defined in: [src/datastru/quadTree.ts:8](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/datastru/quadTree.ts#L8) *** ### northWest -> **northWest**: `null` \| [`QuadTree`](QuadTree.md) +```ts +northWest: null | QuadTree; +``` -Defined in: src/datastru/quadTree.ts:7 +Defined in: [src/datastru/quadTree.ts:7](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/datastru/quadTree.ts#L7) *** ### southEast -> **southEast**: `null` \| [`QuadTree`](QuadTree.md) +```ts +southEast: null | QuadTree; +``` -Defined in: src/datastru/quadTree.ts:10 +Defined in: [src/datastru/quadTree.ts:10](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/datastru/quadTree.ts#L10) *** ### southWest -> **southWest**: `null` \| [`QuadTree`](QuadTree.md) +```ts +southWest: null | QuadTree; +``` -Defined in: src/datastru/quadTree.ts:9 +Defined in: [src/datastru/quadTree.ts:9](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/datastru/quadTree.ts#L9) ## Accessors @@ -96,9 +111,11 @@ Defined in: src/datastru/quadTree.ts:9 #### Get Signature -> **get** **pointsList**(): `null` \| \[`number`, `number`\][] +```ts +get pointsList(): null | [number, number][] +``` -Defined in: src/datastru/quadTree.ts:68 +Defined in: [src/datastru/quadTree.ts:68](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/datastru/quadTree.ts#L68) ##### Returns @@ -108,9 +125,11 @@ Defined in: src/datastru/quadTree.ts:68 ### contains() -> **contains**(`point`, `boundary`): `boolean` +```ts +contains(point, boundary): boolean +``` -Defined in: src/datastru/quadTree.ts:29 +Defined in: [src/datastru/quadTree.ts:29](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/datastru/quadTree.ts#L29) #### Parameters @@ -130,9 +149,11 @@ Defined in: src/datastru/quadTree.ts:29 ### customQuery() -> **customQuery**(`range`): \[`number`, `number`\][] +```ts +customQuery(range): [number, number][] +``` -Defined in: src/datastru/quadTree.ts:128 +Defined in: [src/datastru/quadTree.ts:128](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/datastru/quadTree.ts#L128) you need a customRange object to support custom range query - note : this function has the SAME LOGIC as queryRange. @@ -155,9 +176,11 @@ customRange ### insert() -> **insert**(`point`): `boolean` +```ts +insert(point): boolean +``` -Defined in: src/datastru/quadTree.ts:42 +Defined in: [src/datastru/quadTree.ts:42](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/datastru/quadTree.ts#L42) 插入一个点 @@ -179,9 +202,11 @@ Defined in: src/datastru/quadTree.ts:42 ### intersects() -> **intersects**(`boundary`, `range`): `boolean` +```ts +intersects(boundary, range): boolean +``` -Defined in: src/datastru/quadTree.ts:33 +Defined in: [src/datastru/quadTree.ts:33](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/datastru/quadTree.ts#L33) #### Parameters @@ -201,9 +226,11 @@ Defined in: src/datastru/quadTree.ts:33 ### queryRange() -> **queryRange**(`range`): \[`number`, `number`\][] +```ts +queryRange(range): [number, number][] +``` -Defined in: src/datastru/quadTree.ts:103 +Defined in: [src/datastru/quadTree.ts:103](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/datastru/quadTree.ts#L103) 四叉树范围查询 - 输入一个矩形范围，返回范围内的所有点 @@ -223,9 +250,11 @@ Defined in: src/datastru/quadTree.ts:103 ### subdivide() -> **subdivide**(): `void` +```ts +subdivide(): void +``` -Defined in: src/datastru/quadTree.ts:79 +Defined in: [src/datastru/quadTree.ts:79](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/datastru/quadTree.ts#L79) 剖分当前节点 diff --git a/docs/api/classes/Queue.md b/docs/api/classes/Queue.md index 3295a3b..be6c603 100644 --- a/docs/api/classes/Queue.md +++ b/docs/api/classes/Queue.md @@ -1,12 +1,8 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / Queue -*** - -[rvgeo](../globals.md) / Queue - -# Class: Queue\ +# Queue\ -Defined in: src/net/utils.ts:2 +Defined in: [src/net/utils.ts:2](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/utils.ts#L2) ## Type Parameters @@ -16,7 +12,9 @@ Defined in: src/net/utils.ts:2 ### new Queue() -> **new Queue**\<`T`\>(): [`Queue`](Queue.md)\<`T`\> +```ts +new Queue(): Queue +``` #### Returns @@ -26,9 +24,11 @@ Defined in: src/net/utils.ts:2 ### get() -> **get**(): `undefined` \| `T` +```ts +get(): undefined | T +``` -Defined in: src/net/utils.ts:17 +Defined in: [src/net/utils.ts:17](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/utils.ts#L17) #### Returns @@ -38,9 +38,11 @@ Defined in: src/net/utils.ts:17 ### isEmpty() -> **isEmpty**(): `boolean` +```ts +isEmpty(): boolean +``` -Defined in: src/net/utils.ts:21 +Defined in: [src/net/utils.ts:21](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/utils.ts#L21) #### Returns @@ -50,9 +52,11 @@ Defined in: src/net/utils.ts:21 ### pop() -> **pop**(): `undefined` \| `T` +```ts +pop(): undefined | T +``` -Defined in: src/net/utils.ts:9 +Defined in: [src/net/utils.ts:9](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/utils.ts#L9) #### Returns @@ -62,9 +66,11 @@ Defined in: src/net/utils.ts:9 ### push() -> **push**(`item`): `void` +```ts +push(item): void +``` -Defined in: src/net/utils.ts:5 +Defined in: [src/net/utils.ts:5](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/utils.ts#L5) #### Parameters @@ -80,9 +86,11 @@ Defined in: src/net/utils.ts:5 ### put() -> **put**(`item`): `void` +```ts +put(item): void +``` -Defined in: src/net/utils.ts:13 +Defined in: [src/net/utils.ts:13](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/utils.ts#L13) #### Parameters diff --git a/docs/api/classes/Voronoi.md b/docs/api/classes/Voronoi.md index 754492f..d1adf85 100644 --- a/docs/api/classes/Voronoi.md +++ b/docs/api/classes/Voronoi.md @@ -1,20 +1,21 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / Voronoi -*** - -[rvgeo](../globals.md) / Voronoi - -# Class: Voronoi +# Voronoi -Defined in: src/triangulation/Delaunay.ts:649 +Defined in: [src/triangulation/Delaunay.ts:649](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/triangulation/Delaunay.ts#L649) ## Constructors ### new Voronoi() -> **new Voronoi**(`params`?, `x`?, `y`?): [`Voronoi`](Voronoi.md) +```ts +new Voronoi( + params?, + x?, + y?): Voronoi +``` -Defined in: src/triangulation/Delaunay.ts:660 +Defined in: [src/triangulation/Delaunay.ts:660](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/triangulation/Delaunay.ts#L660) - 从点数组构造 Voronoi 图或包装 Delaunator - Construct Voronoi diagram from points array or wrap Delaunator @@ -47,25 +48,31 @@ Defined in: src/triangulation/Delaunay.ts:660 ### delaunay -> **delaunay**: [`Delaunator`](Delaunator.md) +```ts +delaunay: Delaunator; +``` -Defined in: src/triangulation/Delaunay.ts:650 +Defined in: [src/triangulation/Delaunay.ts:650](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/triangulation/Delaunay.ts#L650) *** ### points -> **points**: `number`[][] +```ts +points: number[][]; +``` -Defined in: src/triangulation/Delaunay.ts:651 +Defined in: [src/triangulation/Delaunay.ts:651](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/triangulation/Delaunay.ts#L651) ## Methods ### cutVoronoiByMBR() -> **cutVoronoiByMBR**(`MBR`): `Map`\<`any`, `any`\> +```ts +cutVoronoiByMBR(MBR): Map +``` -Defined in: src/triangulation/Delaunay.ts:691 +Defined in: [src/triangulation/Delaunay.ts:691](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/triangulation/Delaunay.ts#L691) 使用 MBR 对 Voronoi 图进行裁剪（由于精度问题，极端情况下不可靠） @@ -83,9 +90,11 @@ Defined in: src/triangulation/Delaunay.ts:691 ### getVoronoi() -> **getVoronoi**(): `Map`\<`number`, `number`[][]\> +```ts +getVoronoi(): Map +``` -Defined in: src/triangulation/Delaunay.ts:677 +Defined in: [src/triangulation/Delaunay.ts:677](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/triangulation/Delaunay.ts#L677) - 获取 Voronoi cell 的顶点数组 @@ -99,9 +108,11 @@ Defined in: src/triangulation/Delaunay.ts:677 ### isInsideMBR() -> **isInsideMBR**(`points`, `MBR`): `boolean` +```ts +isInsideMBR(points, MBR): boolean +``` -Defined in: src/triangulation/Delaunay.ts:724 +Defined in: [src/triangulation/Delaunay.ts:724](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/triangulation/Delaunay.ts#L724) #### Parameters @@ -121,9 +132,11 @@ Defined in: src/triangulation/Delaunay.ts:724 ### robustVoronoi() -> **robustVoronoi**(`MBR`): `Map`\<`any`, `any`\> +```ts +robustVoronoi(MBR): Map +``` -Defined in: src/triangulation/Delaunay.ts:712 +Defined in: [src/triangulation/Delaunay.ts:712](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/triangulation/Delaunay.ts#L712) - 更加健壮的 Voronoi 图（将超出 MBR 部分都删去） diff --git a/docs/api/enumerations/colorListType.md b/docs/api/enumerations/colorListType.md index dc39f4b..13003f6 100644 --- a/docs/api/enumerations/colorListType.md +++ b/docs/api/enumerations/colorListType.md @@ -1,17 +1,15 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / colorListType -*** +# colorListType -[rvgeo](../globals.md) / colorListType - -# Enumeration: colorListType - -Defined in: src/render/colors.ts:9 +Defined in: [src/render/colors.ts:9](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/render/colors.ts#L9) ## Enumeration Members ### default -> **default**: `0` +```ts +default: 0; +``` -Defined in: src/render/colors.ts:10 +Defined in: [src/render/colors.ts:10](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/render/colors.ts#L10) diff --git a/docs/api/enumerations/stretchType.md b/docs/api/enumerations/stretchType.md index 9ee126b..e94aac2 100644 --- a/docs/api/enumerations/stretchType.md +++ b/docs/api/enumerations/stretchType.md @@ -1,49 +1,55 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / stretchType -*** - -[rvgeo](../globals.md) / stretchType - -# Enumeration: stretchType +# stretchType -Defined in: src/render/colors.ts:1 +Defined in: [src/render/colors.ts:1](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/render/colors.ts#L1) ## Enumeration Members ### groupStretch -> **groupStretch**: `4` +```ts +groupStretch: 4; +``` -Defined in: src/render/colors.ts:6 +Defined in: [src/render/colors.ts:6](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/render/colors.ts#L6) *** ### linear -> **linear**: `0` +```ts +linear: 0; +``` -Defined in: src/render/colors.ts:2 +Defined in: [src/render/colors.ts:2](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/render/colors.ts#L2) *** ### log -> **log**: `2` +```ts +log: 2; +``` -Defined in: src/render/colors.ts:4 +Defined in: [src/render/colors.ts:4](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/render/colors.ts#L4) *** ### power -> **power**: `3` +```ts +power: 3; +``` -Defined in: src/render/colors.ts:5 +Defined in: [src/render/colors.ts:5](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/render/colors.ts#L5) *** ### square -> **square**: `1` +```ts +square: 1; +``` -Defined in: src/render/colors.ts:3 +Defined in: [src/render/colors.ts:3](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/render/colors.ts#L3) diff --git a/docs/api/functions/FFT.md b/docs/api/functions/FFT.md index 48d46db..819ed38 100644 --- a/docs/api/functions/FFT.md +++ b/docs/api/functions/FFT.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / FFT -*** +# FFT() -[rvgeo](../globals.md) / FFT +```ts +function FFT(X): Complex[] +``` -# Function: FFT() - -> **FFT**(`X`): [`Complex`](../type-aliases/Complex.md)[] - -Defined in: src/math/fourier.ts:107 +Defined in: [src/math/fourier.ts:107](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/fourier.ts#L107) 快速傅里叶变换 real to complex diff --git a/docs/api/functions/FFT2.md b/docs/api/functions/FFT2.md index 27fd55f..e99ae21 100644 --- a/docs/api/functions/FFT2.md +++ b/docs/api/functions/FFT2.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / FFT2 -*** +# FFT2() -[rvgeo](../globals.md) / FFT2 +```ts +function FFT2(X, mode): Complex[][] +``` -# Function: FFT2() - -> **FFT2**(`X`, `mode`): [`Complex`](../type-aliases/Complex.md)[][] - -Defined in: src/math/fourier.ts:236 +Defined in: [src/math/fourier.ts:236](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/fourier.ts#L236) ## Parameters diff --git a/docs/api/functions/FFTImag.md b/docs/api/functions/FFTImag.md index a917484..77fa26d 100644 --- a/docs/api/functions/FFTImag.md +++ b/docs/api/functions/FFTImag.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / FFTImag -*** +# FFTImag() -[rvgeo](../globals.md) / FFTImag +```ts +function FFTImag(fftResult): number[] +``` -# Function: FFTImag() - -> **FFTImag**(`fftResult`): `number`[] - -Defined in: src/math/fourier.ts:341 +Defined in: [src/math/fourier.ts:341](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/fourier.ts#L341) 获取傅里叶变换结果的振幅 diff --git a/docs/api/functions/FFTImag2.md b/docs/api/functions/FFTImag2.md index 8cfb506..751dc2a 100644 --- a/docs/api/functions/FFTImag2.md +++ b/docs/api/functions/FFTImag2.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / FFTImag2 -*** +# FFTImag2() -[rvgeo](../globals.md) / FFTImag2 +```ts +function FFTImag2(fftResult, mode): number[][] +``` -# Function: FFTImag2() - -> **FFTImag2**(`fftResult`, `mode`): `number`[][] - -Defined in: src/math/fourier.ts:353 +Defined in: [src/math/fourier.ts:353](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/fourier.ts#L353) ## Parameters diff --git a/docs/api/functions/FFTReal.md b/docs/api/functions/FFTReal.md index 92c0ab9..c4ba466 100644 --- a/docs/api/functions/FFTReal.md +++ b/docs/api/functions/FFTReal.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / FFTReal -*** +# FFTReal() -[rvgeo](../globals.md) / FFTReal +```ts +function FFTReal(fftResult): number[] +``` -# Function: FFTReal() - -> **FFTReal**(`fftResult`): `number`[] - -Defined in: src/math/fourier.ts:370 +Defined in: [src/math/fourier.ts:370](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/fourier.ts#L370) 获取傅里叶变换结果的振幅 diff --git a/docs/api/functions/FFTReal2.md b/docs/api/functions/FFTReal2.md index e2d0ad8..badbb7a 100644 --- a/docs/api/functions/FFTReal2.md +++ b/docs/api/functions/FFTReal2.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / FFTReal2 -*** +# FFTReal2() -[rvgeo](../globals.md) / FFTReal2 +```ts +function FFTReal2(fftResult, mode): number[][] +``` -# Function: FFTReal2() - -> **FFTReal2**(`fftResult`, `mode`): `number`[][] - -Defined in: src/math/fourier.ts:395 +Defined in: [src/math/fourier.ts:395](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/fourier.ts#L395) ## Parameters diff --git a/docs/api/functions/FFTShift.md b/docs/api/functions/FFTShift.md index a29a63b..4f4f58c 100644 --- a/docs/api/functions/FFTShift.md +++ b/docs/api/functions/FFTShift.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / FFTShift -*** +# FFTShift() -[rvgeo](../globals.md) / FFTShift +```ts +function FFTShift(fftResult): Complex[][] +``` -# Function: FFTShift() - -> **FFTShift**(`fftResult`): [`Complex`](../type-aliases/Complex.md)[][] - -Defined in: src/math/fourier.ts:409 +Defined in: [src/math/fourier.ts:409](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/fourier.ts#L409) ## Parameters diff --git a/docs/api/functions/IFFT.md b/docs/api/functions/IFFT.md index 3bf9456..9c18332 100644 --- a/docs/api/functions/IFFT.md +++ b/docs/api/functions/IFFT.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / IFFT -*** +# IFFT() -[rvgeo](../globals.md) / IFFT +```ts +function IFFT(X): Complex[] +``` -# Function: IFFT() - -> **IFFT**(`X`): [`Complex`](../type-aliases/Complex.md)[] - -Defined in: src/math/fourier.ts:153 +Defined in: [src/math/fourier.ts:153](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/fourier.ts#L153) 快速傅里叶逆变换 complex to real diff --git a/docs/api/functions/IFFT2.md b/docs/api/functions/IFFT2.md index 8fab3bb..c65dc74 100644 --- a/docs/api/functions/IFFT2.md +++ b/docs/api/functions/IFFT2.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / IFFT2 -*** +# IFFT2() -[rvgeo](../globals.md) / IFFT2 +```ts +function IFFT2(X, mode): Complex[][] +``` -# Function: IFFT2() - -> **IFFT2**(`X`, `mode`): [`Complex`](../type-aliases/Complex.md)[][] - -Defined in: src/math/fourier.ts:270 +Defined in: [src/math/fourier.ts:270](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/fourier.ts#L270) ## Parameters diff --git a/docs/api/functions/IFFTReal.md b/docs/api/functions/IFFTReal.md index 93e85e9..641b515 100644 --- a/docs/api/functions/IFFTReal.md +++ b/docs/api/functions/IFFTReal.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / IFFTReal -*** +# IFFTReal() -[rvgeo](../globals.md) / IFFTReal +```ts +function IFFTReal(ifftResult): number[] +``` -# Function: IFFTReal() - -> **IFFTReal**(`ifftResult`): `number`[] - -Defined in: src/math/fourier.ts:197 +Defined in: [src/math/fourier.ts:197](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/fourier.ts#L197) 取 IFFT 结果的实部（也就是原函数值） diff --git a/docs/api/functions/IFFTReal2.md b/docs/api/functions/IFFTReal2.md index 0b67d6d..83d1dbd 100644 --- a/docs/api/functions/IFFTReal2.md +++ b/docs/api/functions/IFFTReal2.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / IFFTReal2 -*** +# IFFTReal2() -[rvgeo](../globals.md) / IFFTReal2 +```ts +function IFFTReal2(ifftResult, mode): number[][] +``` -# Function: IFFTReal2() - -> **IFFTReal2**(`ifftResult`, `mode`): `number`[][] - -Defined in: src/math/fourier.ts:209 +Defined in: [src/math/fourier.ts:209](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/fourier.ts#L209) ## Parameters diff --git a/docs/api/functions/K_means.md b/docs/api/functions/K_means.md index 9148438..5cb9bdf 100644 --- a/docs/api/functions/K_means.md +++ b/docs/api/functions/K_means.md @@ -1,14 +1,16 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / K\_means -*** +# K\_means() -[rvgeo](../globals.md) / K\_means +```ts +function K_means( + k, + thresh, + maxtime, + points): undefined | [number, number][][] +``` -# Function: K\_means() - -> **K\_means**(`k`, `thresh`, `maxtime`, `points`): `undefined` \| \[`number`, `number`\][][] - -Defined in: src/cluster/kmeans.ts:37 +Defined in: [src/cluster/kmeans.ts:37](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/cluster/kmeans.ts#L37) k均值聚类 diff --git a/docs/api/functions/MBR2Plane.md b/docs/api/functions/MBR2Plane.md index 6506cc9..69772ca 100644 --- a/docs/api/functions/MBR2Plane.md +++ b/docs/api/functions/MBR2Plane.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / MBR2Plane -*** +# MBR2Plane() -[rvgeo](../globals.md) / MBR2Plane +```ts +function MBR2Plane(mbr, projection): MBR +``` -# Function: MBR2Plane() - -> **MBR2Plane**(`mbr`, `projection`): [`MBR`](../type-aliases/MBR.md) - -Defined in: src/geometry/MBR.ts:61 +Defined in: [src/geometry/MBR.ts:61](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/MBR.ts#L61) default projection : SphericalMercator - you can change the projection by passing the second parameter diff --git a/docs/api/functions/Perlin.md b/docs/api/functions/Perlin.md index 6fa7216..33a819d 100644 --- a/docs/api/functions/Perlin.md +++ b/docs/api/functions/Perlin.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / Perlin -*** +# Perlin() -[rvgeo](../globals.md) / Perlin - -# Function: Perlin() - -> **Perlin**(`X`, `Y`): `number` +```ts +function Perlin(X, Y): number +``` -Defined in: src/coverage/Noise.ts:78 +Defined in: [src/coverage/Noise.ts:78](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/Noise.ts#L78) 2D [Perlin](https://en.wikipedia.org/wiki/Perlin_noise) 噪声 diff --git a/docs/api/functions/PointInsidePolygon.md b/docs/api/functions/PointInsidePolygon.md index cfcccce..cd5915c 100644 --- a/docs/api/functions/PointInsidePolygon.md +++ b/docs/api/functions/PointInsidePolygon.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / PointInsidePolygon -*** +# PointInsidePolygon() -[rvgeo](../globals.md) / PointInsidePolygon +```ts +function PointInsidePolygon(point, polygon): boolean +``` -# Function: PointInsidePolygon() - -> **PointInsidePolygon**(`point`, `polygon`): `boolean` - -Defined in: src/topology/utils.ts:169 +Defined in: [src/topology/utils.ts:169](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/topology/utils.ts#L169) 判断点是否在简单多边形内部（平面与经纬度坐标通用，多边形边界算作在内） diff --git a/docs/api/functions/PointOutsideMBR.md b/docs/api/functions/PointOutsideMBR.md index d57bdd4..81ce1e1 100644 --- a/docs/api/functions/PointOutsideMBR.md +++ b/docs/api/functions/PointOutsideMBR.md @@ -1,14 +1,15 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / PointOutsideMBR -*** +# PointOutsideMBR() -[rvgeo](../globals.md) / PointOutsideMBR +```ts +function PointOutsideMBR( + point, + mbr, + isPlane): boolean +``` -# Function: PointOutsideMBR() - -> **PointOutsideMBR**(`point`, `mbr`, `isPlane`): `boolean` - -Defined in: src/topology/utils.ts:82 +Defined in: [src/topology/utils.ts:82](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/topology/utils.ts#L82) 判断点是否在 MBR 外（平面与经纬度坐标通用，多边形边界算作在内） determine if a point is outside of a MBR (polygon boundary is considered inside) diff --git a/docs/api/functions/Sin3D.md b/docs/api/functions/Sin3D.md index 6f52f64..8b12e31 100644 --- a/docs/api/functions/Sin3D.md +++ b/docs/api/functions/Sin3D.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / Sin3D -*** +# Sin3D() -[rvgeo](../globals.md) / Sin3D +```ts +function Sin3D(x, y): number +``` -# Function: Sin3D() - -> **Sin3D**(`x`, `y`): `number` - -Defined in: src/coverage/Noise.ts:114 +Defined in: [src/coverage/Noise.ts:114](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/Noise.ts#L114) ## Parameters diff --git a/docs/api/functions/UUID.md b/docs/api/functions/UUID.md index 8f5d6d9..3dc9df4 100644 --- a/docs/api/functions/UUID.md +++ b/docs/api/functions/UUID.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / UUID -*** +# UUID() -[rvgeo](../globals.md) / UUID +```ts +function UUID(): string +``` -# Function: UUID() - -> **UUID**(): `string` - -Defined in: src/core/utils.ts:81 +Defined in: [src/core/utils.ts:81](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/core/utils.ts#L81) 生成UUID diff --git a/docs/api/functions/XY2ColRow.md b/docs/api/functions/XY2ColRow.md index 87ae291..c9a4027 100644 --- a/docs/api/functions/XY2ColRow.md +++ b/docs/api/functions/XY2ColRow.md @@ -1,14 +1,15 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / XY2ColRow -*** +# XY2ColRow() -[rvgeo](../globals.md) / XY2ColRow +```ts +function XY2ColRow( + colRow, + Rect, + XY): number[] +``` -# Function: XY2ColRow() - -> **XY2ColRow**(`colRow`, `Rect`, `XY`): `number`[] - -Defined in: src/render/renderGrid.ts:45 +Defined in: [src/render/renderGrid.ts:45](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/render/renderGrid.ts#L45) 将屏幕像素坐标转化为对应的行列号 diff --git a/docs/api/functions/acos.md b/docs/api/functions/acos.md index bb45ee5..bf12ecb 100644 --- a/docs/api/functions/acos.md +++ b/docs/api/functions/acos.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / acos -*** +# acos() -[rvgeo](../globals.md) / acos +```ts +function acos(x): number +``` -# Function: acos() - -> **acos**(`x`): `number` - -Defined in: src/math/vector.ts:29 +Defined in: [src/math/vector.ts:29](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/vector.ts#L29) ## Parameters diff --git a/docs/api/functions/add.md b/docs/api/functions/add.md index b6ecebb..7f89cce 100644 --- a/docs/api/functions/add.md +++ b/docs/api/functions/add.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / add -*** +# add() -[rvgeo](../globals.md) / add +```ts +function add(a, b): [number, number] +``` -# Function: add() - -> **add**(`a`, `b`): \[`number`, `number`\] - -Defined in: src/math/vector.ts:175 +Defined in: [src/math/vector.ts:175](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/vector.ts#L175) 计算两个二维笛卡尔坐标系下的向量 a 和 b 的和，返回一个新的向量。 This function adds two 2D Cartesian vectors a and b, returning a new vector representing the sum. diff --git a/docs/api/functions/adjust_lon.md b/docs/api/functions/adjust_lon.md index 37bc592..c7965c0 100644 --- a/docs/api/functions/adjust_lon.md +++ b/docs/api/functions/adjust_lon.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / adjust\_lon -*** +# adjust\_lon() -[rvgeo](../globals.md) / adjust\_lon +```ts +function adjust_lon(lon): number +``` -# Function: adjust\_lon() - -> **adjust\_lon**(`lon`): `number` - -Defined in: src/topology/utils.ts:249 +Defined in: [src/topology/utils.ts:249](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/topology/utils.ts#L249) - Adjust longitude to [-180, 180] - 将超过 360 的经度调整为[-180, 180] diff --git a/docs/api/functions/alphaComplex.md b/docs/api/functions/alphaComplex.md index f8ea179..5c28333 100644 --- a/docs/api/functions/alphaComplex.md +++ b/docs/api/functions/alphaComplex.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / alphaComplex -*** +# alphaComplex() -[rvgeo](../globals.md) / alphaComplex +```ts +function alphaComplex(points, alpha): [number, number, number][] +``` -# Function: alphaComplex() - -> **alphaComplex**(`points`, `alpha`): \[`number`, `number`, `number`\][] - -Defined in: src/triangulation/Shell.ts:97 +Defined in: [src/triangulation/Shell.ts:97](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/triangulation/Shell.ts#L97) Alpha Complex 算法 - Alpha shapes are a generalization of Delaunay triangulations. diff --git a/docs/api/functions/applyMixins.md b/docs/api/functions/applyMixins.md index 66d9518..eacc9bf 100644 --- a/docs/api/functions/applyMixins.md +++ b/docs/api/functions/applyMixins.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / applyMixins -*** +# applyMixins() -[rvgeo](../globals.md) / applyMixins +```ts +function applyMixins(derivedCtor, constructors): void +``` -# Function: applyMixins() - -> **applyMixins**(`derivedCtor`, `constructors`): `void` - -Defined in: src/core/mixins.ts:8 +Defined in: [src/core/mixins.ts:8](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/core/mixins.ts#L8) Apply mixins to a class diff --git a/docs/api/functions/areaToArea.md b/docs/api/functions/areaToArea.md index d5c2729..f39f709 100644 --- a/docs/api/functions/areaToArea.md +++ b/docs/api/functions/areaToArea.md @@ -1,14 +1,15 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / areaToArea -*** +# areaToArea() -[rvgeo](../globals.md) / areaToArea +```ts +function areaToArea( + area, + from, + to): number +``` -# Function: areaToArea() - -> **areaToArea**(`area`, `from`, `to`): `number` - -Defined in: src/math/units.ts:170 +Defined in: [src/math/units.ts:170](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/units.ts#L170) - 面积单位内互相转换 - Convert area units to each other diff --git a/docs/api/functions/asin.md b/docs/api/functions/asin.md index c930e2d..15b0a6d 100644 --- a/docs/api/functions/asin.md +++ b/docs/api/functions/asin.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / asin -*** +# asin() -[rvgeo](../globals.md) / asin +```ts +function asin(x): number +``` -# Function: asin() - -> **asin**(`x`): `number` - -Defined in: src/math/vector.ts:33 +Defined in: [src/math/vector.ts:33](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/vector.ts#L33) ## Parameters diff --git a/docs/api/functions/atan2.md b/docs/api/functions/atan2.md index 23b6d19..0a5b50e 100644 --- a/docs/api/functions/atan2.md +++ b/docs/api/functions/atan2.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / atan2 -*** +# atan2() -[rvgeo](../globals.md) / atan2 +```ts +function atan2(y, x): number +``` -# Function: atan2() - -> **atan2**(`y`, `x`): `number` - -Defined in: src/math/vector.ts:5 +Defined in: [src/math/vector.ts:5](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/vector.ts#L5) Returns the angle (in radians) from the X axis to a point. diff --git a/docs/api/functions/bearing.md b/docs/api/functions/bearing.md index 06764db..2e12f91 100644 --- a/docs/api/functions/bearing.md +++ b/docs/api/functions/bearing.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / bearing -*** +# bearing() -[rvgeo](../globals.md) / bearing +```ts +function bearing(latlng1, latlng2): number +``` -# Function: bearing() - -> **bearing**(`latlng1`, `latlng2`): `number` - -Defined in: src/math/measuring.ts:92 +Defined in: [src/math/measuring.ts:92](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/measuring.ts#L92) ## Parameters diff --git a/docs/api/functions/binDrawGrid2d.md b/docs/api/functions/binDrawGrid2d.md index addd173..caac5fe 100644 --- a/docs/api/functions/binDrawGrid2d.md +++ b/docs/api/functions/binDrawGrid2d.md @@ -1,14 +1,16 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / binDrawGrid2d -*** +# binDrawGrid2d() -[rvgeo](../globals.md) / binDrawGrid2d +```ts +function binDrawGrid2d( + canavs, + grid2D, + Rect, + colorBand): void +``` -# Function: binDrawGrid2d() - -> **binDrawGrid2d**(`canavs`, `grid2D`, `Rect`, `colorBand`): `void` - -Defined in: src/render/renderGrid.ts:190 +Defined in: [src/render/renderGrid.ts:190](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/render/renderGrid.ts#L190) ## Parameters diff --git a/docs/api/functions/binarization.md b/docs/api/functions/binarization.md index 86b0066..04e34f8 100644 --- a/docs/api/functions/binarization.md +++ b/docs/api/functions/binarization.md @@ -1,14 +1,15 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / binarization -*** +# binarization() -[rvgeo](../globals.md) / binarization +```ts +function binarization( + grid, + band, + threshold): number[][] +``` -# Function: binarization() - -> **binarization**(`grid`, `band`, `threshold`): `number`[][] - -Defined in: src/coverage/grid.ts:372 +Defined in: [src/coverage/grid.ts:372](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L372) 二值化网格数据，返回二值化后的网格数据 diff --git a/docs/api/functions/binaryColorBand.md b/docs/api/functions/binaryColorBand.md index ad4659e..e70af62 100644 --- a/docs/api/functions/binaryColorBand.md +++ b/docs/api/functions/binaryColorBand.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / binaryColorBand -*** +# binaryColorBand() -[rvgeo](../globals.md) / binaryColorBand +```ts +function binaryColorBand(value, colorList): string +``` -# Function: binaryColorBand() - -> **binaryColorBand**(`value`, `colorList`): `string` - -Defined in: src/render/colors.ts:212 +Defined in: [src/render/colors.ts:212](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/render/colors.ts#L212) ## Parameters diff --git a/docs/api/functions/breadthFirstSearch.md b/docs/api/functions/breadthFirstSearch.md index 08afb33..99abe07 100644 --- a/docs/api/functions/breadthFirstSearch.md +++ b/docs/api/functions/breadthFirstSearch.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / breadthFirstSearch -*** +# breadthFirstSearch() -[rvgeo](../globals.md) / breadthFirstSearch +```ts +function breadthFirstSearch(graph, start): Map +``` -# Function: breadthFirstSearch() - -> **breadthFirstSearch**(`graph`, `start`): `Map`\<`any`, `any`\> - -Defined in: src/net/bfs.ts:7 +Defined in: [src/net/bfs.ts:7](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/bfs.ts#L7) ## Parameters diff --git a/docs/api/functions/calculateArrayShape.md b/docs/api/functions/calculateArrayShape.md index cb3c641..26cb80c 100644 --- a/docs/api/functions/calculateArrayShape.md +++ b/docs/api/functions/calculateArrayShape.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / calculateArrayShape -*** +# calculateArrayShape() -[rvgeo](../globals.md) / calculateArrayShape +```ts +function calculateArrayShape(array): number[] +``` -# Function: calculateArrayShape() - -> **calculateArrayShape**(`array`): `number`[] - -Defined in: src/core/utils.ts:94 +Defined in: [src/core/utils.ts:94](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/core/utils.ts#L94) 计算数组的形状 diff --git a/docs/api/functions/calculateMBR.md b/docs/api/functions/calculateMBR.md index 94f1828..66302ab 100644 --- a/docs/api/functions/calculateMBR.md +++ b/docs/api/functions/calculateMBR.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / calculateMBR -*** +# calculateMBR() -[rvgeo](../globals.md) / calculateMBR +```ts +function calculateMBR(clipPolygon): MBR +``` -# Function: calculateMBR() - -> **calculateMBR**(`clipPolygon`): [`MBR`](../type-aliases/MBR.md) - -Defined in: src/topology/utils.ts:185 +Defined in: [src/topology/utils.ts:185](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/topology/utils.ts#L185) 计算多边形的 MBR diff --git a/docs/api/functions/cartesian.md b/docs/api/functions/cartesian.md index 8cb297e..29b01f8 100644 --- a/docs/api/functions/cartesian.md +++ b/docs/api/functions/cartesian.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / cartesian -*** +# cartesian() -[rvgeo](../globals.md) / cartesian +```ts +function cartesian(spherical, toRadians): [number, number, number] +``` -# Function: cartesian() - -> **cartesian**(`spherical`, `toRadians`): \[`number`, `number`, `number`\] - -Defined in: src/math/vector.ts:65 +Defined in: [src/math/vector.ts:65](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/vector.ts#L65) 将球坐标系下的向量 [longitude, latitude]（弧度制）转换为三维笛卡尔坐标系下的向量 [x, y, z]。 - This function takes spherical coordinates [longitude, latitude] and converts them to a 3D Cartesian vector [x, y, z]. diff --git a/docs/api/functions/cartesianAdd.md b/docs/api/functions/cartesianAdd.md index fc43143..d000e21 100644 --- a/docs/api/functions/cartesianAdd.md +++ b/docs/api/functions/cartesianAdd.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / cartesianAdd -*** +# cartesianAdd() -[rvgeo](../globals.md) / cartesianAdd +```ts +function cartesianAdd(a, b): [number, number, number] +``` -# Function: cartesianAdd() - -> **cartesianAdd**(`a`, `b`): \[`number`, `number`, `number`\] - -Defined in: src/math/vector.ts:109 +Defined in: [src/math/vector.ts:109](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/vector.ts#L109) 计算两个三维笛卡尔坐标系下的向量 a 和 b 的和，返回一个新的向量。 This function adds two 3D Cartesian vectors a and b, returning a new vector representing the sum. diff --git a/docs/api/functions/cartesianAddInPlace.md b/docs/api/functions/cartesianAddInPlace.md index 836c81c..f102750 100644 --- a/docs/api/functions/cartesianAddInPlace.md +++ b/docs/api/functions/cartesianAddInPlace.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / cartesianAddInPlace -*** +# cartesianAddInPlace() -[rvgeo](../globals.md) / cartesianAddInPlace +```ts +function cartesianAddInPlace(a, b): void +``` -# Function: cartesianAddInPlace() - -> **cartesianAddInPlace**(`a`, `b`): `void` - -Defined in: src/math/vector.ts:101 +Defined in: [src/math/vector.ts:101](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/vector.ts#L101) 计算两个三维笛卡尔坐标系下的向量 a 和 b 的和，将结果存储在 a 中。 This function adds two 3D Cartesian vectors a and b, modifying a in-place to store the result. (Note: This function is incomplete as it doesn't return the sum) diff --git a/docs/api/functions/cartesianAngle.md b/docs/api/functions/cartesianAngle.md index 5eb9d71..2fded64 100644 --- a/docs/api/functions/cartesianAngle.md +++ b/docs/api/functions/cartesianAngle.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / cartesianAngle -*** +# cartesianAngle() -[rvgeo](../globals.md) / cartesianAngle +```ts +function cartesianAngle(a, b): number +``` -# Function: cartesianAngle() - -> **cartesianAngle**(`a`, `b`): `number` - -Defined in: src/math/vector.ts:144 +Defined in: [src/math/vector.ts:144](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/vector.ts#L144) 计算两个三维笛卡尔坐标系下的向量 a 和 b 的夹角。 This function calculates the angle between two 3D Cartesian vectors a and b. diff --git a/docs/api/functions/cartesianCross.md b/docs/api/functions/cartesianCross.md index f5347d5..94183d9 100644 --- a/docs/api/functions/cartesianCross.md +++ b/docs/api/functions/cartesianCross.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / cartesianCross -*** +# cartesianCross() -[rvgeo](../globals.md) / cartesianCross +```ts +function cartesianCross(a, b): [number, number, number] +``` -# Function: cartesianCross() - -> **cartesianCross**(`a`, `b`): \[`number`, `number`, `number`\] - -Defined in: src/math/vector.ts:92 +Defined in: [src/math/vector.ts:92](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/vector.ts#L92) 计算两个三维笛卡尔坐标系下的向量 a 和 b 的叉积。 This function calculates the cross product of two 3D Cartesian vectors a and b. diff --git a/docs/api/functions/cartesianDot.md b/docs/api/functions/cartesianDot.md index 27f1620..daa53e2 100644 --- a/docs/api/functions/cartesianDot.md +++ b/docs/api/functions/cartesianDot.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / cartesianDot -*** +# cartesianDot() -[rvgeo](../globals.md) / cartesianDot +```ts +function cartesianDot(a, b): number +``` -# Function: cartesianDot() - -> **cartesianDot**(`a`, `b`): `number` - -Defined in: src/math/vector.ts:84 +Defined in: [src/math/vector.ts:84](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/vector.ts#L84) 计算两个三维笛卡尔坐标系下的向量 a 和 b 的点积。 This function calculates the dot product of two 3D Cartesian vectors a and b. diff --git a/docs/api/functions/cartesianNormalize.md b/docs/api/functions/cartesianNormalize.md index a14e3fd..ed17aa8 100644 --- a/docs/api/functions/cartesianNormalize.md +++ b/docs/api/functions/cartesianNormalize.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / cartesianNormalize -*** +# cartesianNormalize() -[rvgeo](../globals.md) / cartesianNormalize +```ts +function cartesianNormalize(d): [number, number, number] +``` -# Function: cartesianNormalize() - -> **cartesianNormalize**(`d`): \[`number`, `number`, `number`\] - -Defined in: src/math/vector.ts:134 +Defined in: [src/math/vector.ts:134](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/vector.ts#L134) 归一化三维笛卡尔坐标系下的向量 d，返回一个新的单位向量。 This function normalizes a 3D Cartesian vector d, returning a new unit vector. diff --git a/docs/api/functions/cartesianNormalizeInPlace.md b/docs/api/functions/cartesianNormalizeInPlace.md index 4db180b..0b4b81b 100644 --- a/docs/api/functions/cartesianNormalizeInPlace.md +++ b/docs/api/functions/cartesianNormalizeInPlace.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / cartesianNormalizeInPlace -*** +# cartesianNormalizeInPlace() -[rvgeo](../globals.md) / cartesianNormalizeInPlace +```ts +function cartesianNormalizeInPlace(d): void +``` -# Function: cartesianNormalizeInPlace() - -> **cartesianNormalizeInPlace**(`d`): `void` - -Defined in: src/math/vector.ts:125 +Defined in: [src/math/vector.ts:125](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/vector.ts#L125) 归一化三维笛卡尔坐标系下的向量 d，将 d 修改为指向相同方向的单位向量。 This function normalizes a 3D Cartesian vector d in-place, modifying d to represent a unit vector pointing in the same direction. (Note: This function is incomplete and requires implementing square root calculation) diff --git a/docs/api/functions/cartesianScale.md b/docs/api/functions/cartesianScale.md index 004d24b..634b553 100644 --- a/docs/api/functions/cartesianScale.md +++ b/docs/api/functions/cartesianScale.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / cartesianScale -*** +# cartesianScale() -[rvgeo](../globals.md) / cartesianScale +```ts +function cartesianScale(vector, k): [number, number, number] +``` -# Function: cartesianScale() - -> **cartesianScale**(`vector`, `k`): \[`number`, `number`, `number`\] - -Defined in: src/math/vector.ts:117 +Defined in: [src/math/vector.ts:117](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/vector.ts#L117) 使用因子 k 缩放三维笛卡尔坐标系下的向量 vector，返回一个新的缩放后的向量。 This function scales a 3D Cartesian vector vector by a factor k, returning a new scaled vector. diff --git a/docs/api/functions/ccw.md b/docs/api/functions/ccw.md index 79da33f..e3b35d6 100644 --- a/docs/api/functions/ccw.md +++ b/docs/api/functions/ccw.md @@ -1,14 +1,15 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / ccw -*** +# ccw() -[rvgeo](../globals.md) / ccw +```ts +function ccw( + p1, + p2, + p3): number +``` -# Function: ccw() - -> **ccw**(`p1`, `p2`, `p3`): `number` - -Defined in: src/topology/utils.ts:277 +Defined in: [src/topology/utils.ts:277](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/topology/utils.ts#L277) Counter-clockwise (not robust version) ccw 算法的非鲁棒版本 diff --git a/docs/api/functions/ccwRobust.md b/docs/api/functions/ccwRobust.md index 8bbd5e9..be05963 100644 --- a/docs/api/functions/ccwRobust.md +++ b/docs/api/functions/ccwRobust.md @@ -1,14 +1,16 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / ccwRobust -*** +# ccwRobust() -[rvgeo](../globals.md) / ccwRobust +```ts +function ccwRobust( + p1, + p2, + p3, + isReverse): number +``` -# Function: ccwRobust() - -> **ccwRobust**(`p1`, `p2`, `p3`, `isReverse`): `number` - -Defined in: src/topology/utils.ts:333 +Defined in: [src/topology/utils.ts:333](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/topology/utils.ts#L333) robust version of ccw 封装了 robust-predicates 库的 orient2d 函数 - `Note:` unlike J. Shewchuk's original code, `all the functions in this library assume y axis is oriented downwards ↓`, so the semantics are different. diff --git a/docs/api/functions/collectionFromFeature.md b/docs/api/functions/collectionFromFeature.md index 60969b2..6a3831d 100644 --- a/docs/api/functions/collectionFromFeature.md +++ b/docs/api/functions/collectionFromFeature.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / collectionFromFeature -*** +# collectionFromFeature() -[rvgeo](../globals.md) / collectionFromFeature +```ts +function collectionFromFeature(feature): GeometryCollection +``` -# Function: collectionFromFeature() - -> **collectionFromFeature**(`feature`): [`GeometryCollection`](../classes/GeometryCollection.md) - -Defined in: src/geometry/Factory.ts:78 +Defined in: [src/geometry/Factory.ts:78](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Factory.ts#L78) Factory function for creating geometryCollection objects from GeoJSON Feature objects diff --git a/docs/api/functions/collectionFromGeometry.md b/docs/api/functions/collectionFromGeometry.md index 3f7d7c7..06c011c 100644 --- a/docs/api/functions/collectionFromGeometry.md +++ b/docs/api/functions/collectionFromGeometry.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / collectionFromGeometry -*** +# collectionFromGeometry() -[rvgeo](../globals.md) / collectionFromGeometry +```ts +function collectionFromGeometry(geometry): GeometryCollection +``` -# Function: collectionFromGeometry() - -> **collectionFromGeometry**(`geometry`): [`GeometryCollection`](../classes/GeometryCollection.md) - -Defined in: src/geometry/Factory.ts:104 +Defined in: [src/geometry/Factory.ts:104](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Factory.ts#L104) Factory function for creating geometryCollection objects from GeoJSON Geometry objects diff --git a/docs/api/functions/complateMap.md b/docs/api/functions/complateMap.md index 13a1a21..0237da4 100644 --- a/docs/api/functions/complateMap.md +++ b/docs/api/functions/complateMap.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / complateMap -*** +# complateMap() -[rvgeo](../globals.md) / complateMap +```ts +function complateMap(allMap, cutMap): Map +``` -# Function: complateMap() - -> **complateMap**(`allMap`, `cutMap`): `Map`\<`any`, `any`\> - -Defined in: src/triangulation/Delaunay.ts:736 +Defined in: [src/triangulation/Delaunay.ts:736](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/triangulation/Delaunay.ts#L736) ## Parameters diff --git a/docs/api/functions/concatEL2DArray.md b/docs/api/functions/concatEL2DArray.md index 4e42b37..63eb4f9 100644 --- a/docs/api/functions/concatEL2DArray.md +++ b/docs/api/functions/concatEL2DArray.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / concatEL2DArray -*** +# concatEL2DArray() -[rvgeo](../globals.md) / concatEL2DArray +```ts +function concatEL2DArray(array1, array2): any[] +``` -# Function: concatEL2DArray() - -> **concatEL2DArray**(`array1`, `array2`): `any`[] - -Defined in: src/core/utils.ts:145 +Defined in: [src/core/utils.ts:145](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/core/utils.ts#L145) 拼接等长二维数组 diff --git a/docs/api/functions/conj.md b/docs/api/functions/conj.md index acf39f5..f72c432 100644 --- a/docs/api/functions/conj.md +++ b/docs/api/functions/conj.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / conj -*** +# conj() -[rvgeo](../globals.md) / conj +```ts +function conj(a): object +``` -# Function: conj() - -> **conj**(`a`): `object` - -Defined in: src/math/fourier.ts:68 +Defined in: [src/math/fourier.ts:68](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/fourier.ts#L68) 复数共轭 - complex conjugate @@ -35,8 +33,12 @@ Defined in: src/math/fourier.ts:68 ### imag -> **imag**: `number` +```ts +imag: number; +``` ### real -> **real**: `number` +```ts +real: number; +``` diff --git a/docs/api/functions/containsMBR.md b/docs/api/functions/containsMBR.md index 4003273..6a3cfda 100644 --- a/docs/api/functions/containsMBR.md +++ b/docs/api/functions/containsMBR.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / containsMBR -*** +# containsMBR() -[rvgeo](../globals.md) / containsMBR +```ts +function containsMBR(mbr1, mbr2): boolean +``` -# Function: containsMBR() - -> **containsMBR**(`mbr1`, `mbr2`): `boolean` - -Defined in: src/geometry/MBR.ts:116 +Defined in: [src/geometry/MBR.ts:116](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/MBR.ts#L116) ## Parameters diff --git a/docs/api/functions/convexHull.md b/docs/api/functions/convexHull.md index 2138e90..083cd05 100644 --- a/docs/api/functions/convexHull.md +++ b/docs/api/functions/convexHull.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / convexHull -*** +# convexHull() -[rvgeo](../globals.md) / convexHull +```ts +function convexHull(points): Point[] +``` -# Function: convexHull() - -> **convexHull**(`points`): [`Point`](../classes/Point.md)[] - -Defined in: src/triangulation/Shell.ts:13 +Defined in: [src/triangulation/Shell.ts:13](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/triangulation/Shell.ts#L13) 凸包算法 diff --git a/docs/api/functions/cos.md b/docs/api/functions/cos.md index 516442c..8ce8463 100644 --- a/docs/api/functions/cos.md +++ b/docs/api/functions/cos.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / cos -*** +# cos() -[rvgeo](../globals.md) / cos +```ts +function cos(x): number +``` -# Function: cos() - -> **cos**(`x`): `number` - -Defined in: src/math/vector.ts:6 +Defined in: [src/math/vector.ts:6](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/vector.ts#L6) Returns the cosine of a number. diff --git a/docs/api/functions/createGraph.md b/docs/api/functions/createGraph.md index f577144..41740b4 100644 --- a/docs/api/functions/createGraph.md +++ b/docs/api/functions/createGraph.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / createGraph -*** +# createGraph() -[rvgeo](../globals.md) / createGraph +```ts +function createGraph(nodes, edges): Graph +``` -# Function: createGraph() - -> **createGraph**\<`T`\>(`nodes`, `edges`): [`Graph`](../interfaces/Graph.md)\<`T`\> - -Defined in: src/net/graph.ts:15 +Defined in: [src/net/graph.ts:15](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/graph.ts#L15) 创建图 diff --git a/docs/api/functions/createGridGraph.md b/docs/api/functions/createGridGraph.md index 3b879aa..f7cdca9 100644 --- a/docs/api/functions/createGridGraph.md +++ b/docs/api/functions/createGridGraph.md @@ -1,14 +1,15 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / createGridGraph -*** +# createGridGraph() -[rvgeo](../globals.md) / createGridGraph +```ts +function createGridGraph( + grid, + strategy?, + mooreNeighborhood?): GridGraph +``` -# Function: createGridGraph() - -> **createGridGraph**(`grid`, `strategy`?, `mooreNeighborhood`?): [`GridGraph`](../interfaces/GridGraph.md) - -Defined in: src/net/graph.ts:62 +Defined in: [src/net/graph.ts:62](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/graph.ts#L62) ## Parameters diff --git a/docs/api/functions/cross.md b/docs/api/functions/cross.md index 17e9524..c571a60 100644 --- a/docs/api/functions/cross.md +++ b/docs/api/functions/cross.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / cross -*** +# cross() -[rvgeo](../globals.md) / cross +```ts +function cross(a, b): number +``` -# Function: cross() - -> **cross**(`a`, `b`): `number` - -Defined in: src/math/vector.ts:167 +Defined in: [src/math/vector.ts:167](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/vector.ts#L167) 计算两个二维笛卡尔坐标系下的向量 a 和 b 的叉积。 This function calculates the cross product of two 2D Cartesian vectors a and b. diff --git a/docs/api/functions/cutPolygonByMBR.md b/docs/api/functions/cutPolygonByMBR.md index 014ae17..b5ea5e0 100644 --- a/docs/api/functions/cutPolygonByMBR.md +++ b/docs/api/functions/cutPolygonByMBR.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / cutPolygonByMBR -*** +# cutPolygonByMBR() -[rvgeo](../globals.md) / cutPolygonByMBR +```ts +function cutPolygonByMBR(polygon, mbr): [number, number][] | null +``` -# Function: cutPolygonByMBR() - -> **cutPolygonByMBR**(`polygon`, `mbr`): \[`number`, `number`\][] \| `null` - -Defined in: src/topology/utils.ts:117 +Defined in: [src/topology/utils.ts:117](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/topology/utils.ts#L117) 使用 MBR 裁剪多边形 diff --git a/docs/api/functions/dampedSin3D.md b/docs/api/functions/dampedSin3D.md index c463499..a78e01d 100644 --- a/docs/api/functions/dampedSin3D.md +++ b/docs/api/functions/dampedSin3D.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / dampedSin3D -*** +# dampedSin3D() -[rvgeo](../globals.md) / dampedSin3D +```ts +function dampedSin3D(x, y): number +``` -# Function: dampedSin3D() - -> **dampedSin3D**(`x`, `y`): `number` - -Defined in: src/coverage/Noise.ts:109 +Defined in: [src/coverage/Noise.ts:109](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/Noise.ts#L109) https://en.m.wikipedia.org/wiki/Damping#Damped_sine_wave diff --git a/docs/api/functions/deMaxMin.md b/docs/api/functions/deMaxMin.md index 7033106..b68950d 100644 --- a/docs/api/functions/deMaxMin.md +++ b/docs/api/functions/deMaxMin.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / deMaxMin -*** +# deMaxMin() -[rvgeo](../globals.md) / deMaxMin +```ts +function deMaxMin(fft): void +``` -# Function: deMaxMin() - -> **deMaxMin**(`fft`): `void` - -Defined in: src/coverage/grid.ts:495 +Defined in: [src/coverage/grid.ts:495](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L495) 去除最大最小值 diff --git a/docs/api/functions/degToDMS.md b/docs/api/functions/degToDMS.md index 7d4c5a8..426072a 100644 --- a/docs/api/functions/degToDMS.md +++ b/docs/api/functions/degToDMS.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / degToDMS -*** +# degToDMS() -[rvgeo](../globals.md) / degToDMS +```ts +function degToDMS(deg): [number, number, number, string] +``` -# Function: degToDMS() - -> **degToDMS**(`deg`): \[`number`, `number`, `number`, `string`\] - -Defined in: src/math/units.ts:191 +Defined in: [src/math/units.ts:191](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/units.ts#L191) ## Parameters diff --git a/docs/api/functions/degreesToRadians.md b/docs/api/functions/degreesToRadians.md index 4706b97..3ef3ace 100644 --- a/docs/api/functions/degreesToRadians.md +++ b/docs/api/functions/degreesToRadians.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / degreesToRadians -*** +# degreesToRadians() -[rvgeo](../globals.md) / degreesToRadians +```ts +function degreesToRadians(degrees): number +``` -# Function: degreesToRadians() - -> **degreesToRadians**(`degrees`): `number` - -Defined in: src/math/units.ts:59 +Defined in: [src/math/units.ts:59](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/units.ts#L59) - Converts an angle in degrees to radians - 将角度转换为弧度 diff --git a/docs/api/functions/destination.md b/docs/api/functions/destination.md index 07c19d4..45c4a0c 100644 --- a/docs/api/functions/destination.md +++ b/docs/api/functions/destination.md @@ -1,14 +1,15 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / destination -*** +# destination() -[rvgeo](../globals.md) / destination +```ts +function destination( + latlng1, + brng, + distance): [number, number] +``` -# Function: destination() - -> **destination**(`latlng1`, `brng`, `distance`): \[`number`, `number`\] - -Defined in: src/math/measuring.ts:212 +Defined in: [src/math/measuring.ts:212](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/measuring.ts#L212) Given a start point, initial bearing, and distance, - this will calculate the destina­tion point and final bearing travelling along a (shortest distance) great circle arc. diff --git a/docs/api/functions/dijkstra.md b/docs/api/functions/dijkstra.md index c0d3964..a5a7c71 100644 --- a/docs/api/functions/dijkstra.md +++ b/docs/api/functions/dijkstra.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / dijkstra -*** +# dijkstra() -[rvgeo](../globals.md) / dijkstra +```ts +function dijkstra(graph, start): Map +``` -# Function: dijkstra() - -> **dijkstra**(`graph`, `start`): `Map`\<`any`, `any`\> - -Defined in: src/net/Dijkstra.ts:33 +Defined in: [src/net/Dijkstra.ts:33](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/Dijkstra.ts#L33) ## Parameters diff --git a/docs/api/functions/dmsToDeg.md b/docs/api/functions/dmsToDeg.md index 247fbc4..17be551 100644 --- a/docs/api/functions/dmsToDeg.md +++ b/docs/api/functions/dmsToDeg.md @@ -1,14 +1,16 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / dmsToDeg -*** +# dmsToDeg() -[rvgeo](../globals.md) / dmsToDeg +```ts +function dmsToDeg( + d, + m, + s, + direction): number +``` -# Function: dmsToDeg() - -> **dmsToDeg**(`d`, `m`, `s`, `direction`): `number` - -Defined in: src/math/units.ts:181 +Defined in: [src/math/units.ts:181](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/units.ts#L181) ## Parameters diff --git a/docs/api/functions/dot.md b/docs/api/functions/dot.md index 5d187cc..368ce49 100644 --- a/docs/api/functions/dot.md +++ b/docs/api/functions/dot.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / dot -*** +# dot() -[rvgeo](../globals.md) / dot +```ts +function dot(a, b): number +``` -# Function: dot() - -> **dot**(`a`, `b`): `number` - -Defined in: src/math/vector.ts:159 +Defined in: [src/math/vector.ts:159](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/vector.ts#L159) 计算两个二维笛卡尔坐标系下的向量 a 和 b 的点积。 This function calculates the dot product of two 2D Cartesian vectors a and b. diff --git a/docs/api/functions/drawArrowField.md b/docs/api/functions/drawArrowField.md index 0e47dfd..34136f5 100644 --- a/docs/api/functions/drawArrowField.md +++ b/docs/api/functions/drawArrowField.md @@ -1,14 +1,18 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / drawArrowField -*** +# drawArrowField() -[rvgeo](../globals.md) / drawArrowField +```ts +function drawArrowField( + canavs, + colRow, + Rect, + toDict, + color, + path?): void +``` -# Function: drawArrowField() - -> **drawArrowField**(`canavs`, `colRow`, `Rect`, `toDict`, `color`, `path`?): `void` - -Defined in: src/render/renderGrid.ts:106 +Defined in: [src/render/renderGrid.ts:106](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/render/renderGrid.ts#L106) 绘制箭头场，默认为起点为当前格子的中心 diff --git a/docs/api/functions/drawCountour.md b/docs/api/functions/drawCountour.md index c6b82ba..fa72e69 100644 --- a/docs/api/functions/drawCountour.md +++ b/docs/api/functions/drawCountour.md @@ -1,14 +1,16 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / drawCountour -*** +# drawCountour() -[rvgeo](../globals.md) / drawCountour +```ts +function drawCountour( + canavs, + countourCodeGrid, + Rect, + strokeColor): void +``` -# Function: drawCountour() - -> **drawCountour**(`canavs`, `countourCodeGrid`, `Rect`, `strokeColor`): `void` - -Defined in: src/render/renderGrid.ts:219 +Defined in: [src/render/renderGrid.ts:219](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/render/renderGrid.ts#L219) ## Parameters diff --git a/docs/api/functions/drawGrid2d.md b/docs/api/functions/drawGrid2d.md index 11b0a4e..fce5d14 100644 --- a/docs/api/functions/drawGrid2d.md +++ b/docs/api/functions/drawGrid2d.md @@ -1,14 +1,18 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / drawGrid2d -*** +# drawGrid2d() -[rvgeo](../globals.md) / drawGrid2d +```ts +function drawGrid2d( + canavs, + grid2D, + Rect, + statistics, + colorBand, + GridMBR?): void +``` -# Function: drawGrid2d() - -> **drawGrid2d**(`canavs`, `grid2D`, `Rect`, `statistics`, `colorBand`, `GridMBR`?): `void` - -Defined in: src/render/renderGrid.ts:57 +Defined in: [src/render/renderGrid.ts:57](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/render/renderGrid.ts#L57) ## Parameters diff --git a/docs/api/functions/drawProgress.md b/docs/api/functions/drawProgress.md index 9ec5a4e..8a0331d 100644 --- a/docs/api/functions/drawProgress.md +++ b/docs/api/functions/drawProgress.md @@ -1,14 +1,16 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / drawProgress -*** +# drawProgress() -[rvgeo](../globals.md) / drawProgress +```ts +function drawProgress( + canvas, + rect, + progress, + style): void +``` -# Function: drawProgress() - -> **drawProgress**(`canvas`, `rect`, `progress`, `style`): `void` - -Defined in: src/render/renderGrid.ts:644 +Defined in: [src/render/renderGrid.ts:644](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/render/renderGrid.ts#L644) 绘制进度条 diff --git a/docs/api/functions/drawQTree2d.md b/docs/api/functions/drawQTree2d.md index 15fd164..62db17c 100644 --- a/docs/api/functions/drawQTree2d.md +++ b/docs/api/functions/drawQTree2d.md @@ -1,14 +1,19 @@ -[**rvgeo**](../README.md) - -*** - -[rvgeo](../globals.md) / drawQTree2d - -# Function: drawQTree2d() - -> **drawQTree2d**(`canvas`, `rect`, `QTree`, `grid`, `colorBand`, `value`?, `statistics`?): `void` - -Defined in: src/render/renderGrid.ts:376 +[rvgeo](../index.md) / drawQTree2d + +# drawQTree2d() + +```ts +function drawQTree2d( + canvas, + rect, + QTree, + grid, + colorBand, + value?, + statistics?): void +``` + +Defined in: [src/render/renderGrid.ts:376](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/render/renderGrid.ts#L376) 绘制四叉树 diff --git a/docs/api/functions/drawSample.md b/docs/api/functions/drawSample.md index e919ceb..a2758d1 100644 --- a/docs/api/functions/drawSample.md +++ b/docs/api/functions/drawSample.md @@ -1,14 +1,18 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / drawSample -*** +# drawSample() -[rvgeo](../globals.md) / drawSample +```ts +function drawSample( + canvas, + rect, + sample, + style, + isText, + statistics?): void +``` -# Function: drawSample() - -> **drawSample**(`canvas`, `rect`, `sample`, `style`, `isText`, `statistics`?): `void` - -Defined in: src/render/renderGrid.ts:432 +Defined in: [src/render/renderGrid.ts:432](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/render/renderGrid.ts#L432) ## Parameters diff --git a/docs/api/functions/drawSample2.md b/docs/api/functions/drawSample2.md index ad8356b..ebda914 100644 --- a/docs/api/functions/drawSample2.md +++ b/docs/api/functions/drawSample2.md @@ -1,14 +1,18 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / drawSample2 -*** +# drawSample2() -[rvgeo](../globals.md) / drawSample2 +```ts +function drawSample2( + canvas, + rect, + sample, + style, + statistics?, + isText?): void +``` -# Function: drawSample2() - -> **drawSample2**(`canvas`, `rect`, `sample`, `style`, `statistics`?, `isText`?): `void` - -Defined in: src/render/renderGrid.ts:507 +Defined in: [src/render/renderGrid.ts:507](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/render/renderGrid.ts#L507) ## Parameters diff --git a/docs/api/functions/drawText.md b/docs/api/functions/drawText.md index 2d949a3..64a74ad 100644 --- a/docs/api/functions/drawText.md +++ b/docs/api/functions/drawText.md @@ -1,14 +1,16 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / drawText -*** +# drawText() -[rvgeo](../globals.md) / drawText +```ts +function drawText( + canvas, + rect, + text, + style): void +``` -# Function: drawText() - -> **drawText**(`canvas`, `rect`, `text`, `style`): `void` - -Defined in: src/render/renderGrid.ts:565 +Defined in: [src/render/renderGrid.ts:565](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/render/renderGrid.ts#L565) ## Parameters diff --git a/docs/api/functions/drawTrueColorGrid2d.md b/docs/api/functions/drawTrueColorGrid2d.md index 270576a..4de2be8 100644 --- a/docs/api/functions/drawTrueColorGrid2d.md +++ b/docs/api/functions/drawTrueColorGrid2d.md @@ -1,14 +1,18 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / drawTrueColorGrid2d -*** +# drawTrueColorGrid2d() -[rvgeo](../globals.md) / drawTrueColorGrid2d +```ts +function drawTrueColorGrid2d( + canavs, + grid, + bands2Draw, + Rect, + colorBand, + GridMBR?): void +``` -# Function: drawTrueColorGrid2d() - -> **drawTrueColorGrid2d**(`canavs`, `grid`, `bands2Draw`, `Rect`, `colorBand`, `GridMBR`?): `void` - -Defined in: src/render/renderGrid.ts:580 +Defined in: [src/render/renderGrid.ts:580](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/render/renderGrid.ts#L580) ## Parameters diff --git a/docs/api/functions/emptyObj.md b/docs/api/functions/emptyObj.md index a3e8e3c..8c1a75c 100644 --- a/docs/api/functions/emptyObj.md +++ b/docs/api/functions/emptyObj.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / emptyObj -*** +# emptyObj() -[rvgeo](../globals.md) / emptyObj +```ts +function emptyObj(obj): void +``` -# Function: emptyObj() - -> **emptyObj**(`obj`): `void` - -Defined in: src/core/utils.ts:71 +Defined in: [src/core/utils.ts:71](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/core/utils.ts#L71) 释放对象 diff --git a/docs/api/functions/equals.md b/docs/api/functions/equals.md index 4c0e837..0f8629b 100644 --- a/docs/api/functions/equals.md +++ b/docs/api/functions/equals.md @@ -1,14 +1,15 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / equals -*** +# equals() -[rvgeo](../globals.md) / equals +```ts +function equals( + a, + b, + tolerance): boolean +``` -# Function: equals() - -> **equals**(`a`, `b`, `tolerance`): `boolean` - -Defined in: src/math/vector.ts:18 +Defined in: [src/math/vector.ts:18](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/vector.ts#L18) deep compare two arrays(1D) diff --git a/docs/api/functions/equalsMBR.md b/docs/api/functions/equalsMBR.md index b9f55e7..9b3d7a7 100644 --- a/docs/api/functions/equalsMBR.md +++ b/docs/api/functions/equalsMBR.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / equalsMBR -*** +# equalsMBR() -[rvgeo](../globals.md) / equalsMBR +```ts +function equalsMBR(mbr1, mbr2): boolean +``` -# Function: equalsMBR() - -> **equalsMBR**(`mbr1`, `mbr2`): `boolean` - -Defined in: src/geometry/MBR.ts:128 +Defined in: [src/geometry/MBR.ts:128](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/MBR.ts#L128) ## Parameters diff --git a/docs/api/functions/extend.md b/docs/api/functions/extend.md index cf25781..4cf5f16 100644 --- a/docs/api/functions/extend.md +++ b/docs/api/functions/extend.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / extend -*** +# extend() -[rvgeo](../globals.md) / extend - -# Function: extend() - -> **extend**(`dest`, ...`args`): `any` +```ts +function extend(dest, ...args): any +``` -Defined in: src/core/utils.ts:57 +Defined in: [src/core/utils.ts:57](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/core/utils.ts#L57) Merge the properties diff --git a/docs/api/functions/fastFFT2.md b/docs/api/functions/fastFFT2.md index 390cac6..09aa516 100644 --- a/docs/api/functions/fastFFT2.md +++ b/docs/api/functions/fastFFT2.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / fastFFT2 -*** +# fastFFT2() -[rvgeo](../globals.md) / fastFFT2 +```ts +function fastFFT2(X): Complex[][] +``` -# Function: fastFFT2() - -> **fastFFT2**(`X`): [`Complex`](../type-aliases/Complex.md)[][] - -Defined in: src/math/fourier.ts:136 +Defined in: [src/math/fourier.ts:136](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/fourier.ts#L136) 快速傅里叶变换 real to complex - 先对每一行进行傅里叶变换，再对每一列进行傅里叶变换，最后中心化 diff --git a/docs/api/functions/feature.md b/docs/api/functions/feature.md index 42670b1..b57a185 100644 --- a/docs/api/functions/feature.md +++ b/docs/api/functions/feature.md @@ -1,14 +1,37 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / feature -*** +# feature() -[rvgeo](../globals.md) / feature +```ts +function feature(topology, o): + | { + bbox: undefined; + geometry: GeometryObject; + id: undefined; + properties: any; + type: string; + } + | { + bbox: undefined; + geometry: GeometryObject; + id: undefined | string | number; + properties: any; + type: string; + } + | { + bbox: MBR; + geometry: GeometryObject; + id: undefined | string | number; + properties: any; + type: string; + } + | { + features: any; + type: string; +} +``` -# Function: feature() - -> **feature**(`topology`, `o`): \{ `bbox`: `undefined`; `geometry`: `GeometryObject`; `id`: `undefined`; `properties`: `any`; `type`: `string`; \} \| \{ `bbox`: `undefined`; `geometry`: `GeometryObject`; `id`: `undefined` \| `string` \| `number`; `properties`: `any`; `type`: `string`; \} \| \{ `bbox`: [`MBR`](../type-aliases/MBR.md); `geometry`: `GeometryObject`; `id`: `undefined` \| `string` \| `number`; `properties`: `any`; `type`: `string`; \} \| \{ `features`: `any`; `type`: `string`; \} - -Defined in: src/topology/client/feature.ts:11 +Defined in: [src/topology/client/feature.ts:11](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/topology/client/feature.ts#L11) ## Parameters @@ -22,4 +45,28 @@ Defined in: src/topology/client/feature.ts:11 ## Returns -\{ `bbox`: `undefined`; `geometry`: `GeometryObject`; `id`: `undefined`; `properties`: `any`; `type`: `string`; \} \| \{ `bbox`: `undefined`; `geometry`: `GeometryObject`; `id`: `undefined` \| `string` \| `number`; `properties`: `any`; `type`: `string`; \} \| \{ `bbox`: [`MBR`](../type-aliases/MBR.md); `geometry`: `GeometryObject`; `id`: `undefined` \| `string` \| `number`; `properties`: `any`; `type`: `string`; \} \| \{ `features`: `any`; `type`: `string`; \} + \| \{ + `bbox`: `undefined`; + `geometry`: `GeometryObject`; + `id`: `undefined`; + `properties`: `any`; + `type`: `string`; + \} + \| \{ + `bbox`: `undefined`; + `geometry`: `GeometryObject`; + `id`: `undefined` \| `string` \| `number`; + `properties`: `any`; + `type`: `string`; + \} + \| \{ + `bbox`: [`MBR`](../type-aliases/MBR.md); + `geometry`: `GeometryObject`; + `id`: `undefined` \| `string` \| `number`; + `properties`: `any`; + `type`: `string`; + \} + \| \{ + `features`: `any`; + `type`: `string`; + \} diff --git a/docs/api/functions/fillIndexArray.md b/docs/api/functions/fillIndexArray.md index 96ac109..22a5b92 100644 --- a/docs/api/functions/fillIndexArray.md +++ b/docs/api/functions/fillIndexArray.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / fillIndexArray -*** +# fillIndexArray() -[rvgeo](../globals.md) / fillIndexArray +```ts +function fillIndexArray(indexArray, fillArray): any +``` -# Function: fillIndexArray() - -> **fillIndexArray**(`indexArray`, `fillArray`): `any` - -Defined in: src/core/utils.ts:125 +Defined in: [src/core/utils.ts:125](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/core/utils.ts#L125) - 根据 indexArray 中存储的索引 从 fillArray 中取出对应的元素并填充到 indexArray 中 - fill indexArray with elements from fillArray according to the index stored in indexArray diff --git a/docs/api/functions/flattenArray.md b/docs/api/functions/flattenArray.md index 294c225..cb4cdda 100644 --- a/docs/api/functions/flattenArray.md +++ b/docs/api/functions/flattenArray.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / flattenArray -*** +# flattenArray() -[rvgeo](../globals.md) / flattenArray +```ts +function flattenArray(array): any[] +``` -# Function: flattenArray() - -> **flattenArray**(`array`): `any`[] - -Defined in: src/core/utils.ts:104 +Defined in: [src/core/utils.ts:104](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/core/utils.ts#L104) ## Parameters diff --git a/docs/api/functions/formatNum.md b/docs/api/functions/formatNum.md index e790648..b97e474 100644 --- a/docs/api/functions/formatNum.md +++ b/docs/api/functions/formatNum.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / formatNum -*** +# formatNum() -[rvgeo](../globals.md) / formatNum +```ts +function formatNum(num, precision?): number +``` -# Function: formatNum() - -> **formatNum**(`num`, `precision`?): `number` - -Defined in: src/math/utils.ts:9 +Defined in: [src/math/utils.ts:9](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/utils.ts#L9) 这个函数的主要目的是将数字 num 四舍五入到指定的 precision 小数位。 diff --git a/docs/api/functions/fromFeatureObj.md b/docs/api/functions/fromFeatureObj.md index ba26743..bd8948c 100644 --- a/docs/api/functions/fromFeatureObj.md +++ b/docs/api/functions/fromFeatureObj.md @@ -1,14 +1,14 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / fromFeatureObj -*** +# fromFeatureObj() -[rvgeo](../globals.md) / fromFeatureObj +```ts +function fromFeatureObj(feature): + | Geometry + | GeometryCollection +``` -# Function: fromFeatureObj() - -> **fromFeatureObj**(`feature`): [`Geometry`](../classes/Geometry.md) \| [`GeometryCollection`](../classes/GeometryCollection.md) - -Defined in: src/geometry/Factory.ts:45 +Defined in: [src/geometry/Factory.ts:45](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Factory.ts#L45) Factory function for creating geometry objects from GeoJSON Feature objects - you can use this function to create inner geometry from Features @@ -22,7 +22,8 @@ Factory function for creating geometry objects from GeoJSON Feature objects ## Returns -[`Geometry`](../classes/Geometry.md) \| [`GeometryCollection`](../classes/GeometryCollection.md) + \| [`Geometry`](../classes/Geometry.md) + \| [`GeometryCollection`](../classes/GeometryCollection.md) ## See diff --git a/docs/api/functions/fromGeometryObj.md b/docs/api/functions/fromGeometryObj.md index dc9dafa..16f279c 100644 --- a/docs/api/functions/fromGeometryObj.md +++ b/docs/api/functions/fromGeometryObj.md @@ -1,14 +1,14 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / fromGeometryObj -*** +# fromGeometryObj() -[rvgeo](../globals.md) / fromGeometryObj +```ts +function fromGeometryObj(geometry): + | Geometry + | GeometryCollection +``` -# Function: fromGeometryObj() - -> **fromGeometryObj**(`geometry`): [`Geometry`](../classes/Geometry.md) \| [`GeometryCollection`](../classes/GeometryCollection.md) - -Defined in: src/geometry/Factory.ts:15 +Defined in: [src/geometry/Factory.ts:15](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Factory.ts#L15) Factory function for creating geometry objects from GeoJSON Geometry objects - about Geometry objects @@ -21,7 +21,8 @@ Factory function for creating geometry objects from GeoJSON Geometry objects ## Returns -[`Geometry`](../classes/Geometry.md) \| [`GeometryCollection`](../classes/GeometryCollection.md) + \| [`Geometry`](../classes/Geometry.md) + \| [`GeometryCollection`](../classes/GeometryCollection.md) ## See diff --git a/docs/api/functions/getAngle.md b/docs/api/functions/getAngle.md index 9b9a281..96f603a 100644 --- a/docs/api/functions/getAngle.md +++ b/docs/api/functions/getAngle.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / getAngle -*** +# getAngle() -[rvgeo](../globals.md) / getAngle +```ts +function getAngle(p1, p2): number +``` -# Function: getAngle() - -> **getAngle**(`p1`, `p2`): `number` - -Defined in: src/topology/utils.ts:302 +Defined in: [src/topology/utils.ts:302](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/topology/utils.ts#L302) - Returns the angle between two points - 返回两点之间的夹角 diff --git a/docs/api/functions/getMBRWithAntimeridian.md b/docs/api/functions/getMBRWithAntimeridian.md index 5facc15..a963851 100644 --- a/docs/api/functions/getMBRWithAntimeridian.md +++ b/docs/api/functions/getMBRWithAntimeridian.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / getMBRWithAntimeridian -*** +# getMBRWithAntimeridian() -[rvgeo](../globals.md) / getMBRWithAntimeridian +```ts +function getMBRWithAntimeridian(points): MBR +``` -# Function: getMBRWithAntimeridian() - -> **getMBRWithAntimeridian**(`points`): [`MBR`](../type-aliases/MBR.md) - -Defined in: src/geometry/MBR.ts:164 +Defined in: [src/geometry/MBR.ts:164](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/MBR.ts#L164) 计算多点的最小外包矩形（跨越反子午线的情况） - 会自动计算并选择面积最小的情况 diff --git a/docs/api/functions/getPointsMBR.md b/docs/api/functions/getPointsMBR.md index abcc809..c0d2d52 100644 --- a/docs/api/functions/getPointsMBR.md +++ b/docs/api/functions/getPointsMBR.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / getPointsMBR -*** +# getPointsMBR() -[rvgeo](../globals.md) / getPointsMBR +```ts +function getPointsMBR(points): MBR +``` -# Function: getPointsMBR() - -> **getPointsMBR**(`points`): [`MBR`](../type-aliases/MBR.md) - -Defined in: src/geometry/MBR.ts:91 +Defined in: [src/geometry/MBR.ts:91](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/MBR.ts#L91) 计算多点的最小外包矩形（默认情况） diff --git a/docs/api/functions/gridAstar.md b/docs/api/functions/gridAstar.md index bcf1409..122ece9 100644 --- a/docs/api/functions/gridAstar.md +++ b/docs/api/functions/gridAstar.md @@ -1,14 +1,15 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / gridAstar -*** +# gridAstar() -[rvgeo](../globals.md) / gridAstar +```ts +function gridAstar( + graph, + start, +goal): Map +``` -# Function: gridAstar() - -> **gridAstar**(`graph`, `start`, `goal`): `Map`\<`string`, \[`number`, `number`\] \| `null`\> - -Defined in: src/net/astar.ts:10 +Defined in: [src/net/astar.ts:10](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/astar.ts#L10) ## Parameters diff --git a/docs/api/functions/gridBreadthFirstSearch.md b/docs/api/functions/gridBreadthFirstSearch.md index 2bf431d..5941390 100644 --- a/docs/api/functions/gridBreadthFirstSearch.md +++ b/docs/api/functions/gridBreadthFirstSearch.md @@ -1,14 +1,15 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / gridBreadthFirstSearch -*** +# gridBreadthFirstSearch() -[rvgeo](../globals.md) / gridBreadthFirstSearch +```ts +function gridBreadthFirstSearch( + graph, + start, +goal?): Map +``` -# Function: gridBreadthFirstSearch() - -> **gridBreadthFirstSearch**(`graph`, `start`, `goal`?): `Map`\<`string`, \[`number`, `number`\] \| `null`\> - -Defined in: src/net/bfs.ts:31 +Defined in: [src/net/bfs.ts:31](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/bfs.ts#L31) ## Parameters diff --git a/docs/api/functions/gridDijkstra.md b/docs/api/functions/gridDijkstra.md index d87e391..7e25fca 100644 --- a/docs/api/functions/gridDijkstra.md +++ b/docs/api/functions/gridDijkstra.md @@ -1,14 +1,15 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / gridDijkstra -*** +# gridDijkstra() -[rvgeo](../globals.md) / gridDijkstra +```ts +function gridDijkstra( + graph, + start, +goal?): Map +``` -# Function: gridDijkstra() - -> **gridDijkstra**(`graph`, `start`, `goal`?): `Map`\<`string`, \[`number`, `number`\] \| `null`\> - -Defined in: src/net/Dijkstra.ts:4 +Defined in: [src/net/Dijkstra.ts:4](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/Dijkstra.ts#L4) ## Parameters diff --git a/docs/api/functions/gridReconstructPath.md b/docs/api/functions/gridReconstructPath.md index 82337df..72074e7 100644 --- a/docs/api/functions/gridReconstructPath.md +++ b/docs/api/functions/gridReconstructPath.md @@ -1,14 +1,15 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / gridReconstructPath -*** +# gridReconstructPath() -[rvgeo](../globals.md) / gridReconstructPath +```ts +function gridReconstructPath( + cameFrom, + start, + goal): [number, number][] +``` -# Function: gridReconstructPath() - -> **gridReconstructPath**(`cameFrom`, `start`, `goal`): \[`number`, `number`\][] - -Defined in: src/net/bfs.ts:68 +Defined in: [src/net/bfs.ts:68](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/bfs.ts#L68) ## Parameters diff --git a/docs/api/functions/haversin.md b/docs/api/functions/haversin.md index 47259f2..f0b1f01 100644 --- a/docs/api/functions/haversin.md +++ b/docs/api/functions/haversin.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / haversin -*** +# haversin() -[rvgeo](../globals.md) / haversin +```ts +function haversin(x): number +``` -# Function: haversin() - -> **haversin**(`x`): `number` - -Defined in: src/math/vector.ts:37 +Defined in: [src/math/vector.ts:37](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/vector.ts#L37) ## Parameters diff --git a/docs/api/functions/haversine.md b/docs/api/functions/haversine.md index f46465f..25ce37a 100644 --- a/docs/api/functions/haversine.md +++ b/docs/api/functions/haversine.md @@ -1,14 +1,15 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / haversine -*** +# haversine() -[rvgeo](../globals.md) / haversine +```ts +function haversine( + latlng1, + latlng2, + R): number +``` -# Function: haversine() - -> **haversine**(`latlng1`, `latlng2`, `R`): `number` - -Defined in: src/math/measuring.ts:81 +Defined in: [src/math/measuring.ts:81](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/measuring.ts#L81) 使用 haversine 公式计算球面两点之间的距离 diff --git a/docs/api/functions/hist.md b/docs/api/functions/hist.md index 13ec8a8..d143b09 100644 --- a/docs/api/functions/hist.md +++ b/docs/api/functions/hist.md @@ -1,14 +1,15 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / hist -*** +# hist() -[rvgeo](../globals.md) / hist +```ts +function hist( + grid2D, + stretch, + statistics?): number[] +``` -# Function: hist() - -> **hist**(`grid2D`, `stretch`, `statistics`?): `number`[] - -Defined in: src/render/colors.ts:246 +Defined in: [src/render/colors.ts:246](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/render/colors.ts#L246) 直方图计算函数 diff --git a/docs/api/functions/inCircle.md b/docs/api/functions/inCircle.md index c768dc8..7d787d7 100644 --- a/docs/api/functions/inCircle.md +++ b/docs/api/functions/inCircle.md @@ -1,14 +1,16 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / inCircle -*** +# inCircle() -[rvgeo](../globals.md) / inCircle +```ts +function inCircle( + p1, + p2, + p3, + p4): 1 | -1 | 0 +``` -# Function: inCircle() - -> **inCircle**(`p1`, `p2`, `p3`, `p4`): `1` \| `-1` \| `0` - -Defined in: src/topology/utils.ts:396 +Defined in: [src/topology/utils.ts:396](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/topology/utils.ts#L396) 快速计算最后一点与前三点组成的圆的关系 calculate the relative position of the last point to the circle formed by the first three points - Returns 1 if point d is outside the circle passing through a, b, and c diff --git a/docs/api/functions/inCircleRobust.md b/docs/api/functions/inCircleRobust.md index 36f0a28..d639263 100644 --- a/docs/api/functions/inCircleRobust.md +++ b/docs/api/functions/inCircleRobust.md @@ -1,14 +1,16 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / inCircleRobust -*** +# inCircleRobust() -[rvgeo](../globals.md) / inCircleRobust +```ts +function inCircleRobust( + p1, + p2, + p3, + p4): number +``` -# Function: inCircleRobust() - -> **inCircleRobust**(`p1`, `p2`, `p3`, `p4`): `number` - -Defined in: src/topology/utils.ts:361 +Defined in: [src/topology/utils.ts:361](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/topology/utils.ts#L361) ## Parameters diff --git a/docs/api/functions/intermediatePoint.md b/docs/api/functions/intermediatePoint.md index 0d6ca0d..8dac61c 100644 --- a/docs/api/functions/intermediatePoint.md +++ b/docs/api/functions/intermediatePoint.md @@ -1,14 +1,15 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / intermediatePoint -*** +# intermediatePoint() -[rvgeo](../globals.md) / intermediatePoint +```ts +function intermediatePoint( + latlng1, + latlng2, + fraction): [number, number] +``` -# Function: intermediatePoint() - -> **intermediatePoint**(`latlng1`, `latlng2`, `fraction`): \[`number`, `number`\] - -Defined in: src/math/measuring.ts:129 +Defined in: [src/math/measuring.ts:129](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/measuring.ts#L129) An intermediate point at any fraction along the great circle path between two points diff --git a/docs/api/functions/interpolate.md b/docs/api/functions/interpolate.md index 9966ae0..cc1c860 100644 --- a/docs/api/functions/interpolate.md +++ b/docs/api/functions/interpolate.md @@ -1,14 +1,15 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / interpolate -*** +# interpolate() -[rvgeo](../globals.md) / interpolate +```ts +function interpolate( + a, + b, + t): [number, number, number] +``` -# Function: interpolate() - -> **interpolate**(`a`, `b`, `t`): \[`number`, `number`, `number`\] - -Defined in: src/math/vector.ts:202 +Defined in: [src/math/vector.ts:202](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/vector.ts#L202) 三维笛卡尔坐标系下的向量插值。 This function interpolates between two 3D Cartesian vectors a and b using a parameter t, returning the resulting vector. diff --git a/docs/api/functions/interpolate2.md b/docs/api/functions/interpolate2.md index 78ecf7d..29aaac3 100644 --- a/docs/api/functions/interpolate2.md +++ b/docs/api/functions/interpolate2.md @@ -1,14 +1,15 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / interpolate2 -*** +# interpolate2() -[rvgeo](../globals.md) / interpolate2 +```ts +function interpolate2( + a, + b, + t): [number, number] +``` -# Function: interpolate2() - -> **interpolate2**(`a`, `b`, `t`): \[`number`, `number`\] - -Defined in: src/math/vector.ts:214 +Defined in: [src/math/vector.ts:214](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/vector.ts#L214) 二维笛卡尔坐标系下的向量插值。 This function interpolates between two 2D Cartesian vectors a and b using a parameter t, returning the resulting vector. diff --git a/docs/api/functions/intersection.md b/docs/api/functions/intersection.md index 0c27868..9679020 100644 --- a/docs/api/functions/intersection.md +++ b/docs/api/functions/intersection.md @@ -1,14 +1,19 @@ -[**rvgeo**](../README.md) - -*** - -[rvgeo](../globals.md) / intersection - -# Function: intersection() - -> **intersection**(`p1`, `p2`, `p3`, `p4`, `projectionFrom`, `projectionTo`, `isInfine`): \[`number`, `number`\] \| `null` - -Defined in: src/topology/utils.ts:21 +[rvgeo](../index.md) / intersection + +# intersection() + +```ts +function intersection( + p1, + p2, + p3, + p4, + projectionFrom, + projectionTo, + isInfine): [number, number] | null +``` + +Defined in: [src/topology/utils.ts:21](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/topology/utils.ts#L21) （默认线段求交）内含投影的线段求交函数（计算开销大） diff --git a/docs/api/functions/intersectionPolygon.md b/docs/api/functions/intersectionPolygon.md index 811928e..9fbd6f2 100644 --- a/docs/api/functions/intersectionPolygon.md +++ b/docs/api/functions/intersectionPolygon.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / intersectionPolygon -*** +# intersectionPolygon() -[rvgeo](../globals.md) / intersectionPolygon +```ts +function intersectionPolygon(clipPolygon, subjectPolygon): [number, number][] +``` -# Function: intersectionPolygon() - -> **intersectionPolygon**(`clipPolygon`, `subjectPolygon`): \[`number`, `number`\][] - -Defined in: src/topology/utils.ts:128 +Defined in: [src/topology/utils.ts:128](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/topology/utils.ts#L128) 使用 Sutherland-Hodgman 算法计算多边形与多边形的交集 diff --git a/docs/api/functions/intersectsMBR.md b/docs/api/functions/intersectsMBR.md index eac47d8..3d9fe47 100644 --- a/docs/api/functions/intersectsMBR.md +++ b/docs/api/functions/intersectsMBR.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / intersectsMBR -*** +# intersectsMBR() -[rvgeo](../globals.md) / intersectsMBR +```ts +function intersectsMBR(mbr1, mbr2): boolean +``` -# Function: intersectsMBR() - -> **intersectsMBR**(`mbr1`, `mbr2`): `boolean` - -Defined in: src/geometry/MBR.ts:120 +Defined in: [src/geometry/MBR.ts:120](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/MBR.ts#L120) ## Parameters diff --git a/docs/api/functions/isEPSG3857.md b/docs/api/functions/isEPSG3857.md index 3c5eb52..b3f5225 100644 --- a/docs/api/functions/isEPSG3857.md +++ b/docs/api/functions/isEPSG3857.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / isEPSG3857 -*** +# isEPSG3857() -[rvgeo](../globals.md) / isEPSG3857 +```ts +function isEPSG3857(srsname?): boolean +``` -# Function: isEPSG3857() - -> **isEPSG3857**(`srsname`?): `boolean` - -Defined in: src/geo/utils.ts:1 +Defined in: [src/geo/utils.ts:1](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geo/utils.ts#L1) ## Parameters diff --git a/docs/api/functions/isEPSG4326.md b/docs/api/functions/isEPSG4326.md index d304d4d..75abf19 100644 --- a/docs/api/functions/isEPSG4326.md +++ b/docs/api/functions/isEPSG4326.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / isEPSG4326 -*** +# isEPSG4326() -[rvgeo](../globals.md) / isEPSG4326 +```ts +function isEPSG4326(srsname?): boolean +``` -# Function: isEPSG4326() - -> **isEPSG4326**(`srsname`?): `boolean` - -Defined in: src/geo/utils.ts:14 +Defined in: [src/geo/utils.ts:14](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geo/utils.ts#L14) ## Parameters diff --git a/docs/api/functions/isFloat.md b/docs/api/functions/isFloat.md index 41ee1f9..89c06f6 100644 --- a/docs/api/functions/isFloat.md +++ b/docs/api/functions/isFloat.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / isFloat -*** +# isFloat() -[rvgeo](../globals.md) / isFloat +```ts +function isFloat(n): boolean +``` -# Function: isFloat() - -> **isFloat**(`n`): `boolean` - -Defined in: src/math/utils.ts:22 +Defined in: [src/math/utils.ts:22](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/utils.ts#L22) 判断一个数字是否为浮点数 diff --git a/docs/api/functions/isPotentialGeoObject.md b/docs/api/functions/isPotentialGeoObject.md index 433626f..945e75b 100644 --- a/docs/api/functions/isPotentialGeoObject.md +++ b/docs/api/functions/isPotentialGeoObject.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / isPotentialGeoObject -*** +# isPotentialGeoObject() -[rvgeo](../globals.md) / isPotentialGeoObject +```ts +function isPotentialGeoObject(obj): boolean +``` -# Function: isPotentialGeoObject() - -> **isPotentialGeoObject**(`obj`): `boolean` - -Defined in: src/core/utils.ts:11 +Defined in: [src/core/utils.ts:11](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/core/utils.ts#L11) 判断一个 object 是否是(潜在的)地理对象（是否含有 X，Y 或者 lon，lat 或者 lng，lat 属性） diff --git a/docs/api/functions/iterPolygonEdge.md b/docs/api/functions/iterPolygonEdge.md index f515e03..49363e7 100644 --- a/docs/api/functions/iterPolygonEdge.md +++ b/docs/api/functions/iterPolygonEdge.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / iterPolygonEdge -*** +# iterPolygonEdge() -[rvgeo](../globals.md) / iterPolygonEdge +```ts +function iterPolygonEdge(polygon, callback): void +``` -# Function: iterPolygonEdge() - -> **iterPolygonEdge**(`polygon`, `callback`): `void` - -Defined in: src/topology/utils.ts:205 +Defined in: [src/topology/utils.ts:205](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/topology/utils.ts#L205) 迭代访问多边形的边（不重复访问） diff --git a/docs/api/functions/lengthToRadians.md b/docs/api/functions/lengthToRadians.md index 6d13ad6..d9ac8d6 100644 --- a/docs/api/functions/lengthToRadians.md +++ b/docs/api/functions/lengthToRadians.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / lengthToRadians -*** +# lengthToRadians() -[rvgeo](../globals.md) / lengthToRadians +```ts +function lengthToRadians(distance, units?): number +``` -# Function: lengthToRadians() - -> **lengthToRadians**(`distance`, `units`?): `number` - -Defined in: src/math/units.ts:41 +Defined in: [src/math/units.ts:41](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/units.ts#L41) - Convert a distance measurement (assuming a spherical Earth) from a real-world unit into radians - 将距离测量值（假设地球是球形的）从现实世界的单位转换为弧度 diff --git a/docs/api/functions/mbrToPolygon.md b/docs/api/functions/mbrToPolygon.md index b3c3411..5bf1a1f 100644 --- a/docs/api/functions/mbrToPolygon.md +++ b/docs/api/functions/mbrToPolygon.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / mbrToPolygon -*** +# mbrToPolygon() -[rvgeo](../globals.md) / mbrToPolygon +```ts +function mbrToPolygon(mbr): [number, number][] +``` -# Function: mbrToPolygon() - -> **mbrToPolygon**(`mbr`): \[`number`, `number`\][] - -Defined in: src/geometry/MBR.ts:223 +Defined in: [src/geometry/MBR.ts:223](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/MBR.ts#L223) 将 MBR 转化为 逆时针方向的（无孔）多边形数组 diff --git a/docs/api/functions/mbrToRectangle.md b/docs/api/functions/mbrToRectangle.md index ef6b11e..b8e9ca3 100644 --- a/docs/api/functions/mbrToRectangle.md +++ b/docs/api/functions/mbrToRectangle.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / mbrToRectangle -*** +# mbrToRectangle() -[rvgeo](../globals.md) / mbrToRectangle +```ts +function mbrToRectangle(mbr): Rectangle +``` -# Function: mbrToRectangle() - -> **mbrToRectangle**(`mbr`): [`Rectangle`](../type-aliases/Rectangle.md) - -Defined in: src/geometry/MBR.ts:192 +Defined in: [src/geometry/MBR.ts:192](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/MBR.ts#L192) MBR 转换为 Rectangle diff --git a/docs/api/functions/merge.md b/docs/api/functions/merge.md index d6e3b10..1b40fe5 100644 --- a/docs/api/functions/merge.md +++ b/docs/api/functions/merge.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / merge -*** +# merge() -[rvgeo](../globals.md) / merge +```ts +function merge(topology): GeometryObject +``` -# Function: merge() - -> **merge**(`topology`): `GeometryObject` - -Defined in: src/topology/client/merge.ts:16 +Defined in: [src/topology/client/merge.ts:16](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/topology/client/merge.ts#L16) ## Parameters diff --git a/docs/api/functions/mergeArcs.md b/docs/api/functions/mergeArcs.md index 50f28a8..ae7ee4e 100644 --- a/docs/api/functions/mergeArcs.md +++ b/docs/api/functions/mergeArcs.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / mergeArcs -*** +# mergeArcs() -[rvgeo](../globals.md) / mergeArcs +```ts +function mergeArcs(topology, objects): object +``` -# Function: mergeArcs() - -> **mergeArcs**(`topology`, `objects`): `object` - -Defined in: src/topology/client/merge.ts:21 +Defined in: [src/topology/client/merge.ts:21](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/topology/client/merge.ts#L21) ## Parameters @@ -26,8 +24,12 @@ Defined in: src/topology/client/merge.ts:21 ### arcs -> **arcs**: `number`[][][] +```ts +arcs: number[][][]; +``` ### type -> **type**: `string` = `"MultiPolygon"` +```ts +type: string = "MultiPolygon"; +``` diff --git a/docs/api/functions/mergeMBR.md b/docs/api/functions/mergeMBR.md index 36daf27..ee2e9e2 100644 --- a/docs/api/functions/mergeMBR.md +++ b/docs/api/functions/mergeMBR.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / mergeMBR -*** +# mergeMBR() -[rvgeo](../globals.md) / mergeMBR +```ts +function mergeMBR(mbr1, mbr2): MBR +``` -# Function: mergeMBR() - -> **mergeMBR**(`mbr1`, `mbr2`): [`MBR`](../type-aliases/MBR.md) - -Defined in: src/geometry/MBR.ts:50 +Defined in: [src/geometry/MBR.ts:50](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/MBR.ts#L50) ## Parameters diff --git a/docs/api/functions/mergePointMBR.md b/docs/api/functions/mergePointMBR.md index a0a2abf..3fdcd8f 100644 --- a/docs/api/functions/mergePointMBR.md +++ b/docs/api/functions/mergePointMBR.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / mergePointMBR -*** +# mergePointMBR() -[rvgeo](../globals.md) / mergePointMBR +```ts +function mergePointMBR(mbr, point): MBR +``` -# Function: mergePointMBR() - -> **mergePointMBR**(`mbr`, `point`): [`MBR`](../type-aliases/MBR.md) - -Defined in: src/geometry/MBR.ts:53 +Defined in: [src/geometry/MBR.ts:53](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/MBR.ts#L53) ## Parameters diff --git a/docs/api/functions/mesh.md b/docs/api/functions/mesh.md index 860fdee..24a0d27 100644 --- a/docs/api/functions/mesh.md +++ b/docs/api/functions/mesh.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / mesh -*** +# mesh() -[rvgeo](../globals.md) / mesh +```ts +function mesh(topology): GeometryObject +``` -# Function: mesh() - -> **mesh**(`topology`): `GeometryObject` - -Defined in: src/topology/client/mesh.ts:12 +Defined in: [src/topology/client/mesh.ts:12](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/topology/client/mesh.ts#L12) ## Parameters diff --git a/docs/api/functions/meshArcs.md b/docs/api/functions/meshArcs.md index 33feed9..d56a4ff 100644 --- a/docs/api/functions/meshArcs.md +++ b/docs/api/functions/meshArcs.md @@ -1,14 +1,15 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / meshArcs -*** +# meshArcs() -[rvgeo](../globals.md) / meshArcs +```ts +function meshArcs( + topology, + object, + filter): object +``` -# Function: meshArcs() - -> **meshArcs**(`topology`, `object`, `filter`): `object` - -Defined in: src/topology/client/mesh.ts:17 +Defined in: [src/topology/client/mesh.ts:17](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/topology/client/mesh.ts#L17) ## Parameters @@ -30,8 +31,12 @@ Defined in: src/topology/client/mesh.ts:17 ### arcs -> **arcs**: `number`[][] +```ts +arcs: number[][]; +``` ### type -> **type**: `string` = `"MultiLineString"` +```ts +type: string = "MultiLineString"; +``` diff --git a/docs/api/functions/metersTo.md b/docs/api/functions/metersTo.md index 56dea06..d6367a6 100644 --- a/docs/api/functions/metersTo.md +++ b/docs/api/functions/metersTo.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / metersTo -*** +# metersTo() -[rvgeo](../globals.md) / metersTo +```ts +function metersTo(distance, units): number +``` -# Function: metersTo() - -> **metersTo**(`distance`, `units`): `number` - -Defined in: src/math/units.ts:101 +Defined in: [src/math/units.ts:101](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/units.ts#L101) - 将距离单位米转换为指定单位 - Convert distance units from meters to specified units diff --git a/docs/api/functions/midpoint.md b/docs/api/functions/midpoint.md index 04dd916..dfbc47c 100644 --- a/docs/api/functions/midpoint.md +++ b/docs/api/functions/midpoint.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / midpoint -*** +# midpoint() -[rvgeo](../globals.md) / midpoint +```ts +function midpoint(latlng1, latlng2): [number, number] +``` -# Function: midpoint() - -> **midpoint**(`latlng1`, `latlng2`): \[`number`, `number`\] - -Defined in: src/math/measuring.ts:107 +Defined in: [src/math/measuring.ts:107](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/measuring.ts#L107) ## Parameters diff --git a/docs/api/functions/neighbors.md b/docs/api/functions/neighbors.md index cbeab06..c33ed4d 100644 --- a/docs/api/functions/neighbors.md +++ b/docs/api/functions/neighbors.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / neighbors -*** +# neighbors() -[rvgeo](../globals.md) / neighbors +```ts +function neighbors(objects): Neighbor[] +``` -# Function: neighbors() - -> **neighbors**(`objects`): `Neighbor`[] - -Defined in: src/topology/client/neighbors.ts:14 +Defined in: [src/topology/client/neighbors.ts:14](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/topology/client/neighbors.ts#L14) ## Parameters diff --git a/docs/api/functions/normalize.md b/docs/api/functions/normalize.md index 0ce45ff..4969e7c 100644 --- a/docs/api/functions/normalize.md +++ b/docs/api/functions/normalize.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / normalize -*** +# normalize() -[rvgeo](../globals.md) / normalize +```ts +function normalize(d): [number, number] +``` -# Function: normalize() - -> **normalize**(`d`): \[`number`, `number`\] - -Defined in: src/math/vector.ts:191 +Defined in: [src/math/vector.ts:191](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/vector.ts#L191) 归一化二维笛卡尔坐标系下的向量 d，返回一个新的单位向量。 This function normalizes a 2D Cartesian vector d, returning a new unit vector. diff --git a/docs/api/functions/object.md b/docs/api/functions/object.md index 2f2a21b..36effdb 100644 --- a/docs/api/functions/object.md +++ b/docs/api/functions/object.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / object -*** +# object() -[rvgeo](../globals.md) / object +```ts +function object(topology, o): GeometryObject +``` -# Function: object() - -> **object**(`topology`, `o`): `GeometryObject` - -Defined in: src/topology/client/feature.ts:33 +Defined in: [src/topology/client/feature.ts:33](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/topology/client/feature.ts#L33) ## Parameters diff --git a/docs/api/functions/overlapsMBR.md b/docs/api/functions/overlapsMBR.md index 93b9ef4..4f3274f 100644 --- a/docs/api/functions/overlapsMBR.md +++ b/docs/api/functions/overlapsMBR.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / overlapsMBR -*** +# overlapsMBR() -[rvgeo](../globals.md) / overlapsMBR +```ts +function overlapsMBR(mbr1, mbr2): boolean +``` -# Function: overlapsMBR() - -> **overlapsMBR**(`mbr1`, `mbr2`): `boolean` - -Defined in: src/geometry/MBR.ts:124 +Defined in: [src/geometry/MBR.ts:124](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/MBR.ts#L124) ## Parameters diff --git a/docs/api/functions/plane2MBR.md b/docs/api/functions/plane2MBR.md index bcc29c5..aa7330a 100644 --- a/docs/api/functions/plane2MBR.md +++ b/docs/api/functions/plane2MBR.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / plane2MBR -*** +# plane2MBR() -[rvgeo](../globals.md) / plane2MBR +```ts +function plane2MBR(plane, projection): MBR +``` -# Function: plane2MBR() - -> **plane2MBR**(`plane`, `projection`): [`MBR`](../type-aliases/MBR.md) - -Defined in: src/geometry/MBR.ts:75 +Defined in: [src/geometry/MBR.ts:75](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/MBR.ts#L75) default projection : SphericalMercator - you can change the projection by passing the second parameter diff --git a/docs/api/functions/planeIntersection.md b/docs/api/functions/planeIntersection.md index f2d82d6..0146183 100644 --- a/docs/api/functions/planeIntersection.md +++ b/docs/api/functions/planeIntersection.md @@ -1,14 +1,19 @@ -[**rvgeo**](../README.md) - -*** - -[rvgeo](../globals.md) / planeIntersection - -# Function: planeIntersection() - -> **planeIntersection**(`p1`, `p2`, `p3`, `p4`, `projectionFrom`, `projectionTo`, `isInfine`): \[`number`, `number`\] \| `null` - -Defined in: src/math/measuring.ts:243 +[rvgeo](../index.md) / planeIntersection + +# planeIntersection() + +```ts +function planeIntersection( + p1, + p2, + p3, + p4, + projectionFrom, + projectionTo, + isInfine): [number, number] | null +``` + +Defined in: [src/math/measuring.ts:243](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/measuring.ts#L243) 也可以使用该函数计算两条线段的交点 - 现将经纬度坐标投影到平面坐标系下，然后计算交点，最后将交点投影回经纬度坐标系 diff --git a/docs/api/functions/planePolygonArea.md b/docs/api/functions/planePolygonArea.md index 4a0ff69..010311a 100644 --- a/docs/api/functions/planePolygonArea.md +++ b/docs/api/functions/planePolygonArea.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / planePolygonArea -*** +# planePolygonArea() -[rvgeo](../globals.md) / planePolygonArea +```ts +function planePolygonArea(points, radius): number +``` -# Function: planePolygonArea() - -> **planePolygonArea**(`points`, `radius`): `number` - -Defined in: src/math/measuring.ts:40 +Defined in: [src/math/measuring.ts:40](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/measuring.ts#L40) - 使用 Shoelace Theorem 求多边形面积 - calculate the area of a polygon using the Shoelace Theorem diff --git a/docs/api/functions/pointInEdge.md b/docs/api/functions/pointInEdge.md index 1a7f8f5..c140002 100644 --- a/docs/api/functions/pointInEdge.md +++ b/docs/api/functions/pointInEdge.md @@ -1,14 +1,15 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / pointInEdge -*** +# pointInEdge() -[rvgeo](../globals.md) / pointInEdge +```ts +function pointInEdge( + point, + p1, + p2): boolean +``` -# Function: pointInEdge() - -> **pointInEdge**(`point`, `p1`, `p2`): `boolean` - -Defined in: src/topology/utils.ts:237 +Defined in: [src/topology/utils.ts:237](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/topology/utils.ts#L237) （前提：逆时针多边形的边）判断点是否在当前边的内部(也就是边前进方向的左侧) diff --git a/docs/api/functions/pointInMBR.md b/docs/api/functions/pointInMBR.md index d8a751f..9c3ee11 100644 --- a/docs/api/functions/pointInMBR.md +++ b/docs/api/functions/pointInMBR.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / pointInMBR -*** +# pointInMBR() -[rvgeo](../globals.md) / pointInMBR +```ts +function pointInMBR(point, mbr): boolean +``` -# Function: pointInMBR() - -> **pointInMBR**(`point`, `mbr`): `boolean` - -Defined in: src/geometry/MBR.ts:110 +Defined in: [src/geometry/MBR.ts:110](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/MBR.ts#L110) 判断点是否在 MBR 内（默认情况） diff --git a/docs/api/functions/pointInMBRWithAntimeridian.md b/docs/api/functions/pointInMBRWithAntimeridian.md index b1c4403..00d979d 100644 --- a/docs/api/functions/pointInMBRWithAntimeridian.md +++ b/docs/api/functions/pointInMBRWithAntimeridian.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / pointInMBRWithAntimeridian -*** +# pointInMBRWithAntimeridian() -[rvgeo](../globals.md) / pointInMBRWithAntimeridian +```ts +function pointInMBRWithAntimeridian(point, mbr): boolean +``` -# Function: pointInMBRWithAntimeridian() - -> **pointInMBRWithAntimeridian**(`point`, `mbr`): `boolean` - -Defined in: src/geometry/MBR.ts:139 +Defined in: [src/geometry/MBR.ts:139](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/MBR.ts#L139) 判断点是否在 MBR 内（跨越了反子午线的情况） - 必须保 MBR 真的跨越了反子午线，否则会出现错误 diff --git a/docs/api/functions/prePointInPolygon.md b/docs/api/functions/prePointInPolygon.md index 4d15b36..29dea35 100644 --- a/docs/api/functions/prePointInPolygon.md +++ b/docs/api/functions/prePointInPolygon.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / prePointInPolygon -*** +# prePointInPolygon() -[rvgeo](../globals.md) / prePointInPolygon +```ts +function prePointInPolygon(index, polygonLength): number +``` -# Function: prePointInPolygon() - -> **prePointInPolygon**(`index`, `polygonLength`): `number` - -Defined in: src/topology/utils.ts:216 +Defined in: [src/topology/utils.ts:216](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/topology/utils.ts#L216) 返回多边形中 输入索引的前一个点的索引 多边形闭合并按照逆时针方向排列 diff --git a/docs/api/functions/pseudoColorBandFactory.md b/docs/api/functions/pseudoColorBandFactory.md index 109e8dd..8162ca4 100644 --- a/docs/api/functions/pseudoColorBandFactory.md +++ b/docs/api/functions/pseudoColorBandFactory.md @@ -1,14 +1,15 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / pseudoColorBandFactory -*** +# pseudoColorBandFactory() -[rvgeo](../globals.md) / pseudoColorBandFactory +```ts +function pseudoColorBandFactory( + type, + level?, + colorList?): (statistics, value) => string +``` -# Function: pseudoColorBandFactory() - -> **pseudoColorBandFactory**(`type`, `level`?, `colorList`?): (`statistics`, `value`) => `string` - -Defined in: src/render/colors.ts:206 +Defined in: [src/render/colors.ts:206](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/render/colors.ts#L206) 伪彩色带渲染工厂函数 diff --git a/docs/api/functions/radiansToDegrees.md b/docs/api/functions/radiansToDegrees.md index eb1cb2b..68216cf 100644 --- a/docs/api/functions/radiansToDegrees.md +++ b/docs/api/functions/radiansToDegrees.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / radiansToDegrees -*** +# radiansToDegrees() -[rvgeo](../globals.md) / radiansToDegrees - -# Function: radiansToDegrees() - -> **radiansToDegrees**(`radians`): `number` +```ts +function radiansToDegrees(radians): number +``` -Defined in: src/math/units.ts:74 +Defined in: [src/math/units.ts:74](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/units.ts#L74) - Converts an angle in radians to degrees diff --git a/docs/api/functions/radiansToLength.md b/docs/api/functions/radiansToLength.md index 7e5c25f..dcf2dad 100644 --- a/docs/api/functions/radiansToLength.md +++ b/docs/api/functions/radiansToLength.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / radiansToLength -*** +# radiansToLength() -[rvgeo](../globals.md) / radiansToLength +```ts +function radiansToLength(radians, units?): number +``` -# Function: radiansToLength() - -> **radiansToLength**(`radians`, `units`?): `number` - -Defined in: src/math/units.ts:19 +Defined in: [src/math/units.ts:19](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/units.ts#L19) - Convert a distance measurement (assuming a spherical Earth) from radians to a more friendly unit. - 将距离测量值（假设地球是球形的）从弧度转换为更友好的单位。 diff --git a/docs/api/functions/randomIndexArray.md b/docs/api/functions/randomIndexArray.md index d307723..5443d04 100644 --- a/docs/api/functions/randomIndexArray.md +++ b/docs/api/functions/randomIndexArray.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / randomIndexArray -*** +# randomIndexArray() -[rvgeo](../globals.md) / randomIndexArray +```ts +function randomIndexArray(length, num): number[] +``` -# Function: randomIndexArray() - -> **randomIndexArray**(`length`, `num`): `number`[] - -Defined in: src/core/utils.ts:198 +Defined in: [src/core/utils.ts:198](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/core/utils.ts#L198) 生成随机索引数组（不重复） diff --git a/docs/api/functions/reactGrid2d.md b/docs/api/functions/reactGrid2d.md index b9ca2e1..bb38d5d 100644 --- a/docs/api/functions/reactGrid2d.md +++ b/docs/api/functions/reactGrid2d.md @@ -1,14 +1,17 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / reactGrid2d -*** +# reactGrid2d() -[rvgeo](../globals.md) / reactGrid2d +```ts +function reactGrid2d( + canavs, + colRow, + Rect, + XY, + callback?): void +``` -# Function: reactGrid2d() - -> **reactGrid2d**(`canavs`, `colRow`, `Rect`, `XY`, `callback`?): `void` - -Defined in: src/render/renderGrid.ts:16 +Defined in: [src/render/renderGrid.ts:16](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/render/renderGrid.ts#L16) ## Parameters diff --git a/docs/api/functions/reconstructPath.md b/docs/api/functions/reconstructPath.md index 755bb3e..53e461e 100644 --- a/docs/api/functions/reconstructPath.md +++ b/docs/api/functions/reconstructPath.md @@ -1,14 +1,15 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / reconstructPath -*** +# reconstructPath() -[rvgeo](../globals.md) / reconstructPath +```ts +function reconstructPath( + cameFrom, + start, + goal): any[] +``` -# Function: reconstructPath() - -> **reconstructPath**(`cameFrom`, `start`, `goal`): `any`[] - -Defined in: src/net/bfs.ts:53 +Defined in: [src/net/bfs.ts:53](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/bfs.ts#L53) ## Parameters diff --git a/docs/api/functions/rectangleToMBR.md b/docs/api/functions/rectangleToMBR.md index 2d5e400..ee41564 100644 --- a/docs/api/functions/rectangleToMBR.md +++ b/docs/api/functions/rectangleToMBR.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / rectangleToMBR -*** +# rectangleToMBR() -[rvgeo](../globals.md) / rectangleToMBR +```ts +function rectangleToMBR(rectangle): MBR +``` -# Function: rectangleToMBR() - -> **rectangleToMBR**(`rectangle`): [`MBR`](../type-aliases/MBR.md) - -Defined in: src/geometry/MBR.ts:208 +Defined in: [src/geometry/MBR.ts:208](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/MBR.ts#L208) Rectangle 转换为 MBR diff --git a/docs/api/functions/reverse.md b/docs/api/functions/reverse.md index 9feff34..1fc9877 100644 --- a/docs/api/functions/reverse.md +++ b/docs/api/functions/reverse.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / reverse -*** +# reverse() -[rvgeo](../globals.md) / reverse +```ts +function reverse(array, n): void +``` -# Function: reverse() - -> **reverse**(`array`, `n`): `void` - -Defined in: src/topology/client/feature.ts:6 +Defined in: [src/topology/client/feature.ts:6](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/topology/client/feature.ts#L6) ## Parameters diff --git a/docs/api/functions/round.md b/docs/api/functions/round.md index 92769e5..69fd6d8 100644 --- a/docs/api/functions/round.md +++ b/docs/api/functions/round.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / round -*** +# round() -[rvgeo](../globals.md) / round - -# Function: round() - -> **round**(`num`, `precision`?): `number` +```ts +function round(num, precision?): number +``` -Defined in: src/core/utils.ts:229 +Defined in: [src/core/utils.ts:229](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/core/utils.ts#L229) - Round number to precision - 将数字四舍五入到指定精度 diff --git a/docs/api/functions/sample.md b/docs/api/functions/sample.md index fbc6e04..a4f8112 100644 --- a/docs/api/functions/sample.md +++ b/docs/api/functions/sample.md @@ -1,14 +1,18 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / sample -*** +# sample() -[rvgeo](../globals.md) / sample +```ts +function sample( + f, + N, + a, + b, + freq, + amp): number[] +``` -# Function: sample() - -> **sample**(`f`, `N`, `a`, `b`, `freq`, `amp`): `number`[] - -Defined in: src/math/fourier.ts:11 +Defined in: [src/math/fourier.ts:11](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/fourier.ts#L11) 采样函数 diff --git a/docs/api/functions/scale.md b/docs/api/functions/scale.md index 820c398..cdb1907 100644 --- a/docs/api/functions/scale.md +++ b/docs/api/functions/scale.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / scale -*** +# scale() -[rvgeo](../globals.md) / scale +```ts +function scale(vector, k): [number, number] +``` -# Function: scale() - -> **scale**(`vector`, `k`): \[`number`, `number`\] - -Defined in: src/math/vector.ts:183 +Defined in: [src/math/vector.ts:183](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/vector.ts#L183) 使用因子 k 缩放二维笛卡尔坐标系下的向量 vector，返回一个新的缩放后的向量。 This function scales a 2D Cartesian vector vector by a factor k, returning a new scaled vector. diff --git a/docs/api/functions/sign.md b/docs/api/functions/sign.md index db5b68f..1604b22 100644 --- a/docs/api/functions/sign.md +++ b/docs/api/functions/sign.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / sign -*** +# sign() -[rvgeo](../globals.md) / sign +```ts +function sign(x): -1 | 0 | 1 +``` -# Function: sign() - -> **sign**(`x`): `-1` \| `0` \| `1` - -Defined in: src/topology/utils.ts:259 +Defined in: [src/topology/utils.ts:259](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/topology/utils.ts#L259) - Returns the sign of the input, or zero - 返回输入的符号，或零 diff --git a/docs/api/functions/simpleColorBand.md b/docs/api/functions/simpleColorBand.md index c48deef..498f928 100644 --- a/docs/api/functions/simpleColorBand.md +++ b/docs/api/functions/simpleColorBand.md @@ -1,14 +1,15 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / simpleColorBand -*** +# simpleColorBand() -[rvgeo](../globals.md) / simpleColorBand +```ts +function simpleColorBand( + statistics, + value, + strachFunc): string +``` -# Function: simpleColorBand() - -> **simpleColorBand**(`statistics`, `value`, `strachFunc`): `string` - -Defined in: src/render/colors.ts:112 +Defined in: [src/render/colors.ts:112](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/render/colors.ts#L112) 连续单波段单色带渲染（灰色） diff --git a/docs/api/functions/simpleColorBandFactory.md b/docs/api/functions/simpleColorBandFactory.md index 6acd2cd..452cfc8 100644 --- a/docs/api/functions/simpleColorBandFactory.md +++ b/docs/api/functions/simpleColorBandFactory.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / simpleColorBandFactory -*** +# simpleColorBandFactory() -[rvgeo](../globals.md) / simpleColorBandFactory +```ts +function simpleColorBandFactory(type, isReverse?): (statistics, value) => string +``` -# Function: simpleColorBandFactory() - -> **simpleColorBandFactory**(`type`, `isReverse`?): (`statistics`, `value`) => `string` - -Defined in: src/render/colors.ts:154 +Defined in: [src/render/colors.ts:154](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/render/colors.ts#L154) ## Parameters diff --git a/docs/api/functions/simplePseudoColorBand.md b/docs/api/functions/simplePseudoColorBand.md index fae49cc..c4597b0 100644 --- a/docs/api/functions/simplePseudoColorBand.md +++ b/docs/api/functions/simplePseudoColorBand.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / simplePseudoColorBand -*** +# simplePseudoColorBand() -[rvgeo](../globals.md) / simplePseudoColorBand +```ts +function simplePseudoColorBand(value, colorList): string +``` -# Function: simplePseudoColorBand() - -> **simplePseudoColorBand**(`value`, `colorList`): `string` - -Defined in: src/render/colors.ts:231 +Defined in: [src/render/colors.ts:231](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/render/colors.ts#L231) 简单离散值颜色计算函数 - 离散值范围为整数 diff --git a/docs/api/functions/sin.md b/docs/api/functions/sin.md index 2446ad9..792978d 100644 --- a/docs/api/functions/sin.md +++ b/docs/api/functions/sin.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / sin -*** +# sin() -[rvgeo](../globals.md) / sin +```ts +function sin(x): number +``` -# Function: sin() - -> **sin**(`x`): `number` - -Defined in: src/math/vector.ts:7 +Defined in: [src/math/vector.ts:7](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/vector.ts#L7) Returns the sine of a number. diff --git a/docs/api/functions/sphereIntersection.md b/docs/api/functions/sphereIntersection.md index a74ac50..0f0ec33 100644 --- a/docs/api/functions/sphereIntersection.md +++ b/docs/api/functions/sphereIntersection.md @@ -1,14 +1,16 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / sphereIntersection -*** +# sphereIntersection() -[rvgeo](../globals.md) / sphereIntersection - -# Function: sphereIntersection() - -> **sphereIntersection**(`latlng11`, `latlng12`, `latlng21`, `latlng22`): \[`number`, `number`\] +```ts +function sphereIntersection( + latlng11, + latlng12, + latlng21, + latlng22): [number, number] +``` -Defined in: src/math/measuring.ts:159 +Defined in: [src/math/measuring.ts:159](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/measuring.ts#L159) 求解两条球面线段的交点 - Given two lines on a sphere, this will return their intersection point. diff --git a/docs/api/functions/spherical.md b/docs/api/functions/spherical.md index 26ab9c7..a19958e 100644 --- a/docs/api/functions/spherical.md +++ b/docs/api/functions/spherical.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / spherical -*** +# spherical() -[rvgeo](../globals.md) / spherical - -# Function: spherical() - -> **spherical**(`cartesian`): \[`number`, `number`\] +```ts +function spherical(cartesian): [number, number] +``` -Defined in: src/math/vector.ts:54 +Defined in: [src/math/vector.ts:54](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/vector.ts#L54) 将三维笛卡尔坐标系下的向量 [x, y, z] 转换为球坐标系下的向量 [lat, lon]（弧度制）。 This function takes a 3D Cartesian vector [x, y, z] and converts it to spherical coordinates [lat, lon]. diff --git a/docs/api/functions/sphericalArea.md b/docs/api/functions/sphericalArea.md index dcce667..1a81452 100644 --- a/docs/api/functions/sphericalArea.md +++ b/docs/api/functions/sphericalArea.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / sphericalArea -*** +# sphericalArea() -[rvgeo](../globals.md) / sphericalArea +```ts +function sphericalArea(points, RADIUS): number +``` -# Function: sphericalArea() - -> **sphericalArea**(`points`, `RADIUS`): `number` - -Defined in: src/math/measuring.ts:7 +Defined in: [src/math/measuring.ts:7](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/measuring.ts#L7) ## Parameters diff --git a/docs/api/functions/splitMBRWithAntimeridian.md b/docs/api/functions/splitMBRWithAntimeridian.md index a043f5c..66c4255 100644 --- a/docs/api/functions/splitMBRWithAntimeridian.md +++ b/docs/api/functions/splitMBRWithAntimeridian.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / splitMBRWithAntimeridian -*** +# splitMBRWithAntimeridian() -[rvgeo](../globals.md) / splitMBRWithAntimeridian +```ts +function splitMBRWithAntimeridian(mbr): MBR[] +``` -# Function: splitMBRWithAntimeridian() - -> **splitMBRWithAntimeridian**(`mbr`): [`MBR`](../type-aliases/MBR.md)[] - -Defined in: src/geometry/MBR.ts:177 +Defined in: [src/geometry/MBR.ts:177](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/MBR.ts#L177) 将单个跨越了反子午线的 MBR 分割成两个简单的 MBR diff --git a/docs/api/functions/sqrt.md b/docs/api/functions/sqrt.md index d2b1f89..425d93b 100644 --- a/docs/api/functions/sqrt.md +++ b/docs/api/functions/sqrt.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / sqrt -*** +# sqrt() -[rvgeo](../globals.md) / sqrt +```ts +function sqrt(x): number +``` -# Function: sqrt() - -> **sqrt**(`x`): `number` - -Defined in: src/math/vector.ts:8 +Defined in: [src/math/vector.ts:8](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/vector.ts#L8) Returns the square root of a number. diff --git a/docs/api/functions/squareMetersTo.md b/docs/api/functions/squareMetersTo.md index 25efc27..c8af46e 100644 --- a/docs/api/functions/squareMetersTo.md +++ b/docs/api/functions/squareMetersTo.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / squareMetersTo -*** +# squareMetersTo() -[rvgeo](../globals.md) / squareMetersTo +```ts +function squareMetersTo(area, units): number +``` -# Function: squareMetersTo() - -> **squareMetersTo**(`area`, `units`): `number` - -Defined in: src/math/units.ts:154 +Defined in: [src/math/units.ts:154](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/units.ts#L154) - 将面积单位平方米转换为指定单位 - Convert area units from square meters to specified units diff --git a/docs/api/functions/subColumnInEL2DArray.md b/docs/api/functions/subColumnInEL2DArray.md index 8568e39..dfa666a 100644 --- a/docs/api/functions/subColumnInEL2DArray.md +++ b/docs/api/functions/subColumnInEL2DArray.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / subColumnInEL2DArray -*** +# subColumnInEL2DArray() -[rvgeo](../globals.md) / subColumnInEL2DArray +```ts +function subColumnInEL2DArray(array, indexArray): any[] +``` -# Function: subColumnInEL2DArray() - -> **subColumnInEL2DArray**(`array`, `indexArray`): `any`[] - -Defined in: src/core/utils.ts:157 +Defined in: [src/core/utils.ts:157](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/core/utils.ts#L157) 抽取二维数组的某一列（或某几列） diff --git a/docs/api/functions/subdivide2QTree.md b/docs/api/functions/subdivide2QTree.md index 38d7977..78afb9c 100644 --- a/docs/api/functions/subdivide2QTree.md +++ b/docs/api/functions/subdivide2QTree.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / subdivide2QTree -*** +# subdivide2QTree() -[rvgeo](../globals.md) / subdivide2QTree +```ts +function subdivide2QTree(grid, maxDepth): QTNode +``` -# Function: subdivide2QTree() - -> **subdivide2QTree**(`grid`, `maxDepth`): [`QTNode`](../type-aliases/QTNode.md) - -Defined in: src/coverage/grid.ts:403 +Defined in: [src/coverage/grid.ts:403](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L403) （简易四叉树）创建一个 gridMBR 层面的四叉树 diff --git a/docs/api/functions/testProgress.md b/docs/api/functions/testProgress.md index 37de6e1..1b82d64 100644 --- a/docs/api/functions/testProgress.md +++ b/docs/api/functions/testProgress.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / testProgress -*** +# testProgress() -[rvgeo](../globals.md) / testProgress +```ts +function testProgress(): void +``` -# Function: testProgress() - -> **testProgress**(): `void` - -Defined in: src/render/renderGrid.ts:680 +Defined in: [src/render/renderGrid.ts:680](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/render/renderGrid.ts#L680) ## Returns diff --git a/docs/api/functions/throttle.md b/docs/api/functions/throttle.md index 3b74242..9b47430 100644 --- a/docs/api/functions/throttle.md +++ b/docs/api/functions/throttle.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / throttle -*** +# throttle() -[rvgeo](../globals.md) / throttle +```ts +function throttle(func, wait): (this, ...args) => void +``` -# Function: throttle() - -> **throttle**(`func`, `wait`): (`this`, ...`args`) => `void` - -Defined in: src/core/utils.ts:37 +Defined in: [src/core/utils.ts:37](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/core/utils.ts#L37) 节流函数 diff --git a/docs/api/functions/toLineString.md b/docs/api/functions/toLineString.md index 06389b5..34d098e 100644 --- a/docs/api/functions/toLineString.md +++ b/docs/api/functions/toLineString.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / toLineString -*** +# toLineString() -[rvgeo](../globals.md) / toLineString +```ts +function toLineString(points): LineString +``` -# Function: toLineString() - -> **toLineString**(`points`): [`LineString`](../classes/LineString.md) - -Defined in: src/geometry/LineString.ts:143 +Defined in: [src/geometry/LineString.ts:143](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/LineString.ts#L143) ## Parameters diff --git a/docs/api/functions/toMeters.md b/docs/api/functions/toMeters.md index 39d23f3..853686c 100644 --- a/docs/api/functions/toMeters.md +++ b/docs/api/functions/toMeters.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / toMeters -*** +# toMeters() -[rvgeo](../globals.md) / toMeters +```ts +function toMeters(distance, units): number +``` -# Function: toMeters() - -> **toMeters**(`distance`, `units`): `number` - -Defined in: src/math/units.ts:86 +Defined in: [src/math/units.ts:86](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/units.ts#L86) - 将距离单位转换为米 - Convert distance units to meters diff --git a/docs/api/functions/toMultiPoint.md b/docs/api/functions/toMultiPoint.md index 3212119..1aa2f9a 100644 --- a/docs/api/functions/toMultiPoint.md +++ b/docs/api/functions/toMultiPoint.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / toMultiPoint -*** +# toMultiPoint() -[rvgeo](../globals.md) / toMultiPoint +```ts +function toMultiPoint(points, properties?): MultiPoint +``` -# Function: toMultiPoint() - -> **toMultiPoint**(`points`, `properties`?): [`MultiPoint`](../classes/MultiPoint.md) - -Defined in: src/geometry/Point.ts:231 +Defined in: [src/geometry/Point.ts:231](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Point.ts#L231) ## Parameters diff --git a/docs/api/functions/toPoint.md b/docs/api/functions/toPoint.md index eb80ecb..17c11d0 100644 --- a/docs/api/functions/toPoint.md +++ b/docs/api/functions/toPoint.md @@ -1,16 +1,17 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / toPoint -*** - -[rvgeo](../globals.md) / toPoint - -# Function: toPoint() +# toPoint() ## Call Signature -> **toPoint**(`Lon`, `Lat`, `properties`?): [`Point`](../classes/Point.md) +```ts +function toPoint( + Lon, + Lat, + properties?): Point +``` -Defined in: src/geometry/Point.ts:203 +Defined in: [src/geometry/Point.ts:203](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Point.ts#L203) the factory function to create a Point(the following ways are equivalent) @@ -47,9 +48,11 @@ let point = toPoint({lon: 120, lat: 30}, { name: 'test' }); ## Call Signature -> **toPoint**(`coordinates`, `properties`?): [`Point`](../classes/Point.md) +```ts +function toPoint(coordinates, properties?): Point +``` -Defined in: src/geometry/Point.ts:204 +Defined in: [src/geometry/Point.ts:204](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Point.ts#L204) the factory function to create a Point(the following ways are equivalent) @@ -82,9 +85,11 @@ let point = toPoint({lon: 120, lat: 30}, { name: 'test' }); ## Call Signature -> **toPoint**(`obj`, `properties`?): [`Point`](../classes/Point.md) +```ts +function toPoint(obj, properties?): Point +``` -Defined in: src/geometry/Point.ts:205 +Defined in: [src/geometry/Point.ts:205](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Point.ts#L205) the factory function to create a Point(the following ways are equivalent) @@ -92,7 +97,16 @@ the factory function to create a Point(the following ways are equivalent) #### obj -\{ `lat`: `number`; `lon`: `number`; \} | \{ `x`: `number`; `y`: `number`; \} | \{ `lat`: `number`; `lng`: `number`; \} +\{ +`lat`: `number`; +`lon`: `number`; +\} | \{ +`x`: `number`; +`y`: `number`; +\} | \{ +`lat`: `number`; +`lng`: `number`; +\} #### properties? diff --git a/docs/api/functions/toSquareMeters.md b/docs/api/functions/toSquareMeters.md index 2c0d046..56571a4 100644 --- a/docs/api/functions/toSquareMeters.md +++ b/docs/api/functions/toSquareMeters.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / toSquareMeters -*** +# toSquareMeters() -[rvgeo](../globals.md) / toSquareMeters +```ts +function toSquareMeters(area, units): number +``` -# Function: toSquareMeters() - -> **toSquareMeters**(`area`, `units`): `number` - -Defined in: src/math/units.ts:139 +Defined in: [src/math/units.ts:139](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/units.ts#L139) - 将面积单位转换为平方米 - Convert area units to square meters diff --git a/docs/api/functions/topology.md b/docs/api/functions/topology.md index 4c85b13..c92115e 100644 --- a/docs/api/functions/topology.md +++ b/docs/api/functions/topology.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / topology -*** +# topology() -[rvgeo](../globals.md) / topology +```ts +function topology(objects, quantization): dedupedTopology +``` -# Function: topology() - -> **topology**(`objects`, `quantization`): `dedupedTopology` - -Defined in: src/topology/sever/topology.ts:15 +Defined in: [src/topology/sever/topology.ts:15](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/topology/sever/topology.ts#L15) ## Parameters diff --git a/docs/api/functions/transform.md b/docs/api/functions/transform.md index ca29db7..e699990 100644 --- a/docs/api/functions/transform.md +++ b/docs/api/functions/transform.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / transform -*** +# transform() -[rvgeo](../globals.md) / transform +```ts +function transform(transform?): (input, i?) => [number, number] +``` -# Function: transform() - -> **transform**(`transform`?): (`input`, `i`?) => \[`number`, `number`\] - -Defined in: src/topology/client/transform.ts:8 +Defined in: [src/topology/client/transform.ts:8](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/topology/client/transform.ts#L8) ## Parameters diff --git a/docs/api/functions/triangleCenter.md b/docs/api/functions/triangleCenter.md index f15918b..5344390 100644 --- a/docs/api/functions/triangleCenter.md +++ b/docs/api/functions/triangleCenter.md @@ -1,14 +1,16 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / triangleCenter -*** +# triangleCenter() -[rvgeo](../globals.md) / triangleCenter +```ts +function triangleCenter( + points, + delaunay, + t, + projection): [number, number] +``` -# Function: triangleCenter() - -> **triangleCenter**(`points`, `delaunay`, `t`, `projection`): \[`number`, `number`\] - -Defined in: src/triangulation/Delaunay.ts:610 +Defined in: [src/triangulation/Delaunay.ts:610](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/triangulation/Delaunay.ts#L610) 计算三角形的外心（对于 Delauany 三角剖分的结果数组） diff --git a/docs/api/functions/trueColorBand.md b/docs/api/functions/trueColorBand.md index 08e1f30..362981b 100644 --- a/docs/api/functions/trueColorBand.md +++ b/docs/api/functions/trueColorBand.md @@ -1,14 +1,15 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / trueColorBand -*** +# trueColorBand() -[rvgeo](../globals.md) / trueColorBand +```ts +function trueColorBand( + statistics, + value, + strachFunc): string +``` -# Function: trueColorBand() - -> **trueColorBand**(`statistics`, `value`, `strachFunc`): `string` - -Defined in: src/render/colors.ts:131 +Defined in: [src/render/colors.ts:131](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/render/colors.ts#L131) 真彩色带渲染 diff --git a/docs/api/functions/trueColorBandFactory.md b/docs/api/functions/trueColorBandFactory.md index a3ae7bc..359c24e 100644 --- a/docs/api/functions/trueColorBandFactory.md +++ b/docs/api/functions/trueColorBandFactory.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / trueColorBandFactory -*** +# trueColorBandFactory() -[rvgeo](../globals.md) / trueColorBandFactory +```ts +function trueColorBandFactory(type, isReverse?): (statistics, value) => string +``` -# Function: trueColorBandFactory() - -> **trueColorBandFactory**(`type`, `isReverse`?): (`statistics`, `value`) => `string` - -Defined in: src/render/colors.ts:149 +Defined in: [src/render/colors.ts:149](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/render/colors.ts#L149) 真彩色带渲染工厂函数 diff --git a/docs/api/functions/unitToUnit.md b/docs/api/functions/unitToUnit.md index a0c7910..87eaafa 100644 --- a/docs/api/functions/unitToUnit.md +++ b/docs/api/functions/unitToUnit.md @@ -1,14 +1,15 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / unitToUnit -*** +# unitToUnit() -[rvgeo](../globals.md) / unitToUnit +```ts +function unitToUnit( + distance, + from, + to): number +``` -# Function: unitToUnit() - -> **unitToUnit**(`distance`, `from`, `to`): `number` - -Defined in: src/math/units.ts:117 +Defined in: [src/math/units.ts:117](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/units.ts#L117) - 距离单位内互相转换 - Convert distance units to each other diff --git a/docs/api/functions/untransform.md b/docs/api/functions/untransform.md index 8c415b6..8f7e51e 100644 --- a/docs/api/functions/untransform.md +++ b/docs/api/functions/untransform.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / untransform -*** +# untransform() -[rvgeo](../globals.md) / untransform +```ts +function untransform(transform?): (input, i?) => [number, number] +``` -# Function: untransform() - -> **untransform**(`transform`?): (`input`, `i`?) => \[`number`, `number`\] - -Defined in: src/topology/client/transform.ts:27 +Defined in: [src/topology/client/transform.ts:27](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/topology/client/transform.ts#L27) ## Parameters diff --git a/docs/api/functions/worleyNoise.md b/docs/api/functions/worleyNoise.md index d96c09b..3f030f3 100644 --- a/docs/api/functions/worleyNoise.md +++ b/docs/api/functions/worleyNoise.md @@ -1,14 +1,15 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / worleyNoise -*** +# worleyNoise() -[rvgeo](../globals.md) / worleyNoise +```ts +function worleyNoise( + row, + col, + n): number[][] +``` -# Function: worleyNoise() - -> **worleyNoise**(`row`, `col`, `n`): `number`[][] - -Defined in: src/coverage/Noise.ts:128 +Defined in: [src/coverage/Noise.ts:128](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/Noise.ts#L128) 生成 Worley 噪声距离场 diff --git a/docs/api/functions/zebraNoise.md b/docs/api/functions/zebraNoise.md index 1eda0f0..d3a5dc6 100644 --- a/docs/api/functions/zebraNoise.md +++ b/docs/api/functions/zebraNoise.md @@ -1,14 +1,16 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / zebraNoise -*** +# zebraNoise() -[rvgeo](../globals.md) / zebraNoise +```ts +function zebraNoise( + row, + col, + n, + mode): number[][] +``` -# Function: zebraNoise() - -> **zebraNoise**(`row`, `col`, `n`, `mode`): `number`[][] - -Defined in: src/coverage/Noise.ts:165 +Defined in: [src/coverage/Noise.ts:165](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/Noise.ts#L165) 生成 条纹 噪声，可选水平或垂直 diff --git a/docs/api/globals.md b/docs/api/globals.md deleted file mode 100644 index 728e972..0000000 --- a/docs/api/globals.md +++ /dev/null @@ -1,248 +0,0 @@ -[**rvgeo**](README.md) - -*** - -# rvgeo - -## Enumerations - -- [colorListType](enumerations/colorListType.md) -- [stretchType](enumerations/stretchType.md) - -## Classes - -- [Circle](classes/Circle.md) -- [Delaunator](classes/Delaunator.md) -- [Evented](classes/Evented.md) -- [Geometry](classes/Geometry.md) -- [GeometryCollection](classes/GeometryCollection.md) -- [Grid](classes/Grid.md) -- [LineString](classes/LineString.md) -- [MultiLineString](classes/MultiLineString.md) -- [MultiPoint](classes/MultiPoint.md) -- [MultiPolygon](classes/MultiPolygon.md) -- [Point](classes/Point.md) -- [Polygon](classes/Polygon.md) -- [PriorityQueue](classes/PriorityQueue.md) -- [QuadTree](classes/QuadTree.md) -- [Queue](classes/Queue.md) -- [Voronoi](classes/Voronoi.md) - -## Interfaces - -- [CRS](interfaces/CRS.md) -- [customRange](interfaces/customRange.md) -- [GeoJSONFeature](interfaces/GeoJSONFeature.md) -- [GeoJSONFeatureCollection](interfaces/GeoJSONFeatureCollection.md) -- [GeoJSONGeometry](interfaces/GeoJSONGeometry.md) -- [GeoJSONGeometryCollection](interfaces/GeoJSONGeometryCollection.md) -- [GeoJSONLineString](interfaces/GeoJSONLineString.md) -- [GeoJSONMultiLineString](interfaces/GeoJSONMultiLineString.md) -- [GeoJSONMultiPoint](interfaces/GeoJSONMultiPoint.md) -- [GeoJSONMultiPolygon](interfaces/GeoJSONMultiPolygon.md) -- [GeoJSONPoint](interfaces/GeoJSONPoint.md) -- [GeoJSONPolygon](interfaces/GeoJSONPolygon.md) -- [Graph](interfaces/Graph.md) -- [GridGraph](interfaces/GridGraph.md) -- [Projection](interfaces/Projection.md) -- [Transform](interfaces/Transform.md) - -## Type Aliases - -- [AreaUnits](type-aliases/AreaUnits.md) -- [Complex](type-aliases/Complex.md) -- [gridValueStrategy](type-aliases/gridValueStrategy.md) -- [MBR](type-aliases/MBR.md) -- [QTNode](type-aliases/QTNode.md) -- [Rectangle](type-aliases/Rectangle.md) -- [Units](type-aliases/Units.md) - -## Variables - -- [areaFactors](variables/areaFactors.md) -- [CountourColorList](variables/CountourColorList.md) -- [D2R](variables/D2R.md) -- [Earth](variables/Earth.md) -- [earthRadius](variables/earthRadius.md) -- [EPSG3857](variables/EPSG3857.md) -- [EPSG900913](variables/EPSG900913.md) -- [EPSLN](variables/EPSLN.md) -- [factors](variables/factors.md) -- [factors2](variables/factors2.md) -- [halfPi](variables/halfPi.md) -- [pi](variables/pi.md) -- [R2D](variables/R2D.md) -- [SphericalMercator](variables/SphericalMercator.md) - -## Functions - -- [acos](functions/acos.md) -- [add](functions/add.md) -- [adjust\_lon](functions/adjust_lon.md) -- [alphaComplex](functions/alphaComplex.md) -- [applyMixins](functions/applyMixins.md) -- [areaToArea](functions/areaToArea.md) -- [asin](functions/asin.md) -- [atan2](functions/atan2.md) -- [bearing](functions/bearing.md) -- [binarization](functions/binarization.md) -- [binaryColorBand](functions/binaryColorBand.md) -- [binDrawGrid2d](functions/binDrawGrid2d.md) -- [breadthFirstSearch](functions/breadthFirstSearch.md) -- [calculateArrayShape](functions/calculateArrayShape.md) -- [calculateMBR](functions/calculateMBR.md) -- [cartesian](functions/cartesian.md) -- [cartesianAdd](functions/cartesianAdd.md) -- [cartesianAddInPlace](functions/cartesianAddInPlace.md) -- [cartesianAngle](functions/cartesianAngle.md) -- [cartesianCross](functions/cartesianCross.md) -- [cartesianDot](functions/cartesianDot.md) -- [cartesianNormalize](functions/cartesianNormalize.md) -- [cartesianNormalizeInPlace](functions/cartesianNormalizeInPlace.md) -- [cartesianScale](functions/cartesianScale.md) -- [ccw](functions/ccw.md) -- [ccwRobust](functions/ccwRobust.md) -- [collectionFromFeature](functions/collectionFromFeature.md) -- [collectionFromGeometry](functions/collectionFromGeometry.md) -- [complateMap](functions/complateMap.md) -- [concatEL2DArray](functions/concatEL2DArray.md) -- [conj](functions/conj.md) -- [containsMBR](functions/containsMBR.md) -- [convexHull](functions/convexHull.md) -- [cos](functions/cos.md) -- [createGraph](functions/createGraph.md) -- [createGridGraph](functions/createGridGraph.md) -- [cross](functions/cross.md) -- [cutPolygonByMBR](functions/cutPolygonByMBR.md) -- [dampedSin3D](functions/dampedSin3D.md) -- [degreesToRadians](functions/degreesToRadians.md) -- [degToDMS](functions/degToDMS.md) -- [deMaxMin](functions/deMaxMin.md) -- [destination](functions/destination.md) -- [dijkstra](functions/dijkstra.md) -- [dmsToDeg](functions/dmsToDeg.md) -- [dot](functions/dot.md) -- [drawArrowField](functions/drawArrowField.md) -- [drawCountour](functions/drawCountour.md) -- [drawGrid2d](functions/drawGrid2d.md) -- [drawProgress](functions/drawProgress.md) -- [drawQTree2d](functions/drawQTree2d.md) -- [drawSample](functions/drawSample.md) -- [drawSample2](functions/drawSample2.md) -- [drawText](functions/drawText.md) -- [drawTrueColorGrid2d](functions/drawTrueColorGrid2d.md) -- [emptyObj](functions/emptyObj.md) -- [equals](functions/equals.md) -- [equalsMBR](functions/equalsMBR.md) -- [extend](functions/extend.md) -- [fastFFT2](functions/fastFFT2.md) -- [feature](functions/feature.md) -- [FFT](functions/FFT.md) -- [FFT2](functions/FFT2.md) -- [FFTImag](functions/FFTImag.md) -- [FFTImag2](functions/FFTImag2.md) -- [FFTReal](functions/FFTReal.md) -- [FFTReal2](functions/FFTReal2.md) -- [FFTShift](functions/FFTShift.md) -- [fillIndexArray](functions/fillIndexArray.md) -- [flattenArray](functions/flattenArray.md) -- [formatNum](functions/formatNum.md) -- [fromFeatureObj](functions/fromFeatureObj.md) -- [fromGeometryObj](functions/fromGeometryObj.md) -- [getAngle](functions/getAngle.md) -- [getMBRWithAntimeridian](functions/getMBRWithAntimeridian.md) -- [getPointsMBR](functions/getPointsMBR.md) -- [gridAstar](functions/gridAstar.md) -- [gridBreadthFirstSearch](functions/gridBreadthFirstSearch.md) -- [gridDijkstra](functions/gridDijkstra.md) -- [gridReconstructPath](functions/gridReconstructPath.md) -- [haversin](functions/haversin.md) -- [haversine](functions/haversine.md) -- [hist](functions/hist.md) -- [IFFT](functions/IFFT.md) -- [IFFT2](functions/IFFT2.md) -- [IFFTReal](functions/IFFTReal.md) -- [IFFTReal2](functions/IFFTReal2.md) -- [inCircle](functions/inCircle.md) -- [inCircleRobust](functions/inCircleRobust.md) -- [intermediatePoint](functions/intermediatePoint.md) -- [interpolate](functions/interpolate.md) -- [interpolate2](functions/interpolate2.md) -- [intersection](functions/intersection.md) -- [intersectionPolygon](functions/intersectionPolygon.md) -- [intersectsMBR](functions/intersectsMBR.md) -- [isEPSG3857](functions/isEPSG3857.md) -- [isEPSG4326](functions/isEPSG4326.md) -- [isFloat](functions/isFloat.md) -- [isPotentialGeoObject](functions/isPotentialGeoObject.md) -- [iterPolygonEdge](functions/iterPolygonEdge.md) -- [K\_means](functions/K_means.md) -- [lengthToRadians](functions/lengthToRadians.md) -- [MBR2Plane](functions/MBR2Plane.md) -- [mbrToPolygon](functions/mbrToPolygon.md) -- [mbrToRectangle](functions/mbrToRectangle.md) -- [merge](functions/merge.md) -- [mergeArcs](functions/mergeArcs.md) -- [mergeMBR](functions/mergeMBR.md) -- [mergePointMBR](functions/mergePointMBR.md) -- [mesh](functions/mesh.md) -- [meshArcs](functions/meshArcs.md) -- [metersTo](functions/metersTo.md) -- [midpoint](functions/midpoint.md) -- [neighbors](functions/neighbors.md) -- [normalize](functions/normalize.md) -- [object](functions/object.md) -- [overlapsMBR](functions/overlapsMBR.md) -- [Perlin](functions/Perlin.md) -- [plane2MBR](functions/plane2MBR.md) -- [planeIntersection](functions/planeIntersection.md) -- [planePolygonArea](functions/planePolygonArea.md) -- [pointInEdge](functions/pointInEdge.md) -- [pointInMBR](functions/pointInMBR.md) -- [pointInMBRWithAntimeridian](functions/pointInMBRWithAntimeridian.md) -- [PointInsidePolygon](functions/PointInsidePolygon.md) -- [PointOutsideMBR](functions/PointOutsideMBR.md) -- [prePointInPolygon](functions/prePointInPolygon.md) -- [pseudoColorBandFactory](functions/pseudoColorBandFactory.md) -- [radiansToDegrees](functions/radiansToDegrees.md) -- [radiansToLength](functions/radiansToLength.md) -- [randomIndexArray](functions/randomIndexArray.md) -- [reactGrid2d](functions/reactGrid2d.md) -- [reconstructPath](functions/reconstructPath.md) -- [rectangleToMBR](functions/rectangleToMBR.md) -- [reverse](functions/reverse.md) -- [round](functions/round.md) -- [sample](functions/sample.md) -- [scale](functions/scale.md) -- [sign](functions/sign.md) -- [simpleColorBand](functions/simpleColorBand.md) -- [simpleColorBandFactory](functions/simpleColorBandFactory.md) -- [simplePseudoColorBand](functions/simplePseudoColorBand.md) -- [sin](functions/sin.md) -- [Sin3D](functions/Sin3D.md) -- [sphereIntersection](functions/sphereIntersection.md) -- [spherical](functions/spherical.md) -- [sphericalArea](functions/sphericalArea.md) -- [splitMBRWithAntimeridian](functions/splitMBRWithAntimeridian.md) -- [sqrt](functions/sqrt.md) -- [squareMetersTo](functions/squareMetersTo.md) -- [subColumnInEL2DArray](functions/subColumnInEL2DArray.md) -- [subdivide2QTree](functions/subdivide2QTree.md) -- [testProgress](functions/testProgress.md) -- [throttle](functions/throttle.md) -- [toLineString](functions/toLineString.md) -- [toMeters](functions/toMeters.md) -- [toMultiPoint](functions/toMultiPoint.md) -- [toPoint](functions/toPoint.md) -- [topology](functions/topology.md) -- [toSquareMeters](functions/toSquareMeters.md) -- [transform](functions/transform.md) -- [triangleCenter](functions/triangleCenter.md) -- [trueColorBand](functions/trueColorBand.md) -- [trueColorBandFactory](functions/trueColorBandFactory.md) -- [unitToUnit](functions/unitToUnit.md) -- [untransform](functions/untransform.md) -- [UUID](functions/UUID.md) -- [worleyNoise](functions/worleyNoise.md) -- [XY2ColRow](functions/XY2ColRow.md) -- [zebraNoise](functions/zebraNoise.md) diff --git a/docs/api/index.md b/docs/api/index.md new file mode 100644 index 0000000..f22e61f --- /dev/null +++ b/docs/api/index.md @@ -0,0 +1,256 @@ +# API Reference + +## Enumerations + +| Enumeration | Description | +| ------ | ------ | +| [colorListType](enumerations/colorListType.md) | - | +| [stretchType](enumerations/stretchType.md) | - | + +## Classes + +| Class | Description | +| ------ | ------ | +| [Circle](classes/Circle.md) | 平面图形：圆形 | +| [Delaunator](classes/Delaunator.md) | - | +| [Evented](classes/Evented.md) | 事件基础函数（类，默认构造函数） - 维护两个事件监听器队列（同步、异步） - 提供事件监听、移除、触发等方法 - 提供一次性事件监听 - 提供获取指定事件类型的监听器 - 提供判断是否存在指定事件类型的监听器 > 参考 [Leaflet 的事件机制设计](https://github.com/Leaflet/Leaflet/blob/80a42768306c8c2f9f1bd1eb48d529ffcac3072f/src/core/Events.js#L29) | +| [Geometry](classes/Geometry.md) | Geometry for GeoJSON independent Objects including Point, LineString, Polygon - no GeometryCollection - no MultiPoint, MultiLineString, MultiPolygon | +| [GeometryCollection](classes/GeometryCollection.md) | - | +| [Grid](classes/Grid.md) | 网格类（本质是三维数组）: - 三维数组的每一层代表一个波段 - 其中一层为一个二维数组，代表一个波段的值，并与对应的 MBR 对象关联用于挂接地图上的位置 - MBR 统一使用 `WGS84` 坐标系 | +| [LineString](classes/LineString.md) | Geometry for GeoJSON independent Objects including Point, LineString, Polygon - no GeometryCollection - no MultiPoint, MultiLineString, MultiPolygon | +| [MultiLineString](classes/MultiLineString.md) | - | +| [MultiPoint](classes/MultiPoint.md) | - | +| [MultiPolygon](classes/MultiPolygon.md) | - | +| [Point](classes/Point.md) | Point geometry | +| [Polygon](classes/Polygon.md) | Geometry for GeoJSON independent Objects including Point, LineString, Polygon - no GeometryCollection - no MultiPoint, MultiLineString, MultiPolygon | +| [PriorityQueue](classes/PriorityQueue.md) | - | +| [QuadTree](classes/QuadTree.md) | - | +| [Queue](classes/Queue.md) | - | +| [Voronoi](classes/Voronoi.md) | - | + +## Interfaces + +| Interface | Description | +| ------ | ------ | +| [CRS](interfaces/CRS.md) | - | +| [customRange](interfaces/customRange.md) | impliment customRange to support custom range query - make sure your customRange object has correct intersects and contains function - note: - the boundary of customRange is the boundary of QuadTree - the point of customRange is the point of QuadTree | +| [GeoJSONFeature](interfaces/GeoJSONFeature.md) | - | +| [GeoJSONFeatureCollection](interfaces/GeoJSONFeatureCollection.md) | - | +| [GeoJSONGeometry](interfaces/GeoJSONGeometry.md) | - | +| [GeoJSONGeometryCollection](interfaces/GeoJSONGeometryCollection.md) | - | +| [GeoJSONLineString](interfaces/GeoJSONLineString.md) | - | +| [GeoJSONMultiLineString](interfaces/GeoJSONMultiLineString.md) | - | +| [GeoJSONMultiPoint](interfaces/GeoJSONMultiPoint.md) | - | +| [GeoJSONMultiPolygon](interfaces/GeoJSONMultiPolygon.md) | - | +| [GeoJSONPoint](interfaces/GeoJSONPoint.md) | - | +| [GeoJSONPolygon](interfaces/GeoJSONPolygon.md) | - | +| [Graph](interfaces/Graph.md) | 数据结构： 图（由节点和边组成） | +| [GridGraph](interfaces/GridGraph.md) | 二维数组转换为图 | +| [Projection](interfaces/Projection.md) | - | +| [Transform](interfaces/Transform.md) | - | + +## Type Aliases + +| Type alias | Description | +| ------ | ------ | +| [AreaUnits](type-aliases/AreaUnits.md) | - | +| [Complex](type-aliases/Complex.md) | 复数类型 | +| [gridValueStrategy](type-aliases/gridValueStrategy.md) | - | +| [MBR](type-aliases/MBR.md) | - MBR 中的 minX, minY, maxX, maxY 的排序在某些情况下会有歧义，尤其是在地理坐标系的语境下。（譬如跨越了反子午圈的情况（斐济群岛）） - 所以允许 minX > maxX 遇到这样的情况时，需要进行特殊处理。 | +| [QTNode](type-aliases/QTNode.md) | 由网格数据生成四叉树(节点) | +| [Rectangle](type-aliases/Rectangle.md) | - Rectangle is a rectangle that bounds a set of points. | +| [Units](type-aliases/Units.md) | - | + +## Variables + +| Variable | Description | +| ------ | ------ | +| [areaFactors](variables/areaFactors.md) | - Area of measurement factors based on 1 square meter. - 单位换算关系，以1平方米为基准。 | +| [CountourColorList](variables/CountourColorList.md) | - | +| [D2R](variables/D2R.md) | D2R usage: 角度转弧度 - PI / 180 | +| [Earth](variables/Earth.md) | - | +| [earthRadius](variables/earthRadius.md) | - | +| [EPSG3857](variables/EPSG3857.md) | EPSG:3857 | +| [EPSG900913](variables/EPSG900913.md) | EPSG:900913 | +| [EPSLN](variables/EPSLN.md) | - | +| [factors](variables/factors.md) | - Unit of measurement factors using a spherical (non-ellipsoid) earth radius. | +| [factors2](variables/factors2.md) | - Unit of measurement factors based on 1 meter. - 单位换算关系，以1米为基准。 | +| [halfPi](variables/halfPi.md) | - | +| [pi](variables/pi.md) | - | +| [R2D](variables/R2D.md) | R2D usage: 弧度转角度 - 180 / PI | +| [SphericalMercator](variables/SphericalMercator.md) | - | + +## Functions + +| Function | Description | +| ------ | ------ | +| [acos](functions/acos.md) | - | +| [add](functions/add.md) | 计算两个二维笛卡尔坐标系下的向量 a 和 b 的和，返回一个新的向量。 This function adds two 2D Cartesian vectors a and b, returning a new vector representing the sum. | +| [adjust\_lon](functions/adjust_lon.md) | - Adjust longitude to [-180, 180] - 将超过 360 的经度调整为[-180, 180] | +| [alphaComplex](functions/alphaComplex.md) | Alpha Complex 算法 - Alpha shapes are a generalization of Delaunay triangulations. - Given a parameter alpha and a point set, they compute a simplicial complex which covers the point set in simplices whose circum radii are less than 1/alpha. | +| [applyMixins](functions/applyMixins.md) | Apply mixins to a class | +| [areaToArea](functions/areaToArea.md) | - 面积单位内互相转换 - Convert area units to each other | +| [asin](functions/asin.md) | - | +| [atan2](functions/atan2.md) | Returns the angle (in radians) from the X axis to a point. | +| [bearing](functions/bearing.md) | - | +| [binarization](functions/binarization.md) | 二值化网格数据，返回二值化后的网格数据 | +| [binaryColorBand](functions/binaryColorBand.md) | - | +| [binDrawGrid2d](functions/binDrawGrid2d.md) | - | +| [breadthFirstSearch](functions/breadthFirstSearch.md) | - | +| [calculateArrayShape](functions/calculateArrayShape.md) | 计算数组的形状 | +| [calculateMBR](functions/calculateMBR.md) | 计算多边形的 MBR | +| [cartesian](functions/cartesian.md) | 将球坐标系下的向量 [longitude, latitude]（弧度制）转换为三维笛卡尔坐标系下的向量 [x, y, z]。 - This function takes spherical coordinates [longitude, latitude] and converts them to a 3D Cartesian vector [x, y, z]. | +| [cartesianAdd](functions/cartesianAdd.md) | 计算两个三维笛卡尔坐标系下的向量 a 和 b 的和，返回一个新的向量。 This function adds two 3D Cartesian vectors a and b, returning a new vector representing the sum. | +| [cartesianAddInPlace](functions/cartesianAddInPlace.md) | 计算两个三维笛卡尔坐标系下的向量 a 和 b 的和，将结果存储在 a 中。 This function adds two 3D Cartesian vectors a and b, modifying a in-place to store the result. (Note: This function is incomplete as it doesn't return the sum) | +| [cartesianAngle](functions/cartesianAngle.md) | 计算两个三维笛卡尔坐标系下的向量 a 和 b 的夹角。 This function calculates the angle between two 3D Cartesian vectors a and b. | +| [cartesianCross](functions/cartesianCross.md) | 计算两个三维笛卡尔坐标系下的向量 a 和 b 的叉积。 This function calculates the cross product of two 3D Cartesian vectors a and b. | +| [cartesianDot](functions/cartesianDot.md) | 计算两个三维笛卡尔坐标系下的向量 a 和 b 的点积。 This function calculates the dot product of two 3D Cartesian vectors a and b. | +| [cartesianNormalize](functions/cartesianNormalize.md) | 归一化三维笛卡尔坐标系下的向量 d，返回一个新的单位向量。 This function normalizes a 3D Cartesian vector d, returning a new unit vector. | +| [cartesianNormalizeInPlace](functions/cartesianNormalizeInPlace.md) | 归一化三维笛卡尔坐标系下的向量 d，将 d 修改为指向相同方向的单位向量。 This function normalizes a 3D Cartesian vector d in-place, modifying d to represent a unit vector pointing in the same direction. (Note: This function is incomplete and requires implementing square root calculation) | +| [cartesianScale](functions/cartesianScale.md) | 使用因子 k 缩放三维笛卡尔坐标系下的向量 vector，返回一个新的缩放后的向量。 This function scales a 3D Cartesian vector vector by a factor k, returning a new scaled vector. | +| [ccw](functions/ccw.md) | Counter-clockwise (not robust version) ccw 算法的非鲁棒版本 - Returns 1 if three points make a counter-clockwise turn - 逆时针返回 1 - Returns -1 if three points make a clockwise turn - 顺时针返回 -1 - Returns 0 if three points are collinear - 共线返回 0 | +| [ccwRobust](functions/ccwRobust.md) | robust version of ccw 封装了 robust-predicates 库的 orient2d 函数 - `Note:` unlike J. Shewchuk's original code, `all the functions in this library assume y axis is oriented downwards ↓`, so the semantics are different. - `注意:` 与 J. Shewchuk 的原始代码不同，`本库中的所有函数都假设 y 轴向下 ↓`，因此语义不同。刚好与 ccw 相反。 - Returns 1 if three points make a counter-clockwise turn - 逆时针返回 1 - Returns -1 if three points make a clockwise turn - 顺时针返回 -1 - Returns 0 if three points are collinear - 共线返回 0 | +| [collectionFromFeature](functions/collectionFromFeature.md) | Factory function for creating geometryCollection objects from GeoJSON Feature objects | +| [collectionFromGeometry](functions/collectionFromGeometry.md) | Factory function for creating geometryCollection objects from GeoJSON Geometry objects | +| [complateMap](functions/complateMap.md) | - | +| [concatEL2DArray](functions/concatEL2DArray.md) | 拼接等长二维数组 | +| [conj](functions/conj.md) | 复数共轭 - complex conjugate | +| [containsMBR](functions/containsMBR.md) | - | +| [convexHull](functions/convexHull.md) | 凸包算法 | +| [cos](functions/cos.md) | Returns the cosine of a number. | +| [createGraph](functions/createGraph.md) | 创建图 | +| [createGridGraph](functions/createGridGraph.md) | - | +| [cross](functions/cross.md) | 计算两个二维笛卡尔坐标系下的向量 a 和 b 的叉积。 This function calculates the cross product of two 2D Cartesian vectors a and b. | +| [cutPolygonByMBR](functions/cutPolygonByMBR.md) | 使用 MBR 裁剪多边形 | +| [dampedSin3D](functions/dampedSin3D.md) | https://en.m.wikipedia.org/wiki/Damping#Damped_sine_wave | +| [degreesToRadians](functions/degreesToRadians.md) | - Converts an angle in degrees to radians - 将角度转换为弧度 | +| [degToDMS](functions/degToDMS.md) | - | +| [deMaxMin](functions/deMaxMin.md) | 去除最大最小值 | +| [destination](functions/destination.md) | Given a start point, initial bearing, and distance, - this will calculate the destina­tion point and final bearing travelling along a (shortest distance) great circle arc. | +| [dijkstra](functions/dijkstra.md) | - | +| [dmsToDeg](functions/dmsToDeg.md) | - | +| [dot](functions/dot.md) | 计算两个二维笛卡尔坐标系下的向量 a 和 b 的点积。 This function calculates the dot product of two 2D Cartesian vectors a and b. | +| [drawArrowField](functions/drawArrowField.md) | 绘制箭头场，默认为起点为当前格子的中心 | +| [drawCountour](functions/drawCountour.md) | - | +| [drawGrid2d](functions/drawGrid2d.md) | - | +| [drawProgress](functions/drawProgress.md) | 绘制进度条 | +| [drawQTree2d](functions/drawQTree2d.md) | 绘制四叉树 | +| [drawSample](functions/drawSample.md) | - | +| [drawSample2](functions/drawSample2.md) | - | +| [drawText](functions/drawText.md) | - | +| [drawTrueColorGrid2d](functions/drawTrueColorGrid2d.md) | - | +| [emptyObj](functions/emptyObj.md) | 释放对象 | +| [equals](functions/equals.md) | deep compare two arrays(1D) | +| [equalsMBR](functions/equalsMBR.md) | - | +| [extend](functions/extend.md) | Merge the properties | +| [fastFFT2](functions/fastFFT2.md) | 快速傅里叶变换 real to complex - 先对每一行进行傅里叶变换，再对每一列进行傅里叶变换，最后中心化 | +| [feature](functions/feature.md) | - | +| [FFT](functions/FFT.md) | 快速傅里叶变换 real to complex | +| [FFT2](functions/FFT2.md) | - | +| [FFTImag](functions/FFTImag.md) | 获取傅里叶变换结果的振幅 | +| [FFTImag2](functions/FFTImag2.md) | - | +| [FFTReal](functions/FFTReal.md) | 获取傅里叶变换结果的振幅 | +| [FFTReal2](functions/FFTReal2.md) | - | +| [FFTShift](functions/FFTShift.md) | - | +| [fillIndexArray](functions/fillIndexArray.md) | - 根据 indexArray 中存储的索引 从 fillArray 中取出对应的元素并填充到 indexArray 中 - fill indexArray with elements from fillArray according to the index stored in indexArray - `注意`： indexArray 的形状未知 但是 fillArray 不论形状如何始终视为一维数组 - Note: the shape of indexArray is unknown, but fillArray is always regarded as a one-dimensional array regardless of its shape | +| [flattenArray](functions/flattenArray.md) | - | +| [formatNum](functions/formatNum.md) | 这个函数的主要目的是将数字 num 四舍五入到指定的 precision 小数位。 | +| [fromFeatureObj](functions/fromFeatureObj.md) | Factory function for creating geometry objects from GeoJSON Feature objects - you can use this function to create inner geometry from Features - about Feature objects | +| [fromGeometryObj](functions/fromGeometryObj.md) | Factory function for creating geometry objects from GeoJSON Geometry objects - about Geometry objects | +| [getAngle](functions/getAngle.md) | - Returns the angle between two points - 返回两点之间的夹角 | +| [getMBRWithAntimeridian](functions/getMBRWithAntimeridian.md) | 计算多点的最小外包矩形（跨越反子午线的情况） - 会自动计算并选择面积最小的情况 - get MBR with antimeridian | +| [getPointsMBR](functions/getPointsMBR.md) | 计算多点的最小外包矩形（默认情况） | +| [gridAstar](functions/gridAstar.md) | - | +| [gridBreadthFirstSearch](functions/gridBreadthFirstSearch.md) | - | +| [gridDijkstra](functions/gridDijkstra.md) | - | +| [gridReconstructPath](functions/gridReconstructPath.md) | - | +| [haversin](functions/haversin.md) | - | +| [haversine](functions/haversine.md) | 使用 haversine 公式计算球面两点之间的距离 | +| [hist](functions/hist.md) | 直方图计算函数 | +| [IFFT](functions/IFFT.md) | 快速傅里叶逆变换 complex to real | +| [IFFT2](functions/IFFT2.md) | - | +| [IFFTReal](functions/IFFTReal.md) | 取 IFFT 结果的实部（也就是原函数值） | +| [IFFTReal2](functions/IFFTReal2.md) | - | +| [inCircle](functions/inCircle.md) | 快速计算最后一点与前三点组成的圆的关系 calculate the relative position of the last point to the circle formed by the first three points - Returns 1 if point d is outside the circle passing through a, b, and c - 返回 1 如果点 d 在通过 a、b 和 c 的圆外 - Returns -1 if point d is inside the circle - 返回 -1 如果点 d 在圆内 - Returns 0 if the four points are cocircular - 返回 0 如果四个点共圆 | +| [inCircleRobust](functions/inCircleRobust.md) | - | +| [intermediatePoint](functions/intermediatePoint.md) | An intermediate point at any fraction along the great circle path between two points | +| [interpolate](functions/interpolate.md) | 三维笛卡尔坐标系下的向量插值。 This function interpolates between two 3D Cartesian vectors a and b using a parameter t, returning the resulting vector. | +| [interpolate2](functions/interpolate2.md) | 二维笛卡尔坐标系下的向量插值。 This function interpolates between two 2D Cartesian vectors a and b using a parameter t, returning the resulting vector. | +| [intersection](functions/intersection.md) | （默认线段求交）内含投影的线段求交函数（计算开销大） | +| [intersectionPolygon](functions/intersectionPolygon.md) | 使用 Sutherland-Hodgman 算法计算多边形与多边形的交集 | +| [intersectsMBR](functions/intersectsMBR.md) | - | +| [isEPSG3857](functions/isEPSG3857.md) | - | +| [isEPSG4326](functions/isEPSG4326.md) | - | +| [isFloat](functions/isFloat.md) | 判断一个数字是否为浮点数 | +| [isPotentialGeoObject](functions/isPotentialGeoObject.md) | 判断一个 object 是否是(潜在的)地理对象（是否含有 X，Y 或者 lon，lat 或者 lng，lat 属性） | +| [iterPolygonEdge](functions/iterPolygonEdge.md) | 迭代访问多边形的边（不重复访问） | +| [K\_means](functions/K_means.md) | k均值聚类 | +| [lengthToRadians](functions/lengthToRadians.md) | - Convert a distance measurement (assuming a spherical Earth) from a real-world unit into radians - 将距离测量值（假设地球是球形的）从现实世界的单位转换为弧度 - Valid units: miles, nauticalmiles, inches, yards, meters, metres, kilometers, centimeters, feet - 有效单位：英里，海里，英寸，码，米，千米，厘米，英尺 | +| [MBR2Plane](functions/MBR2Plane.md) | default projection : SphericalMercator - you can change the projection by passing the second parameter | +| [mbrToPolygon](functions/mbrToPolygon.md) | 将 MBR 转化为 逆时针方向的（无孔）多边形数组 | +| [mbrToRectangle](functions/mbrToRectangle.md) | MBR 转换为 Rectangle | +| [merge](functions/merge.md) | - | +| [mergeArcs](functions/mergeArcs.md) | - | +| [mergeMBR](functions/mergeMBR.md) | - | +| [mergePointMBR](functions/mergePointMBR.md) | - | +| [mesh](functions/mesh.md) | - | +| [meshArcs](functions/meshArcs.md) | - | +| [metersTo](functions/metersTo.md) | - 将距离单位米转换为指定单位 - Convert distance units from meters to specified units | +| [midpoint](functions/midpoint.md) | - | +| [neighbors](functions/neighbors.md) | - | +| [normalize](functions/normalize.md) | 归一化二维笛卡尔坐标系下的向量 d，返回一个新的单位向量。 This function normalizes a 2D Cartesian vector d, returning a new unit vector. | +| [object](functions/object.md) | - | +| [overlapsMBR](functions/overlapsMBR.md) | - | +| [Perlin](functions/Perlin.md) | 2D [Perlin](https://en.wikipedia.org/wiki/Perlin_noise) 噪声 | +| [plane2MBR](functions/plane2MBR.md) | default projection : SphericalMercator - you can change the projection by passing the second parameter | +| [planeIntersection](functions/planeIntersection.md) | 也可以使用该函数计算两条线段的交点 - 现将经纬度坐标投影到平面坐标系下，然后计算交点，最后将交点投影回经纬度坐标系 - lonlats -- (projectionFrom) --> XYs -- (planeIntersection) --> XY -- (projectionTo) --> lonlat | +| [planePolygonArea](functions/planePolygonArea.md) | - 使用 Shoelace Theorem 求多边形面积 - calculate the area of a polygon using the Shoelace Theorem | +| [pointInEdge](functions/pointInEdge.md) | （前提：逆时针多边形的边）判断点是否在当前边的内部(也就是边前进方向的左侧) | +| [pointInMBR](functions/pointInMBR.md) | 判断点是否在 MBR 内（默认情况） | +| [pointInMBRWithAntimeridian](functions/pointInMBRWithAntimeridian.md) | 判断点是否在 MBR 内（跨越了反子午线的情况） - 必须保 MBR 真的跨越了反子午线，否则会出现错误 | +| [PointInsidePolygon](functions/PointInsidePolygon.md) | 判断点是否在简单多边形内部（平面与经纬度坐标通用，多边形边界算作在内） | +| [PointOutsideMBR](functions/PointOutsideMBR.md) | 判断点是否在 MBR 外（平面与经纬度坐标通用，多边形边界算作在内） determine if a point is outside of a MBR (polygon boundary is considered inside) | +| [prePointInPolygon](functions/prePointInPolygon.md) | 返回多边形中 输入索引的前一个点的索引 多边形闭合并按照逆时针方向排列 | +| [pseudoColorBandFactory](functions/pseudoColorBandFactory.md) | 伪彩色带渲染工厂函数 | +| [radiansToDegrees](functions/radiansToDegrees.md) | - Converts an angle in radians to degrees | +| [radiansToLength](functions/radiansToLength.md) | - Convert a distance measurement (assuming a spherical Earth) from radians to a more friendly unit. - 将距离测量值（假设地球是球形的）从弧度转换为更友好的单位。 - Valid units: miles, nauticalmiles, inches, yards, meters, metres, kilometers, centimeters, feet - 有效单位：英里，海里，英寸，码，米，千米，厘米，英尺 | +| [randomIndexArray](functions/randomIndexArray.md) | 生成随机索引数组（不重复） | +| [reactGrid2d](functions/reactGrid2d.md) | - | +| [reconstructPath](functions/reconstructPath.md) | - | +| [rectangleToMBR](functions/rectangleToMBR.md) | Rectangle 转换为 MBR | +| [reverse](functions/reverse.md) | - | +| [round](functions/round.md) | - Round number to precision - 将数字四舍五入到指定精度 | +| [sample](functions/sample.md) | 采样函数 | +| [scale](functions/scale.md) | 使用因子 k 缩放二维笛卡尔坐标系下的向量 vector，返回一个新的缩放后的向量。 This function scales a 2D Cartesian vector vector by a factor k, returning a new scaled vector. | +| [sign](functions/sign.md) | - Returns the sign of the input, or zero - 返回输入的符号，或零 | +| [simpleColorBand](functions/simpleColorBand.md) | 连续单波段单色带渲染（灰色） | +| [simpleColorBandFactory](functions/simpleColorBandFactory.md) | - | +| [simplePseudoColorBand](functions/simplePseudoColorBand.md) | 简单离散值颜色计算函数 - 离散值范围为整数 - 默认与色带索引一一对应 | +| [sin](functions/sin.md) | Returns the sine of a number. | +| [Sin3D](functions/Sin3D.md) | - | +| [sphereIntersection](functions/sphereIntersection.md) | 求解两条球面线段的交点 - Given two lines on a sphere, this will return their intersection point. | +| [spherical](functions/spherical.md) | 将三维笛卡尔坐标系下的向量 [x, y, z] 转换为球坐标系下的向量 [lat, lon]（弧度制）。 This function takes a 3D Cartesian vector [x, y, z] and converts it to spherical coordinates [lat, lon]. | +| [sphericalArea](functions/sphericalArea.md) | - | +| [splitMBRWithAntimeridian](functions/splitMBRWithAntimeridian.md) | 将单个跨越了反子午线的 MBR 分割成两个简单的 MBR | +| [sqrt](functions/sqrt.md) | Returns the square root of a number. | +| [squareMetersTo](functions/squareMetersTo.md) | - 将面积单位平方米转换为指定单位 - Convert area units from square meters to specified units | +| [subColumnInEL2DArray](functions/subColumnInEL2DArray.md) | 抽取二维数组的某一列（或某几列） | +| [subdivide2QTree](functions/subdivide2QTree.md) | （简易四叉树）创建一个 gridMBR 层面的四叉树 | +| [testProgress](functions/testProgress.md) | - | +| [throttle](functions/throttle.md) | 节流函数 | +| [toLineString](functions/toLineString.md) | - | +| [toMeters](functions/toMeters.md) | - 将距离单位转换为米 - Convert distance units to meters | +| [toMultiPoint](functions/toMultiPoint.md) | - | +| [toPoint](functions/toPoint.md) | the factory function to create a Point(the following ways are equivalent) | +| [topology](functions/topology.md) | - | +| [toSquareMeters](functions/toSquareMeters.md) | - 将面积单位转换为平方米 - Convert area units to square meters | +| [transform](functions/transform.md) | - | +| [triangleCenter](functions/triangleCenter.md) | 计算三角形的外心（对于 Delauany 三角剖分的结果数组） | +| [trueColorBand](functions/trueColorBand.md) | 真彩色带渲染 | +| [trueColorBandFactory](functions/trueColorBandFactory.md) | 真彩色带渲染工厂函数 | +| [unitToUnit](functions/unitToUnit.md) | - 距离单位内互相转换 - Convert distance units to each other | +| [untransform](functions/untransform.md) | - | +| [UUID](functions/UUID.md) | 生成UUID | +| [worleyNoise](functions/worleyNoise.md) | 生成 Worley 噪声距离场 | +| [XY2ColRow](functions/XY2ColRow.md) | 将屏幕像素坐标转化为对应的行列号 | +| [zebraNoise](functions/zebraNoise.md) | 生成 条纹 噪声，可选水平或垂直 | diff --git a/docs/api/interfaces/CRS.md b/docs/api/interfaces/CRS.md index 8b3c31e..0025a18 100644 --- a/docs/api/interfaces/CRS.md +++ b/docs/api/interfaces/CRS.md @@ -1,20 +1,18 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / CRS -*** - -[rvgeo](../globals.md) / CRS - -# Interface: CRS +# CRS -Defined in: src/geo/crs/base.ts:3 +Defined in: [src/geo/crs/base.ts:3](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geo/crs/base.ts#L3) ## Properties ### area()? -> `optional` **area**: (`latlngs`) => `number` +```ts +optional area: (latlngs) => number; +``` -Defined in: src/geo/crs/base.ts:6 +Defined in: [src/geo/crs/base.ts:6](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geo/crs/base.ts#L6) #### Parameters @@ -30,17 +28,21 @@ Defined in: src/geo/crs/base.ts:6 ### code? -> `optional` **code**: `string` +```ts +optional code: string; +``` -Defined in: src/geo/crs/base.ts:8 +Defined in: [src/geo/crs/base.ts:8](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geo/crs/base.ts#L8) *** ### distance() -> **distance**: (`latlng1`, `latlng2`) => `number` +```ts +distance: (latlng1, latlng2) => number; +``` -Defined in: src/geo/crs/base.ts:5 +Defined in: [src/geo/crs/base.ts:5](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geo/crs/base.ts#L5) #### Parameters @@ -60,9 +62,11 @@ Defined in: src/geo/crs/base.ts:5 ### planeArea()? -> `optional` **planeArea**: (`latlngs`) => `number` +```ts +optional planeArea: (latlngs) => number; +``` -Defined in: src/geo/crs/base.ts:7 +Defined in: [src/geo/crs/base.ts:7](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geo/crs/base.ts#L7) #### Parameters @@ -78,30 +82,38 @@ Defined in: src/geo/crs/base.ts:7 ### projection -> **projection**: `null` \| [`Projection`](Projection.md) +```ts +projection: null | Projection; +``` -Defined in: src/geo/crs/base.ts:4 +Defined in: [src/geo/crs/base.ts:4](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geo/crs/base.ts#L4) *** ### R -> **R**: `number` +```ts +R: number; +``` -Defined in: src/geo/crs/base.ts:9 +Defined in: [src/geo/crs/base.ts:9](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geo/crs/base.ts#L9) *** ### wrapLat? -> `optional` **wrapLat**: \[`number`, `number`\] +```ts +optional wrapLat: [number, number]; +``` -Defined in: src/geo/crs/base.ts:11 +Defined in: [src/geo/crs/base.ts:11](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geo/crs/base.ts#L11) *** ### wrapLng? -> `optional` **wrapLng**: \[`number`, `number`\] +```ts +optional wrapLng: [number, number]; +``` -Defined in: src/geo/crs/base.ts:10 +Defined in: [src/geo/crs/base.ts:10](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geo/crs/base.ts#L10) diff --git a/docs/api/interfaces/GeoJSONFeature.md b/docs/api/interfaces/GeoJSONFeature.md index 3be35ba..aa6c94c 100644 --- a/docs/api/interfaces/GeoJSONFeature.md +++ b/docs/api/interfaces/GeoJSONFeature.md @@ -1,49 +1,57 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / GeoJSONFeature -*** - -[rvgeo](../globals.md) / GeoJSONFeature - -# Interface: GeoJSONFeature +# GeoJSONFeature -Defined in: src/geometry/GeoJSON.ts:55 +Defined in: [src/geometry/GeoJSON.ts:55](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L55) ## Properties ### bbox? -> `optional` **bbox**: [`MBR`](../type-aliases/MBR.md) +```ts +optional bbox: MBR; +``` -Defined in: src/geometry/GeoJSON.ts:59 +Defined in: [src/geometry/GeoJSON.ts:59](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L59) *** ### geometry -> **geometry**: [`GeoJSONGeometry`](GeoJSONGeometry.md) \| [`GeoJSONGeometryCollection`](GeoJSONGeometryCollection.md) +```ts +geometry: + | GeoJSONGeometry + | GeoJSONGeometryCollection; +``` -Defined in: src/geometry/GeoJSON.ts:57 +Defined in: [src/geometry/GeoJSON.ts:57](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L57) *** ### id? -> `optional` **id**: `string` \| `number` +```ts +optional id: string | number; +``` -Defined in: src/geometry/GeoJSON.ts:60 +Defined in: [src/geometry/GeoJSON.ts:60](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L60) *** ### properties -> **properties**: `any` +```ts +properties: any; +``` -Defined in: src/geometry/GeoJSON.ts:58 +Defined in: [src/geometry/GeoJSON.ts:58](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L58) *** ### type -> **type**: `"Feature"` +```ts +type: "Feature"; +``` -Defined in: src/geometry/GeoJSON.ts:56 +Defined in: [src/geometry/GeoJSON.ts:56](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L56) diff --git a/docs/api/interfaces/GeoJSONFeatureCollection.md b/docs/api/interfaces/GeoJSONFeatureCollection.md index 02f4831..b2dbbf5 100644 --- a/docs/api/interfaces/GeoJSONFeatureCollection.md +++ b/docs/api/interfaces/GeoJSONFeatureCollection.md @@ -1,33 +1,35 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / GeoJSONFeatureCollection -*** - -[rvgeo](../globals.md) / GeoJSONFeatureCollection - -# Interface: GeoJSONFeatureCollection +# GeoJSONFeatureCollection -Defined in: src/geometry/GeoJSON.ts:64 +Defined in: [src/geometry/GeoJSON.ts:64](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L64) ## Properties ### bbox? -> `optional` **bbox**: [`MBR`](../type-aliases/MBR.md) +```ts +optional bbox: MBR; +``` -Defined in: src/geometry/GeoJSON.ts:67 +Defined in: [src/geometry/GeoJSON.ts:67](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L67) *** ### features -> **features**: [`GeoJSONFeature`](GeoJSONFeature.md)[] +```ts +features: GeoJSONFeature[]; +``` -Defined in: src/geometry/GeoJSON.ts:66 +Defined in: [src/geometry/GeoJSON.ts:66](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L66) *** ### type -> **type**: `"FeatureCollection"` +```ts +type: "FeatureCollection"; +``` -Defined in: src/geometry/GeoJSON.ts:65 +Defined in: [src/geometry/GeoJSON.ts:65](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L65) diff --git a/docs/api/interfaces/GeoJSONGeometry.md b/docs/api/interfaces/GeoJSONGeometry.md index 6900a0c..8c66537 100644 --- a/docs/api/interfaces/GeoJSONGeometry.md +++ b/docs/api/interfaces/GeoJSONGeometry.md @@ -1,12 +1,8 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / GeoJSONGeometry -*** - -[rvgeo](../globals.md) / GeoJSONGeometry - -# Interface: GeoJSONGeometry +# GeoJSONGeometry -Defined in: src/geometry/GeoJSON.ts:6 +Defined in: [src/geometry/GeoJSON.ts:6](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L6) ## Extended by @@ -21,14 +17,18 @@ Defined in: src/geometry/GeoJSON.ts:6 ### coordinates -> **coordinates**: `any` +```ts +coordinates: any; +``` -Defined in: src/geometry/GeoJSON.ts:8 +Defined in: [src/geometry/GeoJSON.ts:8](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L8) *** ### type -> **type**: `string` +```ts +type: string; +``` -Defined in: src/geometry/GeoJSON.ts:7 +Defined in: [src/geometry/GeoJSON.ts:7](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L7) diff --git a/docs/api/interfaces/GeoJSONGeometryCollection.md b/docs/api/interfaces/GeoJSONGeometryCollection.md index 32259d9..568154e 100644 --- a/docs/api/interfaces/GeoJSONGeometryCollection.md +++ b/docs/api/interfaces/GeoJSONGeometryCollection.md @@ -1,33 +1,35 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / GeoJSONGeometryCollection -*** - -[rvgeo](../globals.md) / GeoJSONGeometryCollection - -# Interface: GeoJSONGeometryCollection +# GeoJSONGeometryCollection -Defined in: src/geometry/GeoJSON.ts:48 +Defined in: [src/geometry/GeoJSON.ts:48](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L48) ## Properties ### bbox? -> `optional` **bbox**: [`MBR`](../type-aliases/MBR.md) +```ts +optional bbox: MBR; +``` -Defined in: src/geometry/GeoJSON.ts:51 +Defined in: [src/geometry/GeoJSON.ts:51](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L51) *** ### geometries -> **geometries**: [`GeoJSONGeometry`](GeoJSONGeometry.md)[] +```ts +geometries: GeoJSONGeometry[]; +``` -Defined in: src/geometry/GeoJSON.ts:50 +Defined in: [src/geometry/GeoJSON.ts:50](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L50) *** ### type -> **type**: `"GeometryCollection"` +```ts +type: "GeometryCollection"; +``` -Defined in: src/geometry/GeoJSON.ts:49 +Defined in: [src/geometry/GeoJSON.ts:49](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L49) diff --git a/docs/api/interfaces/GeoJSONLineString.md b/docs/api/interfaces/GeoJSONLineString.md index 7dd3020..e167868 100644 --- a/docs/api/interfaces/GeoJSONLineString.md +++ b/docs/api/interfaces/GeoJSONLineString.md @@ -1,12 +1,8 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / GeoJSONLineString -*** - -[rvgeo](../globals.md) / GeoJSONLineString - -# Interface: GeoJSONLineString +# GeoJSONLineString -Defined in: src/geometry/GeoJSON.ts:24 +Defined in: [src/geometry/GeoJSON.ts:24](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L24) ## Extends @@ -16,9 +12,11 @@ Defined in: src/geometry/GeoJSON.ts:24 ### coordinates -> **coordinates**: \[`number`, `number`\][] +```ts +coordinates: [number, number][]; +``` -Defined in: src/geometry/GeoJSON.ts:26 +Defined in: [src/geometry/GeoJSON.ts:26](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L26) #### Overrides @@ -28,9 +26,11 @@ Defined in: src/geometry/GeoJSON.ts:26 ### type -> **type**: `"LineString"` +```ts +type: "LineString"; +``` -Defined in: src/geometry/GeoJSON.ts:25 +Defined in: [src/geometry/GeoJSON.ts:25](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L25) #### Overrides diff --git a/docs/api/interfaces/GeoJSONMultiLineString.md b/docs/api/interfaces/GeoJSONMultiLineString.md index bbe6c64..868f59f 100644 --- a/docs/api/interfaces/GeoJSONMultiLineString.md +++ b/docs/api/interfaces/GeoJSONMultiLineString.md @@ -1,12 +1,8 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / GeoJSONMultiLineString -*** - -[rvgeo](../globals.md) / GeoJSONMultiLineString - -# Interface: GeoJSONMultiLineString +# GeoJSONMultiLineString -Defined in: src/geometry/GeoJSON.ts:30 +Defined in: [src/geometry/GeoJSON.ts:30](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L30) ## Extends @@ -16,9 +12,11 @@ Defined in: src/geometry/GeoJSON.ts:30 ### coordinates -> **coordinates**: \[`number`, `number`\][][] +```ts +coordinates: [number, number][][]; +``` -Defined in: src/geometry/GeoJSON.ts:32 +Defined in: [src/geometry/GeoJSON.ts:32](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L32) #### Overrides @@ -28,9 +26,11 @@ Defined in: src/geometry/GeoJSON.ts:32 ### type -> **type**: `"MultiLineString"` +```ts +type: "MultiLineString"; +``` -Defined in: src/geometry/GeoJSON.ts:31 +Defined in: [src/geometry/GeoJSON.ts:31](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L31) #### Overrides diff --git a/docs/api/interfaces/GeoJSONMultiPoint.md b/docs/api/interfaces/GeoJSONMultiPoint.md index 09f69b6..d237d9d 100644 --- a/docs/api/interfaces/GeoJSONMultiPoint.md +++ b/docs/api/interfaces/GeoJSONMultiPoint.md @@ -1,12 +1,8 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / GeoJSONMultiPoint -*** - -[rvgeo](../globals.md) / GeoJSONMultiPoint - -# Interface: GeoJSONMultiPoint +# GeoJSONMultiPoint -Defined in: src/geometry/GeoJSON.ts:18 +Defined in: [src/geometry/GeoJSON.ts:18](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L18) ## Extends @@ -16,9 +12,11 @@ Defined in: src/geometry/GeoJSON.ts:18 ### coordinates -> **coordinates**: \[`number`, `number`\][] +```ts +coordinates: [number, number][]; +``` -Defined in: src/geometry/GeoJSON.ts:20 +Defined in: [src/geometry/GeoJSON.ts:20](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L20) #### Overrides @@ -28,9 +26,11 @@ Defined in: src/geometry/GeoJSON.ts:20 ### type -> **type**: `"MultiPoint"` +```ts +type: "MultiPoint"; +``` -Defined in: src/geometry/GeoJSON.ts:19 +Defined in: [src/geometry/GeoJSON.ts:19](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L19) #### Overrides diff --git a/docs/api/interfaces/GeoJSONMultiPolygon.md b/docs/api/interfaces/GeoJSONMultiPolygon.md index b1fdc40..fd3abcf 100644 --- a/docs/api/interfaces/GeoJSONMultiPolygon.md +++ b/docs/api/interfaces/GeoJSONMultiPolygon.md @@ -1,12 +1,8 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / GeoJSONMultiPolygon -*** - -[rvgeo](../globals.md) / GeoJSONMultiPolygon - -# Interface: GeoJSONMultiPolygon +# GeoJSONMultiPolygon -Defined in: src/geometry/GeoJSON.ts:42 +Defined in: [src/geometry/GeoJSON.ts:42](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L42) ## Extends @@ -16,9 +12,11 @@ Defined in: src/geometry/GeoJSON.ts:42 ### coordinates -> **coordinates**: \[`number`, `number`\][][][] +```ts +coordinates: [number, number][][][]; +``` -Defined in: src/geometry/GeoJSON.ts:44 +Defined in: [src/geometry/GeoJSON.ts:44](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L44) #### Overrides @@ -28,9 +26,11 @@ Defined in: src/geometry/GeoJSON.ts:44 ### type -> **type**: `"MultiPolygon"` +```ts +type: "MultiPolygon"; +``` -Defined in: src/geometry/GeoJSON.ts:43 +Defined in: [src/geometry/GeoJSON.ts:43](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L43) #### Overrides diff --git a/docs/api/interfaces/GeoJSONPoint.md b/docs/api/interfaces/GeoJSONPoint.md index 8a1b443..0644ec6 100644 --- a/docs/api/interfaces/GeoJSONPoint.md +++ b/docs/api/interfaces/GeoJSONPoint.md @@ -1,12 +1,8 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / GeoJSONPoint -*** - -[rvgeo](../globals.md) / GeoJSONPoint - -# Interface: GeoJSONPoint +# GeoJSONPoint -Defined in: src/geometry/GeoJSON.ts:12 +Defined in: [src/geometry/GeoJSON.ts:12](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L12) ## Extends @@ -16,9 +12,11 @@ Defined in: src/geometry/GeoJSON.ts:12 ### coordinates -> **coordinates**: \[`number`, `number`\] +```ts +coordinates: [number, number]; +``` -Defined in: src/geometry/GeoJSON.ts:14 +Defined in: [src/geometry/GeoJSON.ts:14](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L14) #### Overrides @@ -28,9 +26,11 @@ Defined in: src/geometry/GeoJSON.ts:14 ### type -> **type**: `"Point"` +```ts +type: "Point"; +``` -Defined in: src/geometry/GeoJSON.ts:13 +Defined in: [src/geometry/GeoJSON.ts:13](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L13) #### Overrides diff --git a/docs/api/interfaces/GeoJSONPolygon.md b/docs/api/interfaces/GeoJSONPolygon.md index 1fbd04a..30bc0b8 100644 --- a/docs/api/interfaces/GeoJSONPolygon.md +++ b/docs/api/interfaces/GeoJSONPolygon.md @@ -1,12 +1,8 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / GeoJSONPolygon -*** - -[rvgeo](../globals.md) / GeoJSONPolygon - -# Interface: GeoJSONPolygon +# GeoJSONPolygon -Defined in: src/geometry/GeoJSON.ts:36 +Defined in: [src/geometry/GeoJSON.ts:36](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L36) ## Extends @@ -16,9 +12,11 @@ Defined in: src/geometry/GeoJSON.ts:36 ### coordinates -> **coordinates**: \[`number`, `number`\][][] +```ts +coordinates: [number, number][][]; +``` -Defined in: src/geometry/GeoJSON.ts:38 +Defined in: [src/geometry/GeoJSON.ts:38](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L38) #### Overrides @@ -28,9 +26,11 @@ Defined in: src/geometry/GeoJSON.ts:38 ### type -> **type**: `"Polygon"` +```ts +type: "Polygon"; +``` -Defined in: src/geometry/GeoJSON.ts:37 +Defined in: [src/geometry/GeoJSON.ts:37](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/GeoJSON.ts#L37) #### Overrides diff --git a/docs/api/interfaces/Graph.md b/docs/api/interfaces/Graph.md index 5f63eba..46fc7e8 100644 --- a/docs/api/interfaces/Graph.md +++ b/docs/api/interfaces/Graph.md @@ -1,12 +1,8 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / Graph -*** - -[rvgeo](../globals.md) / Graph - -# Interface: Graph\ +# Graph\ -Defined in: src/net/graph.ts:4 +Defined in: [src/net/graph.ts:4](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/graph.ts#L4) 数据结构： 图（由节点和边组成） @@ -18,25 +14,31 @@ Defined in: src/net/graph.ts:4 ### edges -> **edges**: `Map`\<`T`, `T`[]\> +```ts +edges: Map; +``` -Defined in: src/net/graph.ts:6 +Defined in: [src/net/graph.ts:6](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/graph.ts#L6) *** ### edgesWeights? -> `optional` **edgesWeights**: `Map`\<`T`, `Map`\<`T`, `number`\>\> +```ts +optional edgesWeights: Map>; +``` -Defined in: src/net/graph.ts:7 +Defined in: [src/net/graph.ts:7](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/graph.ts#L7) *** ### neighbors() -> **neighbors**: (`node`) => `T`[] +```ts +neighbors: (node) => T[]; +``` -Defined in: src/net/graph.ts:9 +Defined in: [src/net/graph.ts:9](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/graph.ts#L9) #### Parameters @@ -52,17 +54,21 @@ Defined in: src/net/graph.ts:9 ### nodes -> **nodes**: `T`[] +```ts +nodes: T[]; +``` -Defined in: src/net/graph.ts:5 +Defined in: [src/net/graph.ts:5](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/graph.ts#L5) *** ### weights()? -> `optional` **weights**: (`from`, `to`) => `number` +```ts +optional weights: (from, to) => number; +``` -Defined in: src/net/graph.ts:8 +Defined in: [src/net/graph.ts:8](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/graph.ts#L8) #### Parameters diff --git a/docs/api/interfaces/GridGraph.md b/docs/api/interfaces/GridGraph.md index 05c2136..444607d 100644 --- a/docs/api/interfaces/GridGraph.md +++ b/docs/api/interfaces/GridGraph.md @@ -1,12 +1,8 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / GridGraph -*** - -[rvgeo](../globals.md) / GridGraph - -# Interface: GridGraph +# GridGraph -Defined in: src/net/graph.ts:52 +Defined in: [src/net/graph.ts:52](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/graph.ts#L52) 二维数组转换为图 @@ -14,25 +10,31 @@ Defined in: src/net/graph.ts:52 ### cols -> **cols**: `number` +```ts +cols: number; +``` -Defined in: src/net/graph.ts:54 +Defined in: [src/net/graph.ts:54](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/graph.ts#L54) *** ### grid -> **grid**: `number`[][] +```ts +grid: number[][]; +``` -Defined in: src/net/graph.ts:53 +Defined in: [src/net/graph.ts:53](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/graph.ts#L53) *** ### neighbors() -> **neighbors**: (`node`) => \[`number`, `number`\][] +```ts +neighbors: (node) => [number, number][]; +``` -Defined in: src/net/graph.ts:57 +Defined in: [src/net/graph.ts:57](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/graph.ts#L57) #### Parameters @@ -48,17 +50,21 @@ Defined in: src/net/graph.ts:57 ### rows -> **rows**: `number` +```ts +rows: number; +``` -Defined in: src/net/graph.ts:55 +Defined in: [src/net/graph.ts:55](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/graph.ts#L55) *** ### weights()? -> `optional` **weights**: (`from`, `to`) => `number` +```ts +optional weights: (from, to) => number; +``` -Defined in: src/net/graph.ts:56 +Defined in: [src/net/graph.ts:56](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/graph.ts#L56) #### Parameters diff --git a/docs/api/interfaces/Projection.md b/docs/api/interfaces/Projection.md index 2ec0ab6..289d4d7 100644 --- a/docs/api/interfaces/Projection.md +++ b/docs/api/interfaces/Projection.md @@ -1,36 +1,38 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / Projection -*** - -[rvgeo](../globals.md) / Projection - -# Interface: Projection +# Projection -Defined in: src/geo/projection/base.ts:3 +Defined in: [src/geo/projection/base.ts:3](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geo/projection/base.ts#L3) ## Properties ### bounds -> **bounds**: [`MBR`](../type-aliases/MBR.md) +```ts +bounds: MBR; +``` -Defined in: src/geo/projection/base.ts:6 +Defined in: [src/geo/projection/base.ts:6](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geo/projection/base.ts#L6) *** ### name? -> `optional` **name**: `string` +```ts +optional name: string; +``` -Defined in: src/geo/projection/base.ts:7 +Defined in: [src/geo/projection/base.ts:7](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geo/projection/base.ts#L7) ## Methods ### project() -> **project**(`latlng`): \[`number`, `number`\] +```ts +project(latlng): [number, number] +``` -Defined in: src/geo/projection/base.ts:4 +Defined in: [src/geo/projection/base.ts:4](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geo/projection/base.ts#L4) #### Parameters @@ -46,9 +48,11 @@ Defined in: src/geo/projection/base.ts:4 ### unproject() -> **unproject**(`point`): \[`number`, `number`\] +```ts +unproject(point): [number, number] +``` -Defined in: src/geo/projection/base.ts:5 +Defined in: [src/geo/projection/base.ts:5](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geo/projection/base.ts#L5) #### Parameters diff --git a/docs/api/interfaces/Transform.md b/docs/api/interfaces/Transform.md index af8b8dd..2e444d1 100644 --- a/docs/api/interfaces/Transform.md +++ b/docs/api/interfaces/Transform.md @@ -1,25 +1,25 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / Transform -*** - -[rvgeo](../globals.md) / Transform - -# Interface: Transform +# Transform -Defined in: src/topology/client/transform.ts:3 +Defined in: [src/topology/client/transform.ts:3](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/topology/client/transform.ts#L3) ## Properties ### scale -> **scale**: \[`number`, `number`\] +```ts +scale: [number, number]; +``` -Defined in: src/topology/client/transform.ts:4 +Defined in: [src/topology/client/transform.ts:4](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/topology/client/transform.ts#L4) *** ### translate -> **translate**: \[`number`, `number`\] +```ts +translate: [number, number]; +``` -Defined in: src/topology/client/transform.ts:5 +Defined in: [src/topology/client/transform.ts:5](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/topology/client/transform.ts#L5) diff --git a/docs/api/interfaces/customRange.md b/docs/api/interfaces/customRange.md index 2ca5784..bcb6171 100644 --- a/docs/api/interfaces/customRange.md +++ b/docs/api/interfaces/customRange.md @@ -1,12 +1,8 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / customRange -*** - -[rvgeo](../globals.md) / customRange +# customRange -# Interface: customRange - -Defined in: src/datastru/quadTree.ts:168 +Defined in: [src/datastru/quadTree.ts:168](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/datastru/quadTree.ts#L168) impliment customRange to support custom range query - make sure your customRange object has correct intersects and contains function @@ -32,9 +28,11 @@ contains: (point: [number,number]) => {} ### contains() -> **contains**: (`point`) => `boolean` +```ts +contains: (point) => boolean; +``` -Defined in: src/datastru/quadTree.ts:170 +Defined in: [src/datastru/quadTree.ts:170](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/datastru/quadTree.ts#L170) #### Parameters @@ -50,9 +48,11 @@ Defined in: src/datastru/quadTree.ts:170 ### intersects() -> **intersects**: (`boundary`) => `boolean` +```ts +intersects: (boundary) => boolean; +``` -Defined in: src/datastru/quadTree.ts:169 +Defined in: [src/datastru/quadTree.ts:169](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/datastru/quadTree.ts#L169) #### Parameters diff --git a/docs/api/type-aliases/AreaUnits.md b/docs/api/type-aliases/AreaUnits.md index 30288ee..2ad5065 100644 --- a/docs/api/type-aliases/AreaUnits.md +++ b/docs/api/type-aliases/AreaUnits.md @@ -1,11 +1,16 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / AreaUnits -*** +# AreaUnits -[rvgeo](../globals.md) / AreaUnits +```ts +type AreaUnits = + | Exclude + | "acres" + | "hectares" + | "squaremeters" + | "squaremetres" + | "squarekilometers" + | "squarekilometres"; +``` -# Type Alias: AreaUnits - -> **AreaUnits**: `Exclude`\<[`Units`](Units.md), `"radians"` \| `"degrees"`\> \| `"acres"` \| `"hectares"` \| `"squaremeters"` \| `"squaremetres"` \| `"squarekilometers"` \| `"squarekilometres"` - -Defined in: src/math/factors.ts:36 +Defined in: [src/math/factors.ts:36](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/factors.ts#L36) diff --git a/docs/api/type-aliases/Complex.md b/docs/api/type-aliases/Complex.md index 94ef874..7aa10f6 100644 --- a/docs/api/type-aliases/Complex.md +++ b/docs/api/type-aliases/Complex.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / Complex -*** +# Complex -[rvgeo](../globals.md) / Complex +```ts +type Complex = object; +``` -# Type Alias: Complex - -> **Complex**: `object` - -Defined in: src/math/fourier.ts:25 +Defined in: [src/math/fourier.ts:25](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/fourier.ts#L25) 复数类型 @@ -16,8 +14,12 @@ Defined in: src/math/fourier.ts:25 ### imag -> **imag**: `number` +```ts +imag: number; +``` ### real -> **real**: `number` +```ts +real: number; +``` diff --git a/docs/api/type-aliases/MBR.md b/docs/api/type-aliases/MBR.md index f0cff5e..d8018a3 100644 --- a/docs/api/type-aliases/MBR.md +++ b/docs/api/type-aliases/MBR.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / MBR -*** +# MBR -[rvgeo](../globals.md) / MBR +```ts +type MBR = [number, number, number, number]; +``` -# Type Alias: MBR - -> **MBR**: \[`number`, `number`, `number`, `number`\] - -Defined in: src/geometry/MBR.ts:21 +Defined in: [src/geometry/MBR.ts:21](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/MBR.ts#L21) - MBR 中的 minX, minY, maxX, maxY 的排序在某些情况下会有歧义，尤其是在地理坐标系的语境下。（譬如跨越了反子午圈的情况（斐济群岛）） - 所以允许 minX > maxX 遇到这样的情况时，需要进行特殊处理。 diff --git a/docs/api/type-aliases/QTNode.md b/docs/api/type-aliases/QTNode.md index ccf841e..d72cd9a 100644 --- a/docs/api/type-aliases/QTNode.md +++ b/docs/api/type-aliases/QTNode.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / QTNode -*** +# QTNode -[rvgeo](../globals.md) / QTNode +```ts +type QTNode = object; +``` -# Type Alias: QTNode - -> **QTNode**: `object` - -Defined in: src/coverage/grid.ts:466 +Defined in: [src/coverage/grid.ts:466](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/coverage/grid.ts#L466) 由网格数据生成四叉树(节点) @@ -16,24 +14,36 @@ Defined in: src/coverage/grid.ts:466 ### boundary -> **boundary**: [`MBR`](MBR.md) +```ts +boundary: MBR; +``` ### children -> **children**: [`QTNode`](QTNode.md)[] +```ts +children: QTNode[]; +``` ### depth -> **depth**: `number` +```ts +depth: number; +``` ### isDivided -> **isDivided**: `boolean` +```ts +isDivided: boolean; +``` ### isLeaf -> **isLeaf**: `boolean` +```ts +isLeaf: boolean; +``` ### maxDepth -> **maxDepth**: `number` +```ts +maxDepth: number; +``` diff --git a/docs/api/type-aliases/Rectangle.md b/docs/api/type-aliases/Rectangle.md index d87fbce..40d8aa3 100644 --- a/docs/api/type-aliases/Rectangle.md +++ b/docs/api/type-aliases/Rectangle.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / Rectangle -*** +# Rectangle -[rvgeo](../globals.md) / Rectangle +```ts +type Rectangle = object; +``` -# Type Alias: Rectangle - -> **Rectangle**: `object` - -Defined in: src/geometry/MBR.ts:48 +Defined in: [src/geometry/MBR.ts:48](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/MBR.ts#L48) - Rectangle is a rectangle that bounds a set of points. @@ -16,16 +14,24 @@ Defined in: src/geometry/MBR.ts:48 ### h -> **h**: `number` +```ts +h: number; +``` ### w -> **w**: `number` +```ts +w: number; +``` ### x -> **x**: `number` +```ts +x: number; +``` ### y -> **y**: `number` +```ts +y: number; +``` diff --git a/docs/api/type-aliases/Units.md b/docs/api/type-aliases/Units.md index 137f23c..5df711c 100644 --- a/docs/api/type-aliases/Units.md +++ b/docs/api/type-aliases/Units.md @@ -1,11 +1,24 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / Units -*** +# Units -[rvgeo](../globals.md) / Units +```ts +type Units = + | "meters" + | "metres" + | "millimeters" + | "millimetres" + | "centimeters" + | "centimetres" + | "kilometers" + | "kilometres" + | "miles" + | "nauticalmiles" + | "inches" + | "yards" + | "feet" + | "radians" + | "degrees"; +``` -# Type Alias: Units - -> **Units**: `"meters"` \| `"metres"` \| `"millimeters"` \| `"millimetres"` \| `"centimeters"` \| `"centimetres"` \| `"kilometers"` \| `"kilometres"` \| `"miles"` \| `"nauticalmiles"` \| `"inches"` \| `"yards"` \| `"feet"` \| `"radians"` \| `"degrees"` - -Defined in: src/math/factors.ts:19 +Defined in: [src/math/factors.ts:19](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/factors.ts#L19) diff --git a/docs/api/type-aliases/gridValueStrategy.md b/docs/api/type-aliases/gridValueStrategy.md index ed2e175..0c17f1a 100644 --- a/docs/api/type-aliases/gridValueStrategy.md +++ b/docs/api/type-aliases/gridValueStrategy.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / gridValueStrategy -*** +# gridValueStrategy() -[rvgeo](../globals.md) / gridValueStrategy +```ts +type gridValueStrategy = (from, to) => number; +``` -# Type Alias: gridValueStrategy() - -> **gridValueStrategy**: (`from`, `to`) => `number` - -Defined in: src/net/graph.ts:60 +Defined in: [src/net/graph.ts:60](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/net/graph.ts#L60) ## Parameters diff --git a/docs/api/typedoc-sidebar.json b/docs/api/typedoc-sidebar.json new file mode 100644 index 0000000..307a020 --- /dev/null +++ b/docs/api/typedoc-sidebar.json @@ -0,0 +1 @@ +[{"text":"Enumerations","collapsed":true,"items":[{"text":"colorListType","link":"/api/enumerations/colorListType.md"},{"text":"stretchType","link":"/api/enumerations/stretchType.md"}]},{"text":"Classes","collapsed":true,"items":[{"text":"Circle","link":"/api/classes/Circle.md"},{"text":"Delaunator","link":"/api/classes/Delaunator.md"},{"text":"Evented","link":"/api/classes/Evented.md"},{"text":"Geometry","link":"/api/classes/Geometry.md"},{"text":"GeometryCollection","link":"/api/classes/GeometryCollection.md"},{"text":"Grid","link":"/api/classes/Grid.md"},{"text":"LineString","link":"/api/classes/LineString.md"},{"text":"MultiLineString","link":"/api/classes/MultiLineString.md"},{"text":"MultiPoint","link":"/api/classes/MultiPoint.md"},{"text":"MultiPolygon","link":"/api/classes/MultiPolygon.md"},{"text":"Point","link":"/api/classes/Point.md"},{"text":"Polygon","link":"/api/classes/Polygon.md"},{"text":"PriorityQueue","link":"/api/classes/PriorityQueue.md"},{"text":"QuadTree","link":"/api/classes/QuadTree.md"},{"text":"Queue","link":"/api/classes/Queue.md"},{"text":"Voronoi","link":"/api/classes/Voronoi.md"}]},{"text":"Interfaces","collapsed":true,"items":[{"text":"CRS","link":"/api/interfaces/CRS.md"},{"text":"customRange","link":"/api/interfaces/customRange.md"},{"text":"GeoJSONFeature","link":"/api/interfaces/GeoJSONFeature.md"},{"text":"GeoJSONFeatureCollection","link":"/api/interfaces/GeoJSONFeatureCollection.md"},{"text":"GeoJSONGeometry","link":"/api/interfaces/GeoJSONGeometry.md"},{"text":"GeoJSONGeometryCollection","link":"/api/interfaces/GeoJSONGeometryCollection.md"},{"text":"GeoJSONLineString","link":"/api/interfaces/GeoJSONLineString.md"},{"text":"GeoJSONMultiLineString","link":"/api/interfaces/GeoJSONMultiLineString.md"},{"text":"GeoJSONMultiPoint","link":"/api/interfaces/GeoJSONMultiPoint.md"},{"text":"GeoJSONMultiPolygon","link":"/api/interfaces/GeoJSONMultiPolygon.md"},{"text":"GeoJSONPoint","link":"/api/interfaces/GeoJSONPoint.md"},{"text":"GeoJSONPolygon","link":"/api/interfaces/GeoJSONPolygon.md"},{"text":"Graph","link":"/api/interfaces/Graph.md"},{"text":"GridGraph","link":"/api/interfaces/GridGraph.md"},{"text":"Projection","link":"/api/interfaces/Projection.md"},{"text":"Transform","link":"/api/interfaces/Transform.md"}]},{"text":"Type Aliases","collapsed":true,"items":[{"text":"AreaUnits","link":"/api/type-aliases/AreaUnits.md"},{"text":"Complex","link":"/api/type-aliases/Complex.md"},{"text":"gridValueStrategy","link":"/api/type-aliases/gridValueStrategy.md"},{"text":"MBR","link":"/api/type-aliases/MBR.md"},{"text":"QTNode","link":"/api/type-aliases/QTNode.md"},{"text":"Rectangle","link":"/api/type-aliases/Rectangle.md"},{"text":"Units","link":"/api/type-aliases/Units.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"areaFactors","link":"/api/variables/areaFactors.md"},{"text":"CountourColorList","link":"/api/variables/CountourColorList.md"},{"text":"D2R","link":"/api/variables/D2R.md"},{"text":"Earth","link":"/api/variables/Earth.md"},{"text":"earthRadius","link":"/api/variables/earthRadius.md"},{"text":"EPSG3857","link":"/api/variables/EPSG3857.md"},{"text":"EPSG900913","link":"/api/variables/EPSG900913.md"},{"text":"EPSLN","link":"/api/variables/EPSLN.md"},{"text":"factors","link":"/api/variables/factors.md"},{"text":"factors2","link":"/api/variables/factors2.md"},{"text":"halfPi","link":"/api/variables/halfPi.md"},{"text":"pi","link":"/api/variables/pi.md"},{"text":"R2D","link":"/api/variables/R2D.md"},{"text":"SphericalMercator","link":"/api/variables/SphericalMercator.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"acos","link":"/api/functions/acos.md"},{"text":"add","link":"/api/functions/add.md"},{"text":"adjust_lon","link":"/api/functions/adjust_lon.md"},{"text":"alphaComplex","link":"/api/functions/alphaComplex.md"},{"text":"applyMixins","link":"/api/functions/applyMixins.md"},{"text":"areaToArea","link":"/api/functions/areaToArea.md"},{"text":"asin","link":"/api/functions/asin.md"},{"text":"atan2","link":"/api/functions/atan2.md"},{"text":"bearing","link":"/api/functions/bearing.md"},{"text":"binarization","link":"/api/functions/binarization.md"},{"text":"binaryColorBand","link":"/api/functions/binaryColorBand.md"},{"text":"binDrawGrid2d","link":"/api/functions/binDrawGrid2d.md"},{"text":"breadthFirstSearch","link":"/api/functions/breadthFirstSearch.md"},{"text":"calculateArrayShape","link":"/api/functions/calculateArrayShape.md"},{"text":"calculateMBR","link":"/api/functions/calculateMBR.md"},{"text":"cartesian","link":"/api/functions/cartesian.md"},{"text":"cartesianAdd","link":"/api/functions/cartesianAdd.md"},{"text":"cartesianAddInPlace","link":"/api/functions/cartesianAddInPlace.md"},{"text":"cartesianAngle","link":"/api/functions/cartesianAngle.md"},{"text":"cartesianCross","link":"/api/functions/cartesianCross.md"},{"text":"cartesianDot","link":"/api/functions/cartesianDot.md"},{"text":"cartesianNormalize","link":"/api/functions/cartesianNormalize.md"},{"text":"cartesianNormalizeInPlace","link":"/api/functions/cartesianNormalizeInPlace.md"},{"text":"cartesianScale","link":"/api/functions/cartesianScale.md"},{"text":"ccw","link":"/api/functions/ccw.md"},{"text":"ccwRobust","link":"/api/functions/ccwRobust.md"},{"text":"collectionFromFeature","link":"/api/functions/collectionFromFeature.md"},{"text":"collectionFromGeometry","link":"/api/functions/collectionFromGeometry.md"},{"text":"complateMap","link":"/api/functions/complateMap.md"},{"text":"concatEL2DArray","link":"/api/functions/concatEL2DArray.md"},{"text":"conj","link":"/api/functions/conj.md"},{"text":"containsMBR","link":"/api/functions/containsMBR.md"},{"text":"convexHull","link":"/api/functions/convexHull.md"},{"text":"cos","link":"/api/functions/cos.md"},{"text":"createGraph","link":"/api/functions/createGraph.md"},{"text":"createGridGraph","link":"/api/functions/createGridGraph.md"},{"text":"cross","link":"/api/functions/cross.md"},{"text":"cutPolygonByMBR","link":"/api/functions/cutPolygonByMBR.md"},{"text":"dampedSin3D","link":"/api/functions/dampedSin3D.md"},{"text":"degreesToRadians","link":"/api/functions/degreesToRadians.md"},{"text":"degToDMS","link":"/api/functions/degToDMS.md"},{"text":"deMaxMin","link":"/api/functions/deMaxMin.md"},{"text":"destination","link":"/api/functions/destination.md"},{"text":"dijkstra","link":"/api/functions/dijkstra.md"},{"text":"dmsToDeg","link":"/api/functions/dmsToDeg.md"},{"text":"dot","link":"/api/functions/dot.md"},{"text":"drawArrowField","link":"/api/functions/drawArrowField.md"},{"text":"drawCountour","link":"/api/functions/drawCountour.md"},{"text":"drawGrid2d","link":"/api/functions/drawGrid2d.md"},{"text":"drawProgress","link":"/api/functions/drawProgress.md"},{"text":"drawQTree2d","link":"/api/functions/drawQTree2d.md"},{"text":"drawSample","link":"/api/functions/drawSample.md"},{"text":"drawSample2","link":"/api/functions/drawSample2.md"},{"text":"drawText","link":"/api/functions/drawText.md"},{"text":"drawTrueColorGrid2d","link":"/api/functions/drawTrueColorGrid2d.md"},{"text":"emptyObj","link":"/api/functions/emptyObj.md"},{"text":"equals","link":"/api/functions/equals.md"},{"text":"equalsMBR","link":"/api/functions/equalsMBR.md"},{"text":"extend","link":"/api/functions/extend.md"},{"text":"fastFFT2","link":"/api/functions/fastFFT2.md"},{"text":"feature","link":"/api/functions/feature.md"},{"text":"FFT","link":"/api/functions/FFT.md"},{"text":"FFT2","link":"/api/functions/FFT2.md"},{"text":"FFTImag","link":"/api/functions/FFTImag.md"},{"text":"FFTImag2","link":"/api/functions/FFTImag2.md"},{"text":"FFTReal","link":"/api/functions/FFTReal.md"},{"text":"FFTReal2","link":"/api/functions/FFTReal2.md"},{"text":"FFTShift","link":"/api/functions/FFTShift.md"},{"text":"fillIndexArray","link":"/api/functions/fillIndexArray.md"},{"text":"flattenArray","link":"/api/functions/flattenArray.md"},{"text":"formatNum","link":"/api/functions/formatNum.md"},{"text":"fromFeatureObj","link":"/api/functions/fromFeatureObj.md"},{"text":"fromGeometryObj","link":"/api/functions/fromGeometryObj.md"},{"text":"getAngle","link":"/api/functions/getAngle.md"},{"text":"getMBRWithAntimeridian","link":"/api/functions/getMBRWithAntimeridian.md"},{"text":"getPointsMBR","link":"/api/functions/getPointsMBR.md"},{"text":"gridAstar","link":"/api/functions/gridAstar.md"},{"text":"gridBreadthFirstSearch","link":"/api/functions/gridBreadthFirstSearch.md"},{"text":"gridDijkstra","link":"/api/functions/gridDijkstra.md"},{"text":"gridReconstructPath","link":"/api/functions/gridReconstructPath.md"},{"text":"haversin","link":"/api/functions/haversin.md"},{"text":"haversine","link":"/api/functions/haversine.md"},{"text":"hist","link":"/api/functions/hist.md"},{"text":"IFFT","link":"/api/functions/IFFT.md"},{"text":"IFFT2","link":"/api/functions/IFFT2.md"},{"text":"IFFTReal","link":"/api/functions/IFFTReal.md"},{"text":"IFFTReal2","link":"/api/functions/IFFTReal2.md"},{"text":"inCircle","link":"/api/functions/inCircle.md"},{"text":"inCircleRobust","link":"/api/functions/inCircleRobust.md"},{"text":"intermediatePoint","link":"/api/functions/intermediatePoint.md"},{"text":"interpolate","link":"/api/functions/interpolate.md"},{"text":"interpolate2","link":"/api/functions/interpolate2.md"},{"text":"intersection","link":"/api/functions/intersection.md"},{"text":"intersectionPolygon","link":"/api/functions/intersectionPolygon.md"},{"text":"intersectsMBR","link":"/api/functions/intersectsMBR.md"},{"text":"isEPSG3857","link":"/api/functions/isEPSG3857.md"},{"text":"isEPSG4326","link":"/api/functions/isEPSG4326.md"},{"text":"isFloat","link":"/api/functions/isFloat.md"},{"text":"isPotentialGeoObject","link":"/api/functions/isPotentialGeoObject.md"},{"text":"iterPolygonEdge","link":"/api/functions/iterPolygonEdge.md"},{"text":"K_means","link":"/api/functions/K_means.md"},{"text":"lengthToRadians","link":"/api/functions/lengthToRadians.md"},{"text":"MBR2Plane","link":"/api/functions/MBR2Plane.md"},{"text":"mbrToPolygon","link":"/api/functions/mbrToPolygon.md"},{"text":"mbrToRectangle","link":"/api/functions/mbrToRectangle.md"},{"text":"merge","link":"/api/functions/merge.md"},{"text":"mergeArcs","link":"/api/functions/mergeArcs.md"},{"text":"mergeMBR","link":"/api/functions/mergeMBR.md"},{"text":"mergePointMBR","link":"/api/functions/mergePointMBR.md"},{"text":"mesh","link":"/api/functions/mesh.md"},{"text":"meshArcs","link":"/api/functions/meshArcs.md"},{"text":"metersTo","link":"/api/functions/metersTo.md"},{"text":"midpoint","link":"/api/functions/midpoint.md"},{"text":"neighbors","link":"/api/functions/neighbors.md"},{"text":"normalize","link":"/api/functions/normalize.md"},{"text":"object","link":"/api/functions/object.md"},{"text":"overlapsMBR","link":"/api/functions/overlapsMBR.md"},{"text":"Perlin","link":"/api/functions/Perlin.md"},{"text":"plane2MBR","link":"/api/functions/plane2MBR.md"},{"text":"planeIntersection","link":"/api/functions/planeIntersection.md"},{"text":"planePolygonArea","link":"/api/functions/planePolygonArea.md"},{"text":"pointInEdge","link":"/api/functions/pointInEdge.md"},{"text":"pointInMBR","link":"/api/functions/pointInMBR.md"},{"text":"pointInMBRWithAntimeridian","link":"/api/functions/pointInMBRWithAntimeridian.md"},{"text":"PointInsidePolygon","link":"/api/functions/PointInsidePolygon.md"},{"text":"PointOutsideMBR","link":"/api/functions/PointOutsideMBR.md"},{"text":"prePointInPolygon","link":"/api/functions/prePointInPolygon.md"},{"text":"pseudoColorBandFactory","link":"/api/functions/pseudoColorBandFactory.md"},{"text":"radiansToDegrees","link":"/api/functions/radiansToDegrees.md"},{"text":"radiansToLength","link":"/api/functions/radiansToLength.md"},{"text":"randomIndexArray","link":"/api/functions/randomIndexArray.md"},{"text":"reactGrid2d","link":"/api/functions/reactGrid2d.md"},{"text":"reconstructPath","link":"/api/functions/reconstructPath.md"},{"text":"rectangleToMBR","link":"/api/functions/rectangleToMBR.md"},{"text":"reverse","link":"/api/functions/reverse.md"},{"text":"round","link":"/api/functions/round.md"},{"text":"sample","link":"/api/functions/sample.md"},{"text":"scale","link":"/api/functions/scale.md"},{"text":"sign","link":"/api/functions/sign.md"},{"text":"simpleColorBand","link":"/api/functions/simpleColorBand.md"},{"text":"simpleColorBandFactory","link":"/api/functions/simpleColorBandFactory.md"},{"text":"simplePseudoColorBand","link":"/api/functions/simplePseudoColorBand.md"},{"text":"sin","link":"/api/functions/sin.md"},{"text":"Sin3D","link":"/api/functions/Sin3D.md"},{"text":"sphereIntersection","link":"/api/functions/sphereIntersection.md"},{"text":"spherical","link":"/api/functions/spherical.md"},{"text":"sphericalArea","link":"/api/functions/sphericalArea.md"},{"text":"splitMBRWithAntimeridian","link":"/api/functions/splitMBRWithAntimeridian.md"},{"text":"sqrt","link":"/api/functions/sqrt.md"},{"text":"squareMetersTo","link":"/api/functions/squareMetersTo.md"},{"text":"subColumnInEL2DArray","link":"/api/functions/subColumnInEL2DArray.md"},{"text":"subdivide2QTree","link":"/api/functions/subdivide2QTree.md"},{"text":"testProgress","link":"/api/functions/testProgress.md"},{"text":"throttle","link":"/api/functions/throttle.md"},{"text":"toLineString","link":"/api/functions/toLineString.md"},{"text":"toMeters","link":"/api/functions/toMeters.md"},{"text":"toMultiPoint","link":"/api/functions/toMultiPoint.md"},{"text":"toPoint","link":"/api/functions/toPoint.md"},{"text":"topology","link":"/api/functions/topology.md"},{"text":"toSquareMeters","link":"/api/functions/toSquareMeters.md"},{"text":"transform","link":"/api/functions/transform.md"},{"text":"triangleCenter","link":"/api/functions/triangleCenter.md"},{"text":"trueColorBand","link":"/api/functions/trueColorBand.md"},{"text":"trueColorBandFactory","link":"/api/functions/trueColorBandFactory.md"},{"text":"unitToUnit","link":"/api/functions/unitToUnit.md"},{"text":"untransform","link":"/api/functions/untransform.md"},{"text":"UUID","link":"/api/functions/UUID.md"},{"text":"worleyNoise","link":"/api/functions/worleyNoise.md"},{"text":"XY2ColRow","link":"/api/functions/XY2ColRow.md"},{"text":"zebraNoise","link":"/api/functions/zebraNoise.md"}]}] \ No newline at end of file diff --git a/docs/api/variables/CountourColorList.md b/docs/api/variables/CountourColorList.md index 52ba842..af13742 100644 --- a/docs/api/variables/CountourColorList.md +++ b/docs/api/variables/CountourColorList.md @@ -1,11 +1,9 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / CountourColorList -*** +# CountourColorList -[rvgeo](../globals.md) / CountourColorList +```ts +const CountourColorList: string[]; +``` -# Variable: CountourColorList - -> `const` **CountourColorList**: `string`[] - -Defined in: src/render/colors.ts:161 +Defined in: [src/render/colors.ts:161](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/render/colors.ts#L161) diff --git a/docs/api/variables/D2R.md b/docs/api/variables/D2R.md index 344ce17..4de8e7f 100644 --- a/docs/api/variables/D2R.md +++ b/docs/api/variables/D2R.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / D2R -*** +# D2R -[rvgeo](../globals.md) / D2R - -# Variable: D2R - -> `const` **D2R**: `number` +```ts +const D2R: number; +``` -Defined in: src/math/factors.ts:7 +Defined in: [src/math/factors.ts:7](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/factors.ts#L7) D2R usage: 角度转弧度 - PI / 180 diff --git a/docs/api/variables/EPSG3857.md b/docs/api/variables/EPSG3857.md index d6ad093..a93d7bc 100644 --- a/docs/api/variables/EPSG3857.md +++ b/docs/api/variables/EPSG3857.md @@ -1,13 +1,11 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / EPSG3857 -*** +# EPSG3857 -[rvgeo](../globals.md) / EPSG3857 +```ts +const EPSG3857: CRS; +``` -# Variable: EPSG3857 - -> `const` **EPSG3857**: [`CRS`](../interfaces/CRS.md) - -Defined in: src/geo/crs/EPSG3857.ts:11 +Defined in: [src/geo/crs/EPSG3857.ts:11](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geo/crs/EPSG3857.ts#L11) EPSG:3857 diff --git a/docs/api/variables/EPSG900913.md b/docs/api/variables/EPSG900913.md index d98729a..412f093 100644 --- a/docs/api/variables/EPSG900913.md +++ b/docs/api/variables/EPSG900913.md @@ -1,13 +1,11 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / EPSG900913 -*** +# EPSG900913 -[rvgeo](../globals.md) / EPSG900913 +```ts +const EPSG900913: CRS; +``` -# Variable: EPSG900913 - -> `const` **EPSG900913**: [`CRS`](../interfaces/CRS.md) - -Defined in: src/geo/crs/EPSG3857.ts:28 +Defined in: [src/geo/crs/EPSG3857.ts:28](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geo/crs/EPSG3857.ts#L28) EPSG:900913 diff --git a/docs/api/variables/EPSLN.md b/docs/api/variables/EPSLN.md index 9c0842b..e022876 100644 --- a/docs/api/variables/EPSLN.md +++ b/docs/api/variables/EPSLN.md @@ -1,11 +1,9 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / EPSLN -*** +# EPSLN -[rvgeo](../globals.md) / EPSLN +```ts +const EPSLN: 1e-10 = 1.0e-10; +``` -# Variable: EPSLN - -> `const` **EPSLN**: `1e-10` = `1.0e-10` - -Defined in: src/math/vector.ts:9 +Defined in: [src/math/vector.ts:9](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/vector.ts#L9) diff --git a/docs/api/variables/Earth.md b/docs/api/variables/Earth.md index b213e5c..3971d83 100644 --- a/docs/api/variables/Earth.md +++ b/docs/api/variables/Earth.md @@ -1,11 +1,9 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / Earth -*** +# Earth -[rvgeo](../globals.md) / Earth +```ts +const Earth: CRS; +``` -# Variable: Earth - -> `const` **Earth**: [`CRS`](../interfaces/CRS.md) - -Defined in: src/geo/crs/base.ts:14 +Defined in: [src/geo/crs/base.ts:14](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geo/crs/base.ts#L14) diff --git a/docs/api/variables/R2D.md b/docs/api/variables/R2D.md index ecb65d5..036cce8 100644 --- a/docs/api/variables/R2D.md +++ b/docs/api/variables/R2D.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / R2D -*** +# R2D -[rvgeo](../globals.md) / R2D - -# Variable: R2D - -> `const` **R2D**: `number` +```ts +const R2D: number; +``` -Defined in: src/math/factors.ts:15 +Defined in: [src/math/factors.ts:15](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/factors.ts#L15) R2D usage: 弧度转角度 - 180 / PI diff --git a/docs/api/variables/SphericalMercator.md b/docs/api/variables/SphericalMercator.md index 53b518f..51b5be6 100644 --- a/docs/api/variables/SphericalMercator.md +++ b/docs/api/variables/SphericalMercator.md @@ -1,11 +1,9 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / SphericalMercator -*** +# SphericalMercator -[rvgeo](../globals.md) / SphericalMercator +```ts +const SphericalMercator: Projection; +``` -# Variable: SphericalMercator - -> `const` **SphericalMercator**: [`Projection`](../interfaces/Projection.md) - -Defined in: src/geo/projection/SphericalMercator.ts:12 +Defined in: [src/geo/projection/SphericalMercator.ts:12](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geo/projection/SphericalMercator.ts#L12) diff --git a/docs/api/variables/areaFactors.md b/docs/api/variables/areaFactors.md index dee9dde..4010ee8 100644 --- a/docs/api/variables/areaFactors.md +++ b/docs/api/variables/areaFactors.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / areaFactors -*** +# areaFactors -[rvgeo](../globals.md) / areaFactors - -# Variable: areaFactors - -> `const` **areaFactors**: `Record`\<[`AreaUnits`](../type-aliases/AreaUnits.md), `number`\> +```ts +const areaFactors: Record; +``` -Defined in: src/math/factors.ts:105 +Defined in: [src/math/factors.ts:105](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/factors.ts#L105) - Area of measurement factors based on 1 square meter. - 单位换算关系，以1平方米为基准。 diff --git a/docs/api/variables/earthRadius.md b/docs/api/variables/earthRadius.md index 4678084..b4e6e9f 100644 --- a/docs/api/variables/earthRadius.md +++ b/docs/api/variables/earthRadius.md @@ -1,11 +1,9 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / earthRadius -*** +# earthRadius -[rvgeo](../globals.md) / earthRadius +```ts +const earthRadius: 6371008.8 = 6371008.8; +``` -# Variable: earthRadius - -> `const` **earthRadius**: `6371008.8` = `6371008.8` - -Defined in: src/math/factors.ts:17 +Defined in: [src/math/factors.ts:17](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/factors.ts#L17) diff --git a/docs/api/variables/factors.md b/docs/api/variables/factors.md index 528c89e..fc44089 100644 --- a/docs/api/variables/factors.md +++ b/docs/api/variables/factors.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / factors -*** +# factors -[rvgeo](../globals.md) / factors - -# Variable: factors - -> `const` **factors**: `Record`\<[`Units`](../type-aliases/Units.md), `number`\> +```ts +const factors: Record; +``` -Defined in: src/math/factors.ts:55 +Defined in: [src/math/factors.ts:55](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/factors.ts#L55) - Unit of measurement factors using a spherical (non-ellipsoid) earth radius. diff --git a/docs/api/variables/factors2.md b/docs/api/variables/factors2.md index 9d259df..a726a00 100644 --- a/docs/api/variables/factors2.md +++ b/docs/api/variables/factors2.md @@ -1,14 +1,12 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / factors2 -*** +# factors2 -[rvgeo](../globals.md) / factors2 - -# Variable: factors2 - -> `const` **factors2**: `Record`\<[`Units`](../type-aliases/Units.md), `number`\> +```ts +const factors2: Record; +``` -Defined in: src/math/factors.ts:80 +Defined in: [src/math/factors.ts:80](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/factors.ts#L80) - Unit of measurement factors based on 1 meter. - 单位换算关系，以1米为基准。 diff --git a/docs/api/variables/halfPi.md b/docs/api/variables/halfPi.md index 199dbee..ea9839a 100644 --- a/docs/api/variables/halfPi.md +++ b/docs/api/variables/halfPi.md @@ -1,11 +1,9 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / halfPi -*** +# halfPi -[rvgeo](../globals.md) / halfPi +```ts +const halfPi: number; +``` -# Variable: halfPi - -> `const` **halfPi**: `number` - -Defined in: src/math/vector.ts:4 +Defined in: [src/math/vector.ts:4](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/vector.ts#L4) diff --git a/docs/api/variables/pi.md b/docs/api/variables/pi.md index d769f5e..1235841 100644 --- a/docs/api/variables/pi.md +++ b/docs/api/variables/pi.md @@ -1,11 +1,9 @@ -[**rvgeo**](../README.md) +[rvgeo](../index.md) / pi -*** +# pi -[rvgeo](../globals.md) / pi +```ts +const pi: number = Math.PI; +``` -# Variable: pi - -> `const` **pi**: `number` = `Math.PI` - -Defined in: src/math/vector.ts:3 +Defined in: [src/math/vector.ts:3](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/math/vector.ts#L3) diff --git a/docs/assets/logo.svg b/docs/assets/logo.svg index 2fc15a8..06c2721 100644 --- a/docs/assets/logo.svg +++ b/docs/assets/logo.svg @@ -1,31 +1,25 @@ - - - - - - - - - + + + + + - + + + + + + + RV - - RV - - Geo.js - - + + Geo.js - - + + \ No newline at end of file diff --git a/docs/documents/index.md b/docs/documents/index.md index 6e0eceb..10a1cf1 100644 --- a/docs/documents/index.md +++ b/docs/documents/index.md @@ -1,10 +1,231 @@ # Core concepts + + +## Usage + | 名称 | 徽章 | 链接 | |------------|--------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------| | NPM | [![](https://img.shields.io/npm/v/rvgeo.svg?label=NPM&logo=npm&color=CB3837)](https://www.npmjs.com/package/rvgeo) | [NPM](https://www.npmjs.com/package/rvgeo) | | Downloads | [![](https://img.shields.io/npm/dm/rvgeo?label=Downloads&color=CB3837&logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAAsQAAALEBxi1JjQAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAKoSURBVEiJ7ZZLTBNRFIb%2FedDS6UNKVQgZAkJTlJdACoZgGhKj0QSNwUVxIbrRhSaasCJh58atcaExkYXogoRISF2UxJVReYkWK6gTB9KK1bZjBQlMNcz0ujAlJe3QamSl%2F%2B7m3PP995w592aAbRaVy6bqanujycZeSa4TKlGXo2qvKIpStlw2FwOdjnG5zvFnS%2BuMAIDJoci3icHoLQB%2FxwAATDYWBSX5AADOwiZyzaNz3fin%2Bm%2FwDxhojSlTW19xgaXz9ACgqIpr05WkQOWb6dMNDVUHAUBJrP%2BY9S%2FcBpA2vpo3udHpeNx0sqiNrzExFEVQWm8Gq%2FtVsLysIPxeBgB8nFtVfZ7o2MspwZWJo9kiKSwf9Xujs9YSHfY4d2zAAYArYFHRbEEhr4ffK71VgsvHtDiMVmBlZUXRMeaRRd9qZ%2B0RmzXVAAASCsHA5XcLkWC8XQiFlrQ4W37kQCAQlhbXOwd7hVBCIZvg%2FlFpms6nnYFAILwVQ7OCpGKxWMRssIhRUT60r73QCACeawuSbyTWN%2FXkzYts%2BRtTVNfc9ojhOCtREsxaJHhRFMXxZMzvEz163V7H0%2Fuf%2BmhC6KBv7cbMjDCUCrLb7a3GorKbFEurqiwvvX7%2B7PAmp5YO93yPQEhXv5c4yivdmU7jbK0acLY57maKOcor3V39XtIjENLS4Z5PqyApmmHA6jkuE2R6XOjW6ARYPcfRTHrH0wxsNU5wFfarDcXFl7RgmZRnMO0urG3ewiChqgCQZ7HCdX2YB8D%2FjkGqiKqoaQbxr1%2BmPowO8Tv3HzCAYcDtKoEcDQGEgCviEZc%2Bg6hKVrj0aiL%2BfSk2mVynPhV0dVPLeZ3B2ApCkcoTZ4bnHw6cAoCy490Pgp57naBI1p%2BE9TV5bG5m8g4yvEvbop%2BZL%2FJtWVlNhAAAAABJRU5ErkJggg%3D%3D)](https://www.npmjs.com/package/rvgeo) | [Downloads](https://www.npmjs.com/package/rvgeo) | | jsDelivr | [![](https://data.jsdelivr.com/v1/package/npm/rvgeo/badge)](https://www.jsdelivr.com/package/npm/rvgeo) | [jsDelivr](https://www.jsdelivr.com/package/npm/rvgeo) | -| Home Page | | [Home Page](https://pzq123456.github.io/RVGeo/) | + +### Browser +``` html + +``` +- test: +```js + console.log(rvgeo); +``` +- result: +``` bash +Module +CGUtils: Module { +MBRIntersectMBR: function, PointInsidePolygon: function, PointOutsideMBR: function, calculateMBR: function, cross: function, …} +#... +``` +### npm + +``` bash +npm install rvgeo +``` + +```js +import * as RVGeo from 'rvgeo' +``` + +## Release Notes +### 2023-11-12 V2.0.7 +> new function for Class Grid : `Grid.fillInvalidValue(bandIndex)`; +> - This function can replace the "invalid value" in given band with the mean value. +> - The so called values are now: -99999, 0. (may the 0 makes no sense and this function will uograde in the future) +- 新增 `RGB` 三通道遥感影像渲染，指定渲染通道对应的波段即可实现真彩色、标准假彩色等遥感影像的渲染。 +- Add `RGB` three-channel remote sensing image rendering, specify the band corresponding to the rendering channel to achieve the rendering of true color, standard false color and other remote sensing images. + +```js +const drawGrid2d = RVGeo.Renderer.drawGrid2d; +const trueColorBandFactory = RVGeo.Colors.trueColorBandFactory; +const drawTrueColorGrid2d2 = RVGeo.Renderer.drawTrueColorGrid2d2; + +let URL = 'exa2.tif'; +let URL2 = 'exa.tif'; +let rect = {x: 512, y: 0, w: 512, h: 512}; +let rect2 = {x: 512, y: 512, w: 512, h: 512}; +getShowTif(URL, rect); +getShowTif(URL2, rect2); + +function getShowTif(URL: string, rect: {x: number, y: number, w: number, h: number}){ +GeoTIFF.fromUrl(URL).then((tif:any) => { + tif.getImage().then((image:any) => { + let width = image.getWidth(); + // let height = image.getHeight(); + image.readRasters().then((rasters:any) => { + let data = [] as number[][][]; + //选择 LadSet8 的 4、3、2 波段 + let bands = [3,2,1]; // 但是索引是从 0 开始的 + bands.forEach((band) => { + data.push(parseData2(rasters[band], width,true,256)); + }); + console.log(data); + let grid = new RVGeo.Coverage.Grid(myMBR1,data); + let myTrueColorBand = trueColorBandFactory(RVGeo.Colors.stretchType.linear); + drawTrueColorGrid2d2(canvas, grid, [0,1,2],rect, myTrueColorBand); + }); + }); +}); +} +``` +- 新增影像直方图，正在测试中，仅供参考。 +```js + const drawSample2 = RVGeo.Renderer.drawSample2; + const drawProgress = RVGeo.Renderer.drawProgress; + const progressBar = {x: 924, y: 1004, w: 100, h: 20}; + drawProgress(canvas,progressBar,0); + + const trueColorBandFactory = RVGeo.Colors.trueColorBandFactory; + const drawTrueColorGrid2d = RVGeo.Renderer.drawTrueColorGrid2d; + + let URL = 'exa2.tif'; + let URL2 = 'exa.tif'; + let rect = {x: 0, y: 0, w: 512, h: 512}; + let rect2 = {x: 0, y: 512, w: 512, h: 512}; + + let rect3r = {x: 512, y: 0, w: 512, h: 170}; + let rect3g = {x: 512, y: 170, w: 512, h: 170}; + let rect3b = {x: 512, y: 340, w: 512, h: 170}; + let rect4r = {x: 512, y: 512, w: 512, h: 170}; + let rect4g = {x: 512, y: 682, w: 512, h: 170}; + let rect4b = {x: 512, y: 852, w: 512, h: 170}; + + getShowTif(URL, rect, [rect3r,rect3g,rect3b]); + getShowTif(URL2, rect2, [rect4r,rect4g,rect4b]); + + +function getShowTif(URL: string, rect: {x: number, y: number, w: number, h: number}, + rect2?: {x: number, y: number, w: number, h: number}[] + ){ + GeoTIFF.fromUrl(URL).then((tif:any) => { + tif.getImage().then((image:any) => { + let width = image.getWidth(); + image.readRasters().then((rasters:any) => { + let data = [] as number[][][]; + // 4、3、2 波段 但是数组的索引是从0开始的 所以是3、2、1 + let bands = [3,2,1]; + bands.forEach((band) => { + data.push(parseData2(rasters[band], width, true, 256)); + }); + let grid = new RVGeo.Coverage.Grid(myMBR1,data); + + grid.fillInvalidValue(0); // 填充无效值 + grid.fillInvalidValue(1); + grid.fillInvalidValue(2); + + let myTrueColorBand = trueColorBandFactory(RVGeo.Colors.stretchType.square); + drawTrueColorGrid2d(canvas, grid, [0,1,2], rect, myTrueColorBand); + drawProgress(canvas,progressBar,50); + if(rect2){ + let styles = [ + {color: "rgba(255,0,0,1)", backgroundColor: "rgba(0,0,0,1)"}, + {color: "rgba(0,255,0,1)", backgroundColor: "rgba(0,0,0,1)"}, + {color: "rgba(0,0,255,1)", backgroundColor: "rgba(0,0,0,1)"} + ] + for(let i = 0; i < rect2.length; i++){ + drawSample2(canvas,rect2[i],grid.getSorted1DArray(i),styles[i]); + } + } + drawProgress(canvas,progressBar,100); + }); + }); + }); +} +``` +### 2023-11-12 V2.0.6 +- 新增影像金字塔（Example14） 图像傅里叶变换（Example15） +- New image pyramid (Example14) image Fourier transform (Example15) +- You can use `RVGeo.Coverage.subdivide2QTree` to get the image pyramid, and use `RVGeo.Renderer.drawQTree2d` to draw the image pyramid. + ```js + const subdivide2QTree = RVGeo.Coverage.subdivide2QTree; + const Grid = RVGeo.Coverage.Grid; + const drawQTree2d = RVGeo.Renderer.drawQTree2d; + const drawGrid2d = RVGeo.Renderer.drawGrid2d; + let mySimpleColorBand = RVGeo.Colors.simpleColorBandFactory(RVGeo.Colors.stretchType.linear); + axios.get('dem.csv').then((res)=>{ + let data = parseData(res.data); + let grid = new Grid(myMBR1,[data]); + let subgrid = subdivide2QTree(grid,10); // 10 为金字塔层数 + drawQTree2d(canvas,{x: 0, y: 0, w: 1024, h: 1024},subgrid,grid,mySimpleColorBand) + drawGrid2d(canvas, data, {x: 1024, y: 0, w: 1024, h: 1024}, grid.getBandStatistics(0), mySimpleColorBand); + }); + ``` +- You can use the following code segment to test 1D FFT and visualize the result. + ``` js + const subdivide2QTree = RVGeo.Coverage.subdivide2QTree; + const Grid = RVGeo.Coverage.Grid; + const drawQTree2d = RVGeo.Renderer.drawQTree2d; + const drawGrid2d = RVGeo.Renderer.drawGrid2d; + let mySimpleColorBand = RVGeo.Colors.simpleColorBandFactory(RVGeo.Colors.stretchType.linear); + axios.get('dem.csv').then((res)=>{ + let data = parseData(res.data); + let grid = new Grid(myMBR1,[data]); + let subgrid = subdivide2QTree(grid,10); + drawQTree2d(canvas,{x: 0, y: 0, w: 1024, h: 1024},subgrid,grid,mySimpleColorBand) + drawGrid2d(canvas, data, {x: 1024, y: 0, w: 1024, h: 1024}, grid.getBandStatistics(0), mySimpleColorBand); + }); + ``` +- You can use the following code segment to test 2D FFT and visualize the result. + ``` js + const subdivide2QTree = RVGeo.Coverage.subdivide2QTree; + const Grid = RVGeo.Coverage.Grid; + const drawQTree2d = RVGeo.Renderer.drawQTree2d; + const drawGrid2d = RVGeo.Renderer.drawGrid2d; + let mySimpleColorBand = RVGeo.Colors.simpleColorBandFactory(RVGeo.Colors.stretchType.linear); + axios.get('dem.csv').then((res)=>{ + let data = parseData(res.data); + let grid = new Grid(myMBR1,[data]); + let subgrid = subdivide2QTree(grid,10); + drawQTree2d(canvas,{x: 0, y: 0, w: 1024, h: 1024},subgrid,grid,mySimpleColorBand) + drawGrid2d(canvas, data, {x: 1024, y: 0, w: 1024, h: 1024}, grid.getBandStatistics(0), mySimpleColorBand); + }); + ``` + + +### 2023-11-4 V2.0.5 +- 新增等值线计算与渲染（基于 Marching Squares 方法） +- Contour calculation and rendering (based on Marching Squares method) +- You can use `RVGeo.Renderer.drawCountour` to draw contour lines, after you get the contour code from `RVGeo.Coverage.Grid.getCoutourCode` +```ts + const drawCountour = RVGeo.Renderer.drawCountour; + + axios.get('dem.csv').then((res)=>{ + let data = parseData(res.data); + let grid = new RVGeo.Coverage.Grid(myMBR1,[data]); + let countour1 = grid.getCoutourCode(0,0.6); + drawCountour(canvas, countour1, {x: 0, y: 0, w: 1024, h: 1024},"red"); + }) +``` + + +### 2023-11-2 V2.0.4 +- 栅格数据新增伪彩色渲染器 +- New pseudocolor renderer for raster data +- 噪声模块新增三维 sin 函数噪声、三维柏林噪声及三维阻尼 sin 函数噪声 +- New 3D sin noise, 3D Perlin noise and 3D damped sin noise in noise module + +## Example +```js +let ps = mockPoints(30, myMBR1); +let mps = new RVGeo.Geometry.MultiPoint(ps); + +function example1(){ // 绘制多点及其重心 + removeAllOverlay(map); + let icon = innerIcon(0); + // console.log(mps.calculateCentroid()); + drawPoint2BLMap(mps.calculateCentroid(), map); + drawMultiPoint2BLMap(mps, map, icon); +} +``` ## 0. 项目总体结构安排 diff --git a/docs/index.md b/docs/index.md index f5eae1a..df29170 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,7 +6,7 @@ hero: name: "RVGeo" text: "Raster & Vector Geospatial" tagline: RVGeo is a frontend TypeScript library for simple spatial data computation and visualization - image: /assets/logo.svg + image: ./assets/logo.svg actions: - theme: brand text: start diff --git a/package-lock.json b/package-lock.json index 1ced3f8..cfe02c1 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "rvgeo", - "version": "2.0.9", + "version": "2.0.91", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "rvgeo", - "version": "2.0.9", + "version": "2.0.91", "license": "MIT", "dependencies": { "axios": "^1.6.0", @@ -14,8 +14,10 @@ "vite-plugin-dts": "latest" }, "devDependencies": { + "markdown-it-mathjax3": "^4.3.2", "typedoc": "^0.27.6", "typedoc-plugin-markdown": "^4.4.0", + "typedoc-vitepress-theme": "^1.1.1", "typescript": "latest", "vite": "latest", "vitepress": "latest", @@ -2012,6 +2014,16 @@ "integrity": "sha512-cZIRkbERILsBOXTQmMrxc9hgpxglstn69zm+F1ARf4aPAzdAFYd6sBq87ErO0Fj3DV94tglcyHG5kQz9nDC/8A==", "license": "MIT" }, + "node_modules/ansi-colors": { + "version": "4.1.3", + "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.3.tgz", + "integrity": "sha512-/6w/C21Pm1A7aZitlI5Ni/2J6FFQN8i1Cvz3kHABAAbw93v/NlvKdVOqz7CCWz/3iv/JplRSEEZ83XION15ovw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, "node_modules/argparse": { "version": "2.0.1", "resolved": "https://registry.npmmirror.com/argparse/-/argparse-2.0.1.tgz", @@ -2062,6 +2074,13 @@ "url": "https://github.com/sponsors/antfu" } }, + "node_modules/boolbase": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/boolbase/-/boolbase-1.0.0.tgz", + "integrity": "sha512-JZOSA7Mo9sNGB8+UjSgzdLtokWAky1zbztM3WRLCbZ70/3cTANmQmOdR7y2g+J0e2WXywy1yS468tY+IruqEww==", + "dev": true, + "license": "ISC" + }, "node_modules/brace-expansion": { "version": "2.0.1", "resolved": "https://registry.npmmirror.com/brace-expansion/-/brace-expansion-2.0.1.tgz", @@ -2141,6 +2160,45 @@ "node": ">= 16" } }, + "node_modules/cheerio": { + "version": "1.0.0-rc.10", + "resolved": "https://registry.npmjs.org/cheerio/-/cheerio-1.0.0-rc.10.tgz", + "integrity": "sha512-g0J0q/O6mW8z5zxQ3A8E8J1hUgp4SMOvEoW/x84OwyHKe/Zccz83PVT4y5Crcr530FV6NgmKI1qvGTKVl9XXVw==", + "dev": true, + "license": "MIT", + "dependencies": { + "cheerio-select": "^1.5.0", + "dom-serializer": "^1.3.2", + "domhandler": "^4.2.0", + "htmlparser2": "^6.1.0", + "parse5": "^6.0.1", + "parse5-htmlparser2-tree-adapter": "^6.0.1", + "tslib": "^2.2.0" + }, + "engines": { + "node": ">= 6" + }, + "funding": { + "url": "https://github.com/cheeriojs/cheerio?sponsor=1" + } + }, + "node_modules/cheerio-select": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/cheerio-select/-/cheerio-select-1.6.0.tgz", + "integrity": "sha512-eq0GdBvxVFbqWgmCm7M3XGs1I8oLy/nExUnh6oLqmBditPO9AqQJrkslDpMun/hZ0yyTs8L0m85OHp4ho6Qm9g==", + "dev": true, + "license": "BSD-2-Clause", + "dependencies": { + "css-select": "^4.3.0", + "css-what": "^6.0.1", + "domelementtype": "^2.2.0", + "domhandler": "^4.3.1", + "domutils": "^2.8.0" + }, + "funding": { + "url": "https://github.com/sponsors/fb55" + } + }, "node_modules/combined-stream": { "version": "1.0.8", "resolved": "https://registry.npmmirror.com/combined-stream/-/combined-stream-1.0.8.tgz", @@ -2164,6 +2222,16 @@ "url": "https://github.com/sponsors/wooorm" } }, + "node_modules/commander": { + "version": "6.2.1", + "resolved": "https://registry.npmjs.org/commander/-/commander-6.2.1.tgz", + "integrity": "sha512-U7VdrJFnJgo4xjrHpTzu0yrHPGImdsmD95ZlgYSEajAn2JKzDhDTPG9kBTefmObL2w/ngeZnilk+OV9CG3d7UA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 6" + } + }, "node_modules/compare-versions": { "version": "6.1.1", "resolved": "https://registry.npmmirror.com/compare-versions/-/compare-versions-6.1.1.tgz", @@ -2198,6 +2266,36 @@ "url": "https://github.com/sponsors/mesqueeb" } }, + "node_modules/css-select": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/css-select/-/css-select-4.3.0.tgz", + "integrity": "sha512-wPpOYtnsVontu2mODhA19JrqWxNsfdatRKd64kmpRbQgh1KtItko5sTnEpPdpSaJszTOhEMlF/RPz28qj4HqhQ==", + "dev": true, + "license": "BSD-2-Clause", + "dependencies": { + "boolbase": "^1.0.0", + "css-what": "^6.0.1", + "domhandler": "^4.3.1", + "domutils": "^2.8.0", + "nth-check": "^2.0.1" + }, + "funding": { + "url": "https://github.com/sponsors/fb55" + } + }, + "node_modules/css-what": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/css-what/-/css-what-6.1.0.tgz", + "integrity": "sha512-HTUrgRJ7r4dsZKU6GjmpfRK1O76h97Z8MfS1G0FozR+oF2kG6Vfe8JE6zwrkbxigziPHinCJ+gCPjA9EaBDtRw==", + "dev": true, + "license": "BSD-2-Clause", + "engines": { + "node": ">= 6" + }, + "funding": { + "url": "https://github.com/sponsors/fb55" + } + }, "node_modules/csstype": { "version": "3.1.3", "resolved": "https://registry.npmmirror.com/csstype/-/csstype-3.1.3.tgz", @@ -2271,6 +2369,75 @@ "url": "https://github.com/sponsors/wooorm" } }, + "node_modules/dom-serializer": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/dom-serializer/-/dom-serializer-1.4.1.tgz", + "integrity": "sha512-VHwB3KfrcOOkelEG2ZOfxqLZdfkil8PtJi4P8N2MMXucZq2yLp75ClViUlOVwyoHEDjYU433Aq+5zWP61+RGag==", + "dev": true, + "license": "MIT", + "dependencies": { + "domelementtype": "^2.0.1", + "domhandler": "^4.2.0", + "entities": "^2.0.0" + }, + "funding": { + "url": "https://github.com/cheeriojs/dom-serializer?sponsor=1" + } + }, + "node_modules/dom-serializer/node_modules/entities": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/entities/-/entities-2.2.0.tgz", + "integrity": "sha512-p92if5Nz619I0w+akJrLZH0MX0Pb5DX39XOwQTtXSdQQOaYH03S1uIQp4mhOZtAXrxq4ViO67YTiLBo2638o9A==", + "dev": true, + "license": "BSD-2-Clause", + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, + "node_modules/domelementtype": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/domelementtype/-/domelementtype-2.3.0.tgz", + "integrity": "sha512-OLETBj6w0OsagBwdXnPdN0cnMfF9opN69co+7ZrbfPGrdpPVNBUj02spi6B1N7wChLQiPn4CSH/zJvXw56gmHw==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/fb55" + } + ], + "license": "BSD-2-Clause" + }, + "node_modules/domhandler": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-4.3.1.tgz", + "integrity": "sha512-GrwoxYN+uWlzO8uhUXRl0P+kHE4GtVPfYzVLcUxPL7KNdHKj66vvlhiweIHqYYXWlw+T8iLMp42Lm67ghw4WMQ==", + "dev": true, + "license": "BSD-2-Clause", + "dependencies": { + "domelementtype": "^2.2.0" + }, + "engines": { + "node": ">= 4" + }, + "funding": { + "url": "https://github.com/fb55/domhandler?sponsor=1" + } + }, + "node_modules/domutils": { + "version": "2.8.0", + "resolved": "https://registry.npmjs.org/domutils/-/domutils-2.8.0.tgz", + "integrity": "sha512-w96Cjofp72M5IIhpjgobBimYEfoPjx1Vx0BSX9P30WBdZW2WIKU0T1Bd0kz2eNZ9ikjKgHbEyKx8BB6H1L3h3A==", + "dev": true, + "license": "BSD-2-Clause", + "dependencies": { + "dom-serializer": "^1.0.1", + "domelementtype": "^2.2.0", + "domhandler": "^4.2.0" + }, + "funding": { + "url": "https://github.com/fb55/domutils?sponsor=1" + } + }, "node_modules/emoji-regex-xs": { "version": "1.0.0", "resolved": "https://registry.npmmirror.com/emoji-regex-xs/-/emoji-regex-xs-1.0.0.tgz", @@ -2336,6 +2503,29 @@ "@esbuild/win32-x64": "0.21.5" } }, + "node_modules/escape-goat": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/escape-goat/-/escape-goat-3.0.0.tgz", + "integrity": "sha512-w3PwNZJwRxlp47QGzhuEBldEqVHHhh8/tIPcl6ecf2Bou99cdAt0knihBV0Ecc7CGxYduXVBDheH1K2oADRlvw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/esm": { + "version": "3.2.25", + "resolved": "https://registry.npmjs.org/esm/-/esm-3.2.25.tgz", + "integrity": "sha512-U1suiZ2oDVWv4zPO56S0NcR5QriEahGtdN2OR6FiOG4WJvcjBVFB0qI4+eKoWFH483PKGuLuu6V8Z4T5g63UVA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, "node_modules/estree-walker": { "version": "2.0.2", "resolved": "https://registry.npmmirror.com/estree-walker/-/estree-walker-2.0.2.tgz", @@ -2532,6 +2722,36 @@ "url": "https://github.com/sponsors/wooorm" } }, + "node_modules/htmlparser2": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-6.1.0.tgz", + "integrity": "sha512-gyyPk6rgonLFEDGoeRgQNaEUvdJ4ktTmmUh/h2t7s+M8oPpIPxgNACWa+6ESR57kXstwqPiCut0V8NRpcwgU7A==", + "dev": true, + "funding": [ + "https://github.com/fb55/htmlparser2?sponsor=1", + { + "type": "github", + "url": "https://github.com/sponsors/fb55" + } + ], + "license": "MIT", + "dependencies": { + "domelementtype": "^2.0.1", + "domhandler": "^4.0.0", + "domutils": "^2.5.2", + "entities": "^2.0.0" + } + }, + "node_modules/htmlparser2/node_modules/entities": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/entities/-/entities-2.2.0.tgz", + "integrity": "sha512-p92if5Nz619I0w+akJrLZH0MX0Pb5DX39XOwQTtXSdQQOaYH03S1uIQp4mhOZtAXrxq4ViO67YTiLBo2638o9A==", + "dev": true, + "license": "BSD-2-Clause", + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, "node_modules/import-lazy": { "version": "4.0.0", "resolved": "https://registry.npmmirror.com/import-lazy/-/import-lazy-4.0.0.tgz", @@ -2590,6 +2810,26 @@ "graceful-fs": "^4.1.6" } }, + "node_modules/juice": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/juice/-/juice-8.1.0.tgz", + "integrity": "sha512-FLzurJrx5Iv1e7CfBSZH68dC04EEvXvvVvPYB7Vx1WAuhCp1ZPIMtqxc+WTWxVkpTIC2Ach/GAv0rQbtGf6YMA==", + "dev": true, + "license": "MIT", + "dependencies": { + "cheerio": "1.0.0-rc.10", + "commander": "^6.1.0", + "mensch": "^0.3.4", + "slick": "^1.12.2", + "web-resource-inliner": "^6.0.1" + }, + "bin": { + "juice": "bin/juice" + }, + "engines": { + "node": ">=10.0.0" + } + }, "node_modules/kolorist": { "version": "1.8.0", "resolved": "https://registry.npmmirror.com/kolorist/-/kolorist-1.8.0.tgz", @@ -2688,6 +2928,30 @@ "markdown-it": "bin/markdown-it.mjs" } }, + "node_modules/markdown-it-mathjax3": { + "version": "4.3.2", + "resolved": "https://registry.npmjs.org/markdown-it-mathjax3/-/markdown-it-mathjax3-4.3.2.tgz", + "integrity": "sha512-TX3GW5NjmupgFtMJGRauioMbbkGsOXAAt1DZ/rzzYmTHqzkO1rNAdiMD4NiruurToPApn2kYy76x02QN26qr2w==", + "dev": true, + "license": "MIT", + "dependencies": { + "juice": "^8.0.0", + "mathjax-full": "^3.2.0" + } + }, + "node_modules/mathjax-full": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/mathjax-full/-/mathjax-full-3.2.2.tgz", + "integrity": "sha512-+LfG9Fik+OuI8SLwsiR02IVdjcnRCy5MufYLi0C3TdMT56L/pjB0alMVGgoWJF8pN9Rc7FESycZB9BMNWIid5w==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "esm": "^3.2.25", + "mhchemparser": "^4.1.0", + "mj-context-menu": "^0.6.1", + "speech-rule-engine": "^4.0.6" + } + }, "node_modules/mdast-util-to-hast": { "version": "13.2.0", "resolved": "https://registry.npmmirror.com/mdast-util-to-hast/-/mdast-util-to-hast-13.2.0.tgz", @@ -2717,6 +2981,20 @@ "dev": true, "license": "MIT" }, + "node_modules/mensch": { + "version": "0.3.4", + "resolved": "https://registry.npmjs.org/mensch/-/mensch-0.3.4.tgz", + "integrity": "sha512-IAeFvcOnV9V0Yk+bFhYR07O3yNina9ANIN5MoXBKYJ/RLYPurd2d0yw14MDhpr9/momp0WofT1bPUh3hkzdi/g==", + "dev": true, + "license": "MIT" + }, + "node_modules/mhchemparser": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/mhchemparser/-/mhchemparser-4.2.1.tgz", + "integrity": "sha512-kYmyrCirqJf3zZ9t/0wGgRZ4/ZJw//VwaRVGA75C4nhE60vtnIzhl9J9ndkX/h6hxSN7pjg/cE0VxbnNM+bnDQ==", + "dev": true, + "license": "Apache-2.0" + }, "node_modules/micromark-util-character": { "version": "2.1.1", "resolved": "https://registry.npmmirror.com/micromark-util-character/-/micromark-util-character-2.1.1.tgz", @@ -2811,6 +3089,19 @@ ], "license": "MIT" }, + "node_modules/mime": { + "version": "2.6.0", + "resolved": "https://registry.npmjs.org/mime/-/mime-2.6.0.tgz", + "integrity": "sha512-USPkMeET31rOMiarsBNIHZKLGgvKc/LrjofAnBlOttf5ajRvqiRA8QsenbcooctK6d6Ts6aqZXBA+XbkKthiQg==", + "dev": true, + "license": "MIT", + "bin": { + "mime": "cli.js" + }, + "engines": { + "node": ">=4.0.0" + } + }, "node_modules/mime-db": { "version": "1.52.0", "resolved": "https://registry.npmmirror.com/mime-db/-/mime-db-1.52.0.tgz", @@ -2861,6 +3152,13 @@ "dev": true, "license": "MIT" }, + "node_modules/mj-context-menu": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/mj-context-menu/-/mj-context-menu-0.6.1.tgz", + "integrity": "sha512-7NO5s6n10TIV96d4g2uDpG7ZDpIhMh0QNfGdJw/W47JswFcosz457wqz/b5sAKvl12sxINGFCn80NZHKwxQEXA==", + "dev": true, + "license": "Apache-2.0" + }, "node_modules/mlly": { "version": "1.7.3", "resolved": "https://registry.npmmirror.com/mlly/-/mlly-1.7.3.tgz", @@ -2904,6 +3202,40 @@ "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" } }, + "node_modules/node-fetch": { + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz", + "integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==", + "dev": true, + "license": "MIT", + "dependencies": { + "whatwg-url": "^5.0.0" + }, + "engines": { + "node": "4.x || >=6.0.0" + }, + "peerDependencies": { + "encoding": "^0.1.0" + }, + "peerDependenciesMeta": { + "encoding": { + "optional": true + } + } + }, + "node_modules/nth-check": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/nth-check/-/nth-check-2.1.1.tgz", + "integrity": "sha512-lqjrjmaOoAnWfMmBPL+XNnynZh2+swxiX3WUE0s4yEHI6m+AwrK2UZOimIRl3X/4QctVqS8AiZjFqyOGrMXb/w==", + "dev": true, + "license": "BSD-2-Clause", + "dependencies": { + "boolbase": "^1.0.0" + }, + "funding": { + "url": "https://github.com/fb55/nth-check?sponsor=1" + } + }, "node_modules/oniguruma-to-es": { "version": "0.8.1", "resolved": "https://registry.npmmirror.com/oniguruma-to-es/-/oniguruma-to-es-0.8.1.tgz", @@ -2916,6 +3248,23 @@ "regex-recursion": "^5.0.0" } }, + "node_modules/parse5": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/parse5/-/parse5-6.0.1.tgz", + "integrity": "sha512-Ofn/CTFzRGTTxwpNEs9PP93gXShHcTq255nzRYSKe8AkVpZY7e1fpmTfOyoIvjP5HG7Z2ZM7VS9PPhQGW2pOpw==", + "dev": true, + "license": "MIT" + }, + "node_modules/parse5-htmlparser2-tree-adapter": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/parse5-htmlparser2-tree-adapter/-/parse5-htmlparser2-tree-adapter-6.0.1.tgz", + "integrity": "sha512-qPuWvbLgvDGilKc5BoicRovlT4MtYT6JfJyBOMDsKoiT+GiuP5qyrPCnR9HcPECIJJmZh5jRndyNThnhhb/vlA==", + "dev": true, + "license": "MIT", + "dependencies": { + "parse5": "^6.0.1" + } + }, "node_modules/path-browserify": { "version": "1.0.1", "resolved": "https://registry.npmmirror.com/path-browserify/-/path-browserify-1.0.1.tgz", @@ -3211,6 +3560,16 @@ "dev": true, "license": "ISC" }, + "node_modules/slick": { + "version": "1.12.2", + "resolved": "https://registry.npmjs.org/slick/-/slick-1.12.2.tgz", + "integrity": "sha512-4qdtOGcBjral6YIBCWJ0ljFSKNLz9KkhbWtuGvUyRowl1kxfuE1x/Z/aJcaiilpb3do9bl5K7/1h9XC5wWpY/A==", + "dev": true, + "license": "MIT (http://mootools.net/license.txt)", + "engines": { + "node": "*" + } + }, "node_modules/source-map": { "version": "0.6.1", "resolved": "https://registry.npmmirror.com/source-map/-/source-map-0.6.1.tgz", @@ -3250,6 +3609,31 @@ "node": ">=0.10.0" } }, + "node_modules/speech-rule-engine": { + "version": "4.0.7", + "resolved": "https://registry.npmjs.org/speech-rule-engine/-/speech-rule-engine-4.0.7.tgz", + "integrity": "sha512-sJrL3/wHzNwJRLBdf6CjJWIlxC04iYKkyXvYSVsWVOiC2DSkHmxsqOhEeMsBA9XK+CHuNcsdkbFDnoUfAsmp9g==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "commander": "9.2.0", + "wicked-good-xpath": "1.3.0", + "xmldom-sre": "0.1.31" + }, + "bin": { + "sre": "bin/sre" + } + }, + "node_modules/speech-rule-engine/node_modules/commander": { + "version": "9.2.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-9.2.0.tgz", + "integrity": "sha512-e2i4wANQiSXgnrBlIatyHtP1odfUp0BbV5Y5nEGbxtIrStkEOAAzCUirvLBNXHLr7kwLvJl6V+4V3XV9x7Wd9w==", + "dev": true, + "license": "MIT", + "engines": { + "node": "^12.20.0 || >=14" + } + }, "node_modules/sprintf-js": { "version": "1.0.3", "resolved": "https://registry.npmmirror.com/sprintf-js/-/sprintf-js-1.0.3.tgz", @@ -3397,6 +3781,13 @@ "node": ">=14.0.0" } }, + "node_modules/tr46": { + "version": "0.0.3", + "resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz", + "integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==", + "dev": true, + "license": "MIT" + }, "node_modules/trim-lines": { "version": "3.0.1", "resolved": "https://registry.npmmirror.com/trim-lines/-/trim-lines-3.0.1.tgz", @@ -3408,6 +3799,13 @@ "url": "https://github.com/sponsors/wooorm" } }, + "node_modules/tslib": { + "version": "2.8.1", + "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.8.1.tgz", + "integrity": "sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==", + "dev": true, + "license": "0BSD" + }, "node_modules/typedoc": { "version": "0.27.6", "resolved": "https://mirrors.huaweicloud.com/repository/npm/typedoc/-/typedoc-0.27.6.tgz", @@ -3444,6 +3842,16 @@ "typedoc": "0.27.x" } }, + "node_modules/typedoc-vitepress-theme": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/typedoc-vitepress-theme/-/typedoc-vitepress-theme-1.1.1.tgz", + "integrity": "sha512-1UbhZdQIkGKLkIZCbw8putrel+Vo7KKFfd8RhQRSBgetUZGUJkum89kIyF3+Kzy+1nqE56/MLKVxpPgQYubYYg==", + "dev": true, + "license": "MIT", + "peerDependencies": { + "typedoc-plugin-markdown": ">=4.3.0" + } + }, "node_modules/typescript": { "version": "5.7.2", "resolved": "https://registry.npmmirror.com/typescript/-/typescript-5.7.2.tgz", @@ -3561,6 +3969,16 @@ "punycode": "^2.1.0" } }, + "node_modules/valid-data-url": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/valid-data-url/-/valid-data-url-3.0.1.tgz", + "integrity": "sha512-jOWVmzVceKlVVdwjNSenT4PbGghU0SBIizAev8ofZVgivk/TVHXSbNL8LP6M3spZvkR9/QolkyJavGSX5Cs0UA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10" + } + }, "node_modules/vfile": { "version": "6.0.3", "resolved": "https://registry.npmmirror.com/vfile/-/vfile-6.0.3.tgz", @@ -3839,6 +4257,84 @@ } } }, + "node_modules/web-resource-inliner": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/web-resource-inliner/-/web-resource-inliner-6.0.1.tgz", + "integrity": "sha512-kfqDxt5dTB1JhqsCUQVFDj0rmY+4HLwGQIsLPbyrsN9y9WV/1oFDSx3BQ4GfCv9X+jVeQ7rouTqwK53rA/7t8A==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-colors": "^4.1.1", + "escape-goat": "^3.0.0", + "htmlparser2": "^5.0.0", + "mime": "^2.4.6", + "node-fetch": "^2.6.0", + "valid-data-url": "^3.0.0" + }, + "engines": { + "node": ">=10.0.0" + } + }, + "node_modules/web-resource-inliner/node_modules/domhandler": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/domhandler/-/domhandler-3.3.0.tgz", + "integrity": "sha512-J1C5rIANUbuYK+FuFL98650rihynUOEzRLxW+90bKZRWB6A1X1Tf82GxR1qAWLyfNPRvjqfip3Q5tdYlmAa9lA==", + "dev": true, + "license": "BSD-2-Clause", + "dependencies": { + "domelementtype": "^2.0.1" + }, + "engines": { + "node": ">= 4" + }, + "funding": { + "url": "https://github.com/fb55/domhandler?sponsor=1" + } + }, + "node_modules/web-resource-inliner/node_modules/entities": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/entities/-/entities-2.2.0.tgz", + "integrity": "sha512-p92if5Nz619I0w+akJrLZH0MX0Pb5DX39XOwQTtXSdQQOaYH03S1uIQp4mhOZtAXrxq4ViO67YTiLBo2638o9A==", + "dev": true, + "license": "BSD-2-Clause", + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, + "node_modules/web-resource-inliner/node_modules/htmlparser2": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/htmlparser2/-/htmlparser2-5.0.1.tgz", + "integrity": "sha512-vKZZra6CSe9qsJzh0BjBGXo8dvzNsq/oGvsjfRdOrrryfeD9UOBEEQdeoqCRmKZchF5h2zOBMQ6YuQ0uRUmdbQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "domelementtype": "^2.0.1", + "domhandler": "^3.3.0", + "domutils": "^2.4.2", + "entities": "^2.0.0" + }, + "funding": { + "url": "https://github.com/fb55/htmlparser2?sponsor=1" + } + }, + "node_modules/webidl-conversions": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz", + "integrity": "sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ==", + "dev": true, + "license": "BSD-2-Clause" + }, + "node_modules/whatwg-url": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz", + "integrity": "sha512-saE57nupxk6v3HY35+jzBwYa0rKSy0XR8JSxZPwgLr7ys0IBzhGviA1/TUGJLmSVqs8pb9AnvICXEuOHLprYTw==", + "dev": true, + "license": "MIT", + "dependencies": { + "tr46": "~0.0.3", + "webidl-conversions": "^3.0.0" + } + }, "node_modules/why-is-node-running": { "version": "2.3.0", "resolved": "https://registry.npmmirror.com/why-is-node-running/-/why-is-node-running-2.3.0.tgz", @@ -3856,6 +4352,23 @@ "node": ">=8" } }, + "node_modules/wicked-good-xpath": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/wicked-good-xpath/-/wicked-good-xpath-1.3.0.tgz", + "integrity": "sha512-Gd9+TUn5nXdwj/hFsPVx5cuHHiF5Bwuc30jZ4+ronF1qHK5O7HD0sgmXWSEgwKquT3ClLoKPVbO6qGwVwLzvAw==", + "dev": true, + "license": "MIT" + }, + "node_modules/xmldom-sre": { + "version": "0.1.31", + "resolved": "https://registry.npmjs.org/xmldom-sre/-/xmldom-sre-0.1.31.tgz", + "integrity": "sha512-f9s+fUkX04BxQf+7mMWAp5zk61pciie+fFLC9hX9UVvCeJQfNHRHXpeo5MPcR0EUf57PYLdt+ZO4f3Ipk2oZUw==", + "dev": true, + "license": "(LGPL-2.0 or MIT)", + "engines": { + "node": ">=0.1" + } + }, "node_modules/yallist": { "version": "4.0.0", "resolved": "https://registry.npmmirror.com/yallist/-/yallist-4.0.0.tgz", diff --git a/package.json b/package.json index 02ac4f1..f27d101 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "rvgeo", + "name": "rvgeo", "version": "2.0.91", "description": "RVGeo is a frontend TypeScript library for simple spatial data computation and visualization.", "main": "./dist/rvgeo.umd.cjs", @@ -42,8 +42,10 @@ "docs:preview": "vitepress preview docs" }, "devDependencies": { + "markdown-it-mathjax3": "^4.3.2", "typedoc": "^0.27.6", "typedoc-plugin-markdown": "^4.4.0", + "typedoc-vitepress-theme": "^1.1.1", "typescript": "latest", "vite": "latest", "vitepress": "latest", diff --git a/tsconfig.json b/tsconfig.json index fad3c72..f8cc03f 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -26,8 +26,20 @@ "include": ["src"], "typedocOptions": { - "plugin": ["typedoc-plugin-markdown"], - "entryPoints": ["src/index.ts"], - "out": "./docs/api/", + "entryPoints": ["src/index.ts"], + + "plugin": ["typedoc-plugin-markdown", "typedoc-vitepress-theme"], + "githubPages": false, + "readme": "none", + "indexFormat": "table", + "useCodeBlocks": true, + // "disableSources": true, + "textContentMappings": { + "title.indexPage": "API Reference", + "title.memberPage": "{name}" + }, + + "out": "./docs/api/", + "docsRoot": "./docs" } } \ No newline at end of file