Crestron Components Lib - Showcase App

ch5-overlay-panel: customStyle, receiveStateCustomStyle

Emulator Scenario (click to expand)
{
  "cues": [
    {
      "type": "boolean",
      "event": "sig_trig_style1",
      "trigger": true,
      "actions": [
        {
          "type": "string",
          "state": "sig_custom_style",
          "logic": "set",
          "value": "border:2px dashed blue;"
        }
      ]
    },
    {
      "type": "boolean",
      "event": "sig_trig_style2",
      "trigger": "&change",
      "actions": [
        {
          "state": "sig_custom_style",
          "type": "s",
          "logic": "set",
          "value": "border:3px dotted green; color:red;"
        }
      ]
    },
    {
      "type": "boolean",
      "event": "sig_trig_style3",
      "trigger": true,
      "actions": [
        {
          "state": "sig_custom_style",
          "type": "s",
          "logic": "set",
          "value": "border:1px solid red; color:green;"
        }
      ]
    }
  ]
}

Press the Load button to load the scenario.

Press the Run button to run the scenario. You only need to do this if the scenario (the json) has an onStart key.

The Emulator Scenario JSON contains an array of cues and an optional array onStart A cue is defined by: type:string, signal:string, trigger:boolean|string|number, actions:array. An action is defined by: type:string, signal:string, logic:string ... plus other fields ( depending on type)

type for cue or for action can be the string:

  • b or boolean - for a boolean signal
  • n or number or numeric - for a number signal
  • s or string - for a string signal
  • o or object - for an object signal

signal for cue or for action is a string representing the name of the signal:

trigger can be either a fixed value of the same type as the signal, or the string "&change". If it is a fixed value then, when the emulator detects that the signal has changed to the value given in trigger then it also executes the actions for that signal. If the value is the string "&change", regardless of signal type, then the actions are executed on any change in the value of the signal.

logic can be:

  • link - passes the value received on the incoming join through to the outgoing join. Using this between incompatible join types will attempt to cast the value. In the event of a cast failure the value will be set to false, 0 or "" (empty string)
  • set - assigns a specific value to the join. This requires a 5th key of 'value' and the specific value to assign. ie. {"signal":"light_level", "type":"n", "logic": "set","value":5}. If the 5th key is omitted, the default value will be sent (false, 0, "" or {})
  • toggle - (boolean Only) reads the current state and changes it to the opposite state
  • pulse - (boolean Only) value goes high and then low.
  • increment - (Numeric Only) reads the current value of the analog and adds an offset. This logic accepts an optional 5th key of 'offset which determines how many to incrementby. ie. {"signal":"volume_level","type":"n", "logic":"increment","offset":5}. If this 5th key is omitted, the default offset of 1 will be applied.
  • decrement - (Numeric Only) reads the current value of the analog and subtracts an offset. This logic accepts an optional 5th key of 'offset which determines how many to decrement by. ie. {"signal":"volume_level","type":"n", "logic":"decrement","offset":5}. If this 5th key is omitted, the default offset of 1 will be applied.

RCB logic can be accomplished by defining an action containing an object signal of RCB type:
{ "rcb":{ "value": numeric_value, "time": duration_in_ms } }
Scenario example:


    {
      "cues": [
        {
          "type": "boolean",
          "signal": "trigger",
          "trigger": true,
          "actions": [
            {
              "signal": "action1",
              "type": "boolean",
              "logic": "toggle"
            },
            {
                "signal": "rcb_signal",
                "type": "object",
                "logic": "set",
                "value": {
                    "rcb":{
                        "value": 101,
                        "time": 1500
                    }
                }
            }
          ]
        }
      ],
      "onStart": [
      ]
    }
    

Inherited from common: customStyle attribute

The css rules defined in the customStyle attribute are added to the element

Pressing this button wil show the overlay

Sample text

<p>
Pressing this button wil show the overlay <ch5-button label="Show overlay" sendEventOnClick="trig_show_1"></ch5-button>
</p>

<ch5-overlay-panel
        receiveStateCustomStyle="sig_custom_style"
        customStyle="border:1px solid red;"
        receiveStateShowPulse="trig_show_1"
        closable
    >

    <p>Sample text</p>
    <ch5-image
            id="ex1-img"
            url="https://picsum.photos/200/300/?random">
    </ch5-image>
</ch5-overlay-panel>

Inherited from common: Receiving custom style from a signal

Clicking the "trigger" buttons will change the value of the signal defined in the receiveStateCustomStyle

Pressing this button wil show the overlay

This changes the value of the sig_custom_style signal to "border:2px dashed blue;" ( see Emulator Scenario )

This changes the value of the sig_custom_style signal to "border:3px dotted green; color:red;" ( see Emulator Scenario )

This changes the value of the sig_custom_style signal to "border:1px solid red; color:green;" ( see Emulator Scenario )


Sample text

<p>
    Pressing this button wil show the overlay <ch5-button label="Show overlay" sendEventOnClick="trig_show_2"></ch5-button>
</p>
<p>
    This changes the value of the <b>sig_custom_style</b> signal to "border:2px dashed blue;" ( see Emulator Scenario )
    <ch5-button label="trigger 1" sendEventOnClick="sig_trig_style1"></ch5-button>
</p>
<p>
    This changes the value of the <b>sig_custom_style</b> signal to "border:3px dotted green; color:red;" ( see Emulator Scenario )
    <ch5-button label="trigger 2" sendEventOnClick="sig_trig_style2"></ch5-button>
</p>
<p>
    This changes the value of the <b>sig_custom_style</b> signal to "border:1px solid red; color:green;" ( see Emulator Scenario )
    <ch5-button label="trigger 3" sendEventOnClick="sig_trig_style3"></ch5-button>
</p>

<hr>


<ch5-overlay-panel
        dismissable="false"
        closable="true"
        closeIcon="fas fa-power-off"
        receiveStateCustomStyle="sig_custom_style"
        customStyle="border:1px solid red;"
        receiveStateShowPulse="trig_show_2"
        >
    <p>Sample text</p>
    <ch5-image
            id="ex1-img"
            url="https://picsum.photos/200/300/?random">
    </ch5-image>
</ch5-overlay-panel>