|
<< Click to Display Table of Contents >> Navigation: Support > Athena Support > Spectator Displays > Composing Configuration Files for the Spectator Displays > View Definition Files |
Description
A View Definition defines a screen that is displayed by a Spectator Display at one moment in time. It defines the Display Entity to show, the Display Entity's configuration, and options to show or hide the top and bottom strip.
View Definition files are JSON text files that must be edited by hand. They are located in the My Matches/DATABASE/Display/ViewDefinitions folder.
Files who's name start with "Athena" are reserved for use by Orion. Do not edit these files as upgrades to Orion may overwrite them. It is permissible to copy these files and edit the copies.
Fields
Name |
Value Type |
Description |
ViewName |
String |
A unique name given to this View Definition. Names beginning with "Athena" are reserved for use by Orion. |
EntityName |
String |
The name of the Display Entity to show. Must be a known Display Entity name. |
Configuration |
Dictionary with name value pairs. |
Configuration options for the Display Entity. Each Display Entity has it's own set of options. See the "Configuration Options" section for valid values. |
ReplaceAttributes |
List of strings. |
In the Configuration dictionary, there are two fields that Orion will replace, if there name is listed in ReplaceAttributes, with match specific result list names. These values are: •ResultList: Orion will replace the value with the name of the first primary result list. •ResultLists: Orion will replace the value with the list of primary result list. Typically two to four in each match. |
ShowTopStrip |
Boolean |
True if the top match information strip is shown. |
ShowBottomStrip |
Boolean |
True if the bottom marquee strip is shown. |
Description |
String |
A brief human-readable description of the View Definition contents |
Example
{
"ViewName": "AthenaResultListByAvg",
"EntityName": "ResultList",
"Config": {
"ResultLists": [],
"ByRelay": true,
"SortByAvg": true
},
"ReplaceAttributes" : ["ResultLists"],
"ShowTopStrip": true,
"ShowBottomStrip": true,
"Description": "A resultlist sorted by relay and average shot fired"
}