servers.json
file to define the default connection behavior in Heavy Immerse. It describes how to enable default behavior using servers.json
, provides basic syntax, and includes examples. You can define the HEAVY.AI database to connect to, as well as the username and password. You can also configure Immerse to use additional tile sources for geo charts.servers.json
file, you must first edit heavy.conf
to include servers.json
information:heavy.conf
. For information about heavy.conf
and available options, see Configuration Parameters.[web]
section of heavy.conf
, reference servers.json
by adding the following line:servers.json
.heavy.conf
."database": "<database_name>"
"host": "<hostname>"
"loadDashboard": "<id>"
"login_panel_databases" : [ "database_1", "database_2", "database_3" ]
database
key, it should be one of the databases listed in login_panel_databases
, which is then selected by default."password": "<password>"
"port": "<port_number>"
"protocol": "<protocol>"
http
or https
."url": "<URL>"
"username": "<username>"
"offline": true
true
to help Immerse identify an offline environment and show a basemap (countries boundary geojson polygons) for Geo charts. Otherwise, Immerse shows Mapbox basemaps and any custom basemaps you have defined."enableJupyter": <boolean>
true
to enable Jupyter features in Immerse. For more information, see JupyterLab Installation and Configuration."SAMLUrl": "<url>"
"customStyles": "<[options]>"
"mapboxCustomStyles": "<[options]>"
servers.json
file to control the default configuration when you log in to Heavy Immerse. The information in servers.json
can identify the database you connect to and credentials to use during automatic login.servers.json
does not exist yet, create a file by that name in the HEAVYAI_STORAGE directory.servers.json
, specify the database to connect to, as well as username and password information. You can use host, port, and protocol to specify the path to the data:servers.json
.servers.json
must be formatted as an array.feature_flags
section lets you set global default settings for the Immerse user interface."ui/dashboard_tabs": <boolean>
true
to enable the tabbed interface for dashboards. Tabbed interface is enabled by default (true
)."ui/default_filter_panel_open": <boolean>
false
)."ui/default_simple_filters": <boolean>
true
."ui/default_theme": "light" | "dark"
servers.json
, that default theme is used.dark
mode."ui/enable_auto_dashboard_refresh": <boolean>
true
to enable dashboard Auto Refresh dropdown dialog (default). When set to false
, the Refresh button is still available, but the Auto Refresh dropdown option is unavailable. "ui/enable_brush_filter_edits_from_chart": <boolean>
true
to enable editing of Combo chart brush ranges through text input in the upper-right corner of the chart. Disabled by default (false
)."ui/enable_data_catalog": <boolean>
true
by default. Set the value to false
to disable and hide the Data Catalog."ui/enable_linked_zoom": <boolean>
false
). Set to true
to enable linked zoom. Enabling linked zoom can impact performance."ui/enable_map_exports": <boolean>
true
to enable geoJSON and CSV export for Choropleth, Linemap, and Pointmap charts. Disabled by default (false
)."ui/enable_new_combo_chart": <boolean>
true
by default. Set to false
to disable New Combo charts."ui/enable_unrestricted_
percentage_view_pie_chart": <boolean>
false
), Pie chart percentage labels and All Others slice options can only be toggled on for a # Records or SUM() aggregate. Set to true
to allow percentage labels to be toggled on or off for any aggregate value in a Pie chart."ui/geojoined-bounding-boxes":<boolean
>false
) the bounding box of the geo table does not affect the fact table. If you pan or zoom on the Choropleth chart, other charts on the fact table are not affected.true
for panning and zooming on a geojoined Choropleth chart to affect other charts on the fact table."ui/map_export_limit": <number>
"ui/pointmap_default_points": <number>
pointmap_max_points
. Default: 10,000,000."ui/pointmap_max_points": <number>
"ui/restricted_viewing": <boolean>
true
, a user with VIEW-only access to a dashboard and no EDIT privileges cannot add new charts or modify existing charts. Default: false
."ui/shift_to_zoom": <boolean>
true
to require that the Shift key be held down for pan/zoom actions on Combo and Map charts. By default, the Shift key is not required (false
)."ui/show_ui_config_panel": <boolean>
true
). Set to false
to make the panel unavailable."ui/show_ui_config_panel_axis_trunc": <boolean>
true
). Set to false
to make Label defaults unavailable.customStyles
JSON object to servers.json
. Use the customStyles
elements to:buttonPrimaryColor
buttonSecondaryHighlightColor
colors
custom
darkThemeLogoURL
logoURL
is used for both light and dark mode.disableHelpMenu
true
to disable Help dropdown on the navigation bar.loginText
logoURL
darkThemeLogoURL
, the logo defined in logoURL
is used for light mode only. If no dark mode logo is configured, the logo defined in logoURL
is used for both light and dark mode.ordinal
quantitative
secondaryButtonColor
solid
title
servers.json
file that includes customization. When you want to change any of the settings in servers.json
, you must replace all settings in servers.json
, even if you duplicate the default values.servers.json
, you can use custom map styles created with Mapbox Studio, as well as third-party OGC-compliant raster tile sources.mapboxCustomStyles
property, and then define the source.mapboxCustomStyles
is an array, and that the objects in the array have label
and value
properties. To avoid errors, consider using a JSON validator like JSON Lint to make sure the code is correctly formatted before starting Immerse.mapboxCustomStyles
property, in the following order: