Flashing Cells and Rows in AdapTable

Summary

  • AdapTable can be set up to flash Cells when the condition in a Rule is met
  • Flashing Rules can be created in the UI or defined in Initial Adaptable State
  • All Flashing-related properties (e.g. flashing styles, duration, target etc.) are highly configurable

Flashing Cells in AdapTable allows users to see changes in cells values that matter to them.

Cells or Rows can be made to flash on any change, or just when the change meets a defined rule.

This rule can be provided to AdapTable at design-time or created at run-time.

Flashing Concepts

Flashing in AdapTable comprises 5 key concepts:

  • Scope: which Columns or DataTypes when changed will cause the Flash to happen
  • Rule: why the Flash is applied (i.e. what data change will cause a Cell or Row to flash)
  • Styles: how the Flash is applied - different styles are available for up, down and neutral changes
  • Duration: when (ie. how long) the Flash will be applied - either a number (of miliseconds) or 'always'
  • Target: where the Flash is applied - either the cell who's data changed, or the whole row

Hint

You can set defaults for all these properties - so they are only overridden when they do not meet requirements

Flashing Cells
Fork
  • This very basic example sets all numeric column to flash (and has dummy data 'ticking' regularly)
  • The Rules uses the ANY_CHANGE() Expression Function so that all data changes will cause a Flash
  • The default settings for colours and durations are used

Scope

Users can specify which columns or rows in AdapTable are able to flash.

This is done by leveraging the commonly-used Column Scope Object.

Scope contains up to 4 sets of options:

  • Selected Columns - a list of Columns which will Flash

    Note

    All Columns including Calculated and FreeText Columns can flash when changed

  • Data Types - All columns which have a particular data type (e.g. number, text or date)

  • Column Types - All columns which contain the selected Column Type

  • All Columns - An entire Row can be Flashed by providing a Scope of 'All'

Caution

Flashing Cells do not operate on Calculated Columns

Rule

The Rule determines whether a given data change should trigger a Flash.

The Rule (similar to Alert Rules or Column Formatting Conditions) can be one of 2 types :

  • Predicates: most common use case and ideal for straightforward changes

  • Expression: used for creating more complicated Rules and evaluated using AdapTableQL

Hint

The most common Expression Function is ANY_CHANGE which returns true for any data change

Flashing Cells using a Rule
Fork
  • In this example cells in 4 columns (Github Stars, Github Watchers, Open Issues, Closed Issues) tick regularly
  • However the Rule set is that they only flash when the ticking data change occurs in a row where the Language is 'JavaScript'.
Try It Out
  • Change the Rule so it flashes also (or instead) for TypeScript projects

Change Styles

There are 3 "Change Styles" for the Flash (which are all configurable):

StyleWhen InvokedColumn Data Types
UpData change direction is upnumber, date
DownData change direction is downnumber, date
NeutralData change has no directiontext, boolean

Duration

Duration sets for how long the cell / row will flash.

The value provided can be one of 2 types:

  • a number (expressed in miliseconds)
  • 'always' - which will keep the cell / row in the new style indefinitely

Hint

Use the Clear Flash Context Menu Item to remove a currently applied Flash Style from cells or rows

Target

Target defines what will Flash. There are 2 options:

  • Cell - the cell that triggered the data change

  • Row - the entire row which contains the cell which triggered the data change

    Find Out More

    See Flashing Rows for more on using the Row Trigger

Using Flashing Cells

Run-time access to Cell Flashing is primarily available in the Flashing Cell section of the Settings Panel.

This displays a list of existing Flashing Cell Definitions with buttons to edit, suspend, share or delete.

UI Step by Step Guide

Using the Flashing Cell Wizard

Flashing Cell Menu Item

Flashing can be turned on for any Column by clicking Add Flashing Cell in the Column Menu.

Note

AdapTable can listen to 'neutral' data changes, so Flashing (and this menu item) is available in all columns

This will create a new Flashing Cell Rule with 2 features:

  1. An Expression using ANY_CHANGE() function so cells will flash when any data changes in the column
  2. Using Default Flashing properties that were set in Flashing Options (or provided by AdapTable)

Hint

  • Flashing can be turned off (for any Column which has a Flashing Scope of a single Column)
  • This is done via the Remove Flashing Cell menu item which appears automatically in the Column Menu

Setting UI Entitlements

The UI Entitlements behaviour is as expected for Full and Hidden Access Levels.

The ReadOnly Entitlement behaviour is that Flashing Cells will still be applied but Users are not permitted to manage or suspend them.

FAQ

Can we change the colours for a Flashing Cell column? Yes you can choose any colours you want for both the up and down change in number and date Columns. And you can also set the style for 'neutral' changes in text and boolean columns.

Can we change the colour based on the row (e.g. depending on other values in the row, the flash will be different colours or duration)? Yes, simply create a new Flashing Cell Definition for that particular rule using an Expression.

Can we turn on flashing for columns which don't contain numbers? Yes, Flashing Cell Definitions can be provided for any column or combination of columns

Can we add set the flash to remain in place until I see it? Yes, set the FlashDuration to always and the Cell / Row will remain coloured until explicitly cleared by the user

Can we flash Calculated Columns when they update? Not at the moment, no. But we hope to allow this in a future version of AdapTable

PreviousTechnical ReferenceNextFlashing Rows