AdapTable Version:

Framework:

Hiding AdapTable

Summary

This UI Guide shows how developers can hide the AdapTable UI from their users (so they just see AG Grid)
It also shows how they can show the AdapTable UI but remove all explicit mentions, and links, of the Tool

Some of our users want to "hide" AdapTable from their users.

This request can have 2 different meanings:

Not showing any of the AdapTable UI - so the tool still runs and works but none of the UI is visible
Hiding all mentions of the tool (so that all our components appear to be custom built)

Both of these are possible, as this UI Guide illustrates.

Hiding AdapTable UI

Some users have the requirement that they want fully to hide the AdapTable UI.

This includes all means of re-activating the AdapTable UI from inside AG Grid.

Caution

If you wish to give your users a way of redisplaying the AdapTable UI, you will need to provide that mechanism yourself

There are 2 common scenarios that we encounter:

Have a mechanism to switch between showing AG Grid with AdapTable, and just displaying AG Grid
AdapTable's UI is hidden in all circumstances (but AdapTable operates under the covers)

Hint

This could be because our client's setup contains a single directive to create all their Grids
Or it could be because AdapTable's formatting, filtering or Conditional Styles functionality is required

This requirement is possible using 2 companion functions in the UserInterfaceApi Section of Adaptable API:

hideAdaptableUI
showAdaptableUI

These functions will hide / show all AdapTable UI components:

Note

The one exception to this is the AdapTable Column Filtering components, which will remain in operation throughout

Hiding AdapTable UI from Users

Fork Fork

This example provides 2 buttons - placed in a container above AdapTable - that hide / show the AdapTable UI
The Hide button removes the Dashboard, Status Bar panels and AdapTable Tool Panels as well as AdapTable's Column and Context menus
Note: we have also added a Format Style to the 3 Github columns - this remains in place even when AdapTable is hidden, as does the Github Total Calculated Column

Hiding AdapTable Mentions

It is possible to configure AdapTable so that while the UI is fully visible, nothing betrays its a 3rd party tool.

This is easily achievable - each of the following prominent AdapTable elements can be hidden:

Documentation Links
AdapTable Version
AdapTable ToolPanel

Hiding Documentation Links

AdapTable provides links to this documentation inside the tool in 2 places:

in each Screen of the Settings Panel
in the Expression Editor

This can be turned off using the showDocumentationLinks property in User Interface Options.

showDocumentationLinks

Default: true

Boolean

Provide links to AdapTable documentation

Set this property to false if you do not wish your users to see these links:

// Stop users from seeing documentation links
const adaptableOptions: AdaptableOptions = {
  userInterfaceOptions: {
    showDocumentationLinks: false,
  },
};

Hiding AdapTable Version

By default AdapTable provides information about which version number is being used in the Application.

This is displayed as the first item in the Summary section of the Grid Info Screen.

This can be hidden using the showAdapTableVersion property in User Interface Options.

Hint

A companion showAgGridVersion property, also in User Interface Options, will hide the AG Grid version

showAdapTableVersion

Default: true

Boolean

Displays AdapTable Version in GridInfo section of Settings Panel

Set this property to false if you do not wish your users to see the AdapTable Version:

// Stop users from seeing documentation links
const adaptableOptions: AdaptableOptions = {
  userInterfaceOptions: {
    showAdapTableVersion: false,
  },
};

Renaming AdapTable ToolPanel

By default, the Tool Panel provided by AdapTable is named "AdapTable".

It is possible to configure the Tool Panel in order to change this in 2 ways:

Hide the AdapTable ToolPanel altogether, by not listing it in the Tool Panels section
Rename the AdapTable Toolbar, so that it is still present but with a different name displayed

Hiding State Management Module

Most Modules give no indication they are from AdapTable, they just work (e.g. Quick Search, Layout etc).

However the State Management Module is very closely tied to AdapTable State, as it allows run-time users to save or reload their State.

Like all AdapTable Modules, setting the AccessLevel for the Module (in Entitlements) to "hidden" will ensure that the panel is never visible to run-time users.

Hiding AdapTable Mentions from Users

Fork Fork

This demo shows how to "hide" Adaptable from the users of the Application:
- showDocumentationLinks in User Interface Options set to false - this means that no links to AdapTable are displayed in the Settings Panel
- showAdapTableVersion in User Interface Options is also set to false - this hides the version number that otherwise appears as first item in Summary section of Settings Panel
- The AdapTable Tool Panel component in GridOptions has been renamed 'My Grid' - in place of the default value of AdapTable
- The State Management module is set to Hidden in Entitlements

Expand to see the Adaptable Options and GridOptions properties set

These properties have been added to Adaptable Options:

userInterfaceOptions: {
  showDocumentationLinks: false,
  showAdapTableVersion: false,
},
entitlementOptions: {
  moduleEntitlements: [
    {adaptableModule: 'StateManagement', accessLevel: 'Hidden'},
  ],
},

And the Sidebar in GridOptions has been defined as follows:

sideBar: {
  toolPanels: [
    'columns',
    'filters',
    {
      id: 'adaptable',
      toolPanel: 'AdaptableToolPanel',
      labelDefault: 'My Grid',
    },
  ],
},

PreviousDisplaying Progress Indicators NextChoosing American English