@undp/data-viz 1.4.15 → 1.5.0

package/dist/ThreeDGlobe.d.ts

@@ -1,8 +1,11 @@
 import { default as default_2 } from 'react';
-import { default as default_3 } from 'react-globe.gl';
 import { JSX } from 'react/jsx-runtime';
 import * as THREE from 'three';
 
+declare interface AmbientLightConfig extends BaseLightConfig {
+    type: 'ambient';
+}
+
 declare interface AxesClassNameObject {
     gridLines?: string;
     labels?: string;
@@ -17,6 +20,12 @@ declare interface AxesStyleObject {
     axis?: React.CSSProperties;
 }
 
+declare interface BaseLightConfig {
+    type: string;
+    color: number;
+    intensity: number;
+}
+
 declare interface ChoroplethMapDataType {
     x?: number | string | null;
     id: string;
@@ -41,17 +50,38 @@ declare interface ClassNameObject {
     dataCards?: string;
 }
 
+declare interface DirectionalLightConfig extends BaseLightConfig {
+    type: 'directional';
+    target?: Position;
+    castShadow?: boolean;
+    shadow?: ShadowConfig;
+    position?: Position | 'camera';
+}
+
 declare interface FogDataType {
     color: string;
     near: number;
     far: number;
 }
 
-declare type GlobeProps = default_2.ComponentProps<typeof default_3>;
-
 declare type Languages = 'en' | 'ar' | 'az' | 'bn' | 'cy' | 'he' | 'hi' | 'jp' | 'ka' | 'km' | 'ko' | 'my' | 'ne' | 'zh' | 'custom';
 
-declare interface Props extends Partial<Omit<GlobeProps, 'backgroundColor'>> {
+declare type LightConfig = AmbientLightConfig | DirectionalLightConfig | PointLightConfig | SpotLightConfig;
+
+declare interface PointLightConfig extends BaseLightConfig {
+    type: 'point';
+    distance?: number;
+    decay?: number;
+    position?: Position | 'camera';
+}
+
+declare interface Position {
+    x: number;
+    y: number;
+    z: number;
+}
+
+declare interface Props {
     /** Array of data objects */
     data: ChoroplethMapDataType[];
     /** Title of the graph */
@@ -98,6 +128,8 @@ declare interface Props extends Partial<Omit<GlobeProps, 'backgroundColor'>> {
     autoRotate?: number | boolean;
     /** Defines the material property applied to the sphere of the globe */
     globeMaterial?: THREE.Material;
+    /** Defines the lights for the 3D scene */
+    lights?: LightConfig[];
     /** Defines the colo of the glow around the globe */
     atmosphereColor?: string;
     /** Defines if the globe can be zoomed when scrolled */
@@ -118,14 +150,14 @@ declare interface Props extends Partial<Omit<GlobeProps, 'backgroundColor'>> {
     atmosphereAltitude?: number;
     /** Resolution in angular degrees of the sphere curvature. The finer the resolution, the more the globe is fragmented into smaller faces to approximate the spheric surface, at the cost of performance. */
     globeCurvatureResolution?: number;
-    /** Defines the color of the light and atmosphere. */
-    lightColor?: string;
     /** Defines fog settings for the scene. */
     fogSettings?: FogDataType;
     /** Property in the property object in mapData geoJson object is used to match to the id in the data object */
     mapProperty?: string;
     /** Countries or regions to be highlighted */
     highlightedIds?: string[];
+    /** Defines the altitude of the highlighted countries or the countries on mouseover. */
+    highlightedAltitude?: number;
     /** Enable data download option as a csv */
     dataDownload?: boolean;
     /** Reset selection on double-click. Only applicable when used in a dashboard context with filters. */
@@ -148,11 +180,34 @@ declare interface Props extends Partial<Omit<GlobeProps, 'backgroundColor'>> {
 
 declare type ScaleDataType = 'categorical' | 'linear' | 'threshold';
 
+declare interface ShadowConfig {
+    mapSize: {
+        width: number;
+        height: number;
+    };
+    camera: {
+        near: number;
+        far: number;
+    };
+}
+
 declare interface SourcesDataType {
     source: string;
     link?: string;
 }
 
+declare interface SpotLightConfig extends BaseLightConfig {
+    type: 'spot';
+    target?: Position;
+    distance?: number;
+    angle?: number;
+    penumbra?: number;
+    decay?: number;
+    castShadow?: boolean;
+    shadow?: ShadowConfig;
+    position?: Position | 'camera';
+}
+
 declare interface StyleObject {
     title?: React.CSSProperties;
     footnote?: React.CSSProperties;