AdapTable Functions Overview

Most of the functionality in AdapTable is organised through 'AdaptableFunctions'.

A Function is essentially a set of discrete functionality e.g. 'CustomSort', 'Filter', 'SmartEdit' etc. which users will interact with as required.

note

Many AdapTableFunctions contain an array of AdaptableObjects that users can create, edit or delete (if their Entitlements allow), e.g. ConditionalStyle, PercentBars etc.

tip

Use Entitlements to set Functions you dont need to 'Hidden' or don't want users to touch to 'ReadOnly'

AdapTable Functions

AdaptableFunction	Description
Action Column	Creates a Column with a button that when clicked performs an action
Alert	Get notified when things happen in Adaptable that you need to know about
Application	Store custom data in AdapTable state via Application Data Entries
Bulk Update	Update multiple cell simultaneously with a new or existing value
Calculated Column	Create bespoke columns whose cell value is derived dynamically from an Expression
Calendar	Set Working Days using your local calendar
Cell Summary	See summary information on a group of cells using multiple summary operations
Cell Validation	Create custom validation rules for when cells are edited in AdapTable
Conditional Style	Style columns and rows dynamically based on rules and cell values
Custom Sort	Provide bespoke sorting information for Columns (in place of alphabetical sorting)
Data Source	Update the entire data set in AdapTable using pre-populated data sources
Export	Export data from the Grid to numerous locations in numerous formats
Filter	Advanced filtering capability allows users to see precisely the data they want
Flashing Cell	Flash cells to incdicate they have changed value - and in which direction
Format Column	Create a column style, display format or cell alignment
FreeText Column	Dynamic column showing custom content (stored in state and not with grid data)
Gradient Column	Renders a cell showing the contents coloured according to a custom gradient
Grid Info	Display information about the Grid, the Options selected and all columns
Layout	Named sets of column visibility, order, groupings, aggregation, pivots etc.
Percent Bar	Renders a column showing it filled according to contents as % of total value
Plus Minus	Configure how a cell value will edit when the + or - keys are pressed
Query	Run real-time text-based queries using a wealth of powerful functions and operators
Quick Search	Quickly highlight all cells in the grid that contain matching query text
Reminder	Configure reminders (alerts) to popup with a a message at scheduled times
Schedule	Schedule AdapTable functions to run at times of your choosing (e.g. run reports)
Shortcut	Set up rules so cells update mathematically when keys are pressed in numeric cells
Smart Edit	Edit groups of numeric cells using mathematical operations (e.g. Multiply by 10)
State Management	Manages Adaptable State, User State and Predefined Config
System Status	Provide messages about the Status of your application
Theme	Theme AdapTable with a colour configuration set of your choosing
Updated Row	Visually indicate when the contents of a row has changed

Functions UI

There are numerous ways in which end-Users can interact with AdapTable Functions in the AdapTable UI:

• Most AdapTableFunctions have a dedicated Popup Screen. AdapTableFunctions that contain an array of items (e.g. ConditionalStyle) will typically display these in a table with buttons to add / edit. These items are created / edited via a Wizard which provides step-by-step way to edit the sometimes complex objects that can be created.

  AdapTableFunctions which perform actions (e.g SmartEdit, BulkUpdate) will contain UI controls to allow the AdapTableFunction to be used.

• Some AdapTableFunctions provide Dashboard Toolbars which offer easy access to commonly used AdapTable Functions e.g. Layouts, Reports, Quick Search.

• AdapTable Functions can also provide ToolPanels to be hosted in the AdapTable ToolPanel (at the side of the grid). Like toolbars, these provide ready access to common functionality (the same AdapTableFunctions generally provide both).

• Many AdapTableFunctions also provide Menu Entries for both the Column Menu (available through clicking a Column Header) and Context Menu (available through right-clicking on a grid cell, or group of cells).

This table lists all the AdapTableFunctions and which UI elements they support.

AdapTable Functions UI Components

AdaptableFunction	Wizard	Toolbar	Tool Panel	Column Menu	Context Menu
Action Column	No	No	No	No	No
Alert	Yes	Yes	Yes	No	Yes
Application	No	No	No	No	No
Bulk Update	No	Yes	Yes	No	Yes
Calculated Column	Yes	No	No	Yes	No
Calendar	No	No	No	No	No
Cell Summary	No	Yes	Yes	No	Yes
Cell Validation	Yes	No	No	Yes	No
Conditional Style	Yes	No	No	Yes	No
Custom Sort	Yes	No	No	Yes	No
Data Source	Yes	Yes	Yes	No	No
Export	Yes	Yes	Yes	No	No
Filter	No	Yes	Yes	Yes	Yes
Flashing Cell	No	No	No	Yes	No
Format Column	Yes	No	No	Yes	No
FreeText Column	Yes	No	No	Yes	No
Gradient Column	Yes	No	No	Yes	Yes
Grid Info	No	No	No	Yes	Yes
Layout	Yes	Yes	Yes	No	No
Percent Bar	Yes	No	No	Yes	Yes
Plus Minus	Yes	No	No	Yes	No
Query	Yes	Yes	Yes	No	No
Quick Search	No	Yes	Yes	No	No
Reminder	No	No	No	No	No
Schedule	Yes	No	No	No	No
Shortcut	Yes	No	No	No	No
Smart Edit	No	Yes	Yes	No	Yes
System Status	No	Yes	Yes	Yes	Yes
Theme	No	Yes	Yes	No	No
Updated Row	No	No	No	Yes	Yes

Plugin-based Functions

Adaptable Function	Wizard	Toolbar	Tool Panel	Column Menu	Context Menu
Chart	No	Yes	No	No	No
ipushpull	No	Yes	No	No	No
Glue42	No	Yes	No	No	No
OpenFin	No	Yes	No	No	No
Finsemble	No	No	No	No	No

Entitlements

All AdapTableFunctions are subject to Entitlements (aka permissions).

This means that end-users will only be able to access a AdapTableFunction according to whether it has been given an Entitlement of Full, ReadOnly or Hidden.

Predefined Config / State

Design-time Users are able to pre-populate AdapTable with Predefined Config - this is the AdapTable State that will be available when the application first loads.

Nearly every AdapTableFunction has its own section / property in PredefinedConfig which will be the same as the FunctionName (e.g. 'CustomSort').

note

There are many sections in Predefined Config most which are AdapTableFunction-related.

Function Name

Each AdapTable Function has a FunctionName property.

This is a strongly-typed object called AdaptableFunctionName.

note

This allows you to easily reference Adaptable Functions when creating Predefined Config as they will appear in a dropdown as you type.

An Adaptable Function also a FriendlyName property which is how the Function is referred to in AdapTable menus and toolbars.

tip

The Friendly Name can be changed via the alternativeFunctionNames property in General Options

FAQ

Can we hide particular Functions from our users as they are not relevant (i.e. we are a readonly grid so don't require Smart Edit or Shortcuts Functions)?

Yes, you can use the Entitlements section of Predefined Config to set which Functions are available to each user, and whether they are hidden, editable or readonly.

Do you plan to add more Functions?

Yes, we continue to add more Functions all the time, primarily in response to suggestions and ideas submitted by our Users.

Can I change the Name of the Dashboard Function as we already have a Dashboard section in our application?

Yes, use the the alternativeFunctionNames property in General Options which allows you provide an alternative name for an Adaptable Function and will used whenever the Function name is displayed.