Jodit Editor

ImageEditor

modules/image-editor.ImageEditor

The module allows you to edit the image: resize or cut any part of it

Hierarchy

constructor

new ImageEditor(editor): ImageEditor

Parameters

Name Type
editor IViewWithToolbar<IViewOptions> & IDlgs

Returns

ImageEditor

Overrides

ViewComponent.constructor

Defined in

src/modules/image-editor/image-editor.ts#726

STATUSES

Static STATUSES: Object = STATUSES

Type declaration

Name Type
beforeInit "beforeInit"
ready "ready"
beforeDestruct "beforeDestruct"
destructed "destructed"

Inherited from

ViewComponent.STATUSES

Defined in

src/core/component/component.ts#40

async

async: IAsync

Inherited from

ViewComponent.async

Defined in

src/core/component/component.ts#44

uid

Readonly uid: string

Inherited from

ViewComponent.uid

Defined in

src/core/component/component.ts#59

ownerWindow

ownerWindow: Window = window

The window in which jodit was created

Inherited from

ViewComponent.ownerWindow

Defined in

src/core/component/component.ts#109

jodit

jodit: IViewWithToolbar<IViewOptions> & IDlgs

Parent View element

Inherited from

ViewComponent.jodit

Defined in

src/core/component/view-component.ts#22

options

options: ImageEditorOptions

Defined in

src/modules/image-editor/image-editor.ts#81

componentName

get componentName(): string

Returns

string

Inherited from

ViewComponent.componentName

Defined in

src/core/component/component.ts#46

ownerDocument

get ownerDocument(): Document

The document in which jodit was created

Returns

Document

Inherited from

ViewComponent.ownerDocument

Defined in

src/core/component/component.ts#95

od

get od(): Document

Shortcut for this.ownerDocument

Returns

Document

Inherited from

ViewComponent.od

Defined in

src/core/component/component.ts#102

ow

get ow(): Window

Returns

Window

Inherited from

ViewComponent.ow

Defined in

src/core/component/component.ts#110

isReady

get isReady(): boolean

Component is ready for work

Returns

boolean

Inherited from

ViewComponent.isReady

Defined in

src/core/component/component.ts#145

isDestructed

get isDestructed(): boolean

Component was destructed

Returns

boolean

Inherited from

ViewComponent.isDestructed

Defined in

src/core/component/component.ts#152

isInDestruct

get isInDestruct(): boolean

The component is currently undergoing destructuring or has already been destroyed.
Those. you should not the app froze new events on him now or do anything else with him.

Returns

boolean

Inherited from

ViewComponent.isInDestruct

Defined in

src/core/component/component.ts#160

componentStatus

get componentStatus(): ComponentStatus

Current component status

Returns

ComponentStatus

Inherited from

ViewComponent.componentStatus

Defined in

src/core/component/component.ts#210

set componentStatus(componentStatus): void

Setter for current component status

Parameters

Name Type
componentStatus ComponentStatus

Returns

void

Inherited from

ViewComponent.componentStatus

Defined in

src/core/component/component.ts#217

j

get j(): T

Shortcut for this.jodit

Returns

T

Inherited from

ViewComponent.j

Defined in

src/core/component/view-component.ts#27

defaultTimeout

get defaultTimeout(): number

Returns

number

Inherited from

ViewComponent.defaultTimeout

Defined in

src/core/component/view-component.ts#31

o

get o(): this["options"]

Returns

this["options"]

Defined in

src/modules/image-editor/image-editor.ts#82

getFullElName

getFullElName(elementName): string

Calc BEM element class name

Parameters

Name Type Description
elementName string element name in the bem classification

Returns

string

Inherited from

ViewComponent.getFullElName

Defined in

src/core/component/component.ts#65

getFullElName(elementName, mod): string

Parameters

Name Type
elementName string
mod string

Returns

string

Inherited from

ViewComponent.getFullElName

Defined in

src/core/component/component.ts#66

getFullElName(elementName, mod, modValue): string

Parameters

Name Type
elementName string
mod string
modValue string | boolean

Returns

string

Inherited from

ViewComponent.getFullElName

Defined in

src/core/component/component.ts#67

get

get<T>(chain, obj?): Nullable<T>

Safe get any field

Type parameters

Name
T

Parameters

Name Type Description
chain string the path to be traversed in the obj object
obj? IDictionary the object in which the value is searched

Returns

Nullable<T>

Example

private a = {
  b: {
    c: {
      e: {
        g: {
          color: 'red'
        }
      }
    }
  }
}

this.get('a.b.c.e.g.color'); // Safe access to color
// instead using optionsl chaining
this?.a?.b?.c?.e?.g?.color

Inherited from

ViewComponent.get

Defined in

src/core/component/component.ts#138

bindDestruct

bindDestruct(component): this

Bind destructor to some View

Parameters

Name Type
component IComponent<IViewBased<IViewOptions>>

Returns

this

Inherited from

ViewComponent.bindDestruct

Defined in

src/core/component/component.ts#170

setStatus

setStatus(componentStatus): void

Set component status

Parameters

Name Type Description
componentStatus ComponentStatus component status

Returns

void

See

ComponentStatus

Inherited from

ViewComponent.setStatus

Defined in

src/core/component/component.ts#226

hookStatus

hookStatus(status, callback): void

Adds a handler for changing the component's status

Parameters

Name Type Description
status ComponentStatus the status at which the callback is triggered
callback (component: this) => void a function that will be called when the status is status

Returns

void

Inherited from

ViewComponent.hookStatus

Defined in

src/core/component/component.ts#265

isInstanceOf

isInstanceOf<T>(c, constructorFunc): c is T

Type parameters

Name Type
T extends Component

Parameters

Name Type
c unknown
constructorFunc Function

Returns

c is T

Inherited from

ViewComponent.isInstanceOf

Defined in

src/core/component/component.ts#283

i18n

i18n(text, ...params): string

Parameters

Name Type
text string
...params (string | number)[]

Returns

string

Inherited from

ViewComponent.i18n

Defined in

src/core/component/view-component.ts#35

setParentView

setParentView(jodit): this

Attach component to View

Parameters

Name Type
jodit IViewWithToolbar<IViewOptions> & IDlgs

Returns

this

Inherited from

ViewComponent.setParentView

Defined in

src/core/component/view-component.ts#42

className

className(): string

Returns

string

Overrides

ViewComponent.className

Defined in

src/modules/image-editor/image-editor.ts#77

hide

hide(): void

Hide image editor

Returns

void

Defined in

src/modules/image-editor/image-editor.ts#97

open

open(url, save): Promise<IDialog>

Open image editor

Parameters

Name Type
url string
save onSave

Returns

Promise<IDialog>

Example

const jodit = Jodit.make('.editor', {
     imageeditor: {
         crop: false,
         closeAfterSave: true,
         width: 500
     }
});
jodit.imageeditor.open('https://xdsoft.net/jodit/images/test.png', function (name, data, success, failed) {
     var img = jodit.node.c('img');
     img.setAttribute('src', 'https://xdsoft.net/jodit/images/test.png');
     if (box.action !== 'resize') {
          return failed('Sorry it is work only in resize mode. For croping use FileBrowser');
     }
     img.style.width = data.w;
     img.style.height = data.h;
     jodit.s.insertNode(img);
     success();
});
Defined in

src/modules/image-editor/image-editor.ts#126

destruct

destruct(): any

Returns

any

Overrides

ViewComponent.destruct

Defined in

jodit/src/modules/image-editor/image-editor.ts:783

In this article: