Output¶
Searching¶
Nivio indexes all landscape items in an in-memory search engine called Lucene. You can build sophisticated queries on various item fields (see Model and Syntax). For further information see https://www.lucenetutorial.com/lucene-query-syntax.html
Modifying Item Appearance¶
Icons by Type¶
The icon of an item is determined by its item type (e.g. server, database, …) and defaults to a cog symbol.
1 2 3 | items: - identifier: bar type: database |
As type values all items from https://materialdesignicons.com/ can be chosen. Just add the icon name without the “SVG” suffix, like “account”.
1 2 3 | items: - identifier: bar type: account |
Alternatively you can use any icon name on the icon field.
1 2 3 | items: - identifier: bar icon: flash-circle |
Vendor Logos¶
The icon property can also work with a predefined vendor name, like “redis”, prefixed with vendor://
as scheme.
Vendor icons are work in progress.
1 2 3 | items: - identifier: bar icon: vendor://redis |
To change the appearance of an item to a vendor logo the icon
or fill
properties can be set.
Both properties take a valid URL.
External Images¶
To include external images in the map, just set the icon
property (or fill) to a valid URL.
1 2 3 | items: - identifier: foo icon: http://my.custom/icon.png |
Background fill¶
While icon (see External Images above) is rendered as centered image on the node, fill is used to paint the entire background and is more suitable to be used with images, photos, and so on.
1 2 3 | items: - identifier: bar fill: http://my.custom/background.png |
UTF-8 Symbols and shortname as Icons¶
If NO icon, type, or fill value is set, but a shortname value is given, the value is displayed on the icon. The first
example would display FOOBAR
on the item and the second an enlarged unicorn symbol (shortnames less than three characters are
enlarged).
1 2 3 4 5 | items: - identifier: bar shortname: FOOBAR - identifier: pony shortname: 🦄 |
Custom(er) Branding¶
The appearance of rendered maps can be altered to match corporate identities. When an SVG map is created, Nivio tries to load and include custom CSS from a URL which can be configured in the landscape configuration. Furthermore, a logo can be included. A logo is configured in the landscape config and must be a URL pointing to an includable file.
1 2 3 4 5 6 7 8 9 10 | identifier: branded_landscape name: branded config: branding: mapStylesheet: https://acme.com/css/acme.css mapLogo: https://acme.com/images/logo.png items: ... |
You can also apply custom colors to the user interface. Set the following environment variables to hex values (e.g. #234234
):
NIVIO_BRANDING_FOREGROUND
to set the primary color for interface elementsNIVIO_BRANDING_BACKGROUND
for the background color (dark grey is default)NIVIO_BRANDING_SECONDARY
to set the accent color used for active elements