Skip to content

Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.

[Enhancement] Export more utils (#1233)

Shan He10468e1997bf
diff --git a/package.json b/package.json
index d9fc0ffb9..004ce53b3 100644
--- a/package.json
+++ b/package.json
@@ -83,12 +83,12 @@
"@deck.gl/layers": "^8.2.0",
"@deck.gl/mesh-layers": "^8.2.0",
"@deck.gl/react": "^8.2.0",
- "@loaders.gl/core": "^2.2.5",
- "@loaders.gl/csv": "^2.2.5",
- "@loaders.gl/gltf": "^2.2.5",
- "@loaders.gl/json": "^2.2.5",
- "@loaders.gl/loader-utils": "^2.2.5",
- "@loaders.gl/polyfills": "^2.2.5",
+ "@loaders.gl/core": "^2.3.0-alpha.9",
+ "@loaders.gl/csv": "^2.3.0-alpha.9",
+ "@loaders.gl/gltf": "^2.3.0-alpha.9",
+ "@loaders.gl/json": "^2.3.0-alpha.9",
+ "@loaders.gl/loader-utils": "^2.3.0-alpha.9",
+ "@loaders.gl/polyfills": "^2.3.0-alpha.9",
"@luma.gl/constants": "^8.2.0",
"@luma.gl/core": "^8.2.0",
"@mapbox/geo-viewport": "^0.2.2",
@@ -236,7 +236,13 @@
"lodash": "4.17.19",
"dot-prop": "5.1.1",
"minimist": "1.2.3",
- "jpeg-js": "0.4.0"
+ "jpeg-js": "0.4.0",
+ "@loaders.gl/core": "^2.3.0-alpha.9",
+ "@loaders.gl/csv": "^2.3.0-alpha.9",
+ "@loaders.gl/gltf": "^2.3.0-alpha.9",
+ "@loaders.gl/json": "^2.3.0-alpha.9",
+ "@loaders.gl/loader-utils": "^2.3.0-alpha.9",
+ "@loaders.gl/polyfills": "^2.3.0-alpha.9"
},
"peerDependencies": {
"react": "^16.3",
diff --git a/src/components/index.js b/src/components/index.js
index 51379ec47..2d2145168 100644
--- a/src/components/index.js
+++ b/src/components/index.js
@@ -157,3 +157,6 @@ export const RangeSlider = appInjector.get(RangeSliderFactory);
export const VisConfigSlider = appInjector.get(VisConfigSliderFactory);
export {TimeRangeSliderFactory, RangeSliderFactory, VisConfigSliderFactory};
+
+// Context
+export {default as KeplerGlContext, RootContext} from 'components/context';
diff --git a/src/components/kepler-gl.js b/src/components/kepler-gl.js
index 4cce45e0f..1ec7a3e81 100644
--- a/src/components/kepler-gl.js
+++ b/src/components/kepler-gl.js
@@ -357,7 +357,7 @@ function KeplerGlFactory(
ref={this.root}
>
<NotificationPanel {...notificationPanelFields} />
- {(!uiState.readOnly && !readOnly) && <SidePanel {...sideFields} />}
+ {!uiState.readOnly && !readOnly && <SidePanel {...sideFields} />}
<div className="maps" style={{display: 'flex'}}>
{mapContainers}
</div>
diff --git a/src/components/plot-container.js b/src/components/plot-container.js
index 6ccd7281b..ed44ce15f 100644
--- a/src/components/plot-container.js
+++ b/src/components/plot-container.js
@@ -33,7 +33,7 @@ import {getScaleFromImageSize} from 'utils/export-utils';
import {findMapBounds} from 'utils/data-utils';
import geoViewport from '@mapbox/geo-viewport';
-const CLASS_FILTER = ['mapboxgl-control-container', 'attrition-logo']
+const CLASS_FILTER = ['mapboxgl-control-container', 'attrition-logo'];
const DOM_FILTER_FUNC = node => !CLASS_FILTER.includes(node.className);
const OUT_OF_SCREEN_POSITION = -9999;
diff --git a/src/index.js b/src/index.js
index a2ac96b46..84d17586a 100644
--- a/src/index.js
+++ b/src/index.js
@@ -45,5 +45,8 @@ export * from './styles';
// Middleware
export * from './middleware';
+// Utils
+export * from './utils';
+
// Default export
export {default} from './components';
diff --git a/src/layers/trip-layer/trip-utils.js b/src/layers/trip-layer/trip-utils.js
index 8164bf2d3..89bd485fb 100644
--- a/src/layers/trip-layer/trip-utils.js
+++ b/src/layers/trip-layer/trip-utils.js
@@ -26,7 +26,7 @@ import {parseGeoJsonRawFeature, getGeojsonFeatureTypes} from 'layers/geojson-lay
/**
* Parse geojson from string
- * @param {array} geojson feature object values
+ * @param {array} samples feature object values
* @returns {boolean} whether the geometry coordinates has length of 4
*/
export function coordHasLength4(samples) {
@@ -42,8 +42,8 @@ export function coordHasLength4(samples) {
/**
* Check whether geojson linestring's 4th coordinate is 1) not timestamp 2) unix time stamp 3) real date time
- * @param {array} data array to be tested if its elements are timestamp
- * @returns {string} the type of timestamp: unix/datetime/invalid(not timestamp)
+ * @param {array} timestamps array to be tested if its elements are timestamp
+ * @returns {object | boolean} the type of timestamp: unix/datetime/invalid(not timestamp)
*/
export function containValidTime(timestamps) {
@@ -63,7 +63,8 @@ export function containValidTime(timestamps) {
/**
* Check if geojson features are trip layer animatable by meeting 3 conditions
- * @param {array} features array of geojson feature objects
+ * @param {array} allData array of geojson feature objects
+ * @param {object} field array of geojson feature objects
* @returns {boolean} whether it is trip layer animatable
*/
export function isTripGeoJsonField(allData = [], field) {
@@ -97,7 +98,7 @@ export function isTripGeoJsonField(allData = [], field) {
/**
* Get unix timestamp from animatable geojson for deck.gl trip layer
* @param {Array<Object>} dataToFeature array of geojson feature objects, can be null
- * @returns {Array<Number>} unix timestamp in milliseconds
+ * @returns {{dataToTimeStamp: Array[Number], animationDomain: null | Array<Number>}} {dataToTimeStamp: [], animationDomain: null}
*/
export function parseTripGeoJsonTimestamp(dataToFeature) {
// Analyze type based on coordinates of the 1st lineString
diff --git a/src/processors/file-handler.js b/src/processors/file-handler.js
index 5eb565a74..77610d8a9 100644
--- a/src/processors/file-handler.js
+++ b/src/processors/file-handler.js
@@ -143,7 +143,7 @@ export async function readFileInBatches({file, fileCache = [], loaders = [], loa
...loadOptions
};
- const batchIterator = await parseInBatches(file, loaders, loadOptions, file.name);
+ const batchIterator = await parseInBatches(file, loaders, loadOptions);
const progressIterator = makeProgressIterator(batchIterator, {size: file.size});
return readBatch(progressIterator, file.name);
diff --git a/src/utils/filter-utils.d.ts b/src/utils/filter-utils.d.ts
index 8b9d8e55a..e9d875f11 100644
--- a/src/utils/filter-utils.d.ts
+++ b/src/utils/filter-utils.d.ts
@@ -59,7 +59,7 @@ export function applyFiltersToDatasets(
datasetIds: string[],
datasets: Datasets,
filters: Filter[],
- layers: Layer[]
+ layers?: Layer[]
): Datasets;
export function getFilterRecord(
dataId: string,
diff --git a/src/utils/index.js b/src/utils/index.js
index e80d2d6d1..97238c7a4 100644
--- a/src/utils/index.js
+++ b/src/utils/index.js
@@ -18,7 +18,9 @@
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
-export {maybeToDate, roundValToStep} from './data-utils';
+export {maybeToDate, roundValToStep, timeToUnixMilli} from './data-utils';
export {updateAllLayerDomainData} from '../reducers/vis-state-updaters';
export {findPointFieldPairs} from '../utils/dataset-utils';
export {getHexFields} from '../layers/h3-hexagon-layer/h3-utils';
+export {hexToRgb} from './color-utils';
+export {containValidTime} from '../layers/trip-layer/trip-utils';
diff --git a/yarn.lock b/yarn.lock
index 555cc937b..fa112e09a 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -1476,21 +1476,21 @@
"@math.gl/geospatial" "^3.2.0"
"@probe.gl/stats" "^3.3.0"
-"@loaders.gl/[email protected]", "@loaders.gl/core@^2.2.3", "@loaders.gl/core@^2.2.5":
- version "2.2.5"
- resolved "https://registry.yarnpkg.com/@loaders.gl/core/-/core-2.2.5.tgz#414df7b85ac6387e857e41474dd834fefc802678"
- integrity sha512-mcSbxnKCz2JGOsLFCADWUOc4tQ8gED7keiIm5nzcEWdiz/ft1+B58PlTUMefiUWebad+MoyBG76uASpnX5MXVQ==
+"@loaders.gl/[email protected]", "@loaders.gl/[email protected]", "@loaders.gl/core@^2.2.3", "@loaders.gl/core@^2.3.0-alpha.9":
+ version "2.3.0-alpha.10"
+ resolved "https://registry.yarnpkg.com/@loaders.gl/core/-/core-2.3.0-alpha.10.tgz#bd58888c85c424dde136c7f798440c8f5b597be8"
+ integrity sha512-rkuO0CxzIjJv52AVEhkDNdh9Xm9tyyZs15agM8rYPsV7ScgeBECVlM5tE702SwbwGsZvPBFHK5mqp2c8zuaLlg==
dependencies:
"@babel/runtime" "^7.3.1"
- "@loaders.gl/loader-utils" "2.2.5"
+ "@loaders.gl/loader-utils" "2.3.0-alpha.10"
-"@loaders.gl/csv@^2.2.5":
- version "2.2.5"
- resolved "https://registry.yarnpkg.com/@loaders.gl/csv/-/csv-2.2.5.tgz#4667cbfb62b98d918a1c4e233bfb880939ab74fb"
- integrity sha512-18Sp28zfbkz+0G6l2xTDL/G28ZNEgFC8st96Rib82tRfTpWxEjkJLm0/ESaZFpPX2OPa/kNoU2DVz0CDL+Am/A==
+"@loaders.gl/csv@^2.3.0-alpha.9":
+ version "2.3.0-alpha.10"
+ resolved "https://registry.yarnpkg.com/@loaders.gl/csv/-/csv-2.3.0-alpha.10.tgz#7cd6dc61a2cd6fde0d3348779283a990f0c82d4e"
+ integrity sha512-+TlWt8r9IWNC4MgblBU5qw8OjtGWy1grPv8Kw7dpKMezBKGo0SXT22hAtja530umzAhT9q3X91B0Sf9sWoDwSg==
dependencies:
- "@loaders.gl/loader-utils" "2.2.5"
- "@loaders.gl/tables" "2.2.5"
+ "@loaders.gl/loader-utils" "2.3.0-alpha.10"
+ "@loaders.gl/tables" "2.3.0-alpha.10"
"@loaders.gl/[email protected]":
version "2.2.5"
@@ -1501,15 +1501,33 @@
"@loaders.gl/loader-utils" "2.2.5"
draco3d "^1.3.4"
-"@loaders.gl/[email protected]", "@loaders.gl/gltf@^2.2.5":
- version "2.2.5"
- resolved "https://registry.yarnpkg.com/@loaders.gl/gltf/-/gltf-2.2.5.tgz#78b37dcc9356ab900e95098256d4c2382430a814"
- integrity sha512-fH/bWaHta9IpiiL+aZ0a1OxjHPwEFxtC06NIzNON4+IRjNtDMZXnYAr8YQNGVODjj7wnug3ht6wKmHSWWIDuIA==
+"@loaders.gl/[email protected]":
+ version "2.3.0-alpha.10"
+ resolved "https://registry.yarnpkg.com/@loaders.gl/draco/-/draco-2.3.0-alpha.10.tgz#2c48f91489291585517904176e7a2d9a3d8c95ef"
+ integrity sha512-NJSc7xmLnPrLiCWzEl2lLstdJ98Q/beo/CBPyJbRA6a33+RLBBwFZnO5Z/TFLQCB0sNogXFGhtRfc+ffA7Y12Q==
dependencies:
- "@loaders.gl/core" "2.2.5"
- "@loaders.gl/draco" "2.2.5"
- "@loaders.gl/images" "2.2.5"
- "@loaders.gl/loader-utils" "2.2.5"
+ "@babel/runtime" "^7.3.1"
+ "@loaders.gl/loader-utils" "2.3.0-alpha.10"
+ draco3d "^1.3.4"
+
+"@loaders.gl/[email protected]":
+ version "2.3.0-alpha.10"
+ resolved "https://registry.yarnpkg.com/@loaders.gl/gis/-/gis-2.3.0-alpha.10.tgz#ef9bfed3fa93ae751b6c6a1966660cc3f7435f21"
+ integrity sha512-jEMa8lC/Nem7r6woS/LO8quoDc+iGHmFZ/6F16Vt4+B+HLtpoLM0BzUpb6qIlprvdcDb7Az2+25Wjn91NzheRg==
+ dependencies:
+ "@loaders.gl/loader-utils" "2.3.0-alpha.10"
+ "@mapbox/vector-tile" "^1.3.1"
+ pbf "^3.2.1"
+
+"@loaders.gl/[email protected]", "@loaders.gl/gltf@^2.3.0-alpha.9":
+ version "2.3.0-alpha.10"
+ resolved "https://registry.yarnpkg.com/@loaders.gl/gltf/-/gltf-2.3.0-alpha.10.tgz#fc6ef3f4e637c5dadf84a7fd53e00b0b0b6ecbf8"
+ integrity sha512-mLDMTzPok4/aRKPAcySufFDxZqczRq9jfchkVKEPGq7ASY+dd49CsJmhu5Qrugnr4D1ZV4Bf6qnyTv76jWfvPQ==
+ dependencies:
+ "@loaders.gl/core" "2.3.0-alpha.10"
+ "@loaders.gl/draco" "2.3.0-alpha.10"
+ "@loaders.gl/images" "2.3.0-alpha.10"
+ "@loaders.gl/loader-utils" "2.3.0-alpha.10"
"@loaders.gl/[email protected]", "@loaders.gl/images@^2.2.3":
version "2.2.5"
@@ -1518,26 +1536,26 @@
dependencies:
"@loaders.gl/loader-utils" "2.2.5"
-"@loaders.gl/json@^2.2.5":
- version "2.2.5"
- resolved "https://registry.yarnpkg.com/@loaders.gl/json/-/json-2.2.5.tgz#1f1c757f85ed9f9e267914eaae8403c79ada1017"
- integrity sha512-BlqDTKWQs8RLuEQ7duHAmoDC5oQybdtorRRdAZziIKgMckaqVaU9+HhU3PcT+OcoElB8BAW8++w7JWwFfMhkbQ==
+"@loaders.gl/[email protected]":
+ version "2.3.0-alpha.10"
+ resolved "https://registry.yarnpkg.com/@loaders.gl/images/-/images-2.3.0-alpha.10.tgz#abebdb5fde927cd6e96f9da782a7dd55525f0bc4"
+ integrity sha512-iP7o7ZBO7RhsMHinsiHFeovnx0RzzXqf/4DeWGKDkuSZ6gbqXXtMVnh0HlNg84Jv50iyi7D1gZAIKi2DoqkmrQ==
dependencies:
- "@loaders.gl/loader-utils" "2.2.5"
- "@loaders.gl/tables" "2.2.5"
+ "@loaders.gl/loader-utils" "2.3.0-alpha.10"
-"@loaders.gl/[email protected]", "@loaders.gl/loader-utils@^2.2.3":
- version "2.2.5"
- resolved "https://registry.yarnpkg.com/@loaders.gl/loader-utils/-/loader-utils-2.2.5.tgz#8c19b10c2bd75a2bf2a913be62a701d52a37acfa"
- integrity sha512-GWXHSjcymdPEU8tYM2smEIMwaUTLar5eMANm0QJFu5k5piNQuv9c0ZvM27X0xkDGAf5bb10qAEqXaF4wcNrCLQ==
+"@loaders.gl/json@^2.3.0-alpha.9":
+ version "2.3.0-alpha.10"
+ resolved "https://registry.yarnpkg.com/@loaders.gl/json/-/json-2.3.0-alpha.10.tgz#907b9cc7847aeda74a1d8b7a9addb89b9272e543"
+ integrity sha512-O5XyXJnNKQH6PGtH6eJCwLTr783hARtmRaWP4EVwB3eqBMROW9fD5KyEdjmiQafqP8YAE4uOGymzuEMvq8VvKQ==
dependencies:
- "@babel/runtime" "^7.3.1"
- "@probe.gl/stats" "^3.3.0"
+ "@loaders.gl/gis" "2.3.0-alpha.10"
+ "@loaders.gl/loader-utils" "2.3.0-alpha.10"
+ "@loaders.gl/tables" "2.3.0-alpha.10"
-"@loaders.gl/loader-utils@^2.2.5":
- version "2.2.8"
- resolved "https://registry.yarnpkg.com/@loaders.gl/loader-utils/-/loader-utils-2.2.8.tgz#9f12f3460260b15e961fa46c3d3c867d7bf48bee"
- integrity sha512-3F2VgxJPxjuZwAr8fDBkZzx3Wg275XdVaWnyYQ3uyZQ22yGEkrzKc+TlgcqSrxbO5pHrtS5PdS7dmyoJo2+Bdg==
+"@loaders.gl/[email protected]", "@loaders.gl/[email protected]", "@loaders.gl/loader-utils@^2.2.3", "@loaders.gl/loader-utils@^2.3.0-alpha.9":
+ version "2.3.0-alpha.10"
+ resolved "https://registry.yarnpkg.com/@loaders.gl/loader-utils/-/loader-utils-2.3.0-alpha.10.tgz#b5639e2ae50e827ff552fefe5589f19f2e18f4f0"
+ integrity sha512-+wn7TwLtzDt25OJT+Qc5ZIcBnhuSh76b8HELVsg/XVPC/A+2YcFKD8yKQdCpASvHprcdz7+iwhypZm9HpNTjiQ==
dependencies:
"@babel/runtime" "^7.3.1"
"@probe.gl/stats" "^3.3.0"
@@ -1560,10 +1578,10 @@
"@mapbox/vector-tile" "^1.3.1"
pbf "^3.2.1"
-"@loaders.gl/polyfills@^2.2.5":
- version "2.2.5"
- resolved "https://registry.yarnpkg.com/@loaders.gl/polyfills/-/polyfills-2.2.5.tgz#393a0efc1c472b6090e92080217a78a311af090f"
- integrity sha512-Qlu29L+8PFRRf2UX1yk0oFF68yUBN0e633LDqUoDdUyCP8gXmoAtG+dGeF/6aTgk9UloBpjk2UP8EOg5kC7i6g==
+"@loaders.gl/polyfills@^2.3.0-alpha.9":
+ version "2.3.0-alpha.10"
+ resolved "https://registry.yarnpkg.com/@loaders.gl/polyfills/-/polyfills-2.3.0-alpha.10.tgz#279f03fb45adf15d3310dd2d54f814df63c1806f"
+ integrity sha512-Vgs+yHzmuTOKtwS1Wx12Nm3h90+30NHDwpvDpPyfCp0fLG0wqSXTv08z7RoEwmUXervXFI7+Vn2lFkGP1ia6UA==
dependencies:
"@babel/runtime" "^7.3.1"
get-pixels "^3.3.2"
@@ -1572,12 +1590,12 @@
stream-to-async-iterator "^0.2.0"
through "^2.3.8"
-"@loaders.gl/[email protected]":
- version "2.2.5"
- resolved "https://registry.yarnpkg.com/@loaders.gl/tables/-/tables-2.2.5.tgz#c594262eb4d1fc4e26c356b6f5378ee70b997ea6"
- integrity sha512-GT9mBreBGPsi3AEelNlcZo0UjD3HIa+yyRvIoUMfD+dpHKvrSqk7zsEaC2wvsxIMdi7uW7iIh99ynhfODV+EKA==
+"@loaders.gl/[email protected]":
+ version "2.3.0-alpha.10"
+ resolved "https://registry.yarnpkg.com/@loaders.gl/tables/-/tables-2.3.0-alpha.10.tgz#963854466f4ec11854f54c686a2992d3ec77dde5"
+ integrity sha512-DFVBvSYJh40yie+zjJqS3cyZVK1FOJ07trcMe/Unj3RDfFwCHPIbm0OiXmeTVZR7GoPeX67zpgJS5sggCGuP5g==
dependencies:
- "@loaders.gl/core" "2.2.5"
+ "@loaders.gl/core" "2.3.0-alpha.10"
"@loaders.gl/terrain@^2.2.3":
version "2.2.5"