AdapTable Wizards

The AdapTable Wizard allows run time users to create and edit Adaptable Objects e.g. Custom Sort or Column Formatting in a step by step manner.

Launching Wizards

Wizards can be launched from 2 places:

• Inside the Settings Panel - in any Settings Panel section that holds a collection of Adaptable Objects (e.g. Format Column or Layout), use New and Edit buttons to create and edit objects
• Column or Context Menu - many wizards can be opened directly from the grid, e.g. Create Format Column in the Column Menu, bypassing the Settings Panel

The position, size and modality of a wizard is independent of the Settings Panel.

This is intentional - wizards typically contain more content than the Settings Panel's list view and often need more room.

Wizard Modules

The following AdapTable Modules contain a Wizard:

• Alerts
• Calculated Column
• Charts
• Custom Sort
• Data Import
• Export
• Flashing Cells
• Format Column
• FreeText Column
• Layouts
• Named Query
• Plus Minus
• Shortcuts
• Styled Column

Wizard Features

Wizards contain a number of useful features including:

• vertical menu on the left naming (and numbering) each step in the process

• ability to navigate to a particular step by clicking Ctrl (Command for Mac) and the number of the step

• option to cycle through all the steps clicking Ctrl (Command for Mac) and either + or - key

• full context-sensitive instructions and help regarding what is required in each step

• information icon displayed next to steps which require information to be provided

• if finish button is disabled, message is displayed explaining what is required to re-enable

• intuitive summary screen providing at a glance information about the object created, together with buttons to edit each section of the wizard

Configuring Wizards

Developers can configure the appearance and behaviour of wizards using the wizardOptions property in Adaptable Options.

Wizard Options provides 3 properties:

Popup Type

By default wizards open as a modal - a fixed-size panel centred on screen with a backdrop.

For users who prefer to keep the underlying grid visible (or who want to drag the wizard out of the way), set popupType to 'window'. The wizard is then draggable, resizable and honours the position and size options.

// Make all wizards open as draggable, resizable windows
const adaptableOptions: AdaptableOptions = {
  wizardOptions: {
    popupType: 'window',
  },
};

Size and Position

When popupType is 'window', two further properties control the initial size and location of the wizard:

• position - using x, y values (pixel offset from the top-left of the viewport)
• size - setting width and height in pixels

// The initial position of all wizard windows
const adaptableOptions: AdaptableOptions = {
  wizardOptions: {
    popupType: 'window',
    position: {
      x: 100,
      y: 100,
    },
  },
};

// The initial size of all wizard windows
const adaptableOptions: AdaptableOptions = {
  wizardOptions: {
    popupType: 'window',
    size: {
      width: 1000,
      height: 700,
    },
  },
};

const adaptableOptions: AdaptableOptions = {
  settingsPanelOptions: {
    popupType: 'window',
    position: {x: 10, y: 10},
    size: {width: 500, height: 600},
  },
  wizardOptions: {
    popupType: 'window',
    size: {width: 1000, height: 700},
  },
};