@mk7s/holochart-traces-geo
Classes
| Class | Description |
|---|---|
| GeoSubplot | A geo subplot laid out (see the module comment). |
| GeoView | One geo subplot's projection and view. Build it with createGeoView. |
Interfaces
| Interface | Description |
|---|---|
| BasemapLayers | The basemap of one resolution and scope, decoded to GeoJSON in degrees (ADR-024). Polygons are wound the way d3-geo expects (clockwise outer rings on the sphere), so they stream without a rewind. A layer that failed to load, or was not asked for, is absent. |
| BasemapOptions | Options of loadBasemap and peekBasemap. |
| ChoroplethCalc | - |
| ChoroplethTraceMarker | Outline and opacity of the regions. |
| ChoroplethTraceMarkerLine | The outlines of the regions. |
| ChoroplethTraceSelected | How the selected regions are drawn while a selection is active. |
| ChoroplethTraceSelectedMarker | Style of the selected regions. |
| ChoroplethTraceUnselected | How the unselected regions are drawn while a selection is active. |
| ChoroplethTraceUnselectedMarker | Style of the unselected regions. |
| CountryProperties | Properties of a country feature of the basemap. |
| FullGeoAxis | layout.geo.lonaxis / lataxis after defaults. |
| FullGeoLayout | One layout.geo container after defaults (fullLayout.geo, fullLayout.geo2, …). |
| FullGeoProjection | layout.geo.projection after defaults. |
| GeoViewState | What an interaction changes about a view. |
| LocatedFeature | A feature that locations name. One object per feature and source, shared by its locations. |
| LocationsRequest | The location attributes of a trace (see locationsOf). |
| LocationsResult | The answer of locate; treat it as frozen, traces with the same locations share it. |
| ScattergeoCalc | - |
| ScattergeoTraceLine | Line style (mode lines). Each segment follows the great circle between its points. |
| ScattergeoTraceMarker | Marker style (mode markers). |
| SubunitProperties | Properties of a subunit feature (a US state and the like). |
Type Aliases
| Type Alias | Description |
|---|---|
| ChoroplethTrace | A choropleth map: the regions that locations name (countries, US states, or the features of a geojson) filled with the colors of their z values, on a map-projection subplot (layout.geo). |
| GeoResolution | layout.geo.resolution: the Natural Earth scale denominator in millions. |
| GeoScope | Plotly's layout.geo.scope values. |
| LocationMode | Plotly's locationmode values. |
| ScattergeoTrace | Markers, great-circle lines, text and filled areas at longitudes and latitudes on a map-projection subplot (layout.geo). |
| TracesGeo | Any trace of @mk7s/holochart-traces-geo, discriminated on type. Type a partial bundle's figures with it: FigureInput<TracesGeo>. |
Variables
| Variable | Description |
|---|---|
| choropleth | - |
| choroplethAttributes | - |
| geoAttributes | The geo subplot container family (geo, geo2, …). |
| geoComponent | The geo component: draws the base layers of geo subplots and runs their pan, zoom and rotation (see the module comment). Register it with the geo traces. |
| GLOBE_PROJECTION | The 3D globe (backlog GEO8, ADR-028): the one projection.type that is Holochart's own and not one of Plotly's, which is why it is in neither table above. Its view is the orthographic one (geoOrthographic, the same spans, clip angle, fit and interaction); what differs is how the subplot is drawn, as a sphere in a 3D viewport. |
| scattergeo | - |
| scattergeoAttributes | - |
| tracesGeo | Every geo module, for register(...tracesGeo). |
Functions
| Function | Description |
|---|---|
| loadBasemap | The basemap layers of one resolution and scope, decoded to GeoJSON. |