Skip to content

Data panel ​

The values your graphic is driven by — the names a control system will fill in, and what they start as.

Left sidebar, Data section.

The Data panel, with a view model and its properties

What it does ​

A view model is a named set of properties: name, role, accent, onAir. Those properties are what you bind your artwork to, what Animation States conditions test, and what a controller sends values into on air.

A view model can hold several instances — named sets of values for the same properties. One per candidate, one per team, one for rehearsal. The artboard shows one of them; the first instance is the default, and that is what a player creates when the graphic opens.

Use it ​

The Data + menu: View Model, Enum, Converter… and From an OGraf graphic…

  1. + on the Data header › View Model. Its name opens for typing. The first one you add is bound to the artboard you are on, marked Artboard.
  2. + on the view model's row to add a property, and pick its type. Its name opens for typing, all selected: type the name, and Enter keeps it.
  3. Give it a value. That value is what the graphic shows until something sends a different one. A text's value takes the wider part of its row; hover a long one to read all of it. A name too long for its column shows in full on hover too.
  4. Bind artwork to it from the inspector, then check it is offered to the control system under Visible to controller.

Keys instead of the menu. Select a view model and a single letter adds a property: N number, S string, B boolean, C colour, T trigger, E enum, I image, F font, A artboard, L list, Shift+L list index, V view model. The keys add a run of properties without stopping to name each one; rename them in place afterwards. Selecting something on the stage hands the keys back to the stage, where Q, W and E are translate, rotate and scale.

From an OGraf graphic ​

To re-make a graphic that already plays on an EBU OGraf system, start from its fields: + › From an OGraf graphic…, and pick its manifest, the .ograf.json file. Or drop the file on the stage. Its fields come in as a view model, so the system that fills the old graphic keeps sending the same data to the new one:

From the OGraf graphicIn the Data panel
Text, number, true/false, colour, picture fields, with their defaultsProperties of the same names and types
Choice listsAn enum, with its values
Playing itTriggers Animate In and Animate Out, and next when the graphic has steps
Each custom actionA trigger of its name

The artwork does not come across: an OGraf graphic is web code. Nor do fields that are lists or groups; the import report names them. The editor says what it made: '"<name>" came in as the view model "<vm>": N fields and M triggers (…). Bind them to the artwork you make for it.' One Ctrl+Z takes it all back. A file that is not one is refused, with an error mark and Copy: "Could not import <file>: it is not an OGraf graphic (an OGraf manifest is a .ograf.json file with the OGraf $schema)."

Find a property with Ctrl+F, or with the box that appears once the document has twenty properties or more.

Property types ​

Properties of a view model, each with its value

TypeWhat it holdsHow it edits
NumberA numberDrag sideways on it to change it, or click to type ("Drag to change, click to type"); whole numbers show without decimals
StringTextA field
BooleanOn or offA checkbox
ColorA colourA swatch and a hex field
TriggerA "do it now" pulseA Fire button. It works in Animate mode; in Design it is greyed, with "Switch to Animate mode to fire this trigger". It reads Fired for as long as the row glows
EnumOne of a named setA dropdown of that enum's values
ImageA picture, or, named like Input 1 or Video 1, a live sourceIts size, and the picture this instance starts with: Placeholder, No picture, or one of the document's images. Changed while Animation States play, the new picture shows at once and they keep playing
FontOne of the document's fontsA dropdown, starting at Arial (default)
ArtboardOne of the document's artboardsA dropdown
ListA list of instances to repeatPick the item view model, then add items
List IndexWhich row this isNot editable: the list fills it in
View ModelAnother view model, nestedTwo dropdowns, and the row expands to edit it in place

Dragging a number. Drag sideways on a number's value, with the cursor showing ↔. The step follows the value's size: a fraction up to 1 moves in hundredths, a whole number in whole steps, and other values by about a hundredth of themselves. Hold Shift for finer steps. Letting go keeps the value, and one Undo takes back the whole drag. A click without dragging types, as before.

A trigger nothing will hear. In Animate mode, a trigger that is not part of the active artboard's data gets a warning mark beside its Fire button. Its tooltip says why, for example "TICKER_FILLER's Animation States never see this trigger: it is Artboard's data.", or that no artboard uses this data, and an Open link switches to the artboard that does. Fire still presses, but on this artboard nothing hears it. If you fire a trigger and nothing happens, check that the Animation States header names the artboard you mean, or follow the mark beside Fire.

Adding properties from the keyboard ​

Select a view model's row, and the panel takes the keyboard. One key adds each type of property:

KeyAddsKeyAdds
NNumberIImage
SStringFFont
BBooleanAArtboard
CColourLList
TTriggerShift+LList index
EEnumVView model

Delete removes the selected property and Ctrl+D duplicates it.

The panel lets go as soon as you pick something else. Select an object on the stage or in the hierarchy and the view model's highlight goes, and the keys belong to the stage again — Q, W and E move, rotate and scale instead of adding properties. All these keys can be changed in Keyboard shortcuts.

Instances ​

The instance bar under a view model

The bar under a view model says which instance you are looking at. The first is marked (default).

ControlWhat it does
The nameDouble-click to rename
Switch instanceAppears once there are two or more
+Adds one, and switches to it
Duplicate, with its valuesA copy of this instance, values and all
Delete instanceOnly on instances other than the default

