Elector Player Tags

Scene names must start with the text indicated on the left column (except for 'Other').

To ignore a scene, start the scene's name with a '!', e.g. '!Riding Ignore me'.

To hide a scene from the Playlist Builder module in Elector Flow, append ‘{hidden}’ to the scene name. E.g., ‘Riding No Show in Flow {hidden}’.

Name (Area) or Riding

The scene name for a Riding or Area type for the Elector Player. Showcases voting results from an election area.

Name (Choice) or Candidate

The scene name for a Candidate or Choice type for the Elector Player. Showcases information about individuals.

Name (Party) or Party

A scene of type Party. Showcasing information about parties.

Name (Summary) <filter> or Summary <filter>

A scene of type Summary. Showcasing summary of voting results for areas belonging to a region filtered by some conditions (e.g., Incumbents losing, Party retaining seat).
Summary scenes must contain a filter name. E.g., 'Summary Close Ridings <Very Close Races - 1% lead>'. Note that the angle brackets characters < > are required.

The filters are similar to the ones that you see in Elector Flow in the Riding Results Summary module.
The following filters are supported:

• 'Landslide Race - 20% lead'

• 'Close Races - 5% lead'

• 'Very Close Races - 1% lead'

• 'Party Changing'

• 'Party Unchanging'

• 'Incumbent - losing'

• 'Incumbent - leading'

• 'Polls >= 5%'

• 'Polls >= 15%'

• 'Polls >= 20%'

• 'Polls >= 50%'

• '[PARTYCODE] - holding seat'  e.g., '[LIB] - holding seat’

• '[PARTYCODE] - gaining seat' e.g., '[GRN] - gaining seat’

• '[PARTYCODE] - losing seat'

• '[PARTYCODE] - leading'

• '[PARTYCODE] - losing'

Name (Ticker) or Name (Crawl) or Ticker or Crawl

The scene name for a Ticker or Crawl type. These scene types are only supported by Elector Player for XPression and are not available for Elector Player for Web.

Background

A scene with no active tags of type Background. These will be listed in the Player drop-downs for backgrounds.

Bug

This is an Other scene type but is treated specially in the Ticker tab in the Elector Player where scenes of this type fills the drop-down control for the Bug section.

Sponsor

This is an Other scene type but is treated specially in the Ticker tab in the Elector Player where scenes of this type fills the drop-down control for the Sponsor section.

Other

All other scenes with names that don't start with the above names nor a '!'.

