diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index bca8912..1a6e150 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE52ba1PjNhSG/0s+026XvbTlW4CwhQmQJoYN7OzsKLES1DpWVpZp2E7/e8dW7Mj20TnHfGKG876PdTm62cqXfwdW7uzgZHAtzXKiVWoHR4OtsE+Dk8FGx3kiszd16Ocnu0kGR4O/VRoPTt4fDZZPKomNTAcnX2rQTOdmKbMDxr5sG5C9oAk7/uX3X99+OP7vqOaIxCqbx/LC6E1hFlabxwN1ladLq3Tqk0FL8zkf33uPWCz0LtLzh8dTnadxhsNbYgS71OmzNBbH7UUIJhHWr8gDzmurMXAS6UJHAPcqAjSZ05jJnIBEKpE0plAxQJMdDzXZYbB07TcnVcmWGgFvpFlGejzGgZWKABUPGws7Wwqq/dpqBni+MnozTtc8cKVmgB9KqSAGSFvNAD8W0uF+EuDRGxbkEdsd3WlOQ0DoVK9UCMiW6cuZtXwlAty9/Ij06ektkee1rIP66sFmx2daG79k1UpSRVgLyeWV1bMIKlCNcRKkXrPI6ssrlOEkGENFKqJKUokQzvzh0eoLsQS7vwbVKg7p7p7HursnVkGidk5CMIjCOAnCWJUFtcUSi4I8HY/2CRy3EO8TNnoLXamxmqhqQ0kTuTyClqhUClOkM4HzhSSvaBkiO3whxtPpWNiI7F9Px6MR/dtQIsRUqvXTQpuMmDA8HUL7novYCKuWjA5paTlURre0tNhyIlJGKWsVTmKUrFYRS9z8odhVzaJHrTc4sCVmce/ue3CdmFpBx2WqoUhPRyyigdPYPsBaQkUcw4XZn5fiGKmRiONiqygMgXAiBBSrzIo0tO45TqVhYEbC2CcOqxRi06/Rm9BYdySnIBBYpx8wgS6HUKH5rA3DV6tiMByfySS5PKdwlY7CBUa1B8JGtBPQlSs0BCY0Ux0g+LpbCuiSFBoEs5Y2vJ1zlL0EW8dkusbT2Smw40+eYP5NnuBmepTXImz51GYjEvUDbY9ahICyfIEhsnyBm+nq1CJsnQieG/YHK/zQYNG1oEKQk4LVnDF8UOEodPxS63Fwe1DZgSHnL2hj8SK9XlkmIstk9qb8d9P49vg3z9c8MFe27gG565pZbQLWMoT5T0UmL6SwuU9QqZWm2Ixnb7x460Xmh48w5kwniSwbjQIelBT6k9Qbac1LkFgJMNCZexMpY5TWUWHI2THWdnWUhSDaDdCh2Ki1rfJREbCzatrr3LndlukPctoiDHgvl1Ybsi+7Mhp6nSdWTXTystYpAw7J6YeEW9OLczDcYvYo4dBaoxZ5q6Pc5wg/Rn2JaL4Xc/7uSzDIp3ddn9799JbjfHcOed+dU97OQB2rzLZRoIgmaxOrVNju1x0vRFGaWyZn7+6RAF97Rtlbwakk5IYmkwYnOIvQxOhlGypdU9Sb3GnuroLJRMrYo2Sh8pCl6I5v5w+M5qAfqoYfozhXs9ubcCo0oxRrrFI5s0b5H0oc5xDhM7qj3o/14YTaGtLwuTS1P/P6XiR5N6k6AoroZJ0Pz+V/ed7uV2vmk4u1M5wIrXBPWjclOoLexFA3BoU9n8Dkv5Ie6ixQxWK3tjEeD9rAIIxAZ+1jfThoE7Y0fC5N7cksd2MBWhnrwwm23j7aj0XUtaXqw+aQX8PFErspoahgQrNyOZDGzAwmkrdn3qIp2ytbA4nKzNFgerIzk0zK3vlIpGLPLMQTsGfuGbVRVj13luI6QBP0X/De7BBhMLbSWAXUpo5QDHBDwdpPlKKhMaLTMYcIySgPvMipqyPgEQMnqUawFylQMO6pwKlDidyM9mNB54SugscsNha3q1UmO9NqO87nwdvFdrwvD2/J/rsv7/0Q1QgtUU8y1hw999CgCW+YV+5NG2/PgEW3He/LYxS610rYfduHklnrY9dBJklDx+M7bWCy2Qd5JEbDvqJN0ebs1ZKMRuzVfsMD41kYJRbFRYJh0/XON4yG0+iPb2eX07O764vRdHRzNoIQgIyETofnl3ezMM3FmZhvoz/vhtHt9HI4poielAuf3I6HU5JbqhDk9XA6Q2rthXkQos6wkokO1rgjQoHz0Twa3UQwaB/EAeNhyD0eYtbiluHtszSJ2EJfK70w8q1zUV6XhT+XVjHMnqsknn0/b7x39wiHMA8CXvH14whmKYsPKHBVqhhmLy4Vgd4iQBknOlPNTXwLUAkoUHGtKcQwkmOHP+YfohgiUdvmpxwPsI9hdp1aoVKwE6sYdutJriM9FWAnVDHGpSnQTt+5kjsr0zhU+0MUu2wTuCJT/L/9JaxzS+ccKb4fJzChazpVjLDDycO6HHZ5NROb4LNdlER8NvBsdogSiPBdFPbVtNbetkkANrbAZTQUAV5rZF5BY109g6+vkHfFyg/QmVzCs/AhiiGyUP65CGodS7GCrUUEsSbyWSaQswwgxo00a1kMaglW2QsjkPqSNISogxwAPPh4l7DT4g/o3mGZthVGwpnqIpi1SGJkA+LHUQzYcFuNNdnWyGfQZeQzYjMijvS5BH/nVcVQe7oGk7sMYEb5T/FPyFlGEGumNttErV4gcxVD7T8knFYuQljhSchFEKv7KQ783CqG2kNW6iIieM/V4j9Vw+4vMu8twtbZMWELrhJ1EAeAnfPKy43Urx30XarCv770wijEHehhgouh9s/XsPXzNWYzIs1W2oTX9aYCQZUXiXY32ITfknRgX/8H8q4Amog+AAA=" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE52Y3W7bMAyF30XX2bqm6Iblrj9ogWFdCqQoBgy98FKlVedYgawMCYa9++A4i22RFMnc5hx+luijmPaPPybaTTQTc1nU9sYWcR2sGZlVEV/NxLgq2rAo5rY+6envX+OyNCPzy1XPZjI+//h3hGGufFnaeXS+4oCdk0PfWr+0MWxJ4n9DDjQb5zZ6UEUIZpOIL4t9uPeuijiq1XLlj3YefWD7BG089G5dRnfvy+2LrwRwzM5fhN58T5dgpMtUrPAixuB+rps7WHfEuF3Z+qSvJYwPnz+dno/7Kb6cfk/rm9/4Or+BdX7z7lRSeXaN1Z5dc7VX3odnVxXRgk33JI5yU8xtWt78xtalx3Rfip5Pqho7oQMOeTR54sN2Ra1uaFKTQbuhQ8jMrFGxMmo97CrgKWzriTNH1mPb6Gsc58ts+o2OwlDlWF9dZWcxuOol5XSKnAHPZl/TcKheYx45l6fqmXePRbmGoQIGjtjaUkz7q6wWrEF65eYJRwchkZU0GAlgUBOp20galVcQ8o+kUzcLdYnYybDR42FjRoZB3Ky9puFkW5h45FyeqmTuZiaCttM0HLJ7e1XHYvaauDRsCfkYbi7YQwtHRQMtyjIRY2GCmfAqc5uNrCqtRFCFGSXjKU4mG0p1HpkoKlOYD6Aye8EtXXS/waP4IPAE/4bPZp0iYKxsiA7ZzUHhGOhAIZondqaLEApwYzqFZexeSzNvXcAgIxJvUgNRRSIWJn0raN1UkIeqjoW9J0CHjNkMFtPForbgbzXV5Tx8XEx1LS/fSf301fuKwzUhMSnJuXYoZ2i0KN+YI2fTwTcu5KGb6lqeYNGqJyH8Jpcli56PsIINycAn47de4s9mL8pIgsYe0dNsO1WdFDRR0L+nf/wvDNbRFwAA" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 1f8e0de..9e6c03e 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE61d25LbtrL9F+V1TqIGb6LfnMQ7J7vsxNszyU4ylUpxRpwJcyRxQlHO2Kn8+ymAujQai1RT9Js9AFbjsgA0egHi37Om/ms7e3H79+z/qs1y9sLM84wSczXbFOty9mL2tqn/KO/bqt7Mrma7ZjV7MWs/PJXbL04Jn//erlezq9n9qthuy+3sxWz2z1Uf3r+K+1Ig2T+NwyiLdteUX9WrVVeDmw9PASjKM2wlSY8Wviy2ZYBwtFBt2rJ5KO7L7Rcw47TGnGuIuhHXRtUEkO2SBvSPwaU9f6a/L6kkruAopB/L+7ZuMJ6XNn6cBkdnVCVftm1T3e3sWG5FHXnSNKJK5DDDJfg9qOOwvIGQiH7iKNx/X3//Xe9M9RMHcWM2+F/VdbM81XFdL3crN/BdwiBOegJaVZuyaK5v2vqHH49gD7tNNxInOJ4PYF/Nnoqm3LS8agP2fvixra9vztvr8k2x1xab8407Zppo6XyzjpmmWPpzVyyboq3uz7dMZP0kVs+3UmSdYtXW+9t/Dxnrckyx8e2/zzWoyzGpHdVNdXPGyiHPFDt2+be9/tPPvwyZYtk+kbVvXivtffN6qsWffv7lHO9ZtinWHITnewJbx0yfxNJwu1i2T9CL37xW9mOXcYrF5w8fb+rX9eZ10Q7ZY9km7TIO4ebcLGDZPpG14VngZZy011Sr8qef/9XU6x9+/KWu14Nbjsj7aexe3+jtdnmn2L27q5+HidrlmGpjeH3uckyxsSmrx9/v6mY7vKWxbKOtcR/xbV1tWuAiur9rPcSHpl4PTNwO65TpXIW7Op2x1DONpK3zk+iMtR5Oneycp9QZCz2MOlk4T6gzFnqodLJwnkTn2mC+Klerb78+15J9tsljcnb0bZbJ43LWis0ywUrv1tpZ0Gyog+iDzNK4q4Pog6zSONyD6GfXk1bpBAz30HnenjJNsFQslwMmiuVyGvb1fbEqmmELXZ4Jdra7uwEL293dNOyzbTjmmWBnvVsNWFjvVtOwz7bhmGeCnU3drItV9RGfODo7xzwT7KzKzWP7+4CRLsMEC8tq2xab+/JV0Qwa8vJ9AnsKUxOsPJZt73mwM7LPMWnl+u8bYMD+WRkefFM299j5O6aoA4Srm/rtT6A6J6Quy3CDTzWCVp6eb+rXaEM+WemyTLJiK2qznG2N/d8kS+uyuT/bokOmyT13U60QI/2+s5kmWbIHurfPX9a7DYs7I2s84+TxOtu2Q6ZPYunts8rW2+dJ1u7rzfuyQf7PydQ+zyQ7Lpry5ZffD0/fY65Jtuzh2EU2FAQReSfPtKKtm5/csXDzeHbG8cyfxPLPDgy6s6HlQ+ZPYvkXC/Zy1Vbtbjk8SWCJaTNm82hjO28OPTo8b0TmaZaLloP9PGxZZJ5kudh3HEdEAcaTeVjik4z966K1zqZu2A+Zx1uWUuZ1vWvuA230ZHGfPm2jqa8N9H+ujdZraetOroUwXZIe6odN1dvXLFUPCP2CFnsCWPz/qtsdyuU3Zb0u2+YDugQQZBqEp7nhbu5Y2M9YETzqYZ17jD9wB/u84X328UYlt4O8r6ttK5gO84wJpfpu+Wn4j2lasCeb+fv3ZbMqngAeT9ZC2n25H5GlagHL57bcLL/8skZu1SlRC7cum8fSFiiRf8FStYD3q+qpp3aHpDFj23MyPCR9koj7YKR9IIQ7xLsLFAEY2+yNmI8Lj/eGxXthvu4/+/Nk/QpthwuGQA9JY2oHgXoj82MCsj2B2DER455I8ZiQdk8oe2zsdyDm2+sm9LH6mKYep56pW9yX/0NakGrbswJ0CfqVHS1vT7X+Ulf5vkShUPd3LchAPG0gjoaX2d+rFQqRu7+PAmnKTR9OUw5fngNQcE6dEkfBva23lXe7TyAe0tUk6DwYwAOXoIVpis0jGkL3d3UD601bVBvEykOSeopYd25b3rcI7JSohduUz6iP7J/VHd2U71E3N+V7/bx/XRYPcN7bBHU3l7b9cJU+JKk9ORdYgVCHJC3UtvpYQqAuYQwMnG9dgn7A91cj4Kjv00aDwYoN38IY2O2v7X/6dnybOA7uvw10x0+JWjh3cHn+bqAHRQ4123bVann9p3WzECpPvgByGFHPv/XTqnr4ABnYJanX1PIv+yewqLoEtf/SFJvtQ930Hgn9DMOHd7M44noR833uL3oi5CeEhAxf77dts/MCKAHQZ34ufPx2dek55lfLAXCXOB5zVXwoGbND3GOG8djH4SiHKu7nUlkx83jB9pJX66f2w1DXHHOMRy+WS/lqJDTgZRpv49gDml5SjwQj+Gs7hgG4++snofgJScXxrjo9pNnwvQAY2KdfgPwgn6kAdJZHZ4HHGO0IXLd1U37/5L/bYSE5mUcfYXwKXwiew/3MK9NPG6/SPebX1eYjv8B61vapwETDxfNIw8cC0wxXm2X5/GasdVFqWhXaelU23pnyrH1eZJrxu93DA1s2zlo+5h9vVmzGLhtcDF3KJ9uWT2jqvbmr2mWbBTOn3DEGrW2fVlXb67swYzzjhbYeS5WlUza9He/svbypvy6RJH1IUgdjyseb+l2BnM5D0iBUdGLRq5fvbv73t3cvv/72h+sj3PuiqYo7e0GIJ18C+dur//zw8ub7d9++fH0GneW8yNDb71+/fHfOhss0Dv6rb9999cObf7169+q7r1714nu5tAbevHx33d/1LPUCwOGOxxkvMdPX7UEeLfhLAPZSX7OfXv108+q7G1ijfdoIsNcve5BevxyGkWKiJyt12qH905lgMkKJvgY4EbqwPITDLgEdUOCNH+wLXt/4h1T+1PxGcTzVyLscaFjUPdSmxwD0VD30fof4DPTZHvisvRT641noj5dCQ3/Pg+737ULo4Lc+PGbsf+bjLCUkypvdqq0Q1ClhFN7ralNet03FboR1eKeE8fXrBRWpo5Df1qsPj+EPpXR/vaQPERxPGlm7atMGS9D+rxeOcADHky4c5QCTJ00ZaVzZi9H3YwB6dP/3i0e8r1cvwXXPCqtN0QZXvVjKKMTDfRnwgy886SLMHjz17mZ/HmboIhVPHz95emrppV04kXqgwwwXTqoe/DDDlAk21IiJlvbk7x0BL/XiiTc8Cpfb2C+IQ/w5pV68FJ/l0IU2+Ap5lkdT2qEw1JvvsqV7mE/TxmTYBM6kXui6m6+9rjxLHlX1rlyvByeTL8Dudbxk8qX1PmNgin936FXklnlpl/d5P/TFfl9XvN8PCNIvQB/wCcIME/AHsUdOnnO+Qpjrgop///CwLVvc5fu0CydRV7p3EnXJUybRgAGR5/JJNGDDyzFxQp1rylRbQy4cyDFpSR40M9FflGvwoK2JHh1cjs83bqxVsGdiVw/sniMcvsDMoFsZ2JruYTbVumqr93L1Pf593NgUq135smmKYCCOCePxENTINtZPZdNWwQ52Shjnp6FqvRlfrxMlu8KyekH6FM8Ym8CZLvGJMb6feLE3PFD5KRYwaj/Sr1edhj578be9Sre11xBezMzn0ef57Gr2UJWrpf1J5MOVj/t6ve5u8C7r+53756/7bN3stZm73F/MZ1e386s4+TzP6Ndfr24PhV2C+8MB4/QXV5BmV7d0Fc8/n+exV5CCguQVNLOrW3OV0OfzhVfOBOWMVy6aXd1GoFwUlIu8cvHs6jYG5eKgXOyVS2ZXtwkolwTlEq9cOru6TUG5NCiXeuWy2dVtBsplQbnMK7eYXd0uQLlFUG7hlctnV7c5KJcH5XJ/4C0PaA5KUsgZEqRxrCFUFtDG5w1ZOhBiDoXUIZ87ZClBEeI5hfwhn0BkeUGIQhRyiHwSkeUGIRpRyCPyiUSWH4SoRCGXyCcTWY4QohOFfCKfUGR5QohSFHKKfFKR5QohWlHIK/KJZSxXDCKWCYllfGIZyxWDiGVCYhmxILkVCS5JYE3yiWUsVQxalkzIK+PzyliqGMQrE/LK+LwylioG8cqEvDI+r4ylikG8MiGvjM8rY6liEK9MyCvj88pYqhjEKxPyyvi8MpYqBvHKhLwyPq8iS5UI8SoKeRX5vIosVSLEqyjkVeTzKrJUiRCvopBXkdjs3G4Htzuw3/m8iixVIsSrKORV5PMqslSJEK+ikFeRz6vIUiVCvIpCXkU+ryJLlQjxKgp5Ffm8iixVIsSrKORV5PMqslSJcrQxRCGxIp9YseVKjIgVh8SKfWLFlisxIcNxyKzYZ1ZsyRIjZsUhs2KfWbElSwy3wjikVix8KedMxbAw8Kd8bsWWLnECC4fkin1yxZYvMSJXHJIr9skVW77EiFxxSK7YJ1ds+RIjcsUhuWKfXLGlSwzJFYfkin1yJZYvCXTNk5Bdic+uxPIlgexKQnYlPrsSS5jEwMIhvRKfXoklTIIWriRkV+KzK7F8SdDClYTkSoS37tx16K8Dh93nVmLpkiBuJSG3Ep9biaVLgriVhNxKfG4lli4J4lYScivxuZVYtiRoQ0xCaiU+tVJLlhStW2nIrNRnVmq5kqINMQ2JlfrESi1VUrRspSGvUp9XqaVKCpetNCRW6hMrtVxJEbHSkFipT6zUciVFxEpDYqXiKOjOgvAwCE6DPrFSy5UUESsNiZX6xEotV1JErDQkVuoTK7VcSRGx0pBYqU+szHIlQ8TKQmJlPrEyy5UMESsLiZX5xMosVzJErCwkVuYTK7NUydCClYW8ynxeZZYqGeJVFvIq83mVWapkiFdZyKvM51VmqZIhXmUhrzIRZnBxBhhoAJEGn1eZpUqGeJWFvMp8XmWWKhniVRbyKvN5tbBUWSBeLUJeLXxeLSxVFohXi5BXC59XC0uVBeLVIuTVwufVwlJlgXi1CHm18Hm1sFRZIF4tQl4tfF4tLFUWiFeLkFcLn1cLS5UF4tUi5NXC59XCUmWBeLUIebUQISwXw4JBLBDF8nm1sFRZIF4tQl4tfF7llio54lUe8ir3eZVbquTQxcpDYuU+sXLTFz3NQ2LlPrFyy5UckTIPiZX7xMotV3JEyjwkVu4TK7dcyREp85BYuU+s3HIlR6TMQ2LlPrFyy5UckTIPiZX7xMotV3JEyjwkVi7ioy5AikiZgxCpjJE6ZsE42BxFSUWYdN5/OuzSZHkRKp07fs1xkBZES+ciXDrvPyR2abK8iJjO+8+JXZosL6Kmcxc2ncNA8RwETucicjp3odM5DBbPQfB0LqKn86z3qNqlyfIigjpf9J6/ujRZXkRR53nv4a9Lk+UF/VzYHZ88CUXpgzA99R4BCUbqBf+6WP0cLTSEovUyXN/F66G6hOL1MmDfReznMGSPYvYyaN9F7ecwbI/i9jJw30Xu5zB0j2L3MnjvAvL4sEMofi8D+F0Efw7D/yiGL4P4XRR/DiUAFMcXgXwynUQElz8QyycRzCfTyURw+QLxfBIBfXJBesI6E4jpkwjqkwvUU4/WBPgnAvvkgvVEkP4gtk8iuE8uYE9YcgLxfRIBfnJBe8KyE4jxkwjykwvcE5aeQJyfRKCfXPCesPwEYv0kgv3kAviEJSgQ7ycR8CcXxCcsQ4GYP4mgP7lAPkEpikDcn0Tgn6JOqoT8A7F/EsF/cgF9gpIUgfg/CQGAOgUAL/9AAyAhApAL7BOUtQjoACSEAHLBfYLSFgEtgIQYQC7AT1DeIqAHkBAEyAX5CUpcBDQBEqIAuTg/QZmLgCxAQhcgF+snKHURkAZIaAMUd/yD/AXqAAl5gFzIn6DkRUAhICERUNzJ5ZC/QCQgoRKQC/xTZK5i83k6zwQAEs0FAV3wn6D+RUArICEWkBMACGpgBPQCEoIBORGAoA5GQDMgIRqQEwIIamEEdAMSwgE5LYCiDM5goB2QEA/I6QEERTEC8gEJ/YCcJEARZCBQEEhICJSYAQYAFYGEjEBOGiAorhFQEkhICZTE/Tc+gJpAQk4gJxFQDKcAUBRISArkZALswANRgYSqQE4pICjxERAWSCgL5NQCiuEEAuICCXWBnGJAMZxAQGAgoTCQUw0ohhMIiAwkVAZyygFBvY+A0EBCaSCnHhDU/AiIDSTUBkqjAf4CwYGE4kBpPDCDgepAQnagtCMgnMFAeSAhPZCTEyiGMxioDyTkB3KSAiVwAgIFgoQEQU5WoAROIKBCkJAhyEkL9tYkKg8YKKQIcvICQSWSgBpBQo4gJzEQVCMJKBIkJAlyMgNBRZKAKkFCliAnNRBUJQkoEySkCXJyA0FlkoA6QUKeoKy7uQb5BxQKEhIFOdmBoEJJQKUgIVOQkx4IqpQElAoSUgU5+YGgUklArSAhV5CTICjFMRAgWZDQLMjpEJRCAgLZgoRuQU6L6KsA0C5IiBfkBAmCsicB/YKEgEGL/iAMkDBIaBjkdAmCyikBGYOEjkFOmyConhKQMkhoGbTork/CCQDkDBJ6Bi06AuJ7kICAQtOgRUdAOAGArEFC1yCnVRBUUwlIGyS0DXJ6BUFFlYC8QULfICdZEFRVCSgcJCQO6jQOqKwSUDlIyBzkpAuC6ioBpYOE1EFOviCosBJQO0jIHeQkDIIqKwHFg4TkQU7GIKi0ElA9SMgelHdXeCH/gPJBQvogJ2cQVFwJqB8k5A9ykgZB1ZWAAkJCAjFO0yCovBqggRihgRinaRBUXw3QQIzQQIzTNLBAZ4AGYoQGYpymQVDBNUADMUIDMU7TIKjiGqCBGKGBmE4DgUquARqIERqI6TQQqOYaoIEYoYEYp2kQVHQN0ECM0EDMvLtGDu/7Ag3ECA3EzDv+wTu/QAMxQgMx3TsFqO4aoIEYoYGY7q1Cju+Uo0vlgn+dBgKFWgM0ECM0ENNpIFCsNUAEMUIEMZ0IAgVbA0QQI0QQ04kgULQ1QAQxQgQxnQgChVsDRBAjRBDTPWGA4q0BIogRIojpRBAo4Bogghghgpj9UwbIPyCCGPmaYf+cAfIPPWiQLxq6Jw1QAzXoUUPwqsE9a4AaqIEPGwT/uqcNUMMz6HGDfN3QPW+AIpxBDxzkC4fuiQMU4Qx65CBfOXTPHKAIZ9BDB/nSoXvqAEU0gx47yNcO3XMHKKIZ9OBBvnjonjxAEc2gRw9CBDFO1DBQRDNABDFCBDFR96QG8g+IIEaIIMaJGgaKaAaIIEaIIMaJGgaKaAaIIEaIIMaJGgaKaAaIIEaIIMaJGgaKaAaIIEaIIMaJGgaKaAaIIEaIIMaJGgaKaAaIIEaIIMaJGgaKaAaIIEaIIMaJGgaKaAaIIEaIIMaJGga/5wIiiBEiiHGihsFvuoAIYoQIYuLuWRfkHxBBjBBBjBM1DH7bBUQQI0QQ4zQN0/O+Cz3wEvxzmobBb7yABmKEBmKcpmHwOy+ggRz+5t4adx8a/LZ7c3x7OytmV3/Pftu/QbZBHWfDPke2cZsXf//zz+nV8Yu//2EPj22atVMslxwjiU8QSaxFeDj80jOrTJSxysR5V9hGU5WY2/tiVTRe3RJWt0SHs//Yqv0yyuHLpx855iI6YS4iHWbbNtXdbv8D+KzFxBpMKqi7YluCvmM9l43Fua9Xq8MP4p8QWSt1jbSIp893skbyDrNHKxXYnf3hWwaSGk7UAzcWyk67q5+jpY/HKmXjdVqY+vBlyxNWzkiW66aQRbLfpGHdvWD9vVCDtPXzh493+49lMzpwPigJcVc/7957VWIgkRLE1cRvmb28cerqSNnV+9/NZzBxymBS5cDbT/xs/1xWokqGrzRRPhbLn8SGV0w5dt2nuGRHMQ7YizAqoO6reAxlzttGyupYlKfjx+d4nea8TrpeP31kj1eLN45GNK4pN9UfPhQnlNERyn6JVS4qOatSrqwR/yQC37r48hTH++UpMYc9TLfqnT6Rx0eAr1RGtxnedx8Y9pYEtkpluq3w/vCZYrSs54wYuXIMJN5KzMuc9WKu7TL223J80yG+6ejqtywf27op/OmU8D061U2n5fGrlycgvuF0dLia2dueY/DKoml/90BZh6VGheUwfruvmvvd+qFsSlFN4i6TVTL1mE2xrHb+KCR8WqS6KcbBfiv/3FkHrCpWPi6fE5ludD3cp1p4isTdWKsAqyDdx6eDZYXtB7lugLsfqme1YXXpiuSHpYQO3FH6nhZ69975CdwC37SMzmlhSI/ecPDd1Ogb7HDaWjgdrOmRbhT2WBLJsNXd6OYtcKwZyCgM7FQzjukW8gBNuB58a7gMsHU/m8m6jfXaGES/Ynx+HgirPBzu8WS9GF+VdG3qNVqI7VuUU+Xmuq3QgslJmnM3RLnFWBzfm4nZehsn+66aK2eRQ9u6nwrjrPB6X9/A6o+/Gv9oQ4avipG+41f1ZlV4e3vMej2mQzuVM/yI6C88MSNrrGRrU6+fup8XZiPJOixXsrSp11tzX65Wlecv8FNKrO+vrQkqZd98MX7pm+f7VDFfcw6O6XxEI2WfsxUxVi6JTb321+aYdXh8WB+UoYEOTVSK7UCxbu5An5ZxNN9z1Ch7/oAn1y0rezNPVEf4x7KVq03KxlEZEnss29Z9eYyfovmileoI6jPc3uVmZx3d8lL90dY+L/nKojzVuJLHLxnyRvFVKtG5mfwb4vy0xaGMsnHbsvuWKu8kHhRQzpNqG/iBc14dUnbTduU+JM5bxWMCSmfoj229wV4M8SOCrotWRcsDql5f8Qmy0E22VffxVt7fnNeJbpYdPuPLYXh/K9fvVbl5FMcyto4oI1Wr8n3pn3HmnEGkrEq1KYtm20pf2Bt/3frYQVl/X0SpeBxHxyQLtd3/LD6vE/fDlCGEE5SI5/KIJymjsBwMRq55PMIoHewTKA6G83PXfGw91+/3PzfL1lHDK6n0glartrZz0SMtm0HKo7qFefLOvikbhlRJtFVby20qY1tMpnMLDjB+fTI2nzPd8rnaPPKlyoPjUSWl9tD5rcH5m2+ikbKFJyTf++GLVqRrpL9/pt6c1g3bumi2MOTDly3l2DGs3oiPt4IpG8lgQcCHN1oZEV0Xzy7m46+IKXfUlXLLungWByTiu4a9w66ECb0h7p8lSpw921dFa1VUPwTC6LVQ9vxh8riTm7/uZ6zfta08uA0Ozu+2jC1bmW7ZOsq6Fu6g93otZgOq1AYtZnCES3nQQrfWW5y2Xnnkz1h1lMHOddk8ljYw6W8WOZtFubLvD58s5wzjcadESfid1yY++7Qc3a2Aws+GX+n5r+1vvvf5JLxluW6FF3jSMeHLjDIcHCBi74Tr6qRcaX1k7KLwcK4yEiVwoZ/CqxuPqG4YGeETwj6WGAclB4hvWLlyH2BgeGy4/KS82nECxcOS8GEZVc/9l514o/k5Rym1cTDRh3zBJKWU6sPhXuRNVp40OSzux5z34/i6Qm7ziipDIh2OD8NZEytZg6rDDxnKU+xGRpFjPqaJjiKbsnr8/a4Wh2p+QiGls3tE8qPl/JgfHW4BKX3eTfks7lvwOIZSBNvUzbpYVR/92BzrqlS3Qe8/jexVh/t/RneQC9dGfoyzD9HUKHJZ5J2jDIoProhzPpeVndS/GPLooTKa7dDQ/S2GpVz/4ZLK3e5cO3xoNeUuLSndtDMLKe8uZRhxcA3l2up8VA3heuXFgrXV8xeZOeercq94ako/TEbcF1BK2U+nz1+xJvGIm1Henntq6j/CaCubN/P9gpfo1qon9tEq3tt8JsbKmfgsDyU8ZqC8FmNBgkgPW/SUty7+3BXLpmir+zDO6W2gI9HCUKcXWdNN6KZYtvWy9A8VCd9JlVGxptg8+vuxL/brdtGm/Mt+tsrbjPniovQx/JmW8pmmDAhsjbuoJYB4tyhh0L1xTycdh4MFDn5rXIkXbMTcfVJOsm21flpVD/5Sy6+xkBqorQIycxdV2arqYymuXvIJZn/rTAsj79/yIVNe89nWu+beX8r4kWihbNPTqgKqKO/kVInUAueLH6uUWpZdxfxe9k7Kuom+3d15BGZTS7lZbHd3ILrCdjFlnEd0CJ/jyiFqiw1QsDyfSIsD1nS++elmU8AWfkeNlJGMTpoAN/XZqq68bWmhtm0tFkF+BYKUd0GPSPVTeLeMX9gh5eMZC/j8obs2IqOGXBFX3iQ6we3eB3Bs7ivvOLW11dflZXK+rSoFOTlh+R3h5Hi3SecUtfWqbII7avxWGCmPlNJD44EOZZCsrcOLW/wO7/FCuzKk1dZb41WJcWCh7Wt0zYpfAFbGJiwQuGTFT21KiVeuKdy/Sw4+ujKy1Na7TQU0F37vVEskcceKDf/xMZ3SP7LHZPnGgYeFlRphW//lzVnuOSp32bYpNtuHuvEFCP5aihJlmw5IpbjOxKea8vLYESskVMRdG6UcH0YC+XZnlA+UHErRfTmZQ/GzuvJ5Ujf6fS/6DD9rG6Uz2UH2PNcwc++opew1hwgOBKzvlD3HkcQuyEdzBBjuNx7nUF568+GC29p8/TJKZ7GDtGpNvf84PQfkgQtlCOQECCQ1/srKKG8MSUDYm+S5yWOaflSrUPt5dZVX5QQq6gQ+n5X+K0TFPcF5pYyGM/RwEeM6sVFeGJOAuKZ8nivPjx5wEHc1/Dq/UQZ9QkhcW66jKH3WEBqQjIcsjPJJbAfcgYnFk1dTqWN0aGDkOZYyKsOwcDfyEVKe9g+YYLx53ymPcB4ariPf0pTnCQ8VLSV80ivf87oHks89Ohr3VJQxZfcwSr5Q45K38kcfHI68nsxjicr2HXHEsy82qMr54JDC4wp/iatcYLyLecSvMJLmkPLr1eypeirtGj17cfvrP//8P+0AqSPZ2AAA"; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE6WcbW/cuBHHvwvvrZqYz/K+u9yhRYteEyCH4oCFUWxsOd3rPhi7snuJ4e9+GGltzWhGWpL7LhDJP4ec3wxHWjrP6rD//1Etls/qf+vdnVqYq+uovanUbrVt1EJ9Oux/b27b9X6nKvV42KiFar89NMf3Q8O7/7bbjarU7WZ1PDZHtVDqpZrS++vqthkpwaM8jWbVPh6an/abTW/Br98emKjUZ34WH95m+LA6NkzhbYb1rm0O96vb5vhe7HjZYs4tJHkRn03SEoRuJQuY9kHpzp/Z7xIjZQOzlP7d3Lb7g6xH2vL9NOudLCN/bNvD+ssj+PI4shE3XQbqWJl3KNGfUM3TIo4YK9LGLN1/fP74r8lIpY1Zuh8+7P8YqcGjv+hsFfuzoGN/ztT5+BtT+fhbOtC/ftqvd62Ic980K6WvjHvTusfnxYTQD6dOSK1SD6tDs2uRNRMTHM+qH0ulz+7AD22p9Pez0t9LpbdnpbcZ0qyeIGScSomzSIxVfnnctGtJamjI0vvnetd8bg/r3deR3tCQb9+k6Kg1S/nTfvPtKy/G+qcleyjJ4aZM69a7lqWg09NCDzM53FToZaaJmy7xtGxssfrJB8KOnp4Xe3xqV0t0f9rvD3fr3aplRy1qyVL8W7PfNu3hm1BU4qYizQm9rAqVaY1K1DRRKXgmrCRthYE0Ic07FAbVhD7vcEmAzS3iwplO8E96gLQWB968F8rnOCXEOX6G1uJUfJahwjlwhjzL0SXrSJhosl9Z6p7n6TKfzE8hd0pOdP170mQpj5oL3s0mK7hxc4H2ZOE1bi61+8wEl9R3r7sqlWWkrXzPp6WL675++HQdwNoL1GdqAt7hAv1Z7czgOVcr8F4Fhn+8vz82rbzlp7bCIOpHTwZR33xJEM1MMOpTHkQzc5AeFwbUuaVcOtdcCSf0uCglz05zYb04zsGzc11Y0Ynp+PzicmcVzky51BNOz4yCj00zW1ayuS6vMA/r7bpdP42z79vzPN+sNo/Nj4fDijnirSFfT5LKXOP+oTm0a3aCDQ15dZpk1i/5dg1I9oPH5rH2SypjeQq5U0lNLOvTxuJqeMb4S2aQVaeVbiq13t01f6jFs3pqDkf4uWChzDv77lpV6n7dbO7gZ9dev1K3++226Wrhu/3tY/fPm1O3Pnqhc9/7/ZWqlleVu3pno7m5qZavg7uG7sGrxvCkG6hVtdSV9e9McGSgZgM1GWhUtTTSjIYNNGSgVdXSSgMtG2jJQKeqpZMGOjbQkYFeVUsvDfRsoCcDg6qWQRoY2MBABkZVLaM0MLKBkQysVbWspYE1G1iTgdeqWl5LA6/ZwGsKAPCgRXY0h0eP6Onw0eJgASBKkAYutMiQ5hBpSpEGNrTIkeYgaUqSBj60yJLmMGlKkwZGtMiT5kBpSpQGTnQQA45DpSlVGljRIleag6UpWbqenpnDpSldGpjRIpiaA6YpYeZqKscYDpihgJkOMBFswwEzoxTV5SgRbSNkKQqYAWSMiLbhgBkKmAFkjJweOWCGAmYAGSOibThghgJmABkjom04YIYCZgAZI6JtOGCGAmYAGSOmS8MBMxQwA8gYEW3DATMUMAvMGJFOywmzlDALzBiRMMsJs5QwC8xYkTDLCbOjg7A7CUXCrHAWUsIsMGNFwiwnzFLCLDBj5UOYE2YpYRaYsSJhlhNmKWEWmLEiYZYTZilhFpixImGWE2YpYRaYsSJhlhNmKWEOmLEiYY4T5ihhDpixImGOE+YoYQ6YcSJhjhPmKGEOmHEiYY4T5kblVldviYQ5oeKihDlgxomEOU6Yo4Q5YMbJpR4nzFHCHDDjRMIcJ8xRwhww40TCHCfMUcIcMONEwhwnzFHCPDDjRMI8J8xTwjww40TCPCfMU8I8MONFwjwnzFPCPDDjRcI8J8xTwjww40XCPCfMj4r6rqoXCfNCXU8J88CMFwnznDBPCfPAjJdfKDhhnhLmgRkvEuY5YZ4S5oEZLxLmOWGeEhaAGS8SFjhhgRIWgBkvEhY4YYESFoCZIBIWOGGBEhaAmSASFjhhgRIWgJkgEhY4YYESFoCZIBIWOGFh9OrYvTuKhAXh7ZESFoCZIBIWOGGBEhaAmSC/tnLCAiUsADNBJCxwwgIlLAIzQSQscsIiJSwCM0EkLHLCIiUsAjNRJCxywiIlLAIzUSQscsIiJSwCM1EkLHLCIiUsAjNRJCxywiIlLAIzUSQscsLi6ANF94VCJCwK3ygoYRGYiSJhkRMWKWERmInyxxFOWKSE1cBMlD+QcMJqSlgNzESRsJoTVlPCamCmFgmrOWE1JawGZmqRsJoTdnrUfS18ag5tc/f3/qvhcqlW5BL3s/rP6YOi1q+fJZ+V1mrx/PIyfEBcPL+gb4jQBvN9WR2b+9dL5oNSHIRirs4tugY9KNpB0SYrfn377QIJ1YOSu0qT+gKXqNE+BbRPoR+k62Qpe0fE0F7ptM26xT+Ho5V5tEdpSv39ZmQMsqUfYtK2SGAA7XPa3sz63yGvlalR1A1aqSkTbLv7AoMmksxSpIYh0HUa6SeZsTkI0pCkI0YLotNeZ8mM7bHIIJtGxO/H/U7GQSPWtU8S26x3zfF0twY5DQmZtKAZhGgkWxQ9Ns11WErafoe236Vt/yApCiIbXa6N26fTb1Uo0eNMn2bglmw/Dpq0wN7CL24TzkSImTTERmojjyLrbJF1E25FudGnJdiRrqiKrHVF1koOxmk8w9SH/gYe8g3K4CYtIQ1CI7dcIbekpVosJe4dIsdlkNNJioLIRpdl4+kWHdo55AKb5YL+gibdO+QGm+WGk5i0WI8W6/MXK+4fPvDz7RRIrpGRdaKRT/0lCxQOiJOYyIlgCsrCdVoW5vGECgWTdgIKoWSuEQ5pJf9cFKHD1KUdppMBZJFlLtUyHjvofDJp55McNvj9I3W3ZyLGodX5rNWJasg6l2WdlPGRaXWiacMFLqSDjqOYdhw9oP8TYBBCcZuW/R7QXStkD4IzpsFJK3O0LyZtX45GeC/SaD06bUFvOnIxjBaW5vxjy9KJRoeMTgsUmo7QqkxaduXJFeX8mJbzO41Vf9kPCaF4iGlb8tRdhpr6aBDQ6kLi6jrBiVd1j9KST9vtXk/gCWFZoEQRRw7QaSHbi4lFATIspMULFRu/QHqEaEgLnF4QCtz96RY18inKTyFnsfK7h0fM+Rzm5ov6gBYdcxb9VtoLK0emhhxTZ169PELHJ8aupCnuASIp5pAkv4l45Hif4/j5ij+gmA45kThV93tUa/q0WpMLSpZGVH7GtPKTCwtYoXMopB2wvez+9e9MkBYyMeSYyL2NlHy2kuho/GUtxy+Sj/HZnbNnc+5Fh1XMOaymPYuCO6QF93dSHCAfmAQf3FTqYf3QQFZQi+XNy8ufwEwMxE5KAAA="; \ No newline at end of file diff --git a/docs/classes/Layer.html b/docs/classes/Layer.html deleted file mode 100644 index aed2edc..0000000 --- a/docs/classes/Layer.html +++ /dev/null @@ -1,9 +0,0 @@ -Layer | s2json-spec - v1.5.5

Class Layer

Layer Class to contain the layer information for splitting or simplifying

-

Constructors

Properties

Constructors

  • Parameters

    • name: string

      the layer name

      -
    • features: VectorFeatures[] = []

      the layer's features

      -

    Returns Layer

Properties

features: VectorFeatures[] = []

the layer's features

-
name: string

the layer name

-
diff --git a/docs/classes/Tile.html b/docs/classes/Tile.html deleted file mode 100644 index aee868d..0000000 --- a/docs/classes/Tile.html +++ /dev/null @@ -1,24 +0,0 @@ -Tile | s2json-spec - v1.5.5

Class Tile

Tile Class to contain the tile information for splitting or simplifying

-

Constructors

Properties

Methods

Constructors

  • Parameters

    • id: bigint

      the tile id

      -
    • layers: Record<string, Layer> = {}

      the tile's layers

      -
    • transformed: boolean = false

      whether the tile feature geometry has been transformed to tile coordinates

      -

    Returns Tile

Properties

id: bigint

the tile id

-
layers: Record<string, Layer> = {}

the tile's layers

-
transformed: boolean = false

whether the tile feature geometry has been transformed to tile coordinates

-

Methods

  • Add a vector feature to the tile, optionally to a specific layer to store it in. Defaults to "default".

    -

    Parameters

    • feature: VectorFeatures

      Vector Feature

      -
    • Optionallayer: string

      layer to store the feature to

      -

    Returns void

  • Returns boolean

    true if the tile is empty of features

    -
  • Simplify the geometry to have a tolerance which will be relative to the tile's zoom level. -NOTE: This should be called after the tile has been split into children if that functionality -is needed.

    -

    Parameters

    • tolerance: number

      tolerance

      -
    • Optionalmaxzoom: number

      max zoom at which to simplify

      -

    Returns void

diff --git a/docs/classes/TileStore.html b/docs/classes/TileStore.html deleted file mode 100644 index d4e2968..0000000 --- a/docs/classes/TileStore.html +++ /dev/null @@ -1,18 +0,0 @@ -TileStore | s2json-spec - v1.5.5

Class TileStore

TileStore Class is a tile-lookup system that splits and simplifies as needed for each tile request

-

Constructors

Methods

Constructors

Methods

  • Stores a feature to a tile, creating the tile if it doesn't exist and tracking the faces we use

    -

    Parameters

    • feature: VectorFeatures

      the feature to store to a face tile. Creates the tile if it doesn't exist

      -

    Returns void

  • Parameters

    • id: bigint

      the tile id to acquire

      -

    Returns undefined | Tile

      -
    • the tile if it exists
    • -
    -
  • Splits a tile into smaller tiles given a start and end range, stopping at maxzoom

    -

    Parameters

    • startID: bigint

      where to start tiling

      -
    • OptionalendID: bigint

      where to stop tiling

      -
    • endZoom: number = ...

      stop tiling at this zoom

      -

    Returns void

diff --git a/docs/functions/MercPoint.altitudeFromMercatorZ.html b/docs/functions/MercPoint.altitudeFromMercatorZ.html deleted file mode 100644 index b318f8b..0000000 --- a/docs/functions/MercPoint.altitudeFromMercatorZ.html +++ /dev/null @@ -1,5 +0,0 @@ -altitudeFromMercatorZ | s2json-spec - v1.5.5

Function altitudeFromMercatorZ

  • Convert mercator projection's Z-Value to altitude

    -

    Parameters

    • z: number

      in meters

      -
    • y: number

      in radians

      -

    Returns number

    the altitude

    -
diff --git a/docs/functions/MercPoint.bboxToXYZBounds.html b/docs/functions/MercPoint.bboxToXYZBounds.html deleted file mode 100644 index 41d84ce..0000000 --- a/docs/functions/MercPoint.bboxToXYZBounds.html +++ /dev/null @@ -1,13 +0,0 @@ -bboxToXYZBounds | s2json-spec - v1.5.5

Function bboxToXYZBounds

  • Convert a bbox of the form [w, s, e, n] to a tile's bounding box -in the form of { minX, maxX, minY, maxY } -The bbox can be in lon-lat (WGS84) or WebMercator (900913) -The default expectation is in WebMercator (900913)

    -

    Parameters

    • bbox: BBox

      the bounding box

      -
    • zoom: number

      the zoom level

      -
    • tmsStyle: boolean = true

      if true, the y is inverted

      -
    • source: Sources = '900913'

      the source

      -
    • tileSize: number = 512

      in pixels

      -

    Returns BBox

      -
    • the tile's bounding box [minX, minY, maxX, maxY]
    • -
    -
diff --git a/docs/functions/MercPoint.convert.html b/docs/functions/MercPoint.convert.html deleted file mode 100644 index e4c5401..0000000 --- a/docs/functions/MercPoint.convert.html +++ /dev/null @@ -1,9 +0,0 @@ -convert | s2json-spec - v1.5.5
  • Convert a bbox of the form [w, s, e, n] to a bbox of the form [w, s, e, n] -The result can be in lon-lat (WGS84) or WebMercator (900913) -If the input is in WebMercator (900913), the outSource should be set to 'WGS84'

    -

    Parameters

    • bbox: BBox

      the bounding box to convert

      -
    • outSource: Sources

      the output source

      -

    Returns BBox

      -
    • the converted bbox
    • -
    -
diff --git a/docs/functions/MercPoint.latFromMercatorY.html b/docs/functions/MercPoint.latFromMercatorY.html deleted file mode 100644 index 3536edd..0000000 --- a/docs/functions/MercPoint.latFromMercatorY.html +++ /dev/null @@ -1,4 +0,0 @@ -latFromMercatorY | s2json-spec - v1.5.5

Function latFromMercatorY

  • Convert mercator projection's Y-Value to latitude

    -

    Parameters

    • y: number

      in radians

      -

    Returns number

    the latitude

    -
diff --git a/docs/functions/MercPoint.llToMerc.html b/docs/functions/MercPoint.llToMerc.html deleted file mode 100644 index 6191b14..0000000 --- a/docs/functions/MercPoint.llToMerc.html +++ /dev/null @@ -1,6 +0,0 @@ -llToMerc | s2json-spec - v1.5.5
  • Convert Longitude and Latitude to a mercator x-y coordinates

    -

    Parameters

    • ll: Point

      the longitude and latitude

      -

    Returns Point

      -
    • the mercator pixel
    • -
    -
diff --git a/docs/functions/MercPoint.llToPX.html b/docs/functions/MercPoint.llToPX.html deleted file mode 100644 index 99d7076..0000000 --- a/docs/functions/MercPoint.llToPX.html +++ /dev/null @@ -1,9 +0,0 @@ -llToPX | s2json-spec - v1.5.5
  • Convert Longitude and Latitude to a mercator pixel coordinate

    -

    Parameters

    • ll: Point

      the longitude and latitude

      -
    • zoom: number

      the zoom level

      -
    • antiMeridian: boolean = false

      true if you want to use the antimeridian

      -
    • tileSize: number = 512

      in pixels

      -

    Returns Point

      -
    • the mercator pixel
    • -
    -
diff --git a/docs/functions/MercPoint.llToTile.html b/docs/functions/MercPoint.llToTile.html deleted file mode 100644 index f8ce6ce..0000000 --- a/docs/functions/MercPoint.llToTile.html +++ /dev/null @@ -1,8 +0,0 @@ -llToTile | s2json-spec - v1.5.5
  • Convert a lat-lon and zoom to the tile's x-y coordinates

    -

    Parameters

    • ll: Point

      the lat-lon

      -
    • zoom: number

      the zoom

      -
    • tileSize: number = 512

      in pixels

      -

    Returns Point

      -
    • the tile x-y
    • -
    -
diff --git a/docs/functions/MercPoint.llToTilePx.html b/docs/functions/MercPoint.llToTilePx.html deleted file mode 100644 index a2728d4..0000000 --- a/docs/functions/MercPoint.llToTilePx.html +++ /dev/null @@ -1,8 +0,0 @@ -llToTilePx | s2json-spec - v1.5.5
  • given a lon-lat and tile, find the offset in pixels

    -

    Parameters

    • ll: Point

      the lon-lat

      -
    • tile: Point3D

      the tile

      -
    • tileSize: number = 512

      in pixels

      -

    Returns Point

      -
    • the tile x-y
    • -
    -
diff --git a/docs/functions/MercPoint.lngFromMercatorX.html b/docs/functions/MercPoint.lngFromMercatorX.html deleted file mode 100644 index ec0ede7..0000000 --- a/docs/functions/MercPoint.lngFromMercatorX.html +++ /dev/null @@ -1,4 +0,0 @@ -lngFromMercatorX | s2json-spec - v1.5.5

Function lngFromMercatorX

  • Convert mercator projection's X-Value to longitude

    -

    Parameters

    • x: number

      in radians

      -

    Returns number

    the longitude

    -
diff --git a/docs/functions/MercPoint.mercToLL.html b/docs/functions/MercPoint.mercToLL.html deleted file mode 100644 index 528c413..0000000 --- a/docs/functions/MercPoint.mercToLL.html +++ /dev/null @@ -1,6 +0,0 @@ -mercToLL | s2json-spec - v1.5.5
  • Convert mercator x-y coordinates to Longitude and Latitude

    -

    Parameters

    • merc: Point

      the mercator pixel

      -

    Returns Point

      -
    • the longitude and latitude
    • -
    -
diff --git a/docs/functions/MercPoint.mercatorLatScale.html b/docs/functions/MercPoint.mercatorLatScale.html deleted file mode 100644 index 4bd01dd..0000000 --- a/docs/functions/MercPoint.mercatorLatScale.html +++ /dev/null @@ -1,6 +0,0 @@ -mercatorLatScale | s2json-spec - v1.5.5

Function mercatorLatScale

diff --git a/docs/functions/MercPoint.mercatorXfromLng.html b/docs/functions/MercPoint.mercatorXfromLng.html deleted file mode 100644 index d5fa55a..0000000 --- a/docs/functions/MercPoint.mercatorXfromLng.html +++ /dev/null @@ -1,4 +0,0 @@ -mercatorXfromLng | s2json-spec - v1.5.5

Function mercatorXfromLng

  • Convert longitude to mercator projection X-Value

    -

    Parameters

    • lng: number

      in degrees

      -

    Returns number

    the X-Value

    -
diff --git a/docs/functions/MercPoint.mercatorYfromLat.html b/docs/functions/MercPoint.mercatorYfromLat.html deleted file mode 100644 index 9e1f89e..0000000 --- a/docs/functions/MercPoint.mercatorYfromLat.html +++ /dev/null @@ -1,4 +0,0 @@ -mercatorYfromLat | s2json-spec - v1.5.5

Function mercatorYfromLat

  • Convert latitude to mercator projection Y-Value

    -

    Parameters

    • lat: number

      in degrees

      -

    Returns number

    the Y-Value

    -
diff --git a/docs/functions/MercPoint.mercatorZfromAltitude.html b/docs/functions/MercPoint.mercatorZfromAltitude.html deleted file mode 100644 index 9c33d7e..0000000 --- a/docs/functions/MercPoint.mercatorZfromAltitude.html +++ /dev/null @@ -1,5 +0,0 @@ -mercatorZfromAltitude | s2json-spec - v1.5.5

Function mercatorZfromAltitude

  • Convert altitude to mercator projection Z-Value

    -

    Parameters

    • altitude: number

      in meters

      -
    • lat: number

      in degrees

      -

    Returns number

    the Z-Value

    -
