Difference between revisions of "Visualization options"
Line 90: | Line 90: | ||
[[Category:Setup_and_Configuration]] | [[Category:Setup_and_Configuration]] | ||
− | + | sphinx2022 configuration |
Latest revision as of 17:38, 19 April 2022
[Available for v1.4]
Overview
Visualization options allow a user to plot search and browse results in a variety of ways based on contextual metadata (i.e. dates, coordinates). Settings are handled in a configuration file called visualization.conf. Currently there are two visualization plugins supported: Maps and Timelines.
Maps
basic_map = { name = _("Map"),
Multiple map visualizations can be created if your system has multiple geolocation fields. The name setting allows you to uniquely reference each one in the Visualization drop-down menu.
plugin = Map, sources = { georef = { data = ca_objects.georeference,
Set data to the metadata element code where your location information is stored.
display = { title_template = <l>^ca_objects.preferred_labels.name</l> (^ca_objects.idno), description_template = <div style='float:right; margin-left: 8px;'>^ca_object_representations.media.preview</div>^ca_objects.descriptionSet the formatting for the metadata that will display on each mapped coordinate. Enter as table_name.elementCode.
} } }, options = { width = 100%, height = 100%Set screen size options.
} },
Timelines
basic_timeline = { name = _("Timeline"),
As with maps, multiple timeline visualizations can be created if your system has multiple date fields. The name set here will appear in the visualization drop-down menu.
plugin = Timeline, sources = { lifespan = { data = ca_entities.lifespan,
Set data to the metadata element code where your dates are stored. Must be a DateRange datatype field.
display = { title_template = ca_entities.preferred_labels.name, description_template = ca_entities.biographySet the formatting for the metadata that will display on each entry of the timeline. Enter as table_name.elementCode. For containers (as shown above) enter as table_name.containerElementCode.subElementCode.
} } }, options = { width = 100%, height = 100% } } }
You can also customize the appearance of your timeline - for example, you may want to color code a certain time period so that you can easily see which objects fall into a certain era. An example could be:
options = { width = 100%, height = 100%, highlightSpans = { confederation = { label = Confederation, range = 9/13/1759 to 7/1/1867, startLabel = 1759, endLabel = Confederation, color = #FFC080
sphinx2022 configuration