ShowWhen

<< Click to Display Table of Contents >>

Navigation:  Support > Reconfigurable Rulebook > Definition Objects >

ShowWhen

Description

ShowWhen is an abstract object with three possible concrete implementations. The concrete class identifier is the Operation property.

All ShowWhen expressions evaluate to true or false, to determine if a ResultListDisplayColumn should be shown or not shown to the user.

ShowWhenEquation

A ShowWhenEquation is a ShowWhen expression that evaluates to true or false, based on boolean operations on two or more sub-ShowWhen expressions.  

Definition

Property Name

Value

Description

Operation

String enum ShowWhenOperation

Indicates that this is a ShowWhenVariable.

Value must be EQUATION.

Boolean

String enum ShowWhenBoolean

The type of boolean operation that should be applied to all of the Arguments.

Required.

Arguments

List of ShowWhen expressions.

The list of Show-When expressions to evaluate.

Required.

Example

{

  "Boolean": "OR",

  "Arguments": [

    {

      "Boolean": "AND",

      "Arguments": [

        {

          "Condition": "RESULT_STATUS_INTERMEDIATE",

          "Operation": "VARIABLE"

        },

        {

          "Condition": "SUPPLEMENTAL",

          "Operation": "VARIABLE"

        },

        {

          "Condition": "SHOT_ON_EST",

          "Operation": "VARIABLE"

        }

      ],

      "Operation": "EQUATION"

    },

    {

      "Boolean": "AND",

      "Arguments": [

        {

          "SegmentGroupName": "Standing Sighters",

          "Operation": "SEGMENT_GROUP"

        },

        {

          "Condition": "RESULT_STATUS_FUTURE",

          "Operation": "VARIABLE"

        },

        {

          "Condition": "SUPPLEMENTAL",

          "Operation": "VARIABLE"

        },

        {

          "Condition": "SHOT_ON_EST",

          "Operation": "VARIABLE"

        }

      ],

      "Operation": "EQUATION"

    }

  ],

  "Operation": "EQUATION"

}

ShowWhenSegmentGroup

A ShowWhenSegmentGroup is a ShowWhen expression that evaluates to true or false, based on the run time value the SegmentGroupName from the Range Script.

Definition

Property Name

Value

Description

Operation

String enum ShowWhenOperation

Indicates that this is a ShowWhenSegmentGroup.

Value must be SEGMENT_GROUP.

SegmentGroupName

String

The SegmentGroupName, that the Range Script has to be on, that evaluates to true or false.

Required.

Example

{

  "SegmentGroupName": "Pre-Competition",

  "Operation": "SEGMENT_GROUP"

}

ShowWhenVariable

A ShowWhenVariable is a ShowWhen expression that evaluates to true or false, based on the run time value of an Condition.  Common examples would be RESULT_STATUS_INTERMEDIATE, to evaluates to true, if the Result List's status is Intermediate. Or, DIMENSION_LARGE if the screen resolution is large (as defined by Bootstrap 5).

Definition

Property Name

Value

Description

Operation

String enum ShowWhenOperation

Indicates that this is a ShowWhenVariable.

Value must be VARIABLE.

Condition

String enum ShowWhenCondition

The conditional variable that evaluates to true or false.

Required.

Example

{

  "Condition": "RESULT_STATUS_INTERMEDIATE",

  "Operation": "VARIABLE"

}