Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "src/AdaptableOptions/UserFunctions"

Index

Interfaces

Type aliases

Type aliases

UserFunction

The actual implementations of functions that users reference in Predefined Config.

Predefined Config is stored as JSON - and often remotely - which means that it is not possible to store function implementations (as they cannot be serialised).

So, instead, in Predefined Config the name of the function is provided and the code implementation is in functionOptions in AdaptableOptions.

All of these implementations are of type UserFunction which contains 3 properties:

  1. the type of the function: this allows AdapTable to know which function is being provided; this is strongly typed for user convenience

  2. the name of the function: must be the same as the function name provided in Predefined Config

  3. the function handler: the actual function implementation itself; this varies based on the type of the function.


The types supported are:

User Function Description
CustomSortComparerFunction A Comparer function for running bespoke Custom Sorts
CellSummaryOperationFunction Bespoke Cell Summaries
ActionColumnRenderFunction Render an Action Column in a non-standard way
ActionColumnShouldRenderPredicate Whether or not to render an Acton Column
EntitlementLookUpFunction Enables external look ups for Entitlements
UserMenuItemClickedFunction Action to run when a User Menu item is clicked
UserMenuItemShowPredicate Whether or not to show the User Menu item
UserMenuItemLabelFunction Retrieves a distinct value for the label of a Menu Item
GetColumnValuesFunction Get Columns Values (used in Lookups & Permitted Values)
CustomExportDestinationFunction Provides a custom destination for a Report
CustomReportFunction Runs a Custom Report

UserFunctions

UserFunctions: UserFunction[]

Type which wraps an array of UserFunction

Generated using TypeDoc