Switch to the table view (the toggle on the view model's row) to see every instance at once, one row each, and edit them side by side.

The property menu ​

A property's menu: Rename, Duplicate, Move up, Move down, Drive from…, Visible to controller, Delete

The ⋯ on a row, or a right-click.

ItemWhat it does
RenameRenaming rewrites every binding that runs through it, so nothing breaks inside the document
Duplicate Ctrl+DSame type, same settings, the value it holds on every instance. Bindings are deliberately not copied
Move up, Move downReorder
Picture size… / Slot size / source…Image properties: a plain picture's size, or a live slot's size and what plays in it
Drive from… / Change what drives it…Have one property's value come from another, optionally through a converter
Stop driving itHand the value back to you
Visible to controllerSee below
Forget old names ("…")Shown when a renamed property still answers to its old names: the newest two, then how many more, such as Forget old names ("Score", "Goals" +1 more). Drops them all and says so: "An OGraf package exported from now on takes only "<name>". Undo brings the old names back." See Renaming later
Delete

Visible to controller ​

Ticked — the default — the property goes into the bindings.json written beside the exported file, and into what Send to air sends: its name, its type, what it starts as, an enum's values, an image slot's placeholder. Unticked, the property still works inside the document, the row is drawn dimmed, and both lists leave it out. The controller also reads the graphic itself, and today it lists every property it finds there: see The controller.

Renaming a property that has already been sent to a controller says so, because controllers bind by name:

Renamed "Score" to "Points". The controller this was sent to binds by name, so anything wired to "Score" over there stops filling until it is pointed at the new name, or this is sent to air again. An OGraf package exported from now on still takes "Score" for it.

A renamed property's menu, with Forget old names ("presenter", "name") above Delete

A renamed property that is visible to the controller keeps its old names, so an OGraf package exported afterwards still accepts data sent under them, until Forget old names drops them.

Driven values ​

A value can be driven by another property rather than typed. The editor is replaced by a link icon, the path it comes from, and the converter it runs through — "Driven by <view model> › <path>. Right-click to change it."

A value driven through a path this editor cannot name shows a padlock and the words as authored: the file is kept exactly as it came and written back unchanged.

Lists ​

Choose the item view model first, from the picker that reads Choose… — until then the row says "Choose the item view model to add items." Each item is a row: a drag handle to reorder, its number, and which instance it uses. The list's row counts them, such as 3 items.

+ Add item appends one with values of its own: a new instance named Item 1, Item 2 and so on, a copy of the item view model's first instance. Type one row's name and only that row changes. To have a row show an instance you already have, pick it from the row's menu. Over twenty instances, the picker becomes a search.

An artboard list bound to this property draws one artboard per item.

Enums and converters ​

The Enums section of the Data panel

Enums are named sets of values — Live, Break, Off air. Type the values as a comma-separated list. An instance pointing past the end of a shortened list falls back to the first value.

Converters change a value on its way to what it drives: round it, map it to another range, format it as text, pad or trim it, ease a counter so it animates instead of jumping, negate a boolean, take a list's length. One converter can serve many bindings; its row shows what its steps do and how many places use it, for example Round › Pad text · 7. See Converters.

Live inputs and video ​

+ › Live input or Live video makes an image property named input1, video1, and so on. The name is the role: operators map inputs by number, so the number is never reused, and what you type is a label shown in the editor rather than a rename of the slot.

Click the settings icon at the start of a slot's row — "Slot settings: size, source and playout" — to choose what fills it, or choose Slot size / source… from its menu. On a row that shows the source's state, such as "Clip not found", a click on that text tries again.

Only a name like Input 1 or Video 1 makes a picture live. A picture property is a live slot when its name is Input or Video and a number, in any case, with or without a space or _ between: input1, Video 2, video_3. That is airZ Controller's own rule, and the editor reads names the same way. Any other picture property is a plain picture: the operator swaps it for another picture in airZ Controller's Assets, and it is fitted to the property's size.

A plain picture's settings icon, or Picture size… in its menu, opens Picture: <name> with only Width and Height. It says what the picture is for, and where live video goes instead. A plain picture that still carries video settings from an older document shows them with a warning that airZ Controller will not use them: clear them, or rename the property Input 1 or Video 1 to make it live.

The live input dialog: This scene plays None, Input 1 to 4, and what happens at playout

This scene plays is the part saved with the scene, and it means the same on every machine:

ChoiceWhat it means
None"No default: the controller sends a source at playout."
Input 1 … Input 4The scene plays that input. "Saved with the scene as Input 1. It plays whatever each machine wires to its Input 1."

Input 1 chosen: the DeckLink ports on this computer, and which one feeds Input 1 here

With an input chosen, On this computer, Input 1 comes from lists the DeckLink ports this machine has. Pick one to see the picture in the editor. The eye beside each port previews it. This choice is only for this computer: "Only this computer, for the preview. Playout servers wire their inputs in their own configuration." With none picked, the dialog says what playout will do: "A playout engine without it falls back to its card's port 1, if that port is an input: map it in the engine's configuration to be sure."

Under At playout:

RowWhat it does
AudioWhether the input's sound plays with it
When the source stopsWhat the slot shows if the feed drops: Hold the last frame, and the other choices in the list
Colour spaceAs the source says, or a colour space you set

Advanced holds the rest. See Live video slots for the whole picture, including what happens at playout when a feed drops out.

"1 more property, set by airZ Engine" ​

A grey line under a view model's properties, such as "1 more property, set by airZ Engine", means the view model holds values that airZ Engine sets for itself while the graphic plays: the 3D poster's switch, the take counter, deep output, ray tracing and its level, live global illumination and the render scale. They are kept out of the list and out of the bind menus, because nothing you do should change them. The view model counts them in that one line, and hovering it shows their names and what each is for.

Your own properties are never hidden, even when their names start with airz.

When it is empty ​

"No view models yet. Use + to add one; its properties bind to the inspector and drive Animation States conditions."

See also ​

airZ Editor manual