UIPresetEditor

A class that instantiates the UI Preset Editor and provides APIs to manage presets and their configuration.

UI Preset Editor Documentation

UI Preset Editor Demo

addPreset method

Adds a new preset to the UI Preset Editor.

Type:
(preset: any) => void
Parameters:
preset, type: any ,

An IPreset object to add.

Implemented in:
UIPresetEditor
See also:
removePreset
availablePresets property

A mutable array of presets added to the UI Preset Editor either in code (using registerUIPreset or addPreset) or by the user.

Type:
{} readonly
Implemented in:
UIPresetEditor
getPreset method

Returns a preset with the specified name.

Type:
(name: string) => any
Parameters:
name, type: string ,

The preset name.

Return Value:

An IPreset object or undefined if a preset with this name is not found.

Implemented in:
UIPresetEditor

An event that is raised when the preset list is saved in the Manage Presets dialog.

Parameters:

  • sender: UIPresetEditor
    A UIPresetEditor instance that raised the event.
  • options.presets: IPresetListItem[]
    The updated preset list.
Type:
EventBase<UIPresetEditor, { presets: {}; }>
Implemented in:
UIPresetEditor
preset property

A preset being configured in the UI Preset Editor.

UI Preset Editor Demo

Type:
any readonly
Implemented in:
UIPresetEditor
See also:
savePresetFunc
removePreset method

Removes a preset from the UI Preset Editor.

Type:
(presetAccessor: any) => void
Parameters:
presetAccessor, type: any ,

An IPreset object to delete or a preset name.

Implemented in:
UIPresetEditor
See also:
addPreset
savePresetFunc property

A function that handles saving a preset.

Use the preset property to access the preset being saved.

How to Save and Load Presets

Type:
(saveNo: number, callback: (no: number, isSuccess: boolean) => void) => void readonly
Implemented in:
UIPresetEditor

Send feedback to the SurveyJS team

Need help? Visit our support page

Your cookie settings

We use cookies to make your browsing experience more convenient and personal. Some cookies are essential, while others help us analyse traffic. Your personal data and cookies may be used for ad personalization. By clicking “Accept All”, you consent to the use of all cookies as described in our Terms of Use and Privacy Statement. You can manage your preferences in “Cookie settings.”

Your renewal subscription expires soon.

Since the license is perpetual, you will still have permanent access to the product versions released within the first 12 month of the original purchase date.

If you wish to continue receiving technical support from our Help Desk specialists and maintain access to the latest product updates, make sure to renew your subscription by clicking the "Renew" button below.

Your renewal subscription has expired.

Since the license is perpetual, you will still have permanent access to the product versions released within the first 12 month of the original purchase date.

If you wish to continue receiving technical support from our Help Desk specialists and maintain access to the latest product updates, make sure to renew your subscription by clicking the "Renew" button below.