diff --git a/docs/functions/MercPoint.pxToLL.html b/docs/functions/MercPoint.pxToLL.html deleted file mode 100644 index 7c3c31f..0000000 --- a/docs/functions/MercPoint.pxToLL.html +++ /dev/null @@ -1,8 +0,0 @@ -pxToLL | s2json-spec - v1.5.5
  • Convert mercator pixel coordinates to Longitude and Latitude

    -

    Parameters

    • px: Point

      the mercator pixel

      -
    • zoom: number

      the zoom level

      -
    • tileSize: number = 512

      in pixels

      -

    Returns Point

      -
    • the longitude and latitude
    • -
    -
diff --git a/docs/functions/MercPoint.pxToTile.html b/docs/functions/MercPoint.pxToTile.html deleted file mode 100644 index bfaeaf5..0000000 --- a/docs/functions/MercPoint.pxToTile.html +++ /dev/null @@ -1,7 +0,0 @@ -pxToTile | s2json-spec - v1.5.5
  • Convert a pixel coordinate to a tile x-y coordinate

    -

    Parameters

    • px: Point

      the pixel

      -
    • tileSize: number = 512

      in pixels

      -

    Returns Point

      -
    • the tile x-y
    • -
    -
diff --git a/docs/functions/MercPoint.tilePxBounds.html b/docs/functions/MercPoint.tilePxBounds.html deleted file mode 100644 index b7826b0..0000000 --- a/docs/functions/MercPoint.tilePxBounds.html +++ /dev/null @@ -1,7 +0,0 @@ -tilePxBounds | s2json-spec - v1.5.5
  • Convert a tile x-y-z to a bbox of the form [w, s, e, n]

    -

    Parameters

    • tile: Point3D

      the tile

      -
    • tileSize: number = 512

      in pixels

      -

    Returns BBox

      -
    • the bbox
    • -
    -
diff --git a/docs/functions/MercPoint.xyzToBBOX.html b/docs/functions/MercPoint.xyzToBBOX.html deleted file mode 100644 index a81aa28..0000000 --- a/docs/functions/MercPoint.xyzToBBOX.html +++ /dev/null @@ -1,13 +0,0 @@ -xyzToBBOX | s2json-spec - v1.5.5
  • Convert a tile x-y-z to a bbox of the form [w, s, e, n] -The result can be in lon-lat (WGS84) or WebMercator (900913) -The default result is in WebMercator (900913)

    -

    Parameters

    • x: number

      the x tile position

      -
    • y: number

      the y tile position

      -
    • zoom: number

      the zoom level

      -
    • tmsStyle: boolean = true

      if true, the y is inverted

      -
    • source: Sources = '900913'

      the source

      -
    • tileSize: number = 512

      in pixels

      -

    Returns BBox

      -
    • the bounding box in WGS84
    • -
    -
diff --git a/docs/functions/S2Coords.IJtoST.html b/docs/functions/S2Coords.IJtoST.html deleted file mode 100644 index d752c8c..0000000 --- a/docs/functions/S2Coords.IJtoST.html +++ /dev/null @@ -1,4 +0,0 @@ -IJtoST | s2json-spec - v1.5.5
  • Convert from ij space to st space (ij are whole numbers ranging an entire u30)

    -

    Parameters

    • i: number

      input I or J

      -

    Returns number

    output S or T

    -
diff --git a/docs/functions/S2Coords.STtoIJ.html b/docs/functions/S2Coords.STtoIJ.html deleted file mode 100644 index 53afceb..0000000 --- a/docs/functions/S2Coords.STtoIJ.html +++ /dev/null @@ -1,4 +0,0 @@ -STtoIJ | s2json-spec - v1.5.5
  • Convert from st space to ij space (ij are whole numbers ranging an entire u30)

    -

    Parameters

    • s: number

      input S or T

      -

    Returns number

    output I or J

    -
diff --git a/docs/functions/S2Coords.SiTiToST.html b/docs/functions/S2Coords.SiTiToST.html deleted file mode 100644 index 48e8660..0000000 --- a/docs/functions/S2Coords.SiTiToST.html +++ /dev/null @@ -1,4 +0,0 @@ -SiTiToST | s2json-spec - v1.5.5
  • Convert SiTi to ST.

    -

    Parameters

    • si: number

      input Si or Ti

      -

    Returns number

    output S or T

    -
diff --git a/docs/functions/S2Coords.XYZtoFace.html b/docs/functions/S2Coords.XYZtoFace.html deleted file mode 100644 index 2e37a4e..0000000 --- a/docs/functions/S2Coords.XYZtoFace.html +++ /dev/null @@ -1,6 +0,0 @@ -XYZtoFace | s2json-spec - v1.5.5
  • Find the face the point is located at

    -

    Parameters

    Returns Face

      -
    • outputs the associated face
    • -
    -
diff --git a/docs/functions/S2Coords.XYZtoFaceUV.html b/docs/functions/S2Coords.XYZtoFaceUV.html deleted file mode 100644 index a5253cf..0000000 --- a/docs/functions/S2Coords.XYZtoFaceUV.html +++ /dev/null @@ -1,4 +0,0 @@ -XYZtoFaceUV | s2json-spec - v1.5.5

Function XYZtoFaceUV

  • Convert from an left-hand-rule XYZ Point to a Face-U-V coordinate

    -

    Parameters

    Returns [face: Face, u: number, v: number]

    output's a face, u, and v

    -
diff --git a/docs/functions/S2Coords.bboxST.html b/docs/functions/S2Coords.bboxST.html deleted file mode 100644 index cb9d0ba..0000000 --- a/docs/functions/S2Coords.bboxST.html +++ /dev/null @@ -1,8 +0,0 @@ -bboxST | s2json-spec - v1.5.5
  • Given a quad-based tile schema of "zoom-x-y", get the local ST bounds of said tile.

    -

    Parameters

    • s: number

      s coordinate

      -
    • t: number

      t coordinate

      -
    • zoom: number

      zoom level

      -

    Returns BBox

      -
    • local ST bounds for the tile
    • -
    -
diff --git a/docs/functions/S2Coords.bboxUV.html b/docs/functions/S2Coords.bboxUV.html deleted file mode 100644 index 27f6024..0000000 --- a/docs/functions/S2Coords.bboxUV.html +++ /dev/null @@ -1,8 +0,0 @@ -bboxUV | s2json-spec - v1.5.5
  • Given a quad-based tile schema of "zoom-x-y", get the local UV bounds of said tile.

    -

    Parameters

    • u: number

      u coordinate

      -
    • v: number

      v coordinate

      -
    • zoom: number

      zoom level

      -

    Returns BBox

      -
    • local UV bounds for the tile
    • -
    -
diff --git a/docs/functions/S2Coords.faceUVtoXYZ.html b/docs/functions/S2Coords.faceUVtoXYZ.html deleted file mode 100644 index 33a2ed4..0000000 --- a/docs/functions/S2Coords.faceUVtoXYZ.html +++ /dev/null @@ -1,6 +0,0 @@ -faceUVtoXYZ | s2json-spec - v1.5.5

Function faceUVtoXYZ

  • Convert a face-u-v coords to left-hand-rule XYZ Point coords

    -

    Parameters

    • face: Face

      input face

      -
    • u: number

      input u

      -
    • v: number

      input v

      -

    Returns Point3D

    output

    -
diff --git a/docs/functions/S2Coords.faceUVtoXYZGL.html b/docs/functions/S2Coords.faceUVtoXYZGL.html deleted file mode 100644 index 55f5dae..0000000 --- a/docs/functions/S2Coords.faceUVtoXYZGL.html +++ /dev/null @@ -1,6 +0,0 @@ -faceUVtoXYZGL | s2json-spec - v1.5.5

Function faceUVtoXYZGL

  • Convert a face-u-v coords to right-hand-rule XYZ Point coords

    -

    Parameters

    • face: Face

      input face

      -
    • u: number

      input u

      -
    • v: number

      input v

      -

    Returns Point3D

    output

    -
diff --git a/docs/functions/S2Coords.faceXYZGLtoUV.html b/docs/functions/S2Coords.faceXYZGLtoUV.html deleted file mode 100644 index b496078..0000000 --- a/docs/functions/S2Coords.faceXYZGLtoUV.html +++ /dev/null @@ -1,5 +0,0 @@ -faceXYZGLtoUV | s2json-spec - v1.5.5

Function faceXYZGLtoUV

  • Convert from a face and right-hand-rule XYZ Point to u-v coords

    -

    Parameters

    • face: number

      input face

      -
    • xyz: Point3D

      input Point3D

      -

    Returns [u: number, v: number]

    output WebGL oriented UV coords

    -
diff --git a/docs/functions/S2Coords.faceXYZtoUV.html b/docs/functions/S2Coords.faceXYZtoUV.html deleted file mode 100644 index 061d8b3..0000000 --- a/docs/functions/S2Coords.faceXYZtoUV.html +++ /dev/null @@ -1,5 +0,0 @@ -faceXYZtoUV | s2json-spec - v1.5.5

Function faceXYZtoUV

  • Convert from a face and left-hand-rule XYZ Point to u-v coords

    -

    Parameters

    Returns [u: number, v: number]

    output

    -
diff --git a/docs/functions/S2Coords.linearSTtoUV.html b/docs/functions/S2Coords.linearSTtoUV.html deleted file mode 100644 index acb63b2..0000000 --- a/docs/functions/S2Coords.linearSTtoUV.html +++ /dev/null @@ -1,4 +0,0 @@ -linearSTtoUV | s2json-spec - v1.5.5

Function linearSTtoUV

  • Convert a [0, 1] to a [-1, 1] in a linear fashion

    -

    Parameters

    • s: number

      input S or T coordinate

      -

    Returns number

    output U or V coordinate

    -
diff --git a/docs/functions/S2Coords.linearUVtoST.html b/docs/functions/S2Coords.linearUVtoST.html deleted file mode 100644 index fd6a409..0000000 --- a/docs/functions/S2Coords.linearUVtoST.html +++ /dev/null @@ -1,4 +0,0 @@ -linearUVtoST | s2json-spec - v1.5.5

Function linearUVtoST

  • Convert a [-1, 1] to a [0, 1] in a linear fashion

    -

    Parameters

    • u: number

      input U or V coordinate

      -

    Returns number

    output S or T coordinate

    -
diff --git a/docs/functions/S2Coords.lonLatToXYZ.html b/docs/functions/S2Coords.lonLatToXYZ.html deleted file mode 100644 index 4a1378d..0000000 --- a/docs/functions/S2Coords.lonLatToXYZ.html +++ /dev/null @@ -1,7 +0,0 @@ -lonLatToXYZ | s2json-spec - v1.5.5

Function lonLatToXYZ

  • Convert from a lon-lat coord to an left-hand-rule XYZ Point

    -

    Parameters

    • lon: number

      longitude

      -
    • lat: number

      latitude

      -

    Returns Point3D

      -
    • Point3D
    • -
    -
diff --git a/docs/functions/S2Coords.lonLatToXYZGL.html b/docs/functions/S2Coords.lonLatToXYZGL.html deleted file mode 100644 index 6e4802e..0000000 --- a/docs/functions/S2Coords.lonLatToXYZGL.html +++ /dev/null @@ -1,7 +0,0 @@ -lonLatToXYZGL | s2json-spec - v1.5.5

Function lonLatToXYZGL

  • Convert from a lon-lat coord to an right-hand-rule XYZ Point

    -

    Parameters

    • lon: number

      longitude

      -
    • lat: number

      latitude

      -

    Returns Point3D

      -
    • WebGL oriented Point3D
    • -
    -
diff --git a/docs/functions/S2Coords.neighborsIJ.html b/docs/functions/S2Coords.neighborsIJ.html deleted file mode 100644 index ae8b504..0000000 --- a/docs/functions/S2Coords.neighborsIJ.html +++ /dev/null @@ -1,10 +0,0 @@ -neighborsIJ | s2json-spec - v1.5.5

Function neighborsIJ

  • Find the face-i-j coordinates of neighbors for a specific face-i-j coordinate. -Define an adjusted level (zoom) for the i-j coordinates. The level is 30 by default.

    -

    Parameters

    • face: Face

      face of the cell

      -
    • i: number

      i coordinate

      -
    • j: number

      j coordinate

      -
    • level: number = 30

      zoom level

      -

    Returns [face: Face, i: number, j: number][]

      -
    • Face-i-j coordinates
    • -
    -
diff --git a/docs/functions/S2Coords.quadraticSTtoUV.html b/docs/functions/S2Coords.quadraticSTtoUV.html deleted file mode 100644 index ec59f90..0000000 --- a/docs/functions/S2Coords.quadraticSTtoUV.html +++ /dev/null @@ -1,4 +0,0 @@ -quadraticSTtoUV | s2json-spec - v1.5.5

Function quadraticSTtoUV

  • Convert a [0, 1] to a [-1, 1] in a quadratic fashion

    -

    Parameters

    • s: number

      input S or T coordinate

      -

    Returns number

    output U or V coordinate

    -
diff --git a/docs/functions/S2Coords.quadraticUVtoST.html b/docs/functions/S2Coords.quadraticUVtoST.html deleted file mode 100644 index 3fe68cb..0000000 --- a/docs/functions/S2Coords.quadraticUVtoST.html +++ /dev/null @@ -1,4 +0,0 @@ -quadraticUVtoST | s2json-spec - v1.5.5

Function quadraticUVtoST

  • Convert a [-1, 1] to a [0, 1] in a quadratic fashion

    -

    Parameters

    • u: number

      input U or V coordinate

      -

    Returns number

    output S or T coordinate

    -
diff --git a/docs/functions/S2Coords.tanSTtoUV.html b/docs/functions/S2Coords.tanSTtoUV.html deleted file mode 100644 index f9ac5b4..0000000 --- a/docs/functions/S2Coords.tanSTtoUV.html +++ /dev/null @@ -1,4 +0,0 @@ -tanSTtoUV | s2json-spec - v1.5.5
  • Convert a [0, 1] to a [-1, 1] in a tangential fashion

    -

    Parameters

    • s: number

      input S or T coordinate

      -

    Returns number

    output U or V coordinate

    -
diff --git a/docs/functions/S2Coords.tanUVtoST.html b/docs/functions/S2Coords.tanUVtoST.html deleted file mode 100644 index 0340fcc..0000000 --- a/docs/functions/S2Coords.tanUVtoST.html +++ /dev/null @@ -1,4 +0,0 @@ -tanUVtoST | s2json-spec - v1.5.5
  • Convert a [-1, 1] to a [0, 1] in a tangential fashion

    -

    Parameters

    • u: number

      input U or V coordinate

      -

    Returns number

    output S or T coordinate

    -
diff --git a/docs/functions/S2Coords.tileXYFromSTZoom.html b/docs/functions/S2Coords.tileXYFromSTZoom.html deleted file mode 100644 index 48beb11..0000000 --- a/docs/functions/S2Coords.tileXYFromSTZoom.html +++ /dev/null @@ -1,8 +0,0 @@ -tileXYFromSTZoom | s2json-spec - v1.5.5

Function tileXYFromSTZoom

  • Convert an x-y-zoom coordinate to a tile coordinate

    -

    Parameters

    • x: number

      x coordinate

      -
    • y: number

      y coordinate

      -
    • zoom: number

      zoom level

      -

    Returns Point

      -
    • tile X-Y coordinate
    • -
    -
diff --git a/docs/functions/S2Coords.tileXYFromUVZoom.html b/docs/functions/S2Coords.tileXYFromUVZoom.html deleted file mode 100644 index 7452a53..0000000 --- a/docs/functions/S2Coords.tileXYFromUVZoom.html +++ /dev/null @@ -1,8 +0,0 @@ -tileXYFromUVZoom | s2json-spec - v1.5.5

Function tileXYFromUVZoom

  • Convert an u-v-zoom coordinate to a tile coordinate

    -

    Parameters

    • u: number

      u coordinate

      -
    • v: number

      v coordinate

      -
    • zoom: number

      zoom level

      -

    Returns Point

      -
    • tile X-Y coordinate
    • -
    -
diff --git a/docs/functions/S2Coords.xyzToLonLat.html b/docs/functions/S2Coords.xyzToLonLat.html deleted file mode 100644 index 1c67747..0000000 --- a/docs/functions/S2Coords.xyzToLonLat.html +++ /dev/null @@ -1,6 +0,0 @@ -xyzToLonLat | s2json-spec - v1.5.5

Function xyzToLonLat

  • Convert from an left-hand-rule XYZ Point to a lon-lat coord

    -

    Parameters

    Returns [lon: number, lat: number]

      -
    • lon-lat coordinates
    • -
    -
diff --git a/docs/functions/S2Point.add.html b/docs/functions/S2Point.add.html deleted file mode 100644 index c3b6b8d..0000000 --- a/docs/functions/S2Point.add.html +++ /dev/null @@ -1,7 +0,0 @@ -add | s2json-spec - v1.5.5
  • Take an XYZ Point and add an n to each component

    -

    Parameters

    • xyz: Point3D

      The XYZ Point to add to.

      -
    • n: number

      The amount to add.

      -

    Returns Point3D

      -
    • The XYZ Point with the added amount.
    • -
    -
diff --git a/docs/functions/S2Point.addScalar.html b/docs/functions/S2Point.addScalar.html deleted file mode 100644 index 789a679..0000000 --- a/docs/functions/S2Point.addScalar.html +++ /dev/null @@ -1,7 +0,0 @@ -addScalar | s2json-spec - v1.5.5

Function addScalar

  • Take an XYZ Point and add another XYZ Point to it

    -

    Parameters

    • xyz: Point3D

      The XYZ Point to add to.

      -
    • point: Point3D

      The XYZ Point to add.

      -

    Returns Point3D

      -
    • The XYZ Point with the added XYZ Point.
    • -
    -
diff --git a/docs/functions/S2Point.distance.html b/docs/functions/S2Point.distance.html deleted file mode 100644 index 75c7c75..0000000 --- a/docs/functions/S2Point.distance.html +++ /dev/null @@ -1,7 +0,0 @@ -distance | s2json-spec - v1.5.5
  • Get the distance between two XYZ Points

    -

    Parameters

    Returns number

      -
    • The raw distance between the two XYZ Points. Highly inaccurate for large distances
    • -
    -
diff --git a/docs/functions/S2Point.distanceEarth.html b/docs/functions/S2Point.distanceEarth.html deleted file mode 100644 index ffe6736..0000000 --- a/docs/functions/S2Point.distanceEarth.html +++ /dev/null @@ -1,7 +0,0 @@ -distanceEarth | s2json-spec - v1.5.5

Function distanceEarth

  • Get the distance between two XYZ Points using Earth's size

    -

    Parameters

    Returns number

      -
    • The distance between the two XYZ Points
    • -
    -
diff --git a/docs/functions/S2Point.fromIJ.html b/docs/functions/S2Point.fromIJ.html deleted file mode 100644 index 3d71e90..0000000 --- a/docs/functions/S2Point.fromIJ.html +++ /dev/null @@ -1,6 +0,0 @@ -fromIJ | s2json-spec - v1.5.5
  • Convert an i-j coordinate to an XYZ Point.

    -

    Parameters

    • face: Face

      The face of the S2 cell.

      -
    • i: number

      The i-coordinate on the face.

      -
    • j: number

      The j-coordinate on the face.

      -

    Returns Point3D

    The XYZ Point representing the given i-j coordinates.

    -
diff --git a/docs/functions/S2Point.fromLonLat.html b/docs/functions/S2Point.fromLonLat.html deleted file mode 100644 index 6aca7d5..0000000 --- a/docs/functions/S2Point.fromLonLat.html +++ /dev/null @@ -1,5 +0,0 @@ -fromLonLat | s2json-spec - v1.5.5

Function fromLonLat

  • Convert a lon-lat coord to an XYZ Point using the left-hand-rule

    -

    Parameters

    • lon: number

      The longitude in degrees

      -
    • lat: number

      The latitude in degrees

      -

    Returns Point3D

    The XYZ Point

    -
diff --git a/docs/functions/S2Point.fromLonLatGL.html b/docs/functions/S2Point.fromLonLatGL.html deleted file mode 100644 index 124498a..0000000 --- a/docs/functions/S2Point.fromLonLatGL.html +++ /dev/null @@ -1,6 +0,0 @@ -fromLonLatGL | s2json-spec - v1.5.5

Function fromLonLatGL

  • Convert a lon-lat coord to an XYZ Point using the right-hand-rule. -This function takes longitude and latitude as input and returns the corresponding XYZ coordinates.

    -

    Parameters

    • lon: number

      The longitude in degrees.

      -
    • lat: number

      The latitude in degrees.

      -

    Returns Point3D

    The XYZ Point representing the provided longitude and latitude.

    -
diff --git a/docs/functions/S2Point.fromS2CellID.html b/docs/functions/S2Point.fromS2CellID.html deleted file mode 100644 index e63d1fa..0000000 --- a/docs/functions/S2Point.fromS2CellID.html +++ /dev/null @@ -1,4 +0,0 @@ -fromS2CellID | s2json-spec - v1.5.5

Function fromS2CellID

  • Convert an S2CellID to an XYZ Point.

    -

    Parameters

    • id: bigint

      The S2CellID to convert.

      -

    Returns Point3D

    The XYZ Point representing the given S2CellID.

    -
diff --git a/docs/functions/S2Point.fromST.html b/docs/functions/S2Point.fromST.html deleted file mode 100644 index 493c3b8..0000000 --- a/docs/functions/S2Point.fromST.html +++ /dev/null @@ -1,6 +0,0 @@ -fromST | s2json-spec - v1.5.5
  • Convert an s-t coordinate to an XYZ Point.

    -

    Parameters

    • face: Face

      The face of the S2 cell.

      -
    • s: number

      The s-coordinate on the face.

      -
    • t: number

      The t-coordinate on the face.

      -

    Returns Point3D

    The XYZ Point representing the given s-t coordinates.

    -
diff --git a/docs/functions/S2Point.fromSTGL.html b/docs/functions/S2Point.fromSTGL.html deleted file mode 100644 index 0a6fd50..0000000 --- a/docs/functions/S2Point.fromSTGL.html +++ /dev/null @@ -1,6 +0,0 @@ -fromSTGL | s2json-spec - v1.5.5
  • Convert an Face-S-T coord to an XYZ Point using the right-hand-rule

    -

    Parameters

    • face: Face

      The face of the S2 cell.

      -
    • s: number

      The s-coordinate on the face.

      -
    • t: number

      The t-coordinate on the face.

      -

    Returns Point3D

    The XYZ Point representing the given Face-S-T coordinates.

    -
diff --git a/docs/functions/S2Point.fromUV.html b/docs/functions/S2Point.fromUV.html deleted file mode 100644 index 65eead4..0000000 --- a/docs/functions/S2Point.fromUV.html +++ /dev/null @@ -1,6 +0,0 @@ -fromUV | s2json-spec - v1.5.5
  • Convert a u-v coordinate to an XYZ Point.

    -

    Parameters

    • face: Face

      The face of the S2 cell.

      -
    • u: number

      The u-coordinate on the face.

      -
    • v: number

      The v-coordinate on the face.

      -

    Returns Point3D

    The XYZ Point representing the given u-v coordinates.

    -
diff --git a/docs/functions/S2Point.fromUVGL.html b/docs/functions/S2Point.fromUVGL.html deleted file mode 100644 index f1bc8be..0000000 --- a/docs/functions/S2Point.fromUVGL.html +++ /dev/null @@ -1,6 +0,0 @@ -fromUVGL | s2json-spec - v1.5.5
  • Convert an Face-U-V coord to an XYZ Point using the right-hand-rule

    -

    Parameters

    • face: Face

      The face of the S2 cell.

      -
    • u: number

      The u-coordinate on the face.

      -
    • v: number

      The v-coordinate on the face.

      -

    Returns Point3D

    The XYZ Point representing the given Face-U-V coordinates.

    -
diff --git a/docs/functions/S2Point.getFace.html b/docs/functions/S2Point.getFace.html deleted file mode 100644 index 831bf11..0000000 --- a/docs/functions/S2Point.getFace.html +++ /dev/null @@ -1,6 +0,0 @@ -getFace | s2json-spec - v1.5.5
  • Find the S2 Hilbert Face of the XYZ Point [0, 6)

    -

    Parameters

    Returns number

      -
    • The S2 Hilbert Face
    • -
    -
diff --git a/docs/functions/S2Point.length.html b/docs/functions/S2Point.length.html deleted file mode 100644 index 8256733..0000000 --- a/docs/functions/S2Point.length.html +++ /dev/null @@ -1,6 +0,0 @@ -length | s2json-spec - v1.5.5
  • Get the length of the XYZ Point

    -

    Parameters

    Returns number

      -
    • The length of the XYZ Point
    • -
    -
diff --git a/docs/functions/S2Point.mul.html b/docs/functions/S2Point.mul.html deleted file mode 100644 index 996e363..0000000 --- a/docs/functions/S2Point.mul.html +++ /dev/null @@ -1,7 +0,0 @@ -mul | s2json-spec - v1.5.5
  • Take an XYZ Point and multiply each component by n

    -

    Parameters

    • xyz: Point3D

      The XYZ Point to multiply.

      -
    • n: number

      The amount to multiply.

      -

    Returns Point3D

      -
    • The XYZ Point with the multiplied amount.
    • -
    -
diff --git a/docs/functions/S2Point.mulScalar.html b/docs/functions/S2Point.mulScalar.html deleted file mode 100644 index e9ab7e2..0000000 --- a/docs/functions/S2Point.mulScalar.html +++ /dev/null @@ -1,7 +0,0 @@ -mulScalar | s2json-spec - v1.5.5

Function mulScalar

  • Take an XYZ Point and multiply it by another XYZ Point

    -

    Parameters

    • xyz: Point3D

      The XYZ Point to multiply.

      -
    • point: Point3D

      The XYZ Point to multiply.

      -

    Returns Point3D

      -
    • The XYZ Point with the multiplied XYZ Point.
    • -
    -
diff --git a/docs/functions/S2Point.normalize.html b/docs/functions/S2Point.normalize.html deleted file mode 100644 index d28cdca..0000000 --- a/docs/functions/S2Point.normalize.html +++ /dev/null @@ -1,6 +0,0 @@ -normalize | s2json-spec - v1.5.5

Function normalize

  • Take an XYZ Point and divide each component by its length

    -

    Parameters

    • xyz: Point3D

      The XYZ Point to divide.

      -

    Returns Point3D

      -
    • The XYZ Point with the divided amount.
    • -
    -
diff --git a/docs/functions/S2Point.sub.html b/docs/functions/S2Point.sub.html deleted file mode 100644 index 9dc527d..0000000 --- a/docs/functions/S2Point.sub.html +++ /dev/null @@ -1,7 +0,0 @@ -sub | s2json-spec - v1.5.5
  • Take an XYZ Point and subtract an n from each component

    -

    Parameters

    • xyz: Point3D

      The XYZ Point to subtract from.

      -
    • n: number

      The amount to subtract.

      -

    Returns Point3D

      -
    • The XYZ Point with the subtracted amount.
    • -
    -
diff --git a/docs/functions/S2Point.subScalar.html b/docs/functions/S2Point.subScalar.html deleted file mode 100644 index a090b47..0000000 --- a/docs/functions/S2Point.subScalar.html +++ /dev/null @@ -1,7 +0,0 @@ -subScalar | s2json-spec - v1.5.5

Function subScalar

  • Take an XYZ Point and subtract another XYZ Point from it

    -

    Parameters

    • xyz: Point3D

      The XYZ Point to subtract from.

      -
    • point: Point3D

      The XYZ Point to subtract.

      -

    Returns Point3D

      -
    • The XYZ Point with the subtracted XYZ Point.
    • -
    -
diff --git a/docs/functions/S2Point.toIJ.html b/docs/functions/S2Point.toIJ.html deleted file mode 100644 index 74e3f27..0000000 --- a/docs/functions/S2Point.toIJ.html +++ /dev/null @@ -1,5 +0,0 @@ -toIJ | s2json-spec - v1.5.5
  • Convert an XYZ Point to a Face-I-J coord

    -

    Parameters

    • xyz: Point3D

      The XYZ Point to convert.

      -
    • Optionallevel: number

      The zoom level of the result. If not provided, the result will have 30 bits of precision.

      -

    Returns [face: Face, i: number, j: number]

    The Face-I-J coordinates representing the given XYZ Point.

    -
diff --git a/docs/functions/S2Point.toLonLat.html b/docs/functions/S2Point.toLonLat.html deleted file mode 100644 index 3b5427f..0000000 --- a/docs/functions/S2Point.toLonLat.html +++ /dev/null @@ -1,4 +0,0 @@ -toLonLat | s2json-spec - v1.5.5
  • Convert an XYZ Point to a lon-lat coord

    -

    Parameters

    • xyz: Point3D

      The XYZ Point to convert.

      -

    Returns [lon: number, lat: number]

    The lon-lat coordinates representing the given XYZ Point.

    -
diff --git a/docs/functions/S2Point.toS2CellID.html b/docs/functions/S2Point.toS2CellID.html deleted file mode 100644 index 35ecd9e..0000000 --- a/docs/functions/S2Point.toS2CellID.html +++ /dev/null @@ -1,4 +0,0 @@ -toS2CellID | s2json-spec - v1.5.5

Function toS2CellID

  • Convert an XYZ Point to an S2CellID

    -

    Parameters

    • xyz: Point3D

      The XYZ Point to convert.

      -

    Returns bigint

    The S2CellID representing the given XYZ Point.

    -
diff --git a/docs/functions/S2Point.toST.html b/docs/functions/S2Point.toST.html deleted file mode 100644 index b711ad5..0000000 --- a/docs/functions/S2Point.toST.html +++ /dev/null @@ -1,6 +0,0 @@ -toST | s2json-spec - v1.5.5
  • Convert an XYZ Point to a Face-S-T coord

    -

    Parameters

    • xyz: Point3D

      The XYZ Point to convert.

      -

    Returns [face: Face, s: number, t: number]

      -
    • The Face-S-T coordinates representing the given XYZ Point.
    • -
    -
diff --git a/docs/functions/S2Point.toUV.html b/docs/functions/S2Point.toUV.html deleted file mode 100644 index 625f2e8..0000000 --- a/docs/functions/S2Point.toUV.html +++ /dev/null @@ -1,6 +0,0 @@ -toUV | s2json-spec - v1.5.5
  • Convert an XYZ Point to a Face-U-V coord

    -

    Parameters

    • xyz: Point3D

      The XYZ Point to convert.

      -

    Returns [face: Face, u: number, v: number]

      -
    • The Face-U-V coordinates representing the given XYZ Point.
    • -
    -
diff --git a/docs/functions/bboxOverlap.html b/docs/functions/bboxOverlap.html deleted file mode 100644 index 1fbeba3..0000000 --- a/docs/functions/bboxOverlap.html +++ /dev/null @@ -1,8 +0,0 @@ -bboxOverlap | s2json-spec - v1.5.5

Function bboxOverlap

  • Checks if two bounding boxes overlap. If they don't overlap, returns undefined. -If they do, return the overlap

    -

    Parameters

    • b1: BBox

      first bounding box

      -
    • b2: BBox

      second bounding box

      -

    Returns undefined | BBox

      -
    • undefined if no overlap, or a bbox of the overlap
    • -
    -
diff --git a/docs/functions/boundsST.html b/docs/functions/boundsST.html deleted file mode 100644 index 0055452..0000000 --- a/docs/functions/boundsST.html +++ /dev/null @@ -1,5 +0,0 @@ -boundsST | s2json-spec - v1.5.5

Function boundsST

  • Given an S2CellID and level (zoom), get the S-T bounding range of that cell

    -

    Parameters

    • id: bigint

      the S2CellID

      -
    • lev: number

      zoom level

      -

    Returns BBox

    [sMin, tMin, sMax, tMax]

    -
diff --git a/docs/functions/buildSqDist.html b/docs/functions/buildSqDist.html deleted file mode 100644 index e3b4267..0000000 --- a/docs/functions/buildSqDist.html +++ /dev/null @@ -1,7 +0,0 @@ -buildSqDist | s2json-spec - v1.5.5

Function buildSqDist

  • calculate simplification of line vector data using -optimized Douglas-Peucker algorithm

    -

    Parameters

    • coords: VectorLineString

      input coordinates

      -
    • first: number

      first point index

      -
    • last: number

      last points index

      -
    • sqTolerance: number

      simplification tolerance (higher means simpler)

      -

    Returns void

diff --git a/docs/functions/buildSqDists.html b/docs/functions/buildSqDists.html deleted file mode 100644 index f8674c4..0000000 --- a/docs/functions/buildSqDists.html +++ /dev/null @@ -1,5 +0,0 @@ -buildSqDists | s2json-spec - v1.5.5

Function buildSqDists

  • Builds squared distances for the vector geometry using the Douglas-Peucker algorithm.

    -

    Parameters

    • geometry: VectorGeometry

      input vector geometry

      -
    • tolerance: number

      simplification tolerance

      -
    • maxzoom: number = 16

      max zoom level to simplify

      -

    Returns void

diff --git a/docs/functions/centerST.html b/docs/functions/centerST.html deleted file mode 100644 index 80d92a5..0000000 --- a/docs/functions/centerST.html +++ /dev/null @@ -1,4 +0,0 @@ -centerST | s2json-spec - v1.5.5

Function centerST

  • Given an S2CellID and level (zoom), get the center point of that cell in S-T space

    -

    Parameters

    • id: bigint

      the S2CellID

      -

    Returns [face: Face, s: number, t: number]

    [face, s, t]

    -
diff --git a/docs/functions/child.html b/docs/functions/child.html deleted file mode 100644 index 6d13a1e..0000000 --- a/docs/functions/child.html +++ /dev/null @@ -1,5 +0,0 @@ -child | s2json-spec - v1.5.5

Function child

  • Given an S2CellID, get the quad child tile of your choice [0, 4)

    -

    Parameters

    • id: bigint

      the S2CellID

      -
    • pos:
          | 0n
          | 3n
          | 1n
          | 2n

      quad position 0, 1, 2, or 3

      -

    Returns bigint

    the child tile at that position

    -
diff --git a/docs/functions/childPosition.html b/docs/functions/childPosition.html deleted file mode 100644 index 53f0e5a..0000000 --- a/docs/functions/childPosition.html +++ /dev/null @@ -1,5 +0,0 @@ -childPosition | s2json-spec - v1.5.5

Function childPosition

  • Given an S2CellID, get the quad position relative to its parent

    -

    Parameters

    • id: bigint

      the S2CellID

      -
    • level: number

      zoom level

      -

    Returns number

    the child tile at that position

    -
diff --git a/docs/functions/children.html b/docs/functions/children.html deleted file mode 100644 index de8bc69..0000000 --- a/docs/functions/children.html +++ /dev/null @@ -1,5 +0,0 @@ -children | s2json-spec - v1.5.5