Add [#] for additional Choices. ex: ^choice[1].name for 2nd choice’s name. ^choice.name is the same as ^choice[0].name.
Note: [0] refers to the leading candidate for the election area that the candidate belongs to.
For Area/Riding and Summary scenes, a special index of [inc] is also allowed and targets the incumbent candidate of the election area. E.g., ^choice[inc].name.

^choice[#].firstname

The first name of the candidate (ex: John). [#] = Position of candidate in the race where [0] is the leading candidate.

^choice[#].lastname

The last name of the candidate (ex: Smith).

^choice[#].name

The full name of the candidate (ex: John Smith).

^choice[#].media

An image representing the candidate.

^choice[#].details

Details about the candidate. Limited to 255 characters.

^choice[#].winner

A Visible tag object. Visible if the candidate is elected.

^choice[#].incumbent

A Visible tag object. Visible if the candidate is the incumbent for the office.

^choice[#].acclaimed

A Visible tag object. Visible if the candidate is a winner for the office by acclaim.

^choice[#].vote% or ^choice[#].percentage
^choice[#].percentagetext

The percentage of votes for the candidate.

**See note about the Percent Sign '%' below. If the ^choice.percentagetext tag is used, the '%’ sign will be forcibly shown.
**See note about Percentage Decimal Places below.

^choice[#].votes

The number of votes received for the candidate.

^choice[#].voteslead

The number of votes that the candidate has as a lead over the next nearest candidate in the same election area.

^choice[#].voteslead%

The number of votes that a candidate has as a lead over the next nearest candidate as a percentage of the total votes in the election area that the candidates belong to.

**See note about the Percent Sign '%' below.
**See note about Percentage Decimal Places below.

^choice[#].voteslose

The number of votes that the candidate is losing by as compared to that of the leading candidate in the same election area has.

^choice[#].voteslose%

The number of votes that the candidate is losing by as compared to that of the leading candidate as a percentage of the total votes in the election area that the candidates belong to.

**See note about the Percent Sign '%' below.
**See note about Percentage Decimal Places below.

^choice[#].custom <custom name format>

Customize the display of a candidate’s name. Note that the angle brackets characters < > are required.

The available name format tags are: {firstname} {lastname} {firstinitial} {incumbent} {elected} {partycode} {votes} {vote%}.
Example: <{lastname}, {firstname}> will display a candidate’s name as: Smith, John.

Add [#] for additional Parties. ex: ^choice[1].party.name is the name for the 2nd party. ^choice.party.name is the same as ^choice[0].party.name.

^choice[#].party.name

The full name of the party. (ex: Republican Party, Democratic Party, Liberal Party, Conservative Party, etc.)

^choice[#].party.media

^choice[#].party.media <prefix>

The graphics logo for the party. The <prefix> portion of the tag is optional. Note: when using files as a source for replacement logos, it is always best specify a prefix. The reason is that there are certain file names in the Windows operating system that are reserved. For example, ‘CON’ and ‘LPT’ can’t be used even when paired with file extensions.

Elector Player for XPression:

• In the absence of the <prefix> part, the player looks for an XPression material that is named based on the party code. The name of the material that is assigned to the Quad at design time determines the format of the name of the replacement materials that can be used for replacement on output. The format of the materials is: prefixPARTYCODE. For example: during design time, the material assigned is named ‘logoLIB’ and during output the party should be ‘CON’, then the player will look for a replacement material that is named ‘logoCON’.

• When the <prefix> part is specified as part of the tag’s name, the source of the logo will be from a file that is in the Logos folder (specified in the Elector Player’s Preferences) instead of another XPression material. The file prefix specifies what the prefix of the logo filename to look for on output. For example: we have a tag ^choice[0].party.media <logo> and the party on output is ‘CON’, then the player will look for a logo file that is named ‘logoCON.png'. The extension can be of any type image type that is supported by XPression, e.g., .png, .jpg, .bmp. Note that the search for a matching file is case insensitive, i.e., ‘logocon.png’ or 'LogoCon.Jpg' will also work.

Elector Player for Web:

• In Elector Player for Web, the player always looks for a logo file located in the Logos folder (specified in the Elector Player’s Preferences).

• In the absence of the <prefix> part, the player looks for a file with a name that is the party code. For example: on output, the party of interest is ‘LIB’, then player will look for a file named ‘LIB.png’. The type of image (and hence, the extension of the file) can be of any valid image type, e.g., .png, .jpg, .bmp, etc. The search for the logo filename is case insensitive, i.e., ‘lib.png' or ‘Lib.PNG’ will also work.

• When the <prefix> part is specified as part of the tag’s name, the player will look for a file that name has the following format: prefixPARTYCODE.ext. For example: the desired party code on output is ‘CON', ^choice[0].party.media <logo> is the tag and the prefix is ‘logo’, then the player will search for a logo file named ‘logoCON.jpg’. Again, the search is case insensitive and the file extension can be from any valid image file type, e.g., .png, .jpg, .bmp.

^choice[#].party or ^choice[#].party.code

The short name or acronym for the party. (ex: GOP for the Republicans, DEM for the Democrats)

^choice[#].party.leading

The number of seats/ridings is leading in votes (but not elected).

^choice[#].party.elected

The number of seats/ridings that a party has won (elected or acclaimed).

^choice[#].party.total

^choice[#].party.total.prev[#]

The number of seats/ridings that a party is leading in or has won in the current election event.

For the .prev[#] tag, the number of seats/ridings that a party has won in a previous election event is used. The ‘[#]’ is optional and if missing is the same as ‘[0]’. The previous events must be similar in terms of geographic and political purposes, e.g., Canadian Federal elections or U.S. Presidential elections on different years.

^choice[#].party.total%

^choice[#].party.total%.prev[#]

The percentage of seats/ridings that a party is leading or elected in the current election event.

For the .prev[#] tag, the percentage of seats/ridings that a party was elected in previous election events is used. The ‘[#]’ is optional and if missing is the same as ‘[0]’.

**See note about the Percent Sign '%' below.
**See note about Percentage Decimal Places below.

^choice[#].party.totaldiff

^choice[#].party.totaldiff.prev[#]

The number of seats/ridings that a party is gaining or losing in the current event as compared to the previous election event immediately before the current event.

For the .prev[#] tag, the comparison is done for the current event against the previous event specified by the index in the '[#] part. The ‘[#]’ is optional and if missing is the same as ‘[0]’, i.e., basically the same as the tag without the .prev[#] part.

^choice[#].party.totaldiffhasvotes

^choice[#].party.totaldiffhasvotes.prev[#]

The number of seats/ridings with votes that a party is gaining or losing in the current event as compared to a previous election event. Note that this only really works where the current event and the previous event have the same ridings.

For the .prev[#] tag, the comparison is done for the current event against the previous event specified by the index in the '[#] part. The ‘[#]’ is optional and if missing is the same as ‘[0]’, i.e., basically the same as the tag without the .prev[#] part.

^choice[#].party.totaldiffhasvotes%

^choice[#].party.totaldiffhasvotes%.prev[#]

The percentage of seats/ridings with votes that a party is gaining or losing in the current event as compared to a previous election event. Note that this only really works where the current event and the previous event have the same ridings.

For the .prev[#] tag, the comparison is done for the current event against the previous event specified by the index in the '[#] part. The ‘[#]’ is optional and if missing is the same as ‘[0]’, i.e., basically the same as the tag without the .prev[#] part.

**See note about the Percent Sign '%' below.
**See note about Percentage Decimal Places below.

^choice[#].party.votes

^choice[#].party.votes.prev[#]

The number of votes for the party in the current election event.

For the .prev[#] tag, the number of votes for the party in a previous election event is used. The ‘[#]’ is optional and if missing is the same as ‘[0]’.

^choice[#].party.vote% or ^choice[#].party.percentage
^choice[#].party.percentagetext

^choice[#].party.vote%.prev[#]

The percentage of votes for the party.

For the .prev[#] tag, the percentage of votes for the party in a previous election event is used. The ‘[#]’ is optional and if missing is the same as ‘[0]’.

**See note about the Percent Sign '%' below. If the ^choice.party.percentagetext tag is used, the '%’ sign will be forcibly shown.
**See note about Percentage Decimal Places below.

^choice[#].party.votediff

^choice[#].party.votediff.prev[#]

The difference in the number of votes that a party has for the current event as compared to a previous election event.

For the .prev[#] tag, the # value indicates the index of the previous event to use as a comparison from the list of previous events defined via the Elections Settings dialog in the Elector Player UI. The ‘[#]’ is optional and if missing is the same as ‘[0]’.

^choice[#].party.votediff%

^choice[#].party.votediff%.prev[#]

The difference in the popular vote percentage that a party has for the current event as compared to a previous election event.

For the .prev[#] tag, the # value indicates the index of the previous event to use as a comparison from the list of previous events defined via the Elections Settings dialog in the Elector Player UI. The ‘[#]’ is optional and if missing is the same as ‘[0]’.

**See note about the Percent Sign '%' below.
**See note about Percentage Decimal Places below.

^choice[#].party.voteseligible

^choice[#].party.voteseligible.prev[#]

The maximum number of eligible votes possible for the election event.

For the .prev[#] tag, the # value indicates the index of the previous event to use. The ‘[#]’ is optional and if missing is the same as ‘[0]’.

^choice[#].party.seatseligible

^choice[#].party.seatseligible.prev[#]

The maximum number of eligible seats possible for the election event.

For the .prev[#] tag, the # value indicates the index of the previous event to use. The ‘[#]’ is optional and if missing is the same as ‘[0]’.

^choice.polls.percentage or ^choice.polls.%
^choice.polls.percentagetext

The percentage of polls reporting.

**See note about the Percent Sign '%' below. If the ^choice.polls.percentagetext tag is used, the '%’ sign will be forcibly shown.
**See note about Percentage Decimal Places below.

^choice.polls.reported

The number of polls which have reported results.

^choice.polls.total

The total number of polls available for the area.

^choice.polls.custom <custom polls format>

Customize the display of polling information. Note that the angle brackets characters < > are required.

The available poll format tags are: {polls} {polls%} {totalpolls}.
Example: <{polls} / {totalpolls}> will display the polling results with something like: 123 / 1000.

^choice.event.date

The date for the election event.

^choice.event.date.prev[#]

The date for a previous election event. The ‘[#]’ is optional and if missing is the same as ‘[0]’.

Available only for Party scenes.

^choice.event.year

The year of the election event.

^choice.event.year.prev[#]

The year for a previous election event. The ‘[#]’ is optional and if missing is the same as ‘[0]’.

Available only for Party scenes.

^choice.event or ^choice.event.name

The name of the election event.

^choice.event.name.prev[#]

The name of the previous election event. The ‘[#]’ is optional and if missing is the same as ‘[0]’.

Available only for Party scenes.

If available, add [#] for additional Choices or Summaries. ex: ^choice[1].area.name is the name for the 2nd area. ^choice.area.name is the same as ^choice[0].area.name.

^choice.area or ^choice.area.name

The name of the election area (ex: Region or Riding)

For Party and Area/Riding scenes, use the tags as shown since there is only a single area specified for the scene.
For Choice/Candidate scenes, use ^choice[#].area or ^choice[#].area.name.
For Summary scenes, use ^summary[#].area or ^summary[#].area.name.

^choice.area.nameline1
^choice.area.nameline2

The area/riding name that is split into 2 lines. This is for use with graphics that are too short to hold the entire name of the riding in a single line. The 2 lines of text are assigned using Elector Flow.

For Area/Riding scenes, use the tags as shown since there is only a single area specified for the scene.
For Choice/Candidate scenes, use ^choice[#].nameline1 and ^choice[#].area.nameline2.
For Summary scenes, use ^summary[#].area.nameline1 and ^summary[#].area.nameline2.
Not supported in Party scenes.

^choice.area.ID

An numeric value assigned as the ID for an area/riding. This ID is usually provided by the datafeed. In the absence of a datafeed ID, the database record number is used instead.

For Area/Riding scenes, use the tag as shown since there is only a single area specified for the scene.
For Choice/Candidate scenes, use ^choice[#].area.ID.
For Summary scenes, use ^summary[#].area.ID.
Not supported in Party scenes.

^choice.area.details

Details about the area/riding.

For Area/Riding scenes, use the tag as shown since there is only a single area specified for the scene.
For Choice/Candidate scenes, use ^choice[#].area.details.
For Summary scenes, use ^summary[#].area.details.
Not supported in Party scenes.

^choice.area.electors

The number of electors available for the area/riding.

For Area/Riding scenes, use the tag as shown since there is only a single area specified for the scene.
For Choice/Candidate scenes, use ^choice[#].area.electors.
For Summary scenes, use ^summary[#].area.electors.
Not supported in Party scenes.

^choice.area.mailballots

The number of mail-in ballots submitted for the area/riding.

For Area/Riding scenes, use the tag as shown since there is only a single area specified for the scene.
For Choice/Candidate scenes, use ^choice[#].area.mailballots.
For Summary scenes, use ^summary[#].area.mailballots.
Not supported in Party scenes.

^summary[#].area.totalvotes

The total number of votes in the area/riding for summary [#].

Only for Summary scenes.

^summary[#].area.partyincumbent or ^summary[#].area.partyincumbent.code

The short name or acronym for the party that won the area/riding prior to the current election event.

Only for Summary scenes.

^summary[#].area.partyincumbent.name

The full name of the party that won the area/riding prior to the current election event.

Only for Summary scenes.

Add [#] for additional Captions. ex: ^caption[1].label for the 2nd text caption. ^caption.label is the same as ^caption[0].label

^caption.<label>

Text caption with optional label to show in the Elector Player and the Elector Flow Playlist Builder module.

Summary tags are the same as for Area/Riding scene except that the tags now start with ^summary instead of ^choice.

The index [#] for a summary tag refers to the summary results of an area/riding after the filter is applied.

Add [#] to target specific area/riding summaries. ex: ^summary[1].area.name for the name of the area in the 2nd summary. ^summary.area is the same as ^summary[0].area.

In general, the order is such that the results are in ascending Area IDs although for filters that compare close leads are sorted in ascending closeness, i.e., from smaller lead percentages to larger ones.

^summary.area or ^summary.area.name

The name of the area (ex: Region or Riding).

^summary.area.nameline1
^summary.area.nameline2

The riding name that is split into 2 lines. This is for use with graphics that are too short to hold the entire name of the riding in a single line. The 2 lines of text are assigned using Elector Flow.

^summary.area.ID

An numeric value assigned as the ID for a riding. This ID is usually provided by the datafeed. In the absence of a datafeed ID, the database record number is used instead.

^summary.area.details

Details about the riding.