Triggers #

This section lists and documents most triggers available in Varv.

Reference: A list of actions can also be found in the Reference. The reference might also contain more triggers, that are currently in development and which specification might change in the future.

Reactive Triggers #

"action" Trigger #

A trigger that triggers when another action is run.

Parameters:

Properties:

Event Variables:

The event will carry the same variables as the event of the other action.

Examples:

Trigger before another action is run:

{
    "action": {
        "action": "myActionName",
        "hook": "before"
    }
}

Trigger after another action is run:

{
    "action": {
        "action": "myActionName",
        "hook": "after"
    }
}

Trigger after another action is run (shorthand version):

{ "action": "myActionName" }

Trigger after an action of a specific concept is run (shorthand version):

{ "action": "myConcept.myActionName" }

Triggers after another action (“super-shorthand” version):

"myActionName"

"interval" Trigger #

A trigger that is activated in a given time interval.

Parameters:

Properties:

Event Variables:

Examples:

Trigger every second:

{ "interval": { "interval": 1000 }}

Trigger every second (shorthand version):

{ "interval": 1000 }

"stateChanged" Trigger #

A trigger that is activated when state of concept instances or their properties changes.

Parameters:

Properties:

Event Variables:

Examples:

Triggers when any property on a given concept changes:

{ "stateChanged": { "concept": "myConcept" }}

Triggers when a given property changes (only the first concept that has the property is checked):

{ "stateChanged": { "property": "myProperty" }}

Triggers when a given property changes on a given concept:

{
    "stateChanged": {
        "concept": "myConcept",
        "property": "myProperty"
    }
}

Triggers when any property on a given concept changes (shorthand version):

{ "stateChanged": "myConcept" }

Triggers when a given property changes (shorthand version):

{ "stateChanged": "myProperty" }

Triggers when a given property changes on a given concept (shorthand version):

{ "stateChanged": { "myConcept": "myProperty" }}

Triggers when any property on myConcept changes, or if myProperty changes, on the first concept it was found on:

{ "stateChanged": [ "myConcept", "myProperty" ] }

View Triggers #

"click" Trigger #

A trigger that listens for mouse clicks in the DOM View.

Parameters:

Note: Only one of the three parameters can be used at a time.

Properties:

Event Variables:

Examples:

Click trigger on concepts:

{ "click": { "concept": "theConceptIWantToClickTriggerOn" }}

Click trigger on concepts (shorthand version):

{ "click": "theConceptIWantToClickTriggerOn" }

Click trigger on views:

{ "click": { "view": "aViewBindingIWantToClickTriggerOn" }}

Click trigger on properties:

{ "click": { "property": "aPropertyIWantToClickTriggerOn" }}

"contextmenu" Trigger #

A trigger that listens for mouse right-clicks in the DOM View.

Parameters:

Note: Only one of the three parameters can be used at a time.

Properties:

Event Variables:

Examples:

Context menu trigger on concepts:

{ "contextmenu": { "concept": "theConceptIWantToRightClickTriggerOn" }}

Context menu trigger on concepts (shorthand version):

{ "contextmenu": "theConceptIWantToRightClickTriggerOn" }

Context menu trigger on views:

{ "contextmenu": { "view": "aViewBindingIWantToRightClickTriggerOn" }}

Context menu trigger on properties:

{ "contextmenu": { "property": "aPropertyIWantToRightClickTriggerOn" }}

"key" Trigger #

A trigger that listens key events in the DOM View.

Parameters:

Properties:

Event Variables:

Examples:

Trigger when the “Enter” key is pressed and “shift” is held:

{
    "key": {
        "event": "keyPress",
        "key": "Enter",
        "shift": true
    }
}

Trigger when the “Enter” key is pressed and “ctrl” is held, and a view is in focus:

{
    "key": {
        "event": "keyPress",
        "key": "Enter",
        "ctrl": true,
        "focus": {"view": "myView"}
    }
}

"mousedown" Trigger #

A trigger that listens for “mousedown” events in the DOM View.

Parameters:

Note: Only one of the three parameters can be used at a time.

Properties:

Event Variables:

Examples:

Mousedown trigger on concepts:

{ "mousedown": { "concept": "theConceptIWantToMousedownTriggerOn" }}

Mousedown trigger on concepts (shorthand version):

{ "mousedown": "theConceptIWantToMousedownTriggerOn" }

Mousedown trigger on views:

{ "mousedown": { "view": "aViewBindingIWantToMousedownTriggerOn" }}

Mousedown trigger on properties:

{ "mousedown": { "property": "aPropertyIWantToMousedownTriggerOn" }}

"mousemove" Trigger #

A trigger that listens for mouse “mousemove” events in the DOM View.

Parameters:

Note: Only one of the three parameters can be used at a time.

Properties:

Event Variables:

Examples:

Mousemove trigger on concepts:

{ "mousemove": { "concept": "theConceptIWantToMousemoveTriggerOn" }}

Mousemove trigger on concepts (shorthand version):

{ "mousemove": "theConceptIWantToMousemoveTriggerOn" }

Mousemove trigger on views:

{ "mousemove": { "view": "aViewBindingIWantToMousemoveTriggerOn" }}

Mousemove trigger on properties:

{ "mousemove": { "property": "aPropertyIWantToMousemoveTriggerOn" }}

"mouseup" Trigger #

A trigger that listens for mouse “mouseup” events in the DOM View.

Parameters:

Note: Only one of the three parameters can be used at a time.

Properties:

Event Variables:

Examples:

Mouseup trigger on concepts:

{ "mouseup": { "concept": "theConceptIWantToMouseupTriggerOn" }}

Mouseup trigger on concepts (shorthand version):

{ "mouseup": "theConceptIWantToMouseupTriggerOn" }

Mouseup trigger on views:

{ "mouseup": { "view": "aViewBindingIWantToMouseupTriggerOn" }}

Mouseup trigger on properties:

{ "mouseup": { "property": "aPropertyIWantToMouseupTriggerOn" }}

"wheel" Trigger #

A trigger that listens for mouse wheel events in the DOM View.

Parameters:

Note: Only one of the three parameters can be used at a time.

Properties:

Event Variables:

Examples:

Mouse wheel trigger on concepts:

{ "wheel": { "concept": "theConceptIWantToMousewheelTriggerOn" }}

Mouse wheel trigger on concepts (shorthand version):

{ "wheel": "theConceptIWantToMousewheelTriggerOn" }

Mouse wheel trigger on views:

{ "wheel": { "view": "aViewBindingIWantToMousewheelTriggerOn" }}

Mouse wheel trigger on properties:

{ "wheel": { "property": "aPropertyIWantToMousewheelTriggerOn" }}