Function children

  • Given an S2CellID, get all the quad children tiles

    -

    Parameters

    • id: bigint

      the S2CellID

      -
    • orientation: number = 0

      orientation of the child (0 or 1)

      -

    Returns [bigint, bigint, bigint, bigint]

    the child tile at that position

    -
diff --git a/docs/functions/childrenIJ.html b/docs/functions/childrenIJ.html deleted file mode 100644 index c608b30..0000000 --- a/docs/functions/childrenIJ.html +++ /dev/null @@ -1,7 +0,0 @@ -childrenIJ | s2json-spec - v1.5.5

Function childrenIJ

  • Given a Face-level-i-j coordinate, get all its quad children tiles

    -

    Parameters

    • face: Face

      the Face

      -
    • level: number

      zoom level

      -
    • i: number

      i coordinate

      -
    • j: number

      j coordinate

      -

    Returns [blID: bigint, brID: bigint, tlID: bigint, trID: bigint]

    the child tile at that position

    -
diff --git a/docs/functions/clipBBox.html b/docs/functions/clipBBox.html deleted file mode 100644 index 211143a..0000000 --- a/docs/functions/clipBBox.html +++ /dev/null @@ -1,7 +0,0 @@ -clipBBox | s2json-spec - v1.5.5

Function clipBBox

  • Create a new bounding box clipped by the axis and min-max

    -

    Parameters

    • bb: undefined | BBOX

      the original bounding box

      -
    • axis: 0 | 1

      0 for x, 1 for y

      -
    • k1: number

      the lower bound

      -
    • k2: number

      the upper bound

      -

    Returns BBOX

    the new bounding box clipped by the axis and min-max

    -
diff --git a/docs/functions/contains.html b/docs/functions/contains.html deleted file mode 100644 index 0ea8568..0000000 --- a/docs/functions/contains.html +++ /dev/null @@ -1,5 +0,0 @@ -contains | s2json-spec - v1.5.5

Function contains

  • Check if the first S2CellID contains the second.

    -

    Parameters

    • a: bigint

      the first S2CellID

      -
    • b: bigint

      the second S2CellID

      -

    Returns boolean

    true if a contains b

    -
diff --git a/docs/functions/degToRad.html b/docs/functions/degToRad.html deleted file mode 100644 index 6e02152..0000000 --- a/docs/functions/degToRad.html +++ /dev/null @@ -1,4 +0,0 @@ -degToRad | s2json-spec - v1.5.5

Function degToRad

  • convert degrees to radians

    -

    Parameters

    • deg: number

      degree value

      -

    Returns number

    radians

    -
diff --git a/docs/functions/distance.html b/docs/functions/distance.html deleted file mode 100644 index 1cf2bce..0000000 --- a/docs/functions/distance.html +++ /dev/null @@ -1,5 +0,0 @@ -distance | s2json-spec - v1.5.5

Function distance

  • Given an S2CellID, get the distance it spans (or length it covers)

    -

    Parameters

    • id: bigint

      the S2CellID

      -
    • Optionallev: number

      optional zoom level

      -

    Returns bigint

    distance

    -
diff --git a/docs/functions/extendBBox.html b/docs/functions/extendBBox.html deleted file mode 100644 index 28b0f05..0000000 --- a/docs/functions/extendBBox.html +++ /dev/null @@ -1,6 +0,0 @@ -extendBBox | s2json-spec - v1.5.5

Function extendBBox

  • Parameters

    • bbox: undefined | BBOX

      the bounding box to extend, if it doesn't exist it will be created otherwise just modified

      -
    • point: VectorPoint

      the point to add to the bbox

      -

    Returns BBOX

      -
    • the extended bbox
    • -
    -
diff --git a/docs/functions/face-1.html b/docs/functions/face-1.html deleted file mode 100644 index 9309594..0000000 --- a/docs/functions/face-1.html +++ /dev/null @@ -1,4 +0,0 @@ -face | s2json-spec - v1.5.5

Function face

  • Given an S2CellID, get the face it's located in

    -

    Parameters

    • id: bigint

      the S2CellID

      -

    Returns Face

    face of the cell

    -
diff --git a/docs/functions/fromDistance.html b/docs/functions/fromDistance.html deleted file mode 100644 index becf3a3..0000000 --- a/docs/functions/fromDistance.html +++ /dev/null @@ -1,5 +0,0 @@ -fromDistance | s2json-spec - v1.5.5

Function fromDistance

  • Create an S2CellID given a distance and level (zoom). Default level is 30n

    -

    Parameters

    • distance: bigint

      distance

      -
    • level: bigint = MAX_LEVEL

      level

      -

    Returns bigint

    the S2CellID

    -
diff --git a/docs/functions/fromFace.html b/docs/functions/fromFace.html deleted file mode 100644 index 15b3033..0000000 --- a/docs/functions/fromFace.html +++ /dev/null @@ -1,4 +0,0 @@ -fromFace | s2json-spec - v1.5.5

Function fromFace

  • Create a default S2CellID given a face on the sphere [0-6)

    -

    Parameters

    • face: Face

      the face

      -

    Returns bigint

    the S2CellID

    -
diff --git a/docs/functions/fromIJ.html b/docs/functions/fromIJ.html deleted file mode 100644 index fe7ebf1..0000000 --- a/docs/functions/fromIJ.html +++ /dev/null @@ -1,7 +0,0 @@ -fromIJ | s2json-spec - v1.5.5

Function fromIJ

  • Create an S2CellID from an Face-I-J coordinate and map it to a zoom if desired.

    -

    Parameters

    • face: Face

      the face

      -
    • i: number

      i coordinate

      -
    • j: number

      j coordinate

      -
    • Optionallevel: number

      zoom level

      -

    Returns bigint

    the S2CellID

    -
diff --git a/docs/functions/fromIJSame.html b/docs/functions/fromIJSame.html deleted file mode 100644 index 8e42d7a..0000000 --- a/docs/functions/fromIJSame.html +++ /dev/null @@ -1,7 +0,0 @@ -fromIJSame | s2json-spec - v1.5.5

Function fromIJSame

  • Build an S2CellID given a Face-I-J, but ensure the face is the same if desired

    -

    Parameters

    • face: Face

      the Face

      -
    • i: number

      the I coordinate

      -
    • j: number

      the J coordinate

      -
    • sameFace: boolean

      if the face should be the same

      -

    Returns bigint

    the S2CellID

    -
diff --git a/docs/functions/fromIJWrap.html b/docs/functions/fromIJWrap.html deleted file mode 100644 index 3538f69..0000000 --- a/docs/functions/fromIJWrap.html +++ /dev/null @@ -1,6 +0,0 @@ -fromIJWrap | s2json-spec - v1.5.5

Function fromIJWrap

  • Build an S2CellID given a Face-I-J, but ensure it's a legal value, otherwise wrap before creation

    -

    Parameters

    • face: Face

      the Face

      -
    • i: number

      the I coordinate

      -
    • j: number

      the J coordinate

      -

    Returns bigint

    the S2CellID

    -
diff --git a/docs/functions/fromLonLat.html b/docs/functions/fromLonLat.html deleted file mode 100644 index 4d548cc..0000000 --- a/docs/functions/fromLonLat.html +++ /dev/null @@ -1,5 +0,0 @@ -fromLonLat | s2json-spec - v1.5.5

Function fromLonLat

  • Create an S2CellID from a lon-lat coordinate

    -

    Parameters

    • lon: number

      longitude

      -
    • lat: number

      latitude

      -

    Returns bigint

    the S2CellID

    -
diff --git a/docs/functions/fromPoint.html b/docs/functions/fromPoint.html deleted file mode 100644 index 8d06ab2..0000000 --- a/docs/functions/fromPoint.html +++ /dev/null @@ -1,5 +0,0 @@ -fromPoint | s2json-spec - v1.5.5

Function fromPoint

  • Parameters

    Returns BBOX

      -
    • BBox of the point
    • -
    -
diff --git a/docs/functions/fromS2Point.html b/docs/functions/fromS2Point.html deleted file mode 100644 index 5dddf8a..0000000 --- a/docs/functions/fromS2Point.html +++ /dev/null @@ -1,4 +0,0 @@ -fromS2Point | s2json-spec - v1.5.5

Function fromS2Point

  • Create an S2CellID from an XYZ Point

    -

    Parameters

    Returns bigint

    the S2CellID

    -
diff --git a/docs/functions/fromST.html b/docs/functions/fromST.html deleted file mode 100644 index 0fd2014..0000000 --- a/docs/functions/fromST.html +++ /dev/null @@ -1,6 +0,0 @@ -fromST | s2json-spec - v1.5.5

Function fromST

  • Create an S2CellID from an Face-S-T coordinate

    -

    Parameters

    • face: Face

      the face

      -
    • s: number

      s coordinate

      -
    • t: number

      t coordinate

      -

    Returns bigint

    the S2CellID

    -
diff --git a/docs/functions/fromUV.html b/docs/functions/fromUV.html deleted file mode 100644 index d00e5fe..0000000 --- a/docs/functions/fromUV.html +++ /dev/null @@ -1,6 +0,0 @@ -fromUV | s2json-spec - v1.5.5

Function fromUV

  • Create an S2CellID from an Face-U-V coordinate

    -

    Parameters

    • face: Face

      the face

      -
    • u: number

      u coordinate

      -
    • v: number

      v coordinate

      -

    Returns bigint

    the S2CellID

    -
diff --git a/docs/functions/intersects.html b/docs/functions/intersects.html deleted file mode 100644 index 05a35c2..0000000 --- a/docs/functions/intersects.html +++ /dev/null @@ -1,5 +0,0 @@ -intersects | s2json-spec - v1.5.5

Function intersects

  • Check if an S2CellID intersects another. This includes edges touching.

    -

    Parameters

    • a: bigint

      the first S2CellID

      -
    • b: bigint

      the second S2CellID

      -

    Returns boolean

    true if a intersects b

    -
diff --git a/docs/functions/isFace.html b/docs/functions/isFace.html deleted file mode 100644 index 38821a5..0000000 --- a/docs/functions/isFace.html +++ /dev/null @@ -1,4 +0,0 @@ -isFace | s2json-spec - v1.5.5

Function isFace

  • Given an S2CellID, check if it is a Face Cell.

    -

    Parameters

    • id: bigint

      the S2CellID

      -

    Returns boolean

    true if the cell is a face (lowest zoom level)

    -
diff --git a/docs/functions/isLeaf.html b/docs/functions/isLeaf.html deleted file mode 100644 index 5ff2f26..0000000 --- a/docs/functions/isLeaf.html +++ /dev/null @@ -1,4 +0,0 @@ -isLeaf | s2json-spec - v1.5.5

Function isLeaf

  • Check if the S2CellID is a leaf value. This means it's the smallest possible cell

    -

    Parameters

    • id: bigint

      input S2CellID

      -

    Returns boolean

    true if the S2CellID is a leaf

    -
diff --git a/docs/functions/level.html b/docs/functions/level.html deleted file mode 100644 index 48e3d54..0000000 --- a/docs/functions/level.html +++ /dev/null @@ -1,4 +0,0 @@ -level | s2json-spec - v1.5.5

Function level

  • Given an S2CellID, find the level (zoom) its located in

    -

    Parameters

    • id: bigint

      the S2CellID

      -

    Returns number

    zoom level

    -
diff --git a/docs/functions/mergeBBoxes.html b/docs/functions/mergeBBoxes.html deleted file mode 100644 index 264564b..0000000 --- a/docs/functions/mergeBBoxes.html +++ /dev/null @@ -1,7 +0,0 @@ -mergeBBoxes | s2json-spec - v1.5.5

Function mergeBBoxes

  • Merges two bounding boxes into the first and returns the result

    -

    Parameters

    • b1: BBOX

      the first bounding box

      -
    • b2: BBOX

      the second bounding box

      -

    Returns BBOX

      -
    • the merged bounding box
    • -
    -
diff --git a/docs/functions/neighbors.html b/docs/functions/neighbors.html deleted file mode 100644 index 88a72db..0000000 --- a/docs/functions/neighbors.html +++ /dev/null @@ -1,4 +0,0 @@ -neighbors | s2json-spec - v1.5.5

Function neighbors

  • Given an S2CellID, find the neighboring S2CellIDs

    -

    Parameters

    • id: bigint

      the S2CellID

      -

    Returns [bigint, bigint, bigint, bigint]

    [up, right, down, left]

    -
diff --git a/docs/functions/neighborsIJ.html b/docs/functions/neighborsIJ.html deleted file mode 100644 index e95b133..0000000 --- a/docs/functions/neighborsIJ.html +++ /dev/null @@ -1,7 +0,0 @@ -neighborsIJ | s2json-spec - v1.5.5

Function neighborsIJ

  • Given a Face-I-J and a desired level (zoom), find the neighboring S2CellIDs

    -

    Parameters

    • face: Face

      the Face

      -
    • i: number

      the I coordinate

      -
    • j: number

      the J coordinate

      -
    • level: number

      the zoom level (desired)

      -

    Returns [bigint, bigint, bigint, bigint]

    neighbors: [down, right, up, left]

    -
diff --git a/docs/functions/next.html b/docs/functions/next.html deleted file mode 100644 index 929e369..0000000 --- a/docs/functions/next.html +++ /dev/null @@ -1,4 +0,0 @@ -next | s2json-spec - v1.5.5

Function next

  • Get the next S2CellID in the hilbert space

    -

    Parameters

    • id: bigint

      input S2CellID

      -

    Returns bigint

    the next S2CellID in the hilbert space

    -
diff --git a/docs/functions/parent.html b/docs/functions/parent.html deleted file mode 100644 index 2d920ae..0000000 --- a/docs/functions/parent.html +++ /dev/null @@ -1,5 +0,0 @@ -parent | s2json-spec - v1.5.5

Function parent

  • Given an S2CellID, get the parent quad tile

    -

    Parameters

    • id: bigint

      the S2CellID

      -
    • Optionallevel: number

      zoom level

      -

    Returns bigint

    the parent of the input S2CellID

    -
diff --git a/docs/functions/pointOverlap.html b/docs/functions/pointOverlap.html deleted file mode 100644 index 7c13cd8..0000000 --- a/docs/functions/pointOverlap.html +++ /dev/null @@ -1,7 +0,0 @@ -pointOverlap | s2json-spec - v1.5.5

Function pointOverlap

  • Checks if a point is within a bounding box

    -

    Parameters

    • bbox: BBox

      the bounding box to test

      -
    • point: VectorPoint

      point to test if it exists within the bbox

      -

    Returns boolean

      -
    • true if the point is within the bbox, false otherwise
    • -
    -
diff --git a/docs/functions/pos.html b/docs/functions/pos.html deleted file mode 100644 index 685a8b2..0000000 --- a/docs/functions/pos.html +++ /dev/null @@ -1,4 +0,0 @@ -pos | s2json-spec - v1.5.5

Function pos

  • Given an S2CellID, find the quad tree position [0-4) it's located in

    -

    Parameters

    • id: bigint

      the S2CellID

      -

    Returns bigint

    quad tree position

    -
diff --git a/docs/functions/prev.html b/docs/functions/prev.html deleted file mode 100644 index bcd87d5..0000000 --- a/docs/functions/prev.html +++ /dev/null @@ -1,4 +0,0 @@ -prev | s2json-spec - v1.5.5

Function prev

  • Get the previous S2CellID in the hilbert space

    -

    Parameters

    • id: bigint

      input S2CellID

      -

    Returns bigint

    the previous S2CellID in the hilbert space

    -
diff --git a/docs/functions/radToDeg.html b/docs/functions/radToDeg.html deleted file mode 100644 index fc86e62..0000000 --- a/docs/functions/radToDeg.html +++ /dev/null @@ -1,4 +0,0 @@ -radToDeg | s2json-spec - v1.5.5

Function radToDeg

  • convert radians to degrees

    -

    Parameters

    • radians: number

      radian value

      -

    Returns number

    degrees

    -
diff --git a/docs/functions/range.html b/docs/functions/range.html deleted file mode 100644 index 53b9581..0000000 --- a/docs/functions/range.html +++ /dev/null @@ -1,4 +0,0 @@ -range | s2json-spec - v1.5.5

Function range

  • Given an S2CellID, get the hilbert range it spans

    -

    Parameters

    • id: bigint

      the S2CellID

      -

    Returns [min: bigint, max: bigint]

    [min, max]

    -
diff --git a/docs/functions/rewind.html b/docs/functions/rewind.html deleted file mode 100644 index e836851..0000000 --- a/docs/functions/rewind.html +++ /dev/null @@ -1,4 +0,0 @@ -rewind | s2json-spec - v1.5.5

Function rewind

  • In place adjust the ring if necessary

    -

    Parameters

    • ring: VectorLineString

      the ring to rewind

      -
    • clockwise: boolean

      whether the ring needs to be clockwise

      -

    Returns void

diff --git a/docs/functions/simplify.html b/docs/functions/simplify.html deleted file mode 100644 index c2b2227..0000000 --- a/docs/functions/simplify.html +++ /dev/null @@ -1,6 +0,0 @@ -simplify | s2json-spec - v1.5.5

Function simplify

  • Simplifies the vector geometry based on zoom level and tolerance.

    -

    Parameters

    • geometry: VectorGeometry

      input vector geometry

      -
    • tolerance: number

      simplification tolerance

      -
    • zoom: number

      curent zoom

      -
    • maxzoom: number = 16

      max zoom level

      -

    Returns void

diff --git a/docs/functions/sizeIJ.html b/docs/functions/sizeIJ.html deleted file mode 100644 index e20113e..0000000 --- a/docs/functions/sizeIJ.html +++ /dev/null @@ -1,4 +0,0 @@ -sizeIJ | s2json-spec - v1.5.5

