Difference between revisions of "PresetDocFixtureView:DispatchAction"

Latest revision as of 15:12, 29 September 2016

DispatchAction( action, optionalParameter )

action is a string.

optionalParameter is a string (only some actions require the optionalParameter).

Available in MLA v1.3 onwards.

This function sends a user interface action to the Preset Documentation Fixture view. These actions would normally by triggered by clicking on the user interface, i.e. selecting a Preset in the Fixtures Preset table.

Example.

PresetDocFixtureView:DispatchAction("Select First Preset")

This would send an action that would be the same as clicking on the first preset in the preset list for a fixture.

PresetDocFixtureView:DispatchAction("Set Hide Ignored", "False")

This function with an optional parameter would be the same as clicking on the Hide Ignored checkbox. In this case, the it will set to False (off).

Action Strings

Select First Preset

Will select the first Preset in the Fixtures Preset table in the Preset Documentation Fixture view. It is the same as if you had clicked on the first Preset in the Preset table. Note that table will not scroll to show the selection.

Select Last Preset

Will select the last Preset in the Fixtures Preset table in the Preset Documentation Fixture view. It is the same as if you had clicked on the last Preset in the Preset table. Note that table will not scroll to show the selection.

Select Next Preset

Will select the next Preset in the Fixtures Preset table in the Preset Documentation Fixture view. If no Preset was previously selected, it will select the first Preset. Note that table will not scroll to show the selection.

Select Previous Preset

Will select the previous Preset in the Fixtures Preset table in the Preset Documentation Fixture view. If no Preset was previously selected, it will not do anything. Note that table will not scroll to show the selection.

Select Preset

parameter (string) = Preset Type and/or Preset ID. i.e.Preset,27.

Will select the specified Preset in the Fixtures Preset table in the Preset Documentation Fixture view. Note that table will not scroll to show the selection.

Examples.

PresetDocFixtureView:DispatchAction("Select Preset", "Preset,27")

This will select specifically Preset Type Preset with the Preset ID of 27.

PresetDocFixtureView:DispatchAction("Select Preset", "46")

This will select the first Preset, regardless of Preset Type with a Preset ID of 46.

Display First Preset Photo

Will display the first preset photo for the selected preset.

Display Last Preset Photo

Will display the last preset photo for the selected preset.

Display Next Photo

Where a preset/channel has multiple photos, this will display the next photo.

Display Previous Photo

Where a preset/channel has multiple photos, this will display the previous photo.

Display Channel

parameter (string) = channel number.

Display Fixture

parameter (string) = fixture number.

Display Next Channel/Fixture

Will increment the channel/fixture number and display the relevant presets for the channel/fixture.

Display Previous Channel/Fixture

Will decrement the channel/fixture number and display the relevant presets for the channel/fixture.

Set Hide Ignored

parameter (string) = checkbox state (True or False).

Will set if the preset list displays ignored presets.

Set Channel Focussed

parameter (string) = Focussed checkbox state for presets displayed (True or False).

SUBJECT TO CHANGE ! Will set or clear the Focussed flag for the channel in all the presets displayed in the preset list. Note, while the word Channel is used, it will apply if a fixture is displayed.

Sort By

parameter (string) = sort by item.

Will set the Sort for the Fixtures Preset list.
Sort Items...

Focus Order

Preset ID

Focus Cue

Set

Priority

Example.

PresetDocFixtureView:DispatchAction("Sort By", "Preset ID")

Order By

parameter (string) = sort by item.

Will set the Order for the Fixtures Preset list. Works the same as Sort By but provided for consistency with the fixture view user interface.
Sort Items...

Focus Order

Preset ID

Focus Cue

Set

Priority

Example.

PresetDocFixtureView:DispatchAction("Sort By", "Preset ID")