CKEditor Ecosystem Documentation

Report an issue

Home/CKEditor 4/API

Class

CKEDITOR.plugins.imagebase

class singleton since 4.9.0

Namespace providing a set of helper functions for working with image widgets.

Filtering

Public
Inherited
Mixed
Protected
Private
Deprecated

Properties

featuresDefinitions : Object

See source
An object that contains all available feature definitions.

Methods

addFeature( editor, name, definition ) → imageWidgetDefinition
See source
Adds a new feature to the passed widget's definition by invoking the initial setup once for the editor and extending the widget's definition to include all fields needed by this feature.
```
var widgetDefinition = {};
widgetDefinition = CKEDITOR.plugins.imagebase.addFeature( editor, 'link', widgetDefinition );
CKEDITOR.plugins.imagebase.addImageWidget( editor, 'myWidget', widgetDefinition );
```
Parameters

editor : editor

The editor that will get the widget registered.

name : String

The feature name.

definition : imageWidgetDefinition

The widget's definition.

Returns

imageWidgetDefinition

The widget's definition extended with fields needed by the feature.
addImageWidget( editor, name, definition )

See source
Registers a new widget based on the passed definition.

Parameters

editor : editor

The editor that will get the widget registered.

name : String

The widget name.

definition : imageWidgetDefinition

The widget's definition.