Function sizeIJ

  • Return the range maximum of a level (zoom) in I-J space

    -

    Parameters

    • level: number

      zoom level

      -

    Returns number

    iMax or jMax

    -
diff --git a/docs/functions/sizeST.html b/docs/functions/sizeST.html deleted file mode 100644 index f8a94d3..0000000 --- a/docs/functions/sizeST.html +++ /dev/null @@ -1,4 +0,0 @@ -sizeST | s2json-spec - v1.5.5

Function sizeST

  • Return the range maximum of a level (zoom) in S-T space

    -

    Parameters

    • level: number

      zoom level

      -

    Returns number

    sMax or tMax

    -
diff --git a/docs/functions/toFaceIJ.html b/docs/functions/toFaceIJ.html deleted file mode 100644 index f785c2b..0000000 --- a/docs/functions/toFaceIJ.html +++ /dev/null @@ -1,3 +0,0 @@ -toFaceIJ | s2json-spec - v1.5.5

Function toFaceIJ

  • Parameters

    • id: bigint

      the S2CellID

      -

    Returns [face: Face, zoom: number, i: number, j: number]

    [face, zoom, i, j]

    -
diff --git a/docs/functions/toIJ.html b/docs/functions/toIJ.html deleted file mode 100644 index 2592ece..0000000 --- a/docs/functions/toIJ.html +++ /dev/null @@ -1,6 +0,0 @@ -toIJ | s2json-spec - v1.5.5

Function toIJ

  • Convert an S2CellID to a Face-I-J coordinate and provide its orientation. -If a level is provided, the I-J coordinates will be shifted to that level.

    -

    Parameters

    • id: bigint

      the S2CellID

      -
    • Optionallevel: number | bigint

      zoom level

      -

    Returns [face: Face, i: number, j: number, orientation: number]

    face-i-j with orientation

    -
diff --git a/docs/functions/toLL.html b/docs/functions/toLL.html deleted file mode 100644 index 3d130e4..0000000 --- a/docs/functions/toLL.html +++ /dev/null @@ -1,3 +0,0 @@ -toLL | s2json-spec - v1.5.5

Function toLL

  • Reproject GeoJSON geometry coordinates from 0->1 coordinate system to lon-lat in place

    -

    Parameters

    Returns void

diff --git a/docs/functions/toLonLat.html b/docs/functions/toLonLat.html deleted file mode 100644 index 96b1793..0000000 --- a/docs/functions/toLonLat.html +++ /dev/null @@ -1,4 +0,0 @@ -toLonLat | s2json-spec - v1.5.5

Function toLonLat

  • Convert an S2CellID to an lon-lat coordinate

    -

    Parameters

    • id: bigint

      the S2CellID

      -

    Returns [lon: number, lat: number]

    lon-lat coordinates

    -
diff --git a/docs/functions/toS2.html b/docs/functions/toS2.html deleted file mode 100644 index 7a86cd9..0000000 --- a/docs/functions/toS2.html +++ /dev/null @@ -1,9 +0,0 @@ -toS2 | s2json-spec - v1.5.5

Function toS2

  • Convet a GeoJSON Feature to an S2Feature

    -

    Parameters

    • data: VectorFeature | Feature

      GeoJSON Feature

      -
    • Optionaltolerance: number

      optional tolerance

      -
    • Optionalmaxzoom: number

      optional maxzoom

      -
    • OptionalbuildBBox: boolean

      optional - build a bbox for the feature if desired

      -

    Returns S2Feature[]

      -
    • S2Feature
    • -
    -
diff --git a/docs/functions/toS2Point.html b/docs/functions/toS2Point.html deleted file mode 100644 index ce1193f..0000000 --- a/docs/functions/toS2Point.html +++ /dev/null @@ -1,4 +0,0 @@ -toS2Point | s2json-spec - v1.5.5

Function toS2Point

  • Convert an S2CellID to an XYZ Point

    -

    Parameters

    • id: bigint

      the S2CellID

      -

    Returns Point3D

    a 3D vector

    -
diff --git a/docs/functions/toST.html b/docs/functions/toST.html deleted file mode 100644 index 7b0b4a5..0000000 --- a/docs/functions/toST.html +++ /dev/null @@ -1,4 +0,0 @@ -toST | s2json-spec - v1.5.5

Function toST

  • Convert an S2CellID to an Face-S-T coordinate

    -

    Parameters

    • id: bigint

      the S2CellID

      -

    Returns [face: Face, s: number, t: number]

    face-s-t coordinate associated with the S2CellID

    -
diff --git a/docs/functions/toUV.html b/docs/functions/toUV.html deleted file mode 100644 index 2f4aef0..0000000 --- a/docs/functions/toUV.html +++ /dev/null @@ -1,4 +0,0 @@ -toUV | s2json-spec - v1.5.5

Function toUV

  • Convert an S2CellID to an Face-U-V coordinate

    -

    Parameters

    • id: bigint

      the S2CellID

      -

    Returns [face: Face, u: number, v: number]

    face-u-v coordinate associated with the S2CellID

    -
diff --git a/docs/functions/toUnitScale.html b/docs/functions/toUnitScale.html deleted file mode 100644 index f8779bf..0000000 --- a/docs/functions/toUnitScale.html +++ /dev/null @@ -1,5 +0,0 @@ -toUnitScale | s2json-spec - v1.5.5

Function toUnitScale

  • Reproject GeoJSON geometry coordinates from lon-lat to a 0->1 coordinate system in place

    -

    Parameters

    • feature: VectorFeature

      input GeoJSON

      -
    • Optionaltolerance: number

      if provided, geometry will be prepared for simplification by this tolerance

      -
    • Optionalmaxzoom: number

      if provided,

      -

    Returns void

diff --git a/docs/functions/toVector.html b/docs/functions/toVector.html deleted file mode 100644 index e43accc..0000000 --- a/docs/functions/toVector.html +++ /dev/null @@ -1,7 +0,0 @@ -toVector | s2json-spec - v1.5.5

Function toVector

  • Convert a GeoJSON Feature to a GeoJSON Vector Feature

    -

    Parameters

    • data: Feature

      GeoJSON Feature

      -
    • OptionalbuildBBox: boolean

      optional - build a bbox for the feature if desired

      -

    Returns VectorFeature

      -
    • GeoJson Vector Feature
    • -
    -
diff --git a/docs/functions/toWM.html b/docs/functions/toWM.html deleted file mode 100644 index 77ef763..0000000 --- a/docs/functions/toWM.html +++ /dev/null @@ -1,6 +0,0 @@ -toWM | s2json-spec - v1.5.5

Function toWM

diff --git a/docs/functions/transformPoint.html b/docs/functions/transformPoint.html deleted file mode 100644 index d9bb010..0000000 --- a/docs/functions/transformPoint.html +++ /dev/null @@ -1,6 +0,0 @@ -transformPoint | s2json-spec - v1.5.5

Function transformPoint

  • Mutates the point in place to a tile coordinate

    -

    Parameters

    • vp: VectorPoint

      input vector point that we are mutating in place

      -
    • zoom: number

      current zoom

      -
    • ti: number

      x translation

      -
    • tj: number

      y translation

      -

    Returns void

diff --git a/docs/functions/vertexNeighbors.html b/docs/functions/vertexNeighbors.html deleted file mode 100644 index 0cf214b..0000000 --- a/docs/functions/vertexNeighbors.html +++ /dev/null @@ -1,5 +0,0 @@ -vertexNeighbors | s2json-spec - v1.5.5

Function vertexNeighbors

  • Given an S2CellID, find it's nearest neighbors associated with it

    -

    Parameters

    • id: bigint

      the S2CellID

      -
    • Optionallev: number

      the zoom level (if not provided, defaults to current level of id)

      -

    Returns bigint[]

    neighbors

    -
diff --git a/docs/index.html b/docs/index.html index 4fc62fa..8089e0c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -20,9 +20,6 @@ docs-rust - - code-coverage - Discord @@ -46,6 +43,9 @@

s2json-spec

+
# bun
bun add -D s2json-spec
# pnpm
pnpm add -D s2json-spec
# yarn
yarn add -D s2json-spec
# npm
npm install -D s2json-spec

# cargo
cargo install s2json --dev
@@ -73,4 +73,4 @@
cargo tarpaulin
# bacon
bacon coverage # or type `l` inside the tool
-
+
diff --git a/docs/interfaces/BaseFeature.html b/docs/interfaces/BaseFeature.html index 9f4ac04..aacb554 100644 --- a/docs/interfaces/BaseFeature.html +++ b/docs/interfaces/BaseFeature.html @@ -1,2 +1,2 @@ -BaseFeature | s2json-spec - v1.5.5

Interface BaseFeature<T, P, G>

Base component to build either an S2 or WG Feature

-

Type Parameters

Hierarchy (view full)

+BaseFeature | s2json-spec - v1.5.5

Interface BaseFeature<T, M, D, P, G>

Base component to build either an S2 or WG Feature

+

Type Parameters

Hierarchy (view full)

diff --git a/docs/interfaces/ConvertedGeometry.html b/docs/interfaces/ConvertedGeometry.html deleted file mode 100644 index e036176..0000000 --- a/docs/interfaces/ConvertedGeometry.html +++ /dev/null @@ -1,6 +0,0 @@ -ConvertedGeometry | s2json-spec - v1.5.5

Interface ConvertedGeometry

The resultant geometry after conversion

-
interface ConvertedGeometry {
    face: Face;
    geometry: VectorGeometry;
}

Properties

Properties

face: Face

The face of the vector geometry that was converted

-
geometry: VectorGeometry

The vector geometry that was converted

-
diff --git a/docs/interfaces/S2Feature.html b/docs/interfaces/S2Feature.html index fb1759f..e6ad3e1 100644 --- a/docs/interfaces/S2Feature.html +++ b/docs/interfaces/S2Feature.html @@ -1,2 +1,2 @@ -S2Feature | s2json-spec - v1.5.5

Interface S2Feature<P, G>

S2 Feature

-

Type Parameters

Hierarchy (view full)

+S2Feature | s2json-spec - v1.5.5

Interface S2Feature<M, D, P, G>

S2 Feature

+

Type Parameters

Hierarchy (view full)

diff --git a/docs/interfaces/S2FeatureCollection.html b/docs/interfaces/S2FeatureCollection.html index 00538ac..443bf20 100644 --- a/docs/interfaces/S2FeatureCollection.html +++ b/docs/interfaces/S2FeatureCollection.html @@ -1,2 +1,2 @@ -S2FeatureCollection | s2json-spec - v1.5.5

Interface S2FeatureCollection

S2 FeatureCollection

-

Hierarchy (view full)

+S2FeatureCollection | s2json-spec - v1.5.5

Interface S2FeatureCollection<M, D, P>

S2 FeatureCollection

+

Type Parameters

Hierarchy (view full)

diff --git a/docs/interfaces/TileStoreOptions.html b/docs/interfaces/TileStoreOptions.html deleted file mode 100644 index 8bc7109..0000000 --- a/docs/interfaces/TileStoreOptions.html +++ /dev/null @@ -1,14 +0,0 @@ -TileStoreOptions | s2json-spec - v1.5.5

Interface TileStoreOptions

Options for creating a TileStore

-
interface TileStoreOptions {
    buffer?: number;
    indexMaxzoom?: number;
    maxzoom?: number;
    minzoom?: number;
    projection?: Projection;
    tolerance?: number;
}

Properties

buffer?: number

tile buffer on each side so lines and polygons don't get clipped

-
indexMaxzoom?: number

tile buffer on each side in pixels

-
maxzoom?: number

max zoom level to cluster the points on

-
minzoom?: number

min zoom to generate data on

-
projection?: Projection

manually set the projection, otherwise it defaults to whatever the data type is

-
tolerance?: number

simplification tolerance (higher means simpler)

-
diff --git a/docs/interfaces/VectorMultiPolygonGeometry.html b/docs/interfaces/VectorMultiPolygonGeometry.html index 5349a8d..8de4789 100644 --- a/docs/interfaces/VectorMultiPolygonGeometry.html +++ b/docs/interfaces/VectorMultiPolygonGeometry.html @@ -1,2 +1,2 @@ -VectorMultiPolygonGeometry | s2json-spec - v1.5.5

Interface VectorMultiPolygonGeometry

MultiPolygonGeometry is a polygon with multiple polygons with their own potential holes

-

Hierarchy (view full)

+VectorMultiPolygonGeometry | s2json-spec - v1.5.5

Interface VectorMultiPolygonGeometry<M>

MultiPolygonGeometry is a polygon with multiple polygons with their own potential holes

+

Type Parameters

Hierarchy (view full)

diff --git a/docs/interfaces/VectorPoint.html b/docs/interfaces/VectorPoint.html index ab59ac9..e768749 100644 --- a/docs/interfaces/VectorPoint.html +++ b/docs/interfaces/VectorPoint.html @@ -1,2 +1,2 @@ -VectorPoint | s2json-spec - v1.5.5

Interface VectorPoint

Definition of a Vector Point

-
+VectorPoint | s2json-spec - v1.5.5

Interface VectorPoint<M>

Definition of a Vector Point

+

Type Parameters

diff --git a/docs/interfaces/VectorPolygonGeometry.html b/docs/interfaces/VectorPolygonGeometry.html index 0da2478..c0e27a6 100644 --- a/docs/interfaces/VectorPolygonGeometry.html +++ b/docs/interfaces/VectorPolygonGeometry.html @@ -1,2 +1,2 @@ -VectorPolygonGeometry | s2json-spec - v1.5.5

Interface VectorPolygonGeometry

PolygonGeometry is a polygon with potential holes

-

Hierarchy (view full)

+VectorPolygonGeometry | s2json-spec - v1.5.5

Interface VectorPolygonGeometry<M>

PolygonGeometry is a polygon with potential holes

+

Type Parameters

Hierarchy (view full)

diff --git a/docs/modules.html b/docs/modules.html index d884b2e..7332383 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,17 +1,9 @@ -s2json-spec - v1.5.5

s2json-spec - v1.5.5

Index

Namespaces

Classes

Interfaces

BaseFeature +s2json-spec - v1.5.5
diff --git a/docs/modules/MercPoint.html b/docs/modules/MercPoint.html deleted file mode 100644 index f2e68f6..0000000 --- a/docs/modules/MercPoint.html +++ /dev/null @@ -1,20 +0,0 @@ -MercPoint | s2json-spec - v1.5.5
diff --git a/docs/modules/S2Coords.html b/docs/modules/S2Coords.html deleted file mode 100644 index 2655705..0000000 --- a/docs/modules/S2Coords.html +++ /dev/null @@ -1,24 +0,0 @@ -S2Coords | s2json-spec - v1.5.5
diff --git a/docs/modules/S2Point.html b/docs/modules/S2Point.html deleted file mode 100644 index 271a698..0000000 --- a/docs/modules/S2Point.html +++ /dev/null @@ -1,25 +0,0 @@ -S2Point | s2json-spec - v1.5.5
diff --git a/docs/types/ConvertedGeometryList.html b/docs/types/ConvertedGeometryList.html deleted file mode 100644 index b305658..0000000 --- a/docs/types/ConvertedGeometryList.html +++ /dev/null @@ -1,2 +0,0 @@ -ConvertedGeometryList | s2json-spec - v1.5.5

Type Alias ConvertedGeometryList

ConvertedGeometryList: ConvertedGeometry[]

A list of converted geometries

-
diff --git a/docs/types/Feature.html b/docs/types/Feature.html index 2aa7c32..bb54b77 100644 --- a/docs/types/Feature.html +++ b/docs/types/Feature.html @@ -1,2 +1,2 @@ -Feature | s2json-spec - v1.5.5

Type Alias Feature<P, M, G>

Feature<P, M, G>: BaseFeature<"Feature", P, G>

WG Feature

-

Type Parameters

+Feature | s2json-spec - v1.5.5

Type Alias Feature<M, D, P, G>

Feature<M, D, P, G>: BaseFeature<"Feature", M, D, P, G>

WG Feature

+

Type Parameters

diff --git a/docs/types/FeatureCollection.html b/docs/types/FeatureCollection.html index 52413a1..4e40975 100644 --- a/docs/types/FeatureCollection.html +++ b/docs/types/FeatureCollection.html @@ -1,2 +1,2 @@ -FeatureCollection | s2json-spec - v1.5.5

Type Alias FeatureCollection

FeatureCollection: BaseFeatureCollection<"FeatureCollection", Feature | VectorFeature>

WG FeatureCollection

-
+FeatureCollection | s2json-spec - v1.5.5

Type Alias FeatureCollection<M, D, P>

FeatureCollection<M, D, P>: BaseFeatureCollection<"FeatureCollection", Feature<M, D, P> | VectorFeature<M, D, P>>

WG FeatureCollection

+

Type Parameters

diff --git a/docs/types/FeatureCollections.html b/docs/types/FeatureCollections.html index 18c4560..176a179 100644 --- a/docs/types/FeatureCollections.html +++ b/docs/types/FeatureCollections.html @@ -1,2 +1,2 @@ -FeatureCollections | s2json-spec - v1.5.5

Type Alias FeatureCollections

Either an S2 or WG FeatureCollection

-
+FeatureCollections | s2json-spec - v1.5.5

Type Alias FeatureCollections<M, D, P>

FeatureCollections<M, D, P>: FeatureCollection<M, D, P> | S2FeatureCollection<M, D, P>

Either an S2 or WG FeatureCollection

+

Type Parameters

