The Advanced settings of a collection makes it possible to override the collection default settings. This includes customising the user interface elements to add or remove specific components.

This area requires the use of some configuration code and in most cases you may need to be familiar with the JSON data format.

Advanced settings

The configuration section to be updated can be selected from the drop down list. Once selected the JSON configuration object can be entered into the text box. Clicking the Add button will then validate the JSON object and add it to the collection.

A more detailed explanation of the configuration sections is below.


Extensions are plugins that add custom functionality that is outside of regular plugin functionality (Views, Toolbar items or Facets). This makes it possible to inject custom functionality to extend Zegami in a multitude of ways.


The Web Viewer extension is used to allows for custom URL's to display in a modal window within Zegmai. The window is then accessed via a customisable button which is at the top of the metadata panel of each item.

Web Viewer buttons

The WebViewer URL can be customised and data bound to the selected item, which means dynamic URL's can be created based on the items metadata.

Web Viewer buttons

To configure the WebViewer extension a WebViewer key needs to be added to the Extensions object, which contains an array of configuration items:

  "WebViewer": [
          "url": "{{ID}}",
          "icon": "fa-tachometer",
          "label": "Dashboard"

The example above registeres a WebViewer plugin to the extensions object. The plugin value is an array of configuration objects, making it possible to have multiple WebViewer plugins available within Zegami.

Each configuration item in the array needs the following elements:

url - The url to open in the modal dialog. This can be databoud to the data item using mustache syntax, where the column name is surrounded in opening and closing curley braces i.e. {{ID}}

icon - the name of the icon to use for the button. Zegami uses Font Awesome for all of its icons.

label - the button label text

Facet Types

Custom Facet Types are used to add custom facet filters, facet actions or data types to the filter panel.

{"string": { "itemLimit": 50 }, "geo": { "views": { "Map": {} }, "actions": ["Expand"]}}

Track Visited

The Track Visited setting is used to enable the selected border around previously clicked items.

Track Visited

The Track Visited value is either true or false

true | false


The Toolbar settings is used to configure the toolbar items. By default the toolbar is configured as and array of toolbar items:

    {"type": "snapshot"},
    {"type": "export"},
    {"type": "labels", "enabled": false},
    {"type": "grouptag"},
    {"type": "download"}

Which results in


The order of the items can be changed by reordering the items. At a minimum each toolbar item has the following settings:

type - the type or name of the toolbar item

visible - if the item is visible, the default is true


The View settings is used to add new, reorder and configure views. By default the views are configured as an array of view items:

    {"name": "grid", type: "Grid", "options": {"icon": "fa-th", "tileManager": "dz"}},
    {"name": "graph", type: "Graph", "options": {"icon": "fa-bar-chart", "tileManager": "dz"}},
    {"name": "table", type: "Table", "options": {"icon": "fa-th", "tileManager": "dz"}}

Which results in


At a minimum each view has the following settings:

name - the name of the view, this is used to map to the view button label

type - the name of the registered plugin

options - an object to configure view specific options:

  • icon - the name of the icon to use for the button. Zegami uses Font Awesome for all of its icons.

  • tileManager - the name of the registered tileManager plugin. The default tile manager is dz or DeepZoom

Map View and Map Filter

The Map View and Map Filter is an optional extra for Zegami that allows for items that have geographic or spatial coordinates to be displayed on a map view.

Map View

and filtered with a map filter

Map Filter

The Map View and Filter can be enabled and configured via the Advanced settings for a colleciton.

  1. Select Facet Types from the select list and enter the following JSON object:
    {"string": { "itemLimit": 50 }, "geo": { "views": { "Map": {} }, "actions": ["Expand"]}}
  2. Next select Views from the select list and enter the follwoing JSON object:
    [{"name": "grid", "type": "Grid", "options": {"icon": "fa-th", "tileManager": "dz"}}, {"name": "graph", "type": "Graph", "options": {"icon": "fa-bar-chart", "tileManager": "dz"}}, {"name": "table", "type": "Table", "options": {"icon": "fa-th"}}, {"name": "map", "type": "Map", "options": {"icon": "fa-map-marker", "tileManager": "dz"}}]

The new settings should look like this

Map View settings