SplitLong
* [.splitLongToH3Index(lower, upper)](#module_h3.splitLongToH3Index) ⇒ H3Index
* [.isValidCell(h3Index)](#module_h3.isValidCell) ⇒ boolean
@@ -120,6 +121,7 @@ const coordinates = h3.cellsToMultiPolygon(hexagons, true);
* [.gridDiskDistances(h3Index, ringSize)](#module_h3.gridDiskDistances) ⇒ Array.<Array.<H3Index>>
* [.gridRingUnsafe(h3Index, ringSize)](#module_h3.gridRingUnsafe) ⇒ Array.<H3Index>
* [.polygonToCells(coordinates, res, [isGeoJson])](#module_h3.polygonToCells) ⇒ Array.<H3Index>
+ * [.polygonToCellsExperimental(coordinates, res, flags, [isGeoJson])](#module_h3.polygonToCellsExperimental) ⇒ Array.<H3Index>
* [.cellsToMultiPolygon(h3Indexes, [formatAsGeoJson])](#module_h3.cellsToMultiPolygon) ⇒ Array.<Array.<Array.<CoordPair>>>
* [.compactCells(h3Set)](#module_h3.compactCells) ⇒ Array.<H3Index>
* [.uncompactCells(compactedSet, res)](#module_h3.uncompactCells) ⇒ Array.<H3Index>
@@ -176,6 +178,23 @@ Length/Area units
| rads2 | string |
+* * *
+
+
+
+### h3.POLYGON\_TO\_CELLS\_FLAGS
+Mode flags for polygonToCells
+
+**Properties**
+
+| Name | Type |
+| --- | --- |
+| containmentCenter | string |
+| containmentFull | string |
+| containmentOverlapping | string |
+| containmentOverlappingBbox | string |
+
+
* * *
@@ -555,6 +574,31 @@ expected to be holes.
| [isGeoJson] | boolean | Whether to expect GeoJson-style [lng, lat] pairs instead of [lat, lng] |
+* * *
+
+
+
+### h3.polygonToCellsExperimental(coordinates, res, flags, [isGeoJson]) ⇒ Array.<H3Index>
+Get all hexagons with centers contained in a given polygon. The polygon
+is specified with GeoJson semantics as an array of loops. Each loop is
+an array of [lat, lng] pairs (or [lng, lat] if isGeoJson is specified).
+The first loop is the perimeter of the polygon, and subsequent loops are
+expected to be holes.
+
+**Returns**: Array.<H3Index> - H3 indexes for all hexagons in polygon
+**Throws**:
+
+- H3Error If input is invalid or output is too large for JS
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| coordinates | Array.<Array.<number>> \| Array.<Array.<Array.<number>>> | Array of loops, or a single loop |
+| res | number | Resolution of hexagons to return |
+| flags | string | Value from POLYGON_TO_CELLS_FLAGS |
+| [isGeoJson] | boolean | Whether to expect GeoJson-style [lng, lat] pairs instead of [lat, lng] |
+
+
* * *
diff --git a/lib/bindings.js b/lib/bindings.js
index 57aecc8..41e3b62 100644
--- a/lib/bindings.js
+++ b/lib/bindings.js
@@ -50,6 +50,12 @@ export default [
['gridRingUnsafe', H3_ERROR, [H3_LOWER, H3_UPPER, NUMBER, POINTER]],
['maxPolygonToCellsSize', H3_ERROR, [POINTER, RESOLUTION, NUMBER, POINTER]],
['polygonToCells', H3_ERROR, [POINTER, RESOLUTION, NUMBER, POINTER]],
+ ['maxPolygonToCellsSizeExperimental', H3_ERROR, [POINTER, RESOLUTION, NUMBER, POINTER]],
+ [
+ 'polygonToCellsExperimental',
+ H3_ERROR,
+ [POINTER, RESOLUTION, NUMBER, NUMBER, NUMBER, POINTER]
+ ],
['cellsToLinkedMultiPolygon', H3_ERROR, [POINTER, NUMBER, POINTER]],
['destroyLinkedMultiPolygon', null, [POINTER]],
['compactCells', H3_ERROR, [POINTER, POINTER, NUMBER, NUMBER]],
diff --git a/lib/h3core.js b/lib/h3core.js
index cae337e..eae378d 100644
--- a/lib/h3core.js
+++ b/lib/h3core.js
@@ -28,7 +28,8 @@ import {
E_UNKNOWN_UNIT,
E_ARRAY_LENGTH,
E_NULL_INDEX,
- E_CELL_INVALID
+ E_CELL_INVALID,
+ E_OPTION_INVALID
} from './errors';
/**
@@ -131,9 +132,48 @@ export const UNITS = {
rads2: 'rads2'
};
+// ----------------------------------------------------------------------------
+// Flags
+
+/**
+ * Mode flags for polygonToCells
+ * @static
+ * @property {string} containmentCenter
+ * @property {string} containmentFull
+ * @property {string} containmentOverlapping
+ * @property {string} containmentOverlappingBbox
+ */
+export const POLYGON_TO_CELLS_FLAGS = {
+ containmentCenter: 'containmentCenter',
+ containmentFull: 'containmentFull',
+ containmentOverlapping: 'containmentOverlapping',
+ containmentOverlappingBbox: 'containmentOverlappingBbox'
+};
+
// ----------------------------------------------------------------------------
// Utilities and helpers
+/**
+ * @private
+ * @param {string} flags Value from POLYGON_TO_CELLS_FLAGS
+ * @returns {number} Flag value
+ * @throws {H3Error} If invalid
+ */
+function polygonToCellsFlagsToNumber(flags) {
+ switch (flags) {
+ case POLYGON_TO_CELLS_FLAGS.containmentCenter:
+ return 0;
+ case POLYGON_TO_CELLS_FLAGS.containmentFull:
+ return 1;
+ case POLYGON_TO_CELLS_FLAGS.containmentOverlapping:
+ return 2;
+ case POLYGON_TO_CELLS_FLAGS.containmentOverlappingBbox:
+ return 3;
+ default:
+ throw JSBindingError(E_OPTION_INVALID, flags);
+ }
+}
+
/**
* Validate a resolution, throwing an error if invalid
* @private
@@ -1029,6 +1069,63 @@ export function polygonToCells(coordinates, res, isGeoJson) {
}
}
+/**
+ * Get all hexagons with centers contained in a given polygon. The polygon
+ * is specified with GeoJson semantics as an array of loops. Each loop is
+ * an array of [lat, lng] pairs (or [lng, lat] if isGeoJson is specified).
+ * The first loop is the perimeter of the polygon, and subsequent loops are
+ * expected to be holes.
+ * @static
+ * @param {number[][] | number[][][]} coordinates
+ * Array of loops, or a single loop
+ * @param {number} res Resolution of hexagons to return
+ * @param {string} flags Value from POLYGON_TO_CELLS_FLAGS
+ * @param {boolean} [isGeoJson] Whether to expect GeoJson-style [lng, lat]
+ * pairs instead of [lat, lng]
+ * @return {H3Index[]} H3 indexes for all hexagons in polygon
+ * @throws {H3Error} If input is invalid or output is too large for JS
+ */
+export function polygonToCellsExperimental(coordinates, res, flags, isGeoJson) {
+ validateRes(res);
+ isGeoJson = Boolean(isGeoJson);
+ const flagsInt = polygonToCellsFlagsToNumber(flags);
+ // Guard against empty input
+ if (coordinates.length === 0 || coordinates[0].length === 0) {
+ return [];
+ }
+ // Wrap to expected format if a single loop is provided
+ const polygon = typeof coordinates[0][0] === 'number' ? [coordinates] : coordinates;
+ const geoPolygon = coordinatesToGeoPolygon(
+ // @ts-expect-error - There's no way to convince TS that polygon is now number[][][]
+ polygon,
+ isGeoJson
+ );
+ const countPtr = C._malloc(SZ_INT64);
+ try {
+ throwIfError(H3.maxPolygonToCellsSizeExperimental(geoPolygon, res, flagsInt, countPtr));
+ const count = validateArrayLength(readInt64AsDoubleFromPointer(countPtr));
+ const hexagons = C._calloc(count, SZ_H3INDEX);
+ try {
+ throwIfError(
+ H3.polygonToCellsExperimental(
+ geoPolygon,
+ res,
+ flagsInt,
+ count,
+ UNUSED_UPPER_32_BITS,
+ hexagons
+ )
+ );
+ return readArrayOfH3Indexes(hexagons, count);
+ } finally {
+ C._free(hexagons);
+ }
+ } finally {
+ C._free(countPtr);
+ destroyGeoPolygon(geoPolygon);
+ }
+}
+
/**
* Get the outlines of a set of H3 hexagons, returned in GeoJSON MultiPolygon
* format (an array of polygons, each with an array of loops, each an array of
diff --git a/out/binding-functions b/out/binding-functions
index d73df49..d9d89b2 100644
--- a/out/binding-functions
+++ b/out/binding-functions
@@ -1,3 +1,4 @@
+describeH3Error
latLngToCell
cellToLatLng
cellToBoundary
@@ -5,6 +6,7 @@ gridDisk
gridDiskDistances
gridRingUnsafe
polygonToCells
+polygonToCellsExperimental
cellsToMultiPolygon
degsToRads
radsToDegs
diff --git a/out/libh3.js b/out/libh3.js
index 139423a..cd3ff2e 100644
--- a/out/libh3.js
+++ b/out/libh3.js
@@ -4,18 +4,19 @@ var libh3 = (
function(libh3) {
libh3 = libh3 || {};
-var Module=typeof libh3!=="undefined"?libh3:{};var moduleOverrides={};var key;for(key in Module){if(Module.hasOwnProperty(key)){moduleOverrides[key]=Module[key]}}var arguments_=[];var thisProgram="./this.program";var quit_=function(status,toThrow){throw toThrow};var ENVIRONMENT_IS_WEB=false;var ENVIRONMENT_IS_WORKER=false;var ENVIRONMENT_IS_NODE=false;var ENVIRONMENT_HAS_NODE=false;var ENVIRONMENT_IS_SHELL=false;ENVIRONMENT_IS_WEB=typeof window==="object";ENVIRONMENT_IS_WORKER=typeof importScripts==="function";ENVIRONMENT_HAS_NODE=typeof process==="object"&&typeof process.versions==="object"&&typeof process.versions.node==="string";ENVIRONMENT_IS_NODE=ENVIRONMENT_HAS_NODE&&!ENVIRONMENT_IS_WEB&&!ENVIRONMENT_IS_WORKER;ENVIRONMENT_IS_SHELL=!ENVIRONMENT_IS_WEB&&!ENVIRONMENT_IS_NODE&&!ENVIRONMENT_IS_WORKER;var scriptDirectory="";function locateFile(path){if(Module["locateFile"]){return Module["locateFile"](path,scriptDirectory)}return scriptDirectory+path}var read_,readAsync,readBinary,setWindowTitle;if(ENVIRONMENT_IS_NODE){scriptDirectory=__dirname+"/";var nodeFS;var nodePath;read_=function shell_read(filename,binary){var ret;ret=tryParseAsDataURI(filename);if(!ret){if(!nodeFS)nodeFS=require("fs");if(!nodePath)nodePath=require("path");filename=nodePath["normalize"](filename);ret=nodeFS["readFileSync"](filename)}return binary?ret:ret.toString()};readBinary=function readBinary(filename){var ret=read_(filename,true);if(!ret.buffer){ret=new Uint8Array(ret)}assert(ret.buffer);return ret};if(process["argv"].length>1){thisProgram=process["argv"][1].replace(/\\/g,"/")}arguments_=process["argv"].slice(2);quit_=function(status){process["exit"](status)};Module["inspect"]=function(){return"[Emscripten Module object]"}}else if(ENVIRONMENT_IS_SHELL){if(typeof read!="undefined"){read_=function shell_read(f){var data=tryParseAsDataURI(f);if(data){return intArrayToString(data)}return read(f)}}readBinary=function readBinary(f){var data;data=tryParseAsDataURI(f);if(data){return data}if(typeof readbuffer==="function"){return new Uint8Array(readbuffer(f))}data=read(f,"binary");assert(typeof data==="object");return data};if(typeof scriptArgs!="undefined"){arguments_=scriptArgs}else if(typeof arguments!="undefined"){arguments_=arguments}if(typeof quit==="function"){quit_=function(status){quit(status)}}if(typeof print!=="undefined"){if(typeof console==="undefined")console={};console.log=print;console.warn=console.error=typeof printErr!=="undefined"?printErr:print}}else if(ENVIRONMENT_IS_WEB||ENVIRONMENT_IS_WORKER){if(ENVIRONMENT_IS_WORKER){scriptDirectory=self.location.href}else if(typeof document!=="undefined" && document.currentScript){scriptDirectory=document.currentScript.src}if(scriptDirectory.indexOf("blob:")!==0){scriptDirectory=scriptDirectory.substr(0,scriptDirectory.lastIndexOf("/")+1)}else{scriptDirectory=""}read_=function shell_read(url){try{var xhr=new XMLHttpRequest;xhr.open("GET",url,false);xhr.send(null);return xhr.responseText}catch(err){var data=tryParseAsDataURI(url);if(data){return intArrayToString(data)}throw err}};if(ENVIRONMENT_IS_WORKER){readBinary=function readBinary(url){try{var xhr=new XMLHttpRequest;xhr.open("GET",url,false);xhr.responseType="arraybuffer";xhr.send(null);return new Uint8Array(xhr.response)}catch(err){var data=tryParseAsDataURI(url);if(data){return data}throw err}}}readAsync=function readAsync(url,onload,onerror){var xhr=new XMLHttpRequest;xhr.open("GET",url,true);xhr.responseType="arraybuffer";xhr.onload=function xhr_onload(){if(xhr.status==200||xhr.status==0&&xhr.response){onload(xhr.response);return}var data=tryParseAsDataURI(url);if(data){onload(data.buffer);return}onerror()};xhr.onerror=onerror;xhr.send(null)};setWindowTitle=function(title){document.title=title}}else{}var out=Module["print"]||console.log.bind(console);var err=Module["printErr"]||console.warn.bind(console);for(key in moduleOverrides){if(moduleOverrides.hasOwnProperty(key)){Module[key]=moduleOverrides[key]}}moduleOverrides=null;if(Module["arguments"])arguments_=Module["arguments"];if(Module["thisProgram"])thisProgram=Module["thisProgram"];if(Module["quit"])quit_=Module["quit"];var STACK_ALIGN=16;function dynamicAlloc(size){var ret=HEAP32[DYNAMICTOP_PTR>>2];var end=ret+size+15&-16;if(end>_emscripten_get_heap_size()){abort()}HEAP32[DYNAMICTOP_PTR>>2]=end;return ret}function getNativeTypeSize(type){switch(type){case"i1":case"i8":return 1;case"i16":return 2;case"i32":return 4;case"i64":return 8;case"float":return 4;case"double":return 8;default:{if(type[type.length-1]==="*"){return 4}else if(type[0]==="i"){var bits=parseInt(type.substr(1));assert(bits%8===0,"getNativeTypeSize invalid bits "+bits+", type "+type);return bits/8}else{return 0}}}}function warnOnce(text){if(!warnOnce.shown)warnOnce.shown={};if(!warnOnce.shown[text]){warnOnce.shown[text]=1;err(text)}}var jsCallStartIndex=1;var functionPointers=new Array(0);var funcWrappers={};function dynCall(sig,ptr,args){if(args&&args.length){return Module["dynCall_"+sig].apply(null,[ptr].concat(args))}else{return Module["dynCall_"+sig].call(null,ptr)}}var tempRet0=0;var setTempRet0=function(value){tempRet0=value};var getTempRet0=function(){return tempRet0};var GLOBAL_BASE=8;var wasmBinary;if(Module["wasmBinary"])wasmBinary=Module["wasmBinary"];var noExitRuntime;if(Module["noExitRuntime"])noExitRuntime=Module["noExitRuntime"];function setValue(ptr,value,type,noSafe){type=type||"i8";if(type.charAt(type.length-1)==="*")type="i32";switch(type){case"i1":HEAP8[ptr>>0]=value;break;case"i8":HEAP8[ptr>>0]=value;break;case"i16":HEAP16[ptr>>1]=value;break;case"i32":HEAP32[ptr>>2]=value;break;case"i64":tempI64=[value>>>0,(tempDouble=value,+Math_abs(tempDouble)>=+1?tempDouble>+0?(Math_min(+Math_floor(tempDouble/+4294967296),+4294967295)|0)>>>0:~~+Math_ceil((tempDouble-+(~~tempDouble>>>0))/+4294967296)>>>0:0)],HEAP32[ptr>>2]=tempI64[0],HEAP32[ptr+4>>2]=tempI64[1];break;case"float":HEAPF32[ptr>>2]=value;break;case"double":HEAPF64[ptr>>3]=value;break;default:abort("invalid type for setValue: "+type)}}function getValue(ptr,type,noSafe){type=type||"i8";if(type.charAt(type.length-1)==="*")type="i32";switch(type){case"i1":return HEAP8[ptr>>0];case"i8":return HEAP8[ptr>>0];case"i16":return HEAP16[ptr>>1];case"i32":return HEAP32[ptr>>2];case"i64":return HEAP32[ptr>>2];case"float":return HEAPF32[ptr>>2];case"double":return HEAPF64[ptr>>3];default:abort("invalid type for getValue: "+type)}return null}var ABORT=false;var EXITSTATUS=0;function assert(condition,text){if(!condition){abort("Assertion failed: "+text)}}function getCFunc(ident){var func=Module["_"+ident];assert(func,"Cannot call unknown function "+ident+", make sure it is exported");return func}function ccall(ident,returnType,argTypes,args,opts){var toC={"string":function(str){var ret=0;if(str!==null&&str!==undefined&&str!==0){var len=(str.length<<2)+1;ret=stackAlloc(len);stringToUTF8(str,ret,len)}return ret},"array":function(arr){var ret=stackAlloc(arr.length);writeArrayToMemory(arr,ret);return ret}};function convertReturnValue(ret){if(returnType==="string")return UTF8ToString(ret);if(returnType==="boolean")return Boolean(ret);return ret}var func=getCFunc(ident);var cArgs=[];var stack=0;if(args){for(var i=0;i>>0&((t|0)!=(-1|0)&(p|0)!=(-1|0))^1)):0){h=s?r:c;g=t;q=145}if((q|0)==145){c=(b[5965]|0)+h|0;b[5965]=c;if(c>>>0>(b[5966]|0)>>>0)b[5966]=c;j=b[5863]|0;f:do if(j){c=23876;while(1){a=b[c>>2]|0;d=b[c+4>>2]|0;if((g|0)==(a+d|0)){q=154;break}e=b[c+8>>2]|0;if(!e)break;else c=e}if(((q|0)==154?(u=c+4|0,(b[c+12>>2]&8|0)==0):0)?g>>>0>j>>>0&a>>>0<=j>>>0:0){b[u>>2]=d+h;v=(b[5860]|0)+h|0;t=j+8|0;t=(t&7|0)==0?0:0-t&7;u=j+t|0;t=v-t|0;b[5863]=u;b[5860]=t;b[u+4>>2]=t|1;b[j+v+4>>2]=40;b[5864]=b[5979];break}if(g>>>0<(b[5861]|0)>>>0)b[5861]=g;d=g+h|0;c=23876;while(1){if((b[c>>2]|0)==(d|0)){q=162;break}a=b[c+8>>2]|0;if(!a)break;else c=a}if((q|0)==162?(b[c+12>>2]&8|0)==0:0){b[c>>2]=g;l=c+4|0;b[l>>2]=(b[l>>2]|0)+h;l=g+8|0;l=g+((l&7|0)==0?0:0-l&7)|0;c=d+8|0;c=d+((c&7|0)==0?0:0-c&7)|0;k=l+m|0;i=c-l-m|0;b[l+4>>2]=m|3;g:do if((j|0)==(c|0)){v=(b[5860]|0)+i|0;b[5860]=v;b[5863]=k;b[k+4>>2]=v|1}else{if((b[5862]|0)==(c|0)){v=(b[5859]|0)+i|0;b[5859]=v;b[5862]=k;b[k+4>>2]=v|1;b[k+v>>2]=v;break}a=b[c+4>>2]|0;if((a&3|0)==1){h=a&-8;e=a>>>3;h:do if(a>>>0<256){a=b[c+8>>2]|0;d=b[c+12>>2]|0;if((d|0)==(a|0)){b[5857]=b[5857]&~(1< >>0&((t|0)!=(-1|0)&(p|0)!=(-1|0))^1)):0){h=s?r:c;g=t;q=145}if((q|0)==145){c=(b[7053]|0)+h|0;b[7053]=c;if(c>>>0>(b[7054]|0)>>>0)b[7054]=c;j=b[6951]|0;f:do if(j){c=28228;while(1){a=b[c>>2]|0;d=b[c+4>>2]|0;if((g|0)==(a+d|0)){q=154;break}e=b[c+8>>2]|0;if(!e)break;else c=e}if(((q|0)==154?(u=c+4|0,(b[c+12>>2]&8|0)==0):0)?g>>>0>j>>>0&a>>>0<=j>>>0:0){b[u>>2]=d+h;v=(b[6948]|0)+h|0;t=j+8|0;t=(t&7|0)==0?0:0-t&7;u=j+t|0;t=v-t|0;b[6951]=u;b[6948]=t;b[u+4>>2]=t|1;b[j+v+4>>2]=40;b[6952]=b[7067];break}if(g>>>0<(b[6949]|0)>>>0)b[6949]=g;d=g+h|0;c=28228;while(1){if((b[c>>2]|0)==(d|0)){q=162;break}a=b[c+8>>2]|0;if(!a)break;else c=a}if((q|0)==162?(b[c+12>>2]&8|0)==0:0){b[c>>2]=g;l=c+4|0;b[l>>2]=(b[l>>2]|0)+h;l=g+8|0;l=g+((l&7|0)==0?0:0-l&7)|0;c=d+8|0;c=d+((c&7|0)==0?0:0-c&7)|0;k=l+m|0;i=c-l-m|0;b[l+4>>2]=m|3;g:do if((j|0)==(c|0)){v=(b[6948]|0)+i|0;b[6948]=v;b[6951]=k;b[k+4>>2]=v|1}else{if((b[6950]|0)==(c|0)){v=(b[6947]|0)+i|0;b[6947]=v;b[6950]=k;b[k+4>>2]=v|1;b[k+v>>2]=v;break}a=b[c+4>>2]|0;if((a&3|0)==1){h=a&-8;e=a>>>3;h:do if(a>>>0<256){a=b[c+8>>2]|0;d=b[c+12>>2]|0;if((d|0)==(a|0)){b[6945]=b[6945]&~(1<