diff --git a/docs/types/Features.html b/docs/types/Features.html index 25b9e86..338150d 100644 --- a/docs/types/Features.html +++ b/docs/types/Features.html @@ -1,2 +1,2 @@ -Features | s2json-spec - v1.5.5

Type Alias Features

Either an S2 or WG Feature

-
+Features | s2json-spec - v1.5.5

Type Alias Features<M, D, P>

Features<M, D, P>: Feature<M, D, P> | VectorFeature<M, D, P> | S2Feature<M, D, P>

Either an S2 or WG Feature

+

Type Parameters

diff --git a/docs/types/JSONCollection.html b/docs/types/JSONCollection.html index ba1d6b8..a878175 100644 --- a/docs/types/JSONCollection.html +++ b/docs/types/JSONCollection.html @@ -1,2 +1,2 @@ -JSONCollection | s2json-spec - v1.5.5

Type Alias JSONCollection

All major S2JSON types

-
+JSONCollection | s2json-spec - v1.5.5

Type Alias JSONCollection<M, D, P>

JSONCollection<M, D, P>: FeatureCollection<M, D, P> | S2FeatureCollection<M, D, P> | Features<M, D, P>

All major S2JSON types

+

Type Parameters

diff --git a/docs/types/MercPoint.Sources.html b/docs/types/MercPoint.Sources.html deleted file mode 100644 index 46daa7f..0000000 --- a/docs/types/MercPoint.Sources.html +++ /dev/null @@ -1,2 +0,0 @@ -Sources | s2json-spec - v1.5.5

Type Alias Sources

Sources: "WGS84" | "900913"

The source of the coordinate inputs

-
diff --git a/docs/types/Polygon.html b/docs/types/Polygon.html index 1a97471..272c3ae 100644 --- a/docs/types/Polygon.html +++ b/docs/types/Polygon.html @@ -1,2 +1,2 @@ -Polygon | s2json-spec - v1.5.5

Type Alias Polygon

Polygon: Point[][]

Definition of a Polygon

+Polygon | s2json-spec - v1.5.5

Type Alias Polygon

Polygon: LineString[]

Definition of a Polygon

diff --git a/docs/types/VectorCoordinates.html b/docs/types/VectorCoordinates.html index 55c21f4..97a4778 100644 --- a/docs/types/VectorCoordinates.html +++ b/docs/types/VectorCoordinates.html @@ -1,2 +1,2 @@ -VectorCoordinates | s2json-spec - v1.5.5

Type Alias VectorCoordinates

VectorCoordinates:
    | VectorPoint
    | VectorMultiPoint
    | VectorLineString
    | VectorMultiLineString
    | VectorPolygon
    | VectorMultiPolygon

All possible geometry coordinates

-
+VectorCoordinates | s2json-spec - v1.5.5

Type Alias VectorCoordinates<M>

VectorCoordinates<M>:
    | VectorPoint<M>
    | VectorMultiPoint<M>
    | VectorLineString<M>
    | VectorMultiLineString<M>
    | VectorPolygon<M>
    | VectorMultiPolygon<M>

All possible geometry coordinates

+

Type Parameters

diff --git a/docs/types/VectorFeature.html b/docs/types/VectorFeature.html index 8a8cde5..dfb3c1a 100644 --- a/docs/types/VectorFeature.html +++ b/docs/types/VectorFeature.html @@ -1,2 +1,2 @@ -VectorFeature | s2json-spec - v1.5.5

Type Alias VectorFeature<P, G>

VectorFeature<P, G>: BaseFeature<"VectorFeature", P, G>

WG Vector Feature

-

Type Parameters

+VectorFeature | s2json-spec - v1.5.5

Type Alias VectorFeature<M, D, P, G>

VectorFeature<M, D, P, G>: BaseFeature<"VectorFeature", M, D, P, G>

WG Vector Feature

+

Type Parameters

diff --git a/docs/types/VectorFeatures.html b/docs/types/VectorFeatures.html index ada6993..45f9e31 100644 --- a/docs/types/VectorFeatures.html +++ b/docs/types/VectorFeatures.html @@ -1,2 +1,2 @@ -VectorFeatures | s2json-spec - v1.5.5

Type Alias VectorFeatures

VectorFeatures: VectorFeature | S2Feature

Any Vector Geometry type

-
+VectorFeatures | s2json-spec - v1.5.5

Type Alias VectorFeatures<M, D, P>

VectorFeatures<M, D, P>: VectorFeature<M, D, P> | S2Feature<M, D, P>

Any Vector Geometry type

+

Type Parameters

diff --git a/docs/types/VectorGeometry.html b/docs/types/VectorGeometry.html index f437d36..7e5485f 100644 --- a/docs/types/VectorGeometry.html +++ b/docs/types/VectorGeometry.html @@ -1,2 +1,2 @@ -VectorGeometry | s2json-spec - v1.5.5

Type Alias VectorGeometry

VectorGeometry:
    | VectorPointGeometry
    | VectorMultiPointGeometry
    | VectorLineStringGeometry
    | VectorMultiLineStringGeometry
    | VectorPolygonGeometry
    | VectorMultiPolygonGeometry

All possible geometry shapes

-
+VectorGeometry | s2json-spec - v1.5.5

Type Alias VectorGeometry<M>

VectorGeometry<M>:
    | VectorPointGeometry<M>
    | VectorMultiPointGeometry<M>
    | VectorLineStringGeometry
    | VectorMultiLineStringGeometry
    | VectorPolygonGeometry
    | VectorMultiPolygonGeometry

All possible geometry shapes

+

Type Parameters

diff --git a/docs/types/VectorLineString.html b/docs/types/VectorLineString.html index 83a47af..a5412c7 100644 --- a/docs/types/VectorLineString.html +++ b/docs/types/VectorLineString.html @@ -1,2 +1,2 @@ -VectorLineString | s2json-spec - v1.5.5

Type Alias VectorLineString

VectorLineString: VectorPoint[]

Definition of a Vector LineString

-
+VectorLineString | s2json-spec - v1.5.5

Type Alias VectorLineString<M>

VectorLineString<M>: VectorPoint<M>[]

Definition of a Vector LineString

+

Type Parameters

diff --git a/docs/types/VectorLineStringGeometry.html b/docs/types/VectorLineStringGeometry.html index 769a998..e07da93 100644 --- a/docs/types/VectorLineStringGeometry.html +++ b/docs/types/VectorLineStringGeometry.html @@ -1,2 +1,2 @@ -VectorLineStringGeometry | s2json-spec - v1.5.5

Type Alias VectorLineStringGeometry

VectorLineStringGeometry: VectorBaseGeometry<"LineString", VectorLineString, VectorLineOffset, BBOX>

LineStringGeometry is a line

-
+VectorLineStringGeometry | s2json-spec - v1.5.5

Type Alias VectorLineStringGeometry<M>

VectorLineStringGeometry<M>: VectorBaseGeometry<"LineString", VectorLineString<M>, VectorLineOffset, BBOX>

LineStringGeometry is a line

+

Type Parameters

diff --git a/docs/types/VectorMultiLineString.html b/docs/types/VectorMultiLineString.html index 4c2d38c..5174f67 100644 --- a/docs/types/VectorMultiLineString.html +++ b/docs/types/VectorMultiLineString.html @@ -1,2 +1,2 @@ -VectorMultiLineString | s2json-spec - v1.5.5

Type Alias VectorMultiLineString

VectorMultiLineString: VectorLineString[]

Definition of a Vector MultiLineString

-
+VectorMultiLineString | s2json-spec - v1.5.5

Type Alias VectorMultiLineString<M>

VectorMultiLineString<M>: VectorLineString<M>[]

Definition of a Vector MultiLineString

+

Type Parameters

diff --git a/docs/types/VectorMultiLineStringGeometry.html b/docs/types/VectorMultiLineStringGeometry.html index 9b21f69..f8b0bd1 100644 --- a/docs/types/VectorMultiLineStringGeometry.html +++ b/docs/types/VectorMultiLineStringGeometry.html @@ -1,2 +1,2 @@ -VectorMultiLineStringGeometry | s2json-spec - v1.5.5

Type Alias VectorMultiLineStringGeometry

VectorMultiLineStringGeometry: VectorBaseGeometry<"MultiLineString", VectorMultiLineString, VectorMultiLineOffset, BBOX>

MultiLineStringGeometry contians multiple lines

-
+VectorMultiLineStringGeometry | s2json-spec - v1.5.5

Type Alias VectorMultiLineStringGeometry<M>

VectorMultiLineStringGeometry<M>: VectorBaseGeometry<"MultiLineString", VectorMultiLineString<M>, VectorMultiLineOffset, BBOX>

MultiLineStringGeometry contians multiple lines

+

Type Parameters

diff --git a/docs/types/VectorMultiPoint.html b/docs/types/VectorMultiPoint.html index e9c4d81..45e407a 100644 --- a/docs/types/VectorMultiPoint.html +++ b/docs/types/VectorMultiPoint.html @@ -1,2 +1,2 @@ -VectorMultiPoint | s2json-spec - v1.5.5

Type Alias VectorMultiPoint

VectorMultiPoint: VectorPoint[]

Definition of a Vector MultiPoint

-
+VectorMultiPoint | s2json-spec - v1.5.5

Type Alias VectorMultiPoint<M>

VectorMultiPoint<M>: VectorPoint<M>[]

Definition of a Vector MultiPoint

+

Type Parameters

diff --git a/docs/types/VectorMultiPointGeometry.html b/docs/types/VectorMultiPointGeometry.html index fe0ff93..eaf91ba 100644 --- a/docs/types/VectorMultiPointGeometry.html +++ b/docs/types/VectorMultiPointGeometry.html @@ -1,2 +1,2 @@ -VectorMultiPointGeometry | s2json-spec - v1.5.5

Type Alias VectorMultiPointGeometry

VectorMultiPointGeometry: VectorBaseGeometry<"MultiPoint", VectorMultiPoint, undefined, BBOX>

MultiPointGeometry contains multiple points

-
+VectorMultiPointGeometry | s2json-spec - v1.5.5

Type Alias VectorMultiPointGeometry<M>

VectorMultiPointGeometry<M>: VectorBaseGeometry<"MultiPoint", VectorMultiPoint<M>, undefined, BBOX>

MultiPointGeometry contains multiple points

+

Type Parameters

diff --git a/docs/types/VectorMultiPolygon.html b/docs/types/VectorMultiPolygon.html index 82ed4ed..b1bd404 100644 --- a/docs/types/VectorMultiPolygon.html +++ b/docs/types/VectorMultiPolygon.html @@ -1,2 +1,2 @@ -VectorMultiPolygon | s2json-spec - v1.5.5

Type Alias VectorMultiPolygon

VectorMultiPolygon: VectorPolygon[]

Definition of a Vector MultiPolygon

-
+VectorMultiPolygon | s2json-spec - v1.5.5

Type Alias VectorMultiPolygon<M>

VectorMultiPolygon<M>: VectorPolygon<M>[]

Definition of a Vector MultiPolygon

+

Type Parameters

diff --git a/docs/types/VectorPointGeometry.html b/docs/types/VectorPointGeometry.html index 71c0aea..298980c 100644 --- a/docs/types/VectorPointGeometry.html +++ b/docs/types/VectorPointGeometry.html @@ -1,2 +1,2 @@ -VectorPointGeometry | s2json-spec - v1.5.5

Type Alias VectorPointGeometry

VectorPointGeometry: VectorBaseGeometry<"Point", VectorPoint, undefined, BBOX>

PointGeometry is a point

-
+VectorPointGeometry | s2json-spec - v1.5.5

Type Alias VectorPointGeometry<M>

VectorPointGeometry<M>: VectorBaseGeometry<"Point", VectorPoint<M>, undefined, BBOX>

PointGeometry is a point

+

Type Parameters

diff --git a/docs/types/VectorPolygon.html b/docs/types/VectorPolygon.html index 433c242..16608b7 100644 --- a/docs/types/VectorPolygon.html +++ b/docs/types/VectorPolygon.html @@ -1,2 +1,2 @@ -VectorPolygon | s2json-spec - v1.5.5

Type Alias VectorPolygon

VectorPolygon: VectorLineString[]

Definition of a Vector Polygon

-
+VectorPolygon | s2json-spec - v1.5.5

Type Alias VectorPolygon<M>

VectorPolygon<M>: VectorLineString<M>[]

Definition of a Vector Polygon

+

Type Parameters

diff --git a/docs/variables/A.html b/docs/variables/A.html deleted file mode 100644 index 269d24c..0000000 --- a/docs/variables/A.html +++ /dev/null @@ -1,2 +0,0 @@ -A | s2json-spec - v1.5.5

Variable AConst

A: 6378137 = 6_378_137.0

900913 (Web Mercator) constant

-
diff --git a/docs/variables/EARTH_CIRCUMFERENCE.html b/docs/variables/EARTH_CIRCUMFERENCE.html deleted file mode 100644 index 05abba6..0000000 --- a/docs/variables/EARTH_CIRCUMFERENCE.html +++ /dev/null @@ -1,2 +0,0 @@ -EARTH_CIRCUMFERENCE | s2json-spec - v1.5.5

Variable EARTH_CIRCUMFERENCEConst

EARTH_CIRCUMFERENCE: number = ...

The average circumference of the world in meters.

-
diff --git a/docs/variables/EARTH_RADIUS.html b/docs/variables/EARTH_RADIUS.html deleted file mode 100644 index 9fa5163..0000000 --- a/docs/variables/EARTH_RADIUS.html +++ /dev/null @@ -1,2 +0,0 @@ -EARTH_RADIUS | s2json-spec - v1.5.5

Variable EARTH_RADIUSConst

EARTH_RADIUS: 6371008.8 = 6_371_008.8

Earth's radius in meters

-
diff --git a/docs/variables/EARTH_RADIUS_EQUATORIAL.html b/docs/variables/EARTH_RADIUS_EQUATORIAL.html deleted file mode 100644 index 0fea177..0000000 --- a/docs/variables/EARTH_RADIUS_EQUATORIAL.html +++ /dev/null @@ -1,2 +0,0 @@ -EARTH_RADIUS_EQUATORIAL | s2json-spec - v1.5.5

Variable EARTH_RADIUS_EQUATORIALConst

EARTH_RADIUS_EQUATORIAL: 6378137 = 6_378_137

Earth's equitorial radius in meters

-
diff --git a/docs/variables/EARTH_RADIUS_POLAR.html b/docs/variables/EARTH_RADIUS_POLAR.html deleted file mode 100644 index 51442c3..0000000 --- a/docs/variables/EARTH_RADIUS_POLAR.html +++ /dev/null @@ -1,2 +0,0 @@ -EARTH_RADIUS_POLAR | s2json-spec - v1.5.5

Variable EARTH_RADIUS_POLARConst

EARTH_RADIUS_POLAR: 6356752.3 = 6_356_752.3

Earth's polar radius in meters

-
diff --git a/docs/variables/MARS_RADIUS.html b/docs/variables/MARS_RADIUS.html deleted file mode 100644 index 1d45100..0000000 --- a/docs/variables/MARS_RADIUS.html +++ /dev/null @@ -1,2 +0,0 @@ -MARS_RADIUS | s2json-spec - v1.5.5

Variable MARS_RADIUSConst

MARS_RADIUS: 3389500 = 3_389_500

Mars' radius in meters

-
diff --git a/docs/variables/MARS_RADIUS_EQUATORIAL.html b/docs/variables/MARS_RADIUS_EQUATORIAL.html deleted file mode 100644 index e3b88a8..0000000 --- a/docs/variables/MARS_RADIUS_EQUATORIAL.html +++ /dev/null @@ -1,2 +0,0 @@ -MARS_RADIUS_EQUATORIAL | s2json-spec - v1.5.5

Variable MARS_RADIUS_EQUATORIALConst

MARS_RADIUS_EQUATORIAL: 3396200 = 3_396_200

Mars' equitorial radius in meters

-
diff --git a/docs/variables/MARS_RADIUS_POLAR.html b/docs/variables/MARS_RADIUS_POLAR.html deleted file mode 100644 index 6fac6b7..0000000 --- a/docs/variables/MARS_RADIUS_POLAR.html +++ /dev/null @@ -1,2 +0,0 @@ -MARS_RADIUS_POLAR | s2json-spec - v1.5.5

Variable MARS_RADIUS_POLARConst

MARS_RADIUS_POLAR: 3376200 = 3_376_200

Mars' polar radius in meters

-
diff --git a/docs/variables/MAXEXTENT.html b/docs/variables/MAXEXTENT.html deleted file mode 100644 index 22109e6..0000000 --- a/docs/variables/MAXEXTENT.html +++ /dev/null @@ -1,2 +0,0 @@ -MAXEXTENT | s2json-spec - v1.5.5

Variable MAXEXTENTConst

MAXEXTENT: 20037508.342789244 = 20_037_508.342789244

900913 (Web Mercator) max extent

-
diff --git a/docs/variables/MAXLAT.html b/docs/variables/MAXLAT.html deleted file mode 100644 index f28fe80..0000000 --- a/docs/variables/MAXLAT.html +++ /dev/null @@ -1,2 +0,0 @@ -MAXLAT | s2json-spec - v1.5.5

Variable MAXLATConst

MAXLAT: 85.0511287798 = 85.0511287798

900913 (Web Mercator) maximum latitude

-
diff --git a/package.json b/package.json index 655eac0..372c92a 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,7 @@ "types:bundle": "bun run types:build && node scripts/types.mjs", "prepublishOnly": "bun run lint+build+docs+test", "package-check": "package-check", - "docs": "typedoc", + "docs": "bunx typedoc", "vscode:prepublish": "bun run prepublishOnly", "watch": "tsc -watch -p ./" },