Read-Only Object Entitlements

Summary

Read Ony Object Entitlements are used to set individual AdapTable Objects to be read only
They take precedence over Module Entitlements where all objects by default have a Visible entitlement

Sometimes setting a Module level restriction of Entitlements is insufficient.

For instance, a user might require a Module to have a Full entitlement (i.e. it's editable) but one particular Object should be ReadOnly (i.e. cannot be deleted).

For this reason, AdapTable allows ReadOnly Entitlements to be set at the object level.

It is done by setting the IsReadOnly property of Adaptable Object to true.

Note

This will overrride the Full Entitlement in the Adaptable Module for this object only to be ReadOnly

Caution

There is no property for the opposite use case
You cannot change an AdapTable object to be Full where the Module's Entitlement is ReadOnly

Entitlements: ReadOnly Objects

Fork Fork

This example illustrates how to use ReadOnly objects using 2 Format Columns
One - which provides a red background to Language cells which contain 'TypeScript' - is marked as ReadOnly
The other - which makes GitHub Stars > 50000 light blue - is not marked as ReadOnly (so has the Entitlement of the Module which is Full)

Expand to see the Format Column Definitions

FormatColumn: {
  FormatColumns: [
    {
      Name: 'FormatColumn-language-268',
      // Format Column is ReadOnly - it can be rendered but not endered
      IsReadOnly: true,
      Style: {
        ForeColor: 'gray',
        BackColor: 'brown',
      },
      Scope: {
        ColumnIds: ['language'],
      },
      Rule: {
        BooleanExpression: '[language] = "TypeScript"',
      },
    },
    {
      Name: 'FormatColumn-github_stars-269',
      Style: {
        ForeColor: 'Blue',
      },
      Scope: {
        ColumnIds: ['github_stars'],
      },
      Rule: {
        Predicates: [{
          PredicateId: 'GreaterThan',
          Inputs: [50000],
        }],
      },
    },
  ],
},

Try It Out

Open the Format Column section of the Settings Panel to see the 2 Format Columns
Note that you can edit, suspend, delete one but not the other
Because the Module has an Entitlement of Full you are able to create new Format Columns

Find Out More

See Adaptable Object for more information on this topic

PreviousPermissioning Modules NextDefault Access Level