kepler.gl
Version:
kepler.gl is a webgl based application to visualize large scale location data in the browser
220 lines (219 loc) • 6.87 kB
TypeScript
import { VisConfigBoolean, VisConfigNumber, VisConfigRange, VisConfigObjectSelection, VisConfigInput } from '@kepler.gl/types';
import { ColorRescaling, ConfigOption, PresetData } from './types';
/**
* Known Data Source IDs that work with current STAC Layer limitations
*/
export declare enum DATA_SOURCE_IDS {
SENTINEL_2_L1C = "sentinel-2-l1c",
SENTINEL_2_L1A = "sentinel-2-l2a",
SENTINEL_2_C1_L2A = "sentinel-2-c1-l2a",
SENTINEL_2_PRE_C1_L2A = "sentinel-2-pre-c1-l2a",
LANDSAT_C2_L1 = "landsat-c2-l1",
LANDSAT_C2_L2 = "landsat-c2-l2",
MODIS_09A1_061 = "modis-09A1-061",
MODIS_43A4_061 = "modis-43A4-061",
MOIDS_09Q1_061 = "modis-09Q1-061"
}
export declare const RASTER_COLOR_RESET_PARAMS: {
gammaContrastFactor: number;
sigmoidalContrastFactor: number;
sigmoidalBiasFactor: number;
saturationValue: number;
dynamicColor: boolean;
};
export declare const DEFAULT_BAND_MAPPINGS: {
"sentinel-2-l1c": {
coastal: string;
blue: string;
green: string;
red: string;
rededge1: string;
rededge2: string;
rededge3: string;
nir: string;
nir08: string;
nir09: string;
cirrus: string;
swir11: string;
swir16: string;
swir12: string;
swir22: string;
};
"sentinel-2-l2a": {
coastal: string;
blue: string;
green: string;
red: string;
rededge1: string;
rededge2: string;
rededge3: string;
nir: string;
nir08: string;
nir09: string;
cirrus: string;
swir11: string;
swir16: string;
swir12: string;
swir22: string;
};
"sentinel-2-c1-l2a": {
coastal: string;
blue: string;
green: string;
red: string;
rededge1: string;
rededge2: string;
rededge3: string;
nir: string;
nir08: string;
nir09: string;
cirrus: string;
swir11: string;
swir16: string;
swir12: string;
swir22: string;
};
"sentinel-2-pre-c1-l2a": {
coastal: string;
blue: string;
green: string;
red: string;
rededge1: string;
rededge2: string;
rededge3: string;
nir: string;
nir08: string;
nir09: string;
cirrus: string;
swir11: string;
swir16: string;
swir12: string;
swir22: string;
};
"landsat-c2-l1": {
green: string;
red: string;
nir08: string;
nir09: string;
};
"landsat-c2-l2": {
blue: string;
green: string;
red: string;
nir08: string;
swir16: string;
lwir: string;
swir22: string;
coastal: string;
lwir11: string;
};
"modis-09A1-061": {
sur_refl_b01: string;
sur_refl_b02: string;
sur_refl_b03: string;
sur_refl_b04: string;
sur_refl_b05: string;
sur_refl_b06: string;
sur_refl_b07: string;
Nadir_Reflectance_Band1: string;
Nadir_Reflectance_Band2: string;
Nadir_Reflectance_Band3: string;
Nadir_Reflectance_Band4: string;
Nadir_Reflectance_Band5: string;
Nadir_Reflectance_Band6: string;
Nadir_Reflectance_Band7: string;
};
"modis-43A4-061": {
sur_refl_b01: string;
sur_refl_b02: string;
sur_refl_b03: string;
sur_refl_b04: string;
sur_refl_b05: string;
sur_refl_b06: string;
sur_refl_b07: string;
Nadir_Reflectance_Band1: string;
Nadir_Reflectance_Band2: string;
Nadir_Reflectance_Band3: string;
Nadir_Reflectance_Band4: string;
Nadir_Reflectance_Band5: string;
Nadir_Reflectance_Band6: string;
Nadir_Reflectance_Band7: string;
};
"modis-09Q1-061": {
sur_refl_b01: string;
sur_refl_b02: string;
sur_refl_b03: string;
sur_refl_b04: string;
sur_refl_b05: string;
sur_refl_b06: string;
sur_refl_b07: string;
Nadir_Reflectance_Band1: string;
Nadir_Reflectance_Band2: string;
Nadir_Reflectance_Band3: string;
Nadir_Reflectance_Band4: string;
Nadir_Reflectance_Band5: string;
Nadir_Reflectance_Band6: string;
Nadir_Reflectance_Band7: string;
};
};
/**
* Per-data source color rescaling defaults for known collections
*/
export declare const DATA_SOURCE_COLOR_DEFAULTS: Record<DATA_SOURCE_IDS, ColorRescaling>;
/**
* Available "presets"
*
* I define a "preset" as one specific manner of loading bands and combining them on the frontend.
* In the future I expect we'll want a UI that gives the user full flexibility.
*/
export declare const PRESET_OPTIONS: Record<string, PresetData>;
/**
* Valid zoom ranges for each data source
*
* The maximum zoom is derived from the resolution of each data source.
* The minimum zoom relates to the number of overviews in the COGs at the source. The more
* overviews, the easier it is to create downsampled tiles. The minimum zooms can be reduced but it
* takes longer to serve low-zoom tiles since the server must read from many image sources.
*/
export declare const ZOOM_RANGES: Record<DATA_SOURCE_IDS, [number, number]>;
/**
* Bit depth for each data source
* Sentinel-2 is 12-bit; Landsat-8 is 16-bit; Planet is 12-bit; NAIP is 8-bit
*/
export declare const MAX_PIXEL_VALUES: Record<DATA_SOURCE_IDS, number>;
/**
* Id for categorical colormap. Unlike most colormaps. Categorical colormap image is created
* from colormap set in visConfig
*/
export declare const CATEGORICAL_COLORMAP_ID = "_categorical";
/**
* A list of available colormaps. Colormaps are originally derived from
* matplotlib, then via rio-tiler. Colormaps are 10x256 PNG images that are
* loaded as textures
*/
export declare const COLORMAP_OPTIONS: readonly ConfigOption[];
/**
* Configuration settings to be exposed through the UI
*/
export declare const rasterVisConfigs: {
preset: VisConfigObjectSelection;
useSTACSearching: VisConfigBoolean;
stacSearchProvider: VisConfigObjectSelection;
startDate: VisConfigInput;
endDate: VisConfigInput;
dynamicColor: VisConfigBoolean;
colormapId: VisConfigObjectSelection;
colorRange: "colorRange";
linearRescalingFactor: VisConfigRange;
nonLinearRescaling: VisConfigBoolean;
gammaContrastFactor: VisConfigNumber;
sigmoidalContrastFactor: VisConfigNumber;
sigmoidalBiasFactor: VisConfigNumber;
saturationValue: VisConfigNumber;
filterEnabled: VisConfigBoolean;
filterRange: VisConfigRange;
opacity: VisConfigNumber;
_stacQuery: VisConfigInput;
singleBandName: VisConfigObjectSelection;
enableTerrain: VisConfigBoolean;
};