Skip to content

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

[Chore] Adding application config (#2658)

Shan He25a5b60d83e7
diff --git a/examples/demo-app/yarn.lock b/examples/demo-app/yarn.lock
index f29e15091..f593ac1b6 100644
--- a/examples/demo-app/yarn.lock
+++ b/examples/demo-app/yarn.lock
@@ -1309,6 +1309,23 @@ __metadata:
languageName: node
linkType: hard
+"@loaders.gl/arrow@npm:^4.1.1":
+ version: 4.2.3
+ resolution: "@loaders.gl/arrow@npm:4.2.3"
+ dependencies:
+ "@loaders.gl/gis": "npm:4.2.3"
+ "@loaders.gl/loader-utils": "npm:4.2.3"
+ "@loaders.gl/schema": "npm:4.2.3"
+ "@loaders.gl/wkt": "npm:4.2.3"
+ "@loaders.gl/worker-utils": "npm:4.2.3"
+ "@math.gl/polygon": "npm:4.0.0"
+ apache-arrow: "npm:>= 15.0.0"
+ peerDependencies:
+ "@loaders.gl/core": ^4.0.0
+ checksum: 10c0/d9f296de09f9ea2c989f555fe3bc5c3da8b48c4f9a89d11b4bc9d9aeb1ecb9726ce37fed76c9f20d01a487f176329034d6c1391242fe9dcc8a9273371ea7a6a9
+ languageName: node
+ linkType: hard
+
"@loaders.gl/core@npm:^3.4.13":
version: 3.4.15
resolution: "@loaders.gl/core@npm:3.4.15"
@@ -1333,6 +1350,18 @@ __metadata:
languageName: node
linkType: hard
+"@loaders.gl/core@npm:^4.1.1":
+ version: 4.2.3
+ resolution: "@loaders.gl/core@npm:4.2.3"
+ dependencies:
+ "@loaders.gl/loader-utils": "npm:4.2.3"
+ "@loaders.gl/schema": "npm:4.2.3"
+ "@loaders.gl/worker-utils": "npm:4.2.3"
+ "@probe.gl/log": "npm:^4.0.2"
+ checksum: 10c0/b3ed3cea0a7350c4c2369bbdcaab28642f2051e4e0263bd2d22fa8425da7eea1cc47141adea974308338fa8741f04c0f86f9cceb2bd338fd39245b4da64435fd
+ languageName: node
+ linkType: hard
+
"@loaders.gl/csv@npm:^4.1.0-alpha.4":
version: 4.2.2
resolution: "@loaders.gl/csv@npm:4.2.2"
@@ -1345,6 +1374,18 @@ __metadata:
languageName: node
linkType: hard
+"@loaders.gl/csv@npm:^4.1.1":
+ version: 4.2.3
+ resolution: "@loaders.gl/csv@npm:4.2.3"
+ dependencies:
+ "@loaders.gl/loader-utils": "npm:4.2.3"
+ "@loaders.gl/schema": "npm:4.2.3"
+ peerDependencies:
+ "@loaders.gl/core": ^4.0.0
+ checksum: 10c0/5b58f4e315202d495dfb9d1bfdcdc825e0be79be29986181c93ee3f17916a5e2f2ab8b35bda4edf9b05916bb238bb48ce03bffe0ac97dbdcb98ecc134c9af750
+ languageName: node
+ linkType: hard
+
"@loaders.gl/draco@npm:3.4.15":
version: 3.4.15
resolution: "@loaders.gl/draco@npm:3.4.15"
@@ -1400,6 +1441,21 @@ __metadata:
languageName: node
linkType: hard
+"@loaders.gl/gis@npm:4.2.3":
+ version: 4.2.3
+ resolution: "@loaders.gl/gis@npm:4.2.3"
+ dependencies:
+ "@loaders.gl/loader-utils": "npm:4.2.3"
+ "@loaders.gl/schema": "npm:4.2.3"
+ "@mapbox/vector-tile": "npm:^1.3.1"
+ "@math.gl/polygon": "npm:^4.0.0"
+ pbf: "npm:^3.2.1"
+ peerDependencies:
+ "@loaders.gl/core": ^4.0.0
+ checksum: 10c0/6cbdae6b7b608107b82b77c6ee741706bd1aa2db5783dd06214104bf24b324a392cb37bca44c3cf78ac2fe72d6a76006ed54b2773b6c61fc2efce657f3f6bca4
+ languageName: node
+ linkType: hard
+
"@loaders.gl/gltf@npm:3.4.15, @loaders.gl/gltf@npm:^3.4.13":
version: 3.4.15
resolution: "@loaders.gl/gltf@npm:3.4.15"
@@ -1462,6 +1518,19 @@ __metadata:
languageName: node
linkType: hard
+"@loaders.gl/json@npm:^4.1.1":
+ version: 4.2.3
+ resolution: "@loaders.gl/json@npm:4.2.3"
+ dependencies:
+ "@loaders.gl/gis": "npm:4.2.3"
+ "@loaders.gl/loader-utils": "npm:4.2.3"
+ "@loaders.gl/schema": "npm:4.2.3"
+ peerDependencies:
+ "@loaders.gl/core": ^4.0.0
+ checksum: 10c0/eb79c0ecd6c01190865b1eade356bca341c4a506801c326af305cf6a39768edefec20ada5fcdb76e2da46f4c9ad020c59f6e44aba8c55a46fbd9f0a37b0afe6c
+ languageName: node
+ linkType: hard
+
"@loaders.gl/loader-utils@npm:3.4.15, @loaders.gl/loader-utils@npm:^3.4.13":
version: 3.4.15
resolution: "@loaders.gl/loader-utils@npm:3.4.15"
@@ -1486,6 +1555,19 @@ __metadata:
languageName: node
linkType: hard
+"@loaders.gl/loader-utils@npm:4.2.3":
+ version: 4.2.3
+ resolution: "@loaders.gl/loader-utils@npm:4.2.3"
+ dependencies:
+ "@loaders.gl/schema": "npm:4.2.3"
+ "@loaders.gl/worker-utils": "npm:4.2.3"
+ "@probe.gl/stats": "npm:^4.0.2"
+ peerDependencies:
+ "@loaders.gl/core": ^4.0.0
+ checksum: 10c0/55a5d906193263136ed94cd04fb4414e86256722f402e97a213d125177241b88f2fd5dd205c06bce5ae0842e5f3e93b9d7241d46d78b1ac4da329c7baa22f5b6
+ languageName: node
+ linkType: hard
+
"@loaders.gl/math@npm:3.4.15":
version: 3.4.15
resolution: "@loaders.gl/math@npm:3.4.15"
@@ -1530,6 +1612,17 @@ __metadata:
languageName: node
linkType: hard
+"@loaders.gl/schema@npm:4.2.3":
+ version: 4.2.3
+ resolution: "@loaders.gl/schema@npm:4.2.3"
+ dependencies:
+ "@types/geojson": "npm:^7946.0.7"
+ peerDependencies:
+ "@loaders.gl/core": ^4.0.0
+ checksum: 10c0/b6bf755a8ec64340d333df57e6c56c4a9ca703cdb8f464cdec3cfe8f41a04d7558522e3a90ae178e2d95cef9d9d945f7915e767a877146a47ccf25969e5e35a1
+ languageName: node
+ linkType: hard
+
"@loaders.gl/terrain@npm:^3.4.13":
version: 3.4.15
resolution: "@loaders.gl/terrain@npm:3.4.15"
@@ -1604,6 +1697,19 @@ __metadata:
languageName: node
linkType: hard
+"@loaders.gl/wkt@npm:4.2.3":
+ version: 4.2.3
+ resolution: "@loaders.gl/wkt@npm:4.2.3"
+ dependencies:
+ "@loaders.gl/gis": "npm:4.2.3"
+ "@loaders.gl/loader-utils": "npm:4.2.3"
+ "@loaders.gl/schema": "npm:4.2.3"
+ peerDependencies:
+ "@loaders.gl/core": ^4.0.0
+ checksum: 10c0/f074594e8cbc4dd517cf5552f1af13dd89a82685a4b88a9dd21c2e7635ffa87a5641efb33ce13cfe0c0b3d5462b82e96883f388aea0ba16dedda9fb73d0d6bf4
+ languageName: node
+ linkType: hard
+
"@loaders.gl/wms@npm:^3.4.13":
version: 3.4.15
resolution: "@loaders.gl/wms@npm:3.4.15"
@@ -1638,6 +1744,15 @@ __metadata:
languageName: node
linkType: hard
+"@loaders.gl/worker-utils@npm:4.2.3":
+ version: 4.2.3
+ resolution: "@loaders.gl/worker-utils@npm:4.2.3"
+ peerDependencies:
+ "@loaders.gl/core": ^4.0.0
+ checksum: 10c0/30a9ee62530fa12cb1b2b014386d1709d3f2bfe5e4dbc16a7cbeb1221334ec2073e9a2a3581843cc8e655d7f36fd173def047af92d55cc00c53f2e9ecf1bcc52
+ languageName: node
+ linkType: hard
+
"@loaders.gl/xml@npm:3.4.15":
version: 3.4.15
resolution: "@loaders.gl/xml@npm:3.4.15"
@@ -7356,10 +7471,10 @@ __metadata:
"@kepler.gl/schemas": "npm:^3.0.0-alpha.1"
"@kepler.gl/styles": "npm:^3.0.0-alpha.1"
"@kepler.gl/utils": "npm:^3.0.0-alpha.1"
- "@loaders.gl/arrow": "npm:^4.1.0-alpha.4"
- "@loaders.gl/core": "npm:^4.1.0-alpha.4"
- "@loaders.gl/csv": "npm:^4.1.0-alpha.4"
- "@loaders.gl/json": "npm:^4.1.0-alpha.4"
+ "@loaders.gl/arrow": "npm:^4.1.1"
+ "@loaders.gl/core": "npm:^4.1.1"
+ "@loaders.gl/csv": "npm:^4.1.1"
+ "@loaders.gl/json": "npm:^4.1.1"
"@types/classnames": "npm:^2.3.1"
"@types/keymirror": "npm:^0.1.1"
classnames: "npm:^2.2.1"
diff --git a/src/reducers/src/export-utils.ts b/src/reducers/src/export-utils.ts
index dc51c750e..fc76b95af 100644
--- a/src/reducers/src/export-utils.ts
+++ b/src/reducers/src/export-utils.ts
@@ -12,9 +12,9 @@ import {
createIndexedDataContainer,
DataContainerInterface,
parseFieldValue,
- downloadFile,
- DEFAULT_DATA_NAME
+ downloadFile
} from '@kepler.gl/utils';
+import {getApplicationConfig} from '@kepler.gl/utils';
interface StateType {
visState: {datasets: Datasets};
@@ -26,7 +26,7 @@ export function exportData(state: StateType, options) {
const {datasets} = visState;
const {selectedDataset, dataType, filtered} = options;
// get the selected data
- const filename = appName ? appName : DEFAULT_DATA_NAME;
+ const filename = appName ? appName : getApplicationConfig().defaultDataName;
const selectedDatasets = datasets[selectedDataset]
? [datasets[selectedDataset]]
: Object.values(datasets);
diff --git a/src/utils/src/application-config.ts b/src/utils/src/application-config.ts
new file mode 100644
index 000000000..fc92fe162
--- /dev/null
+++ b/src/utils/src/application-config.ts
@@ -0,0 +1,32 @@
+/**
+ * A mechanism to override default Kepler values/settings so that we
+ * without having to make application-specific changes to the kepler repo.
+ */
+export type KeplerApplicationConfig = {
+ /** Default name of export HTML file, can be overridden by user */
+ defaultHtmlName?: string;
+ defaultImageName?: string;
+ defaultJsonName?: string;
+ defaultDataName?: string;
+ defaultExportJsonSettings?: {
+ hasData?: boolean;
+ };
+};
+
+const DEFAULT_APPLICATION_CONFIG: Required<KeplerApplicationConfig> = {
+ defaultHtmlName: 'kepler.gl.html',
+ defaultImageName: 'kepler.gl.png',
+ defaultJsonName: 'kepler.gl.json',
+ defaultDataName: 'kepler.gl',
+ defaultExportJsonSettings: {
+ hasData: true
+ }
+};
+
+const applicationConfig: Required<KeplerApplicationConfig> = DEFAULT_APPLICATION_CONFIG;
+
+export const getApplicationConfig = (): Required<KeplerApplicationConfig> => applicationConfig;
+
+export function initApplicationConfig(appConfig: KeplerApplicationConfig = {}) {
+ Object.assign(applicationConfig, appConfig);
+}
diff --git a/src/utils/src/export-utils.ts b/src/utils/src/export-utils.ts
index c6e938656..cc0acd86c 100644
--- a/src/utils/src/export-utils.ts
+++ b/src/utils/src/export-utils.ts
@@ -16,21 +16,7 @@ import {
import domtoimage from './dom-to-image';
import {generateHashId, set} from './utils';
import {exportMapToHTML} from './export-map-html';
-
-/**
- * Default file names
- */
-export const DEFAULT_IMAGE_NAME = 'kepler.gl.png';
-export const DEFAULT_HTML_NAME = 'kepler.gl.html';
-export const DEFAULT_JSON_NAME = 'kepler.gl.json';
-export const DEFAULT_DATA_NAME = 'kepler.gl';
-
-/**
- * Default json export settings
- */
-export const DEFAULT_EXPORT_JSON_SETTINGS = {
- hasData: true
-};
+import {getApplicationConfig} from './application-config';
const defaultResolution = OneXResolutionOption;
@@ -136,7 +122,10 @@ export function downloadFile(fileBlob: Blob, fileName: string) {
* Whether color is rgb
* @returns
*/
-export function exportImage(uiStateExportImage: ExportImage, filename = DEFAULT_IMAGE_NAME) {
+export function exportImage(
+ uiStateExportImage: ExportImage,
+ filename = getApplicationConfig().defaultImageName
+) {
const {imageDataUri} = uiStateExportImage;
if (imageDataUri) {
const file = dataURItoBlob(imageDataUri);
@@ -154,7 +143,7 @@ export function exportToJsonString(data) {
}
}
-export function getMapJSON(state, options = DEFAULT_EXPORT_JSON_SETTINGS) {
+export function getMapJSON(state, options = getApplicationConfig().defaultExportJsonSettings) {
const {hasData} = options;
const schema = state.visState.schema;
@@ -175,7 +164,7 @@ export function exportJson(state, options: any = {}) {
const map = getMapJSON(state, options);
map.info.source = 'kepler.gl';
const fileBlob = new Blob([exportToJsonString(map)], {type: 'application/json'});
- const fileName = state.appName ? `${state.appName}.json` : DEFAULT_JSON_NAME;
+ const fileName = state.appName ? `${state.appName}.json` : getApplicationConfig().defaultJsonName;
downloadFile(fileBlob, fileName);
}
@@ -190,10 +179,13 @@ export function exportHtml(state, options) {
};
const fileBlob = new Blob([exportMapToHTML(data)], {type: 'text/html'});
- downloadFile(fileBlob, state.appName ? `${state.appName}.html` : DEFAULT_HTML_NAME);
+ downloadFile(
+ fileBlob,
+ state.appName ? `${state.appName}.html` : getApplicationConfig().defaultHtmlName
+ );
}
-export function exportMap(state, options = DEFAULT_EXPORT_JSON_SETTINGS) {
+export function exportMap(state, options = getApplicationConfig().defaultExportJsonSettings) {
const {imageDataUri} = state.uiState.exportImage;
const thumbnail: Blob | null = imageDataUri ? dataURItoBlob(imageDataUri) : null;
const mapToSave = getMapJSON(state, options);
diff --git a/src/utils/src/index.ts b/src/utils/src/index.ts
index 0ed457150..3c683c2fa 100644
--- a/src/utils/src/index.ts
+++ b/src/utils/src/index.ts
@@ -46,11 +46,6 @@ export {
export {getFormatValue} from './format';
export {exportMapToHTML} from './export-map-html';
export {
- DEFAULT_IMAGE_NAME,
- DEFAULT_HTML_NAME,
- DEFAULT_JSON_NAME,
- DEFAULT_DATA_NAME,
- DEFAULT_EXPORT_JSON_SETTINGS,
isMSEdge,
getScaleFromImageSize,
calculateExportImageSize,
@@ -124,3 +119,10 @@ export {DataRow} from './data-row';
export type {Centroid} from './h3-utils';
export {getCentroid, idToPolygonGeo, h3IsValid, getHexFields} from './h3-utils';
+
+// Application config
+export {
+ getApplicationConfig,
+ initApplicationConfig,
+} from '../../utils/src/application-config';
+export type {KeplerApplicationConfig} from '../../utils/src/application-config';