r3f-globe
v1.6.0TypeScript
React Three Fiber component for Globe Data Visualization
341/weekUpdated 3 months agoMITUnpacked: 20.6 MB
Published by Vasco Asturiano
npm install r3f-globeReact-Three-Fiber Globe Visualization
=====================================
[![NPM package][npm-img]][npm-url]
[![Build Size][build-size-img]][build-size-url]
[![NPM Downloads][npm-downloads-img]][npm-downloads-url]
React-Three-Fiber bindings for the three-globe ThreeJS component.
#### Check out the examples:
* Basic (source)
* Scene with multiple globe styles (source)
* Tiled Map Engine (source)
* Satellites (source)
❤️ Support This Project
If you find this module useful and would like to support its development, you can buy me a ☕. Your contributions help keep open-source sustainable!
Quick start
``js`
import R3fGlobe from 'r3f-globe';
or using a script taghtml`
thenjsx`
API reference
* Globe Layer
* Points Layer
* Arcs Layer
* Polygons Layer
* Paths Layer
* Heatmaps Layer
* Hex Bin Layer
* Hexed Polygons Layer
* Tiles Layer
* Particles Layer
* Rings Layer
* Labels Layer
* HTML Elements Layer
* 3D Objects Layer
* Custom Layer
* Interaction
* Render Control
* Utility
$3
| Prop | Type | Default | Description |
| --- | :--: | :--: | --- |
| globeImageUrl | string| - | URL of the image used in the material that wraps the globe. This image should follow an equirectangular projection. If no image is provided, the globe is represented as a black sphere. |
| bumpImageUrl | string| - | URL of the image used to create a bump map in the material, to represent the globe's terrain. This image should follow an equirectangular projection. |
| globeTileEngineUrl | func(x, y, l) | - | Function that defines the URL of the slippy map tile engine to cover the globe surface. The slippy map coordinates x, y and l (zoom level) are passed as arguments and the function is expected to return a URL string. A falsy value will disable the tiling engine. |true
| showGlobe | bool | | Whether to show the globe surface itself. |false
| showGraticules | bool | | Whether to show a graticule grid demarking latitude and longitude lines at every 10 degrees. |true
| showAtmosphere | bool | | Whether to show a bright halo surrounding the globe, representing the atmosphere. |lightskyblue
| atmosphereColor | string | | The color of the atmosphere. |
| atmosphereAltitude | string | 0.15 | The max altitude of the atmosphere, in terms of globe radius units. |
| globeCurvatureResolution | number | 4 | 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. |
| globeMaterial | Material | MeshPhongMaterial | ThreeJS material used to wrap the globe. |
| onGlobeReady | func | - | Callback function to invoke immediately after the globe has been initialized and visible on the scene. |
| Method | Arguments | Description |
| --- | :--: | --- |
| globeTileEngineClearCache | - | Clear the tile engine cache. |
$3
| Prop | Type | Default | Description |
| --- | :--: | :--: | --- |
| pointsData | array | [] | List of points to represent in the points map layer. Each point is displayed as a cylindrical 3D object rising perpendicularly from the surface of the globe. |lat
| pointLat | number, string or func | | Point object accessor function, attribute or a numeric constant for the cylinder's center latitude coordinate. |lng
| pointLng | number, string or func | | Point object accessor function, attribute or a numeric constant for the cylinder's center longitude coordinate. |() => '#ffffaa'
| pointColor | string or func | | Point object accessor function or attribute for the cylinder color. |0
| pointAltitude | number, string or func | 0.1 | Point object accessor function, attribute or a numeric constant for the cylinder's altitude in terms of globe radius units ( = 0 altitude (flat circle), 1 = globe radius). |false
| pointRadius | number, string or func | 0.25 | Point object accessor function, attribute or a numeric constant for the cylinder's radius, in angular degrees. |
| pointResolution | number | 12 | Radial geometric resolution of each cylinder, expressed in how many slice segments to divide the circumference. Higher values yield smoother cylinders. |
| pointsMerge | bool | | Whether to merge all the point meshes into a single ThreeJS object, for improved rendering performance. Visually both options are equivalent, setting this option only affects the internal organization of the ThreeJS objects. |0
| pointsTransitionDuration | number | 1000 | Duration (ms) of the transition to animate point changes involving geometry modifications. A value of will move the objects immediately to their final position. New objects are animated by scaling them from the ground up. Only works if pointsMerge is disabled. |
$3
| Prop | Type | Default | Description |
| --- | :--: | :--: | --- |
| arcsData | array | [] | List of links to represent in the arcs map layer. Each link is displayed as an arc line that rises from the surface of the globe, connecting the start and end coordinates. |startLat
| arcStartLat | number, string or func | | Arc object accessor function, attribute or a numeric constant for the line's start latitude coordinate. |startLng
| arcStartLng | number, string or func | | Arc object accessor function, attribute or a numeric constant for the line's start longitude coordinate. |endLat
| arcStartAltitude | number, string or func | 0 | Arc object accessor function, attribute or a numeric constant for the line's start altitude. |
| arcEndLat | number, string or func | | Arc object accessor function, attribute or a numeric constant for the line's end latitude coordinate. |endLng
| arcEndLng | number, string or func | | Arc object accessor function, attribute or a numeric constant for the line's end longitude coordinate. |() => '#ffffaa'
| arcEndAltitude | number, string or func | 0 | Arc object accessor function, attribute or a numeric constant for the line's end altitude. |
| arcColor | string, [string, ...] or func | | Arc object accessor function or attribute for the line's color. Also supports color gradients by passing an array of colors, or a color interpolator function. |null
| arcAltitude | number, string or func| |Arc object accessor function, attribute or a numeric constant for the arc's maximum altitude (ocurring at the half-way distance between the two points) in terms of globe radius units (0 = 0 altitude (ground line), 1 = globe radius). If a value of null or undefined is used, the altitude is automatically set proportionally to the distance between the two points, according to the scale set in arcAltitudeAutoScale. |1
| arcAltitudeAutoScale | number, string or func | 0.5 | Arc object accessor function, attribute or a numeric constant for the scale of the arc's automatic altitude, in terms of units of the great-arc distance between the two points. A value of indicates the arc should be as high as its length on the ground. Only applicable if arcAltitude is not set. |null
| arcStroke | number, string or func| | Arc object accessor function, attribute or a numeric constant for the line's diameter, in angular degrees. A value of null or undefined will render a ThreeJS Line whose width is constant (1px) regardless of the camera distance. Otherwise, a TubeGeometry is used. |arcStroke
| arcCurveResolution | number | 64 | Arc's curve resolution, expressed in how many straight line segments to divide the curve by. Higher values yield smoother curves. |
| arcCircularResolution | number | 6 | Radial geometric resolution of each line, expressed in how many slice segments to divide the tube's circumference. Only applicable when using Tube geometries (defined ). |1
| arcDashLength | number, string or func | 1 | Arc object accessor function, attribute or a numeric constant for the length of the dashed segments in the arc, in terms of relative length of the whole line ( = full line length). |ms
| arcDashGap | number, string or func | 0 | Arc object accessor function, attribute or a numeric constant for the length of the gap between dash segments, in terms of relative line length. |
| arcDashInitialGap | number, string or func | 0 | Arc object accessor function, attribute or a numeric constant for the length of the initial gap before the first dash segment, in terms of relative line length. |
| arcDashAnimateTime | number, string or func | 0 | Arc object accessor function, attribute or a numeric constant for the time duration (in ) to animate the motion of dash positions from the start to the end point for a full line length. A value of 0 disables the animation. |0
| arcsTransitionDuration | number | 1000 | Duration (ms) of the transition to animate arc changes involving geometry modifications. A value of will move the arcs immediately to their final position. New arcs are animated by rising them from the ground up. |
$3
| Prop | Type | Default | Description |
| --- | :--: | :--: | --- |
| polygonsData | array | [] | List of polygon shapes to represent in the polygons map layer. Each polygon is displayed as a shaped cone that extrudes from the surface of the globe. |geometry
| polygonGeoJsonGeometry | string or func | | Polygon object accessor function or attribute for the GeoJson geometry specification of the polygon's shape. The returned value should have a minimum of two fields: type and coordinates. Only GeoJson geometries of type Polygon or MultiPolygon are supported, other types will be skipped. |() => '#ffffaa'
| polygonCapColor | string or func | | Polygon object accessor function or attribute for the color of the top surface. |polygonCapColor
| polygonCapMaterial | Material, string or func | - | Polygon object accessor function, attribute or material object for the ThreeJS material to use in the top surface. This prop takes precedence over , which will be ignored if both are defined. |() => '#ffffaa'
| polygonSideColor | string or func | | Polygon object accessor function or attribute for the color of the cone sides. |polygonSideColor
| polygonSideMaterial | Material, string or func | - | Polygon object accessor function, attribute or material object for the ThreeJS material to use in the cone sides. This prop takes precedence over , which will be ignored if both are defined. |0
| polygonStrokeColor | string or func | - | Polygon object accessor function or attribute for the color to stroke the polygon perimeter. A falsy value will disable the stroking. |
| polygonAltitude | number, string or func | 0.01 | Polygon object accessor function, attribute or a numeric constant for the polygon cone's altitude in terms of globe radius units ( = 0 altitude (flat polygon), 1 = globe radius). |0
| polygonCapCurvatureResolution | number, string or func | 5 | Polygon object accessor function, attribute or a numeric constant for the resolution (in angular degrees) of the cap surface curvature. The finer the resolution, the more the polygon is fragmented into smaller faces to approximate the spheric surface, at the cost of performance. |
| polygonsTransitionDuration | number | 1000 | Duration (ms) of the transition to animate polygon altitude changes. A value of will size the cone immediately to their final altitude. New polygons are animated by rising them from the ground up. |
$3
| Prop | Type | Default | Description |
| --- | :--: | :--: | --- |
| pathsData | array | [] | List of lines to represent in the paths map layer. Each path is displayed as a line that connects all the coordinate pairs in the path array. |pnts => pnts
| pathPoints | array, string or func | | Path object accessor function, attribute or an array for the set of points that define the path line. By default, each path point is assumed to be a 2-position array ([). This default behavior can be modified using the pathPointLat and pathPointLng methods. |arr => arr[0]
| pathPointLat | number, string or func | | Path point object accessor function, attribute or a numeric constant for the latitude coordinate. |arr => arr[1]
| pathPointLng | number, string or func | | Path point object accessor function, attribute or a numeric constant for the longitude coordinate. |0
| pathPointAlt | number, string or func | 0.001 | Path point object accessor function, attribute or a numeric constant for the point altitude, in terms of globe radius units ( = 0 altitude (ground), 1 = globe radius). |() => '#ffffaa'
| pathResolution | number | 2 | The path's angular resolution, in lat/lng degrees. If the ground distance (excluding altitude) between two adjacent path points is larger than this value, the line segment will be interpolated in order to approximate the curvature of the sphere surface. Lower values yield more perfectly curved lines, at the cost of performance. |
| pathColor | string, [string, ...] or func | | Path object accessor function or attribute for the line's color. Also supports color gradients by passing an array of colors, or a color interpolator function. Transparent colors are not supported in Fat Lines with set width. |null
| pathStroke | number, string or func | | Path object accessor function, attribute or a numeric constant for the line's diameter, in angular degrees. A value of null or undefined will render a ThreeJS Line whose width is constant (1px) regardless of the camera distance. Otherwise, a FatLine is used. |1
| pathDashLength | number, string or func | 1 | Path object accessor function, attribute or a numeric constant for the length of the dashed segments in the path line, in terms of relative length of the whole line ( = full line length). |ms
| pathDashGap | number, string or func | 0 | Path object accessor function, attribute or a numeric constant for the length of the gap between dash segments, in terms of relative line length. |
| pathDashInitialGap | number, string or func | 0 | Path object accessor function, attribute or a numeric constant for the length of the initial gap before the first dash segment, in terms of relative line length. |
| pathDashAnimateTime | number, string or func | 0 | Path object accessor function, attribute or a numeric constant for the time duration (in ) to animate the motion of dash positions from the start to the end point for a full line length. A value of 0 disables the animation. |0
| pathTransitionDuration | number | 1000 | Duration (ms) of the transition to animate path changes. A value of will move the paths immediately to their final position. New paths are animated from start to end. |
$3
| Prop | Type | Default | Description |
| --- | :--: | :--: | --- |
| heatmapsData | array | [] | List of heatmap datasets to represent in the heatmaps map layer. Each set of points is represented as an individual global heatmap with varying color and/or altitude, according to the point density. It uses a Gaussian KDE to perform the density estimation, based on the great-arc distance between points. |pnts => pnts
| heatmapPoints | array, string or func | | Heatmap object accessor function, attribute or an array for the set of points that define the heatmap. By default, each point is assumed to be a 2-position array ([). This default behavior can be modified using the heatmapPointLat and heatmapPointLng methods. |arr => arr[0]
| heatmapPointLat | number, string or func | | Heatmap point object accessor function, attribute or a numeric constant for the latitude coordinate. |arr => arr[1]
| heatmapPointLng | number, string or func | | Heatmap point object accessor function, attribute or a numeric constant for the longitude coordinate. |0
| heatmapPointWeight | number, string or func | 1 | Heatmap point object accessor function, attribute or a numeric constant for the weight of the point. The weight of a point determines its influence on the density of the surrounding area. |
| heatmapBandwidth | number, string or func | 2.5 | Heatmap object accessor function, attribute or a numeric constant for the heatmap bandwidth, in angular degrees. The bandwidth is an internal parameter of the Gaussian kernel function and defines how localized is the influence of a point on distant locations. A narrow bandwidth leads to a more spiky representation, while a broad one has smoother curves. |
| heatmapColorFn | string or func | Turbo colormap interpolator with fading opacity | Heatmap object accessor function or attribute for the color interpolator function to represent density in the heatmap. This function should receive a number between and 1 (or potentially higher if saturation > 1), and return a color string. |[0,1]
| heatmapColorSaturation | number, string or func | 1.5 | Heatmap object accessor function, attribute or a numeric constant for the color scale saturation. The saturation is a multiplier of the normalized density value () before passing it to the color interpolation function. It can be used to dampen outlier peaks in density and bring the data floor into view. |0
| heatmapBaseAltitude | number, string or func | 0.01 | Heatmap object accessor function, attribute or a numeric constant for the heatmap base floor altitude in terms of globe radius units ( = 0 altitude, 1 = globe radius). |0
| heatmapTopAltitude | number, string or func | - | Heatmap object accessor function, attribute or a numeric constant for the heatmap top peak altitude in terms of globe radius units ( = 0 altitude, 1 = globe radius). An equal value to the base altitude will yield a surface flat heatmap. If a top altitude is set, the variations in density will be used to define the altitude curves between base and top. |0
| heatmapsTransitionDuration | number | 0 | Duration (ms) of the transition to animate heatmap changes. A value of will set the heatmap colors/altitudes immediately in their final position. New heatmaps are animated by rising them from the ground up and gently fading in through the color scale. |
$3
| Prop | Type | Default | Description |
| --- | :--: | :--: | --- |
| hexBinPointsData | array | [] | List of points to aggregate using the hex bin map layer. Each point is added to an hexagonal prism 3D object that represents all the points within a tesselated portion of the space. |lat
| hexBinPointLat | number, string or func | | Point object accessor function, attribute or a numeric constant for the latitude coordinate. |lng
| hexBinPointLng | number, string or func | | Point object accessor function, attribute or a numeric constant for the longitude coordinate. |0
| hexBinPointWeight | number, string or func | 1 | Point object accessor function, attribute or a numeric constant for the weight of the point. Weights for points in the same bin are summed and determine the hexagon default altitude. |
| hexBinResolution | number | 4 | The geographic binning resolution as defined by H3. Determines the area of the hexagons that tesselate the globe's surface. Accepts values between and 15. Level 0 partitions the earth in 122 (mostly) hexagonal cells. Each subsequent level sub-divides the previous in roughly 7 hexagons. |0
| hexMargin | number or func | 0.2 | The radial margin of each hexagon. Margins above will create gaps between adjacent hexagons and serve only a visual purpose, as the data points within the margin still contribute to the hexagon's data. The margin is specified in terms of fraction of the hexagon's surface diameter. Values below 0 or above 1 are disadvised. This property also supports using an accessor method based on the hexagon's aggregated data, following the syntax: hexMargin(({ points, sumWeight, center: { lat, lng }}) => ...). This method should return a numeric constant. |({ sumWeight }) => sumWeight * 0.01
| hexAltitude | number or func | | The altitude of each hexagon, in terms of globe radius units (0 = 0 altitude (flat hexagon), 1 = globe radius). This property also supports using an accessor method based on the hexagon's aggregated data, following the syntax: hexAltitude(({ points, sumWeight, center: { lat, lng }}) => ...). This method should return a numeric constant. |() => '#ffffaa'
| hexTopCurvatureResolution | number | 5 | The resolution (in angular degrees) of the top surface curvature. The finer the resolution, the more the top area is fragmented into smaller faces to approximate the spheric surface, at the cost of performance. |
| hexTopColor | func | | Accessor method for each hexagon's top color. The method should follow the signature: hexTopColor(({ points, sumWeight, center: { lat, lng }}) => ...) and return a color string. |() => '#ffffaa'
| hexSideColor | func | | Accessor method for each hexagon's side color. The method should follow the signature: hexSideColor(({ points, sumWeight, center: { lat, lng }}) => ...) and return a color string. |false
| hexBinMerge | bool | | Whether to merge all the hexagon meshes into a single ThreeJS object, for improved rendering performance. Visually both options are equivalent, setting this option only affects the internal organization of the ThreeJS objects. |0
| hexTransitionDuration | number | 1000 | Duration (ms) of the transition to animate hexagon changes related to geometry modifications (altitude, radius). A value of will move the hexagons immediately to their final position. New hexagons are animated by scaling them from the ground up. Only works if hexBinMerge is disabled. |
$3
| Prop | Type | Default | Description |
| --- | :--: | :--: | --- |
| hexPolygonsData | array | [] | List of polygon shapes to represent in the hexed polygons map layer. Each polygon is displayed as a tesselated group of hexagons that approximate the polygons shape according to the resolution specified in hexPolygonResolution. |geometry
| hexPolygonGeoJsonGeometry | string or func | | Hexed polygon object accessor function or attribute for the GeoJson geometry specification of the polygon's shape. The returned value should have a minimum of two fields: type and coordinates. Only GeoJson geometries of type Polygon or MultiPolygon are supported, other types will be skipped. |() => '#ffffaa'
| hexPolygonColor | string or func | | Hexed polygon object accessor function or attribute for the color of each hexagon in the polygon. |0
| hexPolygonAltitude | number, string or func | 0.001 | Hexed polygon object accessor function, attribute or a numeric constant for the polygon's hexagons altitude in terms of globe radius units ( = 0 altitude, 1 = globe radius). |0
| hexPolygonResolution | number, string or func | 3 | Hexed polygon object accessor function, attribute or a numeric constant for the geographic binning resolution as defined by H3. Determines the area of the hexagons that tesselate the globe's surface. Accepts values between and 15. Level 0 partitions the earth in 122 (mostly) hexagonal cells. Each subsequent level sub-divides the previous in roughly 7 hexagons. |0
| hexPolygonMargin | number, string or func | 0.2 | Hexed polygon object accessor function, attribute or a numeric constant for the radial margin of each hexagon. Margins above will create gaps between adjacent hexagons within a polygon. The margin is specified in terms of fraction of the hexagon's surface diameter. Values below 0 or above 1 are disadvised. |false
| hexPolygonUseDots | bool, string or func | | Hexed polygon object accessor function, attribute or a boolean constant for whether to represent each polygon point as a circular dot instead of an hexagon. |0
| hexPolygonCurvatureResolution | number, string or func | 5 | Hexed polygon object accessor function, attribute or a numeric constant for the resolution (in angular degrees) of each hexed polygon surface curvature. The finer the resolution, the more the polygon hexes are fragmented into smaller faces to approximate the spheric surface, at the cost of performance. |
| hexPolygonDotResolution | number, string or func | 12 | Hexed polygon object accessor function, attribute or a numeric constant for the resolution of each circular dot, expressed in how many slice segments to divide the circumference. Higher values yield smoother circles, at the cost of performance. This is only applicable in dot representation mode. |
| hexPolygonsTransitionDuration | number | 0 | Duration (ms) of the transition to animate hexed polygons altitude and margin changes. A value of will move the hexagons immediately to their final state. New hexed polygons are animated by sizing each hexagon from 0 radius. |
$3
| Prop | Type | Default | Description |
| --- | :--: | :--: | --- |
| tilesData | array | [] | List of tiles to represent in the tiles map layer. Each tile is displayed as a spherical surface segment. The segments can be placed side-by-side for a tiled surface and each can be styled separately. |lat
| tileLat | number, string or func | | Tile object accessor function, attribute or a numeric constant for the segment's centroid latitude coordinate. |lng
| tileLng | number, string or func | | Tile object accessor function, attribute or a numeric constant for the segment's centroid longitude coordinate. |true
| tileAltitude | number, string or func | 0.01 | Tile object accessor function, attribute or a numeric constant for the segment's altitude in terms of globe radius units. |
| tileWidth | number, string or func | 1 | Tile object accessor function, attribute or a numeric constant for the segment's longitudinal width, in angular degrees. |
| tileHeight | number, string or func | 1 | Tile object accessor function, attribute or a numeric constant for the segment's latitudinal height, in angular degrees. |
| tileUseGlobeProjection | bool, string or func | | Tile object accessor function, attribute or a boolean constant for whether to use the globe's projection to shape the segment to its relative tiled position (true), or break free from this projection and shape the segment as if it would be laying directly on the equatorial perimeter (false). |() => new MeshLambertMaterial({ color: '#ffbb88' })
| tileMaterial | Material, string or func | | Tile object accessor function, attribute or material object for the ThreeJS material used to style the segment's surface. |0
| tileCurvatureResolution | number, string or func | 5 | Tile object accessor function, attribute or a numeric constant for the resolution (in angular degrees) of the surface curvature. The finer the resolution, the more the tile geometry is fragmented into smaller faces to approximate the spheric surface, at the cost of performance. |
| tilesTransitionDuration | number | 1000 | Duration (ms) of the transition to animate tile changes involving geometry modifications. A value of will move the tiles immediately to their final position. New tiles are animated by scaling them from the centroid outwards. |
$3
| Prop | Type | Default | Description |
| --- | :--: | :--: | --- |
| particlesData | array | [] | List of particle sets to represent in the particles map layer. Each particle set is displayed as a group of Points. Each point in the group is a geometry vertex and can be individually positioned anywhere relative to the globe. |d => d
| particlesList | string or func | | Particle set accessor function or attribute for the list of particles in the set. By default, the data structure is expected to be an array of arrays of individual particle objects. |lat
| particleLat | number, string or func | | Particle object accessor function, attribute or a numeric constant for the latitude coordinate. |lng
| particleLng | number, string or func | | Particle object accessor function, attribute or a numeric constant for the longitude coordinate. |true
| particleAltitude | number, string or func | 0.01 | Particle object accessor function, attribute or a numeric constant for the altitude in terms of globe radius units. |
| particlesSize | number, string or func | 0.5 | Particle set accessor function, attribute or a numeric constant for the size of all the particles in the group. |
| particlesSizeAttenuation | bool, string or func | | Particle set accessor function, attribute or a boolean constant for whether the size of each particle on the screen should be attenuated according to the distance to the camera. |white
| particlesColor | string or func | | Particle set accessor function or attribute for the color of all the particles in the group. This setting will be ignored if particlesTexture is defined. |
| particlesTexture | string or func | - | Particle set accessor function or attribute for the Texture to be applied to all the particles in the group. |
$3
| Prop | Type | Default | Description |
| --- | :--: | :--: | --- |
| ringsData | array | [] | List of self-propagating ripple rings to represent in the rings map layer. Each data point is displayed as an animated set of concentric circles that propagate outwards from (or inwards to) a central point through the spherical surface. |lat
| ringLat | number, string or func | | Ring object accessor function, attribute or a numeric constant for each circle's center latitude coordinate. |lng
| ringLng | number, string or func | | Ring object accessor function, attribute or a numeric constant for each circle's center longitude coordinate. |() => '#ffffaa'
| ringAltitude | number, string or func | 0.0015 | Ring object accessor function, attribute or a numeric constant for the circle's altitude in terms of globe radius units. |
| ringColor | string, [string, ...] or func | | Ring object accessor function or attribute for the stroke color of each ring. Also supports radial color gradients by passing an array of colors, or a color interpolator function. |maxRadius
| ringResolution | number | 64 | Geometric resolution of each circle, expressed in how many slice segments to divide the circumference. Higher values yield smoother circles. |
| ringMaxRadius | number, string or func | 2 | Ring object accessor function, attribute or a numeric constant for the maximum outer radius of the circles, at which the rings stop propagating and are removed. Defined in angular degrees. |
| ringPropagationSpeed | number, string or func | 1 | Ring object accessor function, attribute or a numeric constant for the propagation velocity of the rings, defined in degrees/second. Setting a negative value will invert the direction and cause the rings to propagate inwards from the . |0
| ringRepeatPeriod | number, string or func | 700 | Ring object accessor function, attribute or a numeric constant for the interval of time (in ms) to wait between consecutive auto-generated concentric circles. A value less or equal than will disable the repetition and emit a single ring. |
$3
| Prop | Type | Default | Description |
| --- | :--: | :--: | --- |
| labelsData | array | [] | List of label objects to represent in the labels map layer. |lat
| labelLat | number, string or func | | Label object accessor function, attribute or a numeric constant for the latitude coordinate. |lng
| labelLng | number, string or func | | Label object accessor function, attribute or a numeric constant for the longitude coordinate. |text
| labelText | string or func | | Label object accessor function or attribute for the label text. |() => 'lightgrey'
| labelColor | string or func | | Label object accessor function or attribute for the label color. |true
| labelAltitude | number, string or func | 0.002 | Label object accessor function, attribute or a numeric constant for the label altitude in terms of globe radius units. |
| labelSize | number, string or func | 0.5 | Label object accessor function, attribute or a numeric constant for the label text height, in angular degrees. |
| labelTypeFace | typeface object | helvetiker regular | Text font typeface JSON object. Supports any typeface font generated by Facetype.js. |
| labelRotation | number, string or func | 0 | Label object accessor function, attribute or a numeric constant for the label rotation in degrees. The rotation is performed clockwise along the axis of its latitude parallel plane. |
| labelResolution | number | 3 | The text geometric resolution of each label, expressed in how many segments to use in the text curves. Higher values yield smoother labels. |
| labelIncludeDot | bool, string or func | | Label object accessor function, attribute or a bool constant for whether to include a dot marker next to the text indicating the exact lat, lng coordinates of the label. If enabled the text will be rendered offset from the dot. |() => 'bottom'
| labelDotRadius | number, string or func | 0.1 | Label object accessor function, attribute or a numeric constant for the radius of the dot marker, in angular degrees. |
| labelDotOrientation | string or func | | Label object accessor function or attribute for the orientation of the label if the dot marker is present. Possible values are right, top and bottom. |lat
| labelsTransitionDuration | number | 1000 | Duration (ms) of the transition to animate label changes involving position modifications (, lng, altitude, rotation). A value of 0 will move the labels immediately to their final position. New labels are animated by scaling their size. |
$3
| Prop | Type | Default | Description |
| --- | :--: | :--: | --- |
| htmlElementsData | array | [] | List objects to represent in the HTML elements map layer. Each HTML element is rendered using ThreeJS CSS2DRenderer. |lat
| htmlLat | number, string or func | | HTML element accessor function, attribute or a numeric constant for the latitude coordinate of the element's central position. |lng
| htmlLng | number, string or func | | HTML element accessor function, attribute or a numeric constant for the longitude coordinate of the element's central position. |null
| htmlAltitude | number, string or func | 0 | HTML element accessor function, attribute or a numeric constant for the altitude coordinate of the element's position, in terms of globe radius units. |
| htmlElement | string or func | | Accessor function or attribute to retrieve the DOM element to use. Should return an instance of HTMLElement. |0
| htmlTransitionDuration | number | 1000 | Duration (ms) of the transition to animate HTML elements position changes. A value of will move the elements immediately to their final position. |
$3
| Prop | Type | Default | Description |
| --- | :--: | :--: | --- |
| objectsData | array | [] | Getter/setter for the list of custom 3D objects to represent in the objects layer. Each object is rendered according to the objectThreeObject method. |lat
| objectLat | number, string or func | | Object accessor function, attribute or a numeric constant for the latitude coordinate of the object's position. |lng
| objectLng | number, string or func | | Object accessor function, attribute or a numeric constant for the longitude coordinate of the object's position. |{x, y, z}
| objectAltitude | number, string or func | 0.01 | Object accessor function, attribute or a numeric constant for the altitude coordinate of the object's position, in terms of globe radius units. |
| objectRotation | {[x], [y], [z]}, string or func | | Object accessor function, attribute or a object for the object's rotation (in degrees). Each dimension is optional, allowing for rotation only in some axes. Rotation is applied in the order X->Y->Z. |true
| objectFacesSurface | bool, string or func | | Object accessor function, attribute or a boolean constant for whether the object should be rotated to face (away from) the globe surface (true), or be left in its original universe orientation (false). |
| objectThreeObject | Object3d, string or func | A yellow sphere | Object accessor function or attribute for defining a custom 3d object to render as part of the objects map layer. Should return an instance of ThreeJS Object3d. |
$3
| Prop | Type | Default | Description |
| --- | :--: | :--: | --- |
| customLayerData | array | [] | List of items to represent in the custom map layer. Each item is rendered according to the customThreeObject method. |customThreeObjectUpdate((obj, objData) => { ... })
| customThreeObject | Object3d, string or func| - |Object accessor function or attribute for generating a custom 3d object to render as part of the custom map layer. Should return an instance of ThreeJS Object3d. |
| customThreeObjectUpdate | string or func| - |Object accessor function or attribute for updating an existing custom 3d object with new data. This can be used for performance improvement on data updates as the objects don't need to be removed and recreated at each update. The callback method's signature includes the object to be update and its new data: . |
$3
| Prop | Type | Default | Description |
| --- | :--: | :--: | --- |
| onClick | func | - | Callback function for globe element clicks. The type of layer, the associated data object (if exists) and the event object are included as arguments: onClick(layer, elementData, event). |undefined
| onHover | func | - | Callback function for globe element mouse over events. The type of layer (or if it's hovering off the globe) and the associated data object (if exists) are included as arguments: onHover(layer, elementData). |
$3
| Prop | Type | Default | Description |
| --- | :--: | :--: | --- |
| rendererSize | Vector2 | Fallback to the full browser window size (THREE.Vector2(window.innerWidth, window.innerHeight)) | It's recommended to inject the current renderer size to ensure the object proportions remain constant. This is specially necessary when using path FatLines. |
| Method | Arguments | Description |
| --- | :--: | --- |
| pauseAnimation| - | Pauses the animation on all globe layers. |
| resumeAnimation| - | Resumes the animation on all globe layers. |
| setPointOfView | (camera) | Some layers require knowledge about the location and view direction of the camera in order to behave correctly. Every time the camera position changes (f.e. on the controls onChange event) it's recommended to invoke this function, passing the current camera as sole argument, in order to keep the layers running optimally and synchronized with the view. |
$3
| Method | Arguments | Description |
| --- | :--: | --- |
| getGlobeRadius | - | Returns the cartesian distance of a globe radius in absolute spatial units. |
| getCoords | lat, lng [,altitude=0] | Utility method to translate spherical coordinates to cartesian. Given a pair of latitude/longitude coordinates and optionally altitude (in terms of globe radius units), returns the equivalent {x, y, z} cartesian spatial coordinates. |{x, y, z}
| toGeoCoords | { x, y, z } | Utility method to translate cartesian coordinates to the geographic domain. Given a set of 3D cartesian coordinates , returns the equivalent {lat, lng, altitude}` spherical coordinates. Altitude is defined in terms of globe radius units. |
[npm-img]: https://img.shields.io/npm/v/r3f-globe
[npm-url]: https://npmjs.org/package/r3f-globe
[build-size-img]: https://img.shields.io/bundlephobia/minzip/r3f-globe
[build-size-url]: https://bundlephobia.com/result?p=r3f-globe
[npm-downloads-img]: https://img.shields.io/npm/dt/r3f-globe
[npm-downloads-url]: https://www.npmtrends.com/r3f-globe