Honeycomb DocsConfig Files
Config files store the entire state (metadata) of a Honeycomb analysis, excluding the actual data used for the analysis. Honeycomb config files use the .json file format.
One of the main use cases of config files is to create a Honeycomb analysis programatically, for example as the last step in a data processing pipeline. Config files can be combined with URL Parameters to create dynamic maps on-the-fly.
Exporting a config file
To export a config file which represents the current state of a Honeycomb map, click on 'Share' on the left-hand sidebar, and then click on 'Save Config File JSON'.
JSON Config Files vs. .honey Files
JSON Config Files (referred to just as 'Config Files' on this page) only contain the metadata for an analysis and are meant to be created or edited manually or by external tools.
Honey Files (.honey) are a zipped file format which contains both the analysis metadata and local data. They are meant as a way to save an analysis locally to work on later, however, they are planned to be deprecated in favor of a web-based editing model. They are not meant to be created or edited manually. Their schema and design may change at any time, breaking compatibility with existing tools and files.
Importing a config file
To import a config file, simply load it like any other local or remote file.
TIP
Config files must have the .json file extension. If you would like to load a data file in the GeoJSON format, it must have the .geojson extension to be recognized correctly.
Using a config file as a URL parameter
Config files can be combined with URL Parameters to create dynamic maps on-the-fly. See the Config File Section of the URL Parameter page for more information.
Using multiple parquet data files as a single source
If your data is stored as a Parquet dataset, containing multiple files and directories in partitions, you can supply a list of .parquet file locations to the location parameter of a source. You can find an example on GitHub.
Example config file
Below is an example of a config file. You can find the raw file on GitHub.
{
"sources": [
{
"id": 0,
"type": "remote_file",
"name": "Kontur Data",
"location": "https://app.honeycomb.place/data/world_population_sorted_rg_122880_zstd.parquet"
}
],
"layers": [
{
"name": "Population",
"description": "Number of people residing in the area",
"color": "#D1980B",
"opacity": 0.4,
"selected": true,
"aggregationType": "SUM",
"sourceId": 0,
"calculateMetrics": true,
"columnName": "population"
}
],
"objects": [
{
"id": 0,
"name": "The Loop",
"geo": {
"type": "Feature",
"properties": {
"selected": true
},
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-87.637884,
41.887189
],
[
-87.629063,
41.887476
],
[
-87.622822,
41.888926
],
[
-87.612689,
41.888295
],
[
-87.616185,
41.880014
],
[
-87.616241,
41.873398
],
[
-87.635256,
41.873447
],
[
-87.638012,
41.877559
],
[
-87.637884,
41.887189
]
]
]
}
},
"selected": true,
"stats": [
{
"id": 0,
"name": "Population",
"value": 23495,
"aggregationType": "SUM",
"color": "#D1980B"
}
],
"buffer_size": 0,
"type": "Polygon"
}
],
"title": "Chicago Loop Population",
"description": "A visualization of the number of people who live in the Loop, with data from Kontur.",
"viewState": {
"width": 1512,
"height": 774,
"latitude": 41.88300745716074,
"longitude": -87.62130918779111,
"zoom": 12.815030667706257,
"bearing": 0,
"pitch": 0,
"altitude": 1.5,
"maxZoom": 20,
"minZoom": 2.4,
"maxPitch": 60,
"minPitch": 0,
"position": [
0,
0,
0
]
},
"settings": {
"layerDisplayResolution": "high",
"tooltipsEnabled": true,
"isLayerSidebarVisible": true,
"isObjectSidebarVisible": true,
"isTitleDescriptionEditable": false
}
}{
"sources": [
{
"id": 0,
"type": "remote_file",
"name": "Kontur Data",
"location": "https://app.honeycomb.place/data/world_population_sorted_rg_122880_zstd.parquet"
}
],
"layers": [
{
"name": "Population",
"description": "Number of people residing in the area",
"color": "#D1980B",
"opacity": 0.4,
"selected": true,
"aggregationType": "SUM",
"sourceId": 0,
"calculateMetrics": true,
"columnName": "population"
}
],
"objects": [
{
"id": 0,
"name": "The Loop",
"geo": {
"type": "Feature",
"properties": {
"selected": true
},
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
-87.637884,
41.887189
],
[
-87.629063,
41.887476
],
[
-87.622822,
41.888926
],
[
-87.612689,
41.888295
],
[
-87.616185,
41.880014
],
[
-87.616241,
41.873398
],
[
-87.635256,
41.873447
],
[
-87.638012,
41.877559
],
[
-87.637884,
41.887189
]
]
]
}
},
"selected": true,
"stats": [
{
"id": 0,
"name": "Population",
"value": 23495,
"aggregationType": "SUM",
"color": "#D1980B"
}
],
"buffer_size": 0,
"type": "Polygon"
}
],
"title": "Chicago Loop Population",
"description": "A visualization of the number of people who live in the Loop, with data from Kontur.",
"viewState": {
"width": 1512,
"height": 774,
"latitude": 41.88300745716074,
"longitude": -87.62130918779111,
"zoom": 12.815030667706257,
"bearing": 0,
"pitch": 0,
"altitude": 1.5,
"maxZoom": 20,
"minZoom": 2.4,
"maxPitch": 60,
"minPitch": 0,
"position": [
0,
0,
0
]
},
"settings": {
"layerDisplayResolution": "high",
"tooltipsEnabled": true,
"isLayerSidebarVisible": true,
"isObjectSidebarVisible": true,
"isTitleDescriptionEditable": false
}
}