UIPresetEditor
A class that instantiates the UI Preset Editor and provides APIs to manage presets and their configuration.
Properties
Methods
Events
Adds a new preset to the UI Preset Editor.
- Type:
- (preset: any) => void
- Parameters:
- Implemented in:
- UIPresetEditor
- See also:
- removePreset
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
Returns a preset with the specified name.
- Type:
- (name: string) => any
- Parameters:
-
name, type: string ,
The preset name.
- Return Value:
-
An
IPresetobject orundefinedif a preset with thisnameis not found.
- Implemented in:
- UIPresetEditor
An event that is raised when the preset list is saved in the Manage Presets dialog.
Parameters:
sender:UIPresetEditor
AUIPresetEditorinstance that raised the event.options.presets:IPresetListItem[]
The updated preset list.
- Type:
- EventBase<UIPresetEditor, { presets: {}; }>
- Implemented in:
- UIPresetEditor
A preset being configured in the UI Preset Editor.
- Type:
- any readonly
- Implemented in:
- UIPresetEditor
- See also:
- savePresetFunc
Removes a preset from the UI Preset Editor.
- Type:
- (presetAccessor: any) => void
- Parameters:
- Implemented in:
- UIPresetEditor
- See also:
- addPreset
A function that handles saving a preset.
Use the preset property to access the preset being saved.
- 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