CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

ResizeState (widget/widgetresize)

@ckeditor/ckeditor5-widget/src/widgetresize/resizerstate

class
See source

Stores the internal state of a single resizable object.

Filtering

Properties

  • observable

    activeHandlePosition : null | string

    See source

    The position of the handle that initiated the resizing. E.g. "top-left", "bottom-right" etc. or null if unknown.

  • readonly

    aspectRatio : undefined | number

    See source

    A width to height ratio of the resized image.

  • readonly

    originalHeight : undefined | number

    See source

    The original height (pixels) of the resized object when the resize process was started.

  • readonly

    originalWidth : undefined | number

    See source

    The original width (pixels) of the resized object when the resize process was started.

  • readonly

    originalWidthPercents : undefined | number

    See source

    The original width (percents) of the resized object when the resize process was started.

  • observable

    proposedHandleHostHeight : null | number

    See source

  • observable

    proposedHandleHostWidth : null | number

    See source

  • observable

    proposedHeight : null | number

    See source

    The height (pixels) proposed, but not committed yet, in the current resize process.

  • observable

    proposedWidth : null | number

    See source

    The width (pixels) proposed, but not committed yet, in the current resize process.

  • observable

    proposedWidthPercents : null | number

    See source

    The width (percents) proposed, but not committed yet, in the current resize process.

  • internal

    _referenceCoordinates : null | object

    See source

    The reference point of the resizer where the dragging started. It is used to measure the distance the user cursor traveled, so how much the image should be enlarged. This information is only known after the DOM was rendered, so it will be updated later.

  • private

    _aspectRatio : number | undefined

    See source

    A width to height ratio of the resized image.

  • private readonly

    _options : ResizerOptions

    See source

    Resizer options.

  • private

    _originalHeight : number | undefined

    See source

    The original height (pixels) of the resized object when the resize process was started.

  • private

    _originalWidth : number | undefined

    See source

    The original width (pixels) of the resized object when the resize process was started.

  • private

    _originalWidthPercents : number | undefined

    See source

    The original width (percents) of the resized object when the resize process was started.

Methods

  • constructor( options )

    See source

    Parameters

    options : ResizerOptions

    Resizer options.

  • begin( domResizeHandle, domHandleHost, domResizeHost ) → void

    See source

    Parameters

    domResizeHandle : HTMLElement

    The handle used to calculate the reference point.

    domHandleHost : HTMLElement
    domResizeHost : HTMLElement

    Returns

    void

  • inherited

    bind( bindProperties ) → MultiBindChain

    See source

    Binds observable properties to other objects implementing the Observable interface.

    Read more in the dedicated guide covering the topic of property bindings with some additional examples.

    Consider two objects: a button and an associated command (both Observable).

    A simple property binding could be as follows:

    button.bind( 'isEnabled' ).to( command, 'isEnabled' );

    or even shorter:

    button.bind( 'isEnabled' ).to( command );

    which works in the following way:

    • button.isEnabled instantly equals command.isEnabled,
    • whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.

    Note: To release the binding, use unbind.

    You can also "rename" the property in the binding by specifying the new name in the to() chain:

    button.bind( 'isEnabled' ).to( command, 'isWorking' );

    It is possible to bind more than one property at a time to shorten the code:

    button.bind( 'isEnabled', 'value' ).to( command );

    which corresponds to:

    button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );

    The binding can include more than one observable, combining multiple data sources in a custom callback:

    button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );

    Using a custom callback allows processing the value before passing it to the target property:

    button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );

    It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) so that each and every one of them must be enabled for the button to become enabled, use the following code:

    button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );

    Parameters

    bindProperties : Array<'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'update' | 'activeHandlePosition' | 'proposedWidthPercents' | 'proposedWidth' | 'proposedHeight' | 'proposedHandleHostWidth' | 'proposedHandleHostHeight' | '_referenceCoordinates' | 'originalWidth' | 'originalHeight' | 'originalWidthPercents' | 'aspectRatio' | 'begin'>

    Observable properties that will be bound to other observable(s).

    Returns

    MultiBindChain

    The bind chain with the to() and toMany() methods.

  • inherited

    bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, ResizeState[ K1 ], K2, ResizeState[ K2 ]>

    See source

    Binds observable properties to other objects implementing the Observable interface.

    Read more in the dedicated guide covering the topic of property bindings with some additional examples.

    Consider two objects: a button and an associated command (both Observable).

    A simple property binding could be as follows:

    button.bind( 'isEnabled' ).to( command, 'isEnabled' );

    or even shorter:

    button.bind( 'isEnabled' ).to( command );

    which works in the following way:

    • button.isEnabled instantly equals command.isEnabled,
    • whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.

    Note: To release the binding, use unbind.

    You can also "rename" the property in the binding by specifying the new name in the to() chain:

    button.bind( 'isEnabled' ).to( command, 'isWorking' );

    It is possible to bind more than one property at a time to shorten the code:

    button.bind( 'isEnabled', 'value' ).to( command );

    which corresponds to:

    button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );

    The binding can include more than one observable, combining multiple data sources in a custom callback:

    button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );

    Using a custom callback allows processing the value before passing it to the target property:

    button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );

    It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) so that each and every one of them must be enabled for the button to become enabled, use the following code:

    button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );

    Type parameters

    K1
    K2

    Parameters

    bindProperty1 : K1

    Observable property that will be bound to other observable(s).

    bindProperty2 : K2

    Observable property that will be bound to other observable(s).

    Returns

    DualBindChain<K1, ResizeState[ K1 ], K2, ResizeState[ K2 ]>

    The bind chain with the to() and toMany() methods.

  • inherited

    bind( bindProperty ) → SingleBindChain<K, ResizeState[ K ]>

    See source

    Binds observable properties to other objects implementing the Observable interface.

    Read more in the dedicated guide covering the topic of property bindings with some additional examples.

    Consider two objects: a button and an associated command (both Observable).

    A simple property binding could be as follows:

    button.bind( 'isEnabled' ).to( command, 'isEnabled' );

    or even shorter:

    button.bind( 'isEnabled' ).to( command );

    which works in the following way:

    • button.isEnabled instantly equals command.isEnabled,
    • whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.

    Note: To release the binding, use unbind.

    You can also "rename" the property in the binding by specifying the new name in the to() chain:

    button.bind( 'isEnabled' ).to( command, 'isWorking' );

    It is possible to bind more than one property at a time to shorten the code:

    button.bind( 'isEnabled', 'value' ).to( command );

    which corresponds to:

    button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );

    The binding can include more than one observable, combining multiple data sources in a custom callback:

    button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );

    Using a custom callback allows processing the value before passing it to the target property:

    button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );

    It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) so that each and every one of them must be enabled for the button to become enabled, use the following code:

    button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );

    Type parameters

    K

    Parameters

    bindProperty : K

    Observable property that will be bound to other observable(s).

    Returns

    SingleBindChain<K, ResizeState[ K ]>

    The bind chain with the to() and toMany() methods.

  • inherited

    decorate( methodName ) → void

    See source

    Turns the given methods of this object into event-based ones. This means that the new method will fire an event (named after the method) and the original action will be plugged as a listener to that event.

    Read more in the dedicated guide covering the topic of decorating methods with some additional examples.

    Decorating the method does not change its behavior (it only adds an event), but it allows to modify it later on by listening to the method's event.

    For example, to cancel the method execution the event can be stopped:

    class Foo extends ObservableMixin() {
	constructor() {
		super();
		this.decorate( 'method' );
	}

	method() {
		console.log( 'called!' );
	}
}

const foo = new Foo();
foo.on( 'method', ( evt ) => {
	evt.stop();
}, { priority: 'high' } );

foo.method(); // Nothing is logged.

    Note: The high priority listener has been used to execute this particular callback before the one which calls the original method (which uses the "normal" priority).

    It is also possible to change the returned value:

    foo.on( 'method', ( evt ) => {
	evt.return = 'Foo!';
} );

foo.method(); // -> 'Foo'

    Finally, it is possible to access and modify the arguments the method is called with:

    method( a, b ) {
	console.log( `${ a }, ${ b }`  );
}

// ...

foo.on( 'method', ( evt, args ) => {
	args[ 0 ] = 3;

	console.log( args[ 1 ] ); // -> 2
}, { priority: 'high' } );

foo.method( 1, 2 ); // -> '3, 2'

    Parameters

    methodName : 'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'update' | 'activeHandlePosition' | 'proposedWidthPercents' | 'proposedWidth' | 'proposedHeight' | 'proposedHandleHostWidth' | 'proposedHandleHostHeight' | '_referenceCoordinates' | 'originalWidth' | 'originalHeight' | 'originalWidthPercents' | 'aspectRatio' | 'begin'

    Name of the method to decorate.

    Returns

    void

  • inherited

    delegate( events ) → EmitterMixinDelegateChain

    See source

    Delegates selected events to another Emitter. For instance:

    emitterA.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );

    then eventX is delegated (fired by) emitterB and emitterC along with data:

    emitterA.fire( 'eventX', data );

    and eventY is delegated (fired by) emitterC along with data:

    emitterA.fire( 'eventY', data );

    Parameters

    events : Array<string>

    Event names that will be delegated to another emitter.

    Returns

    EmitterMixinDelegateChain

  • inherited

    fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]

    See source

    Fires an event, executing all callbacks registered for it.

    The first parameter passed to callbacks is an EventInfo object, followed by the optional args provided in the fire() method call.

    Type parameters

    TEvent : extends BaseEvent

    The type describing the event. See BaseEvent.

    Parameters

    eventOrInfo : GetNameOrEventInfo<TEvent>

    The name of the event or EventInfo object if event is delegated.

    args : TEvent[ 'args' ]

    Additional arguments to be passed to the callbacks.

    Returns

    GetEventInfo<TEvent>[ 'return' ]

    By default the method returns undefined. However, the return value can be changed by listeners through modification of the evt.return's property (the event info is the first param of every callback).

  • inherited

    listenTo( emitter, event, callback, [ options ] ) → void

    See source

    Registers a callback function to be executed when an event is fired in a specific (emitter) object.

    Events can be grouped in namespaces using :. When namespaced event is fired, it additionally fires all callbacks for that namespace.

    // myEmitter.on( ... ) is a shorthand for myEmitter.listenTo( myEmitter, ... ).
myEmitter.on( 'myGroup', genericCallback );
myEmitter.on( 'myGroup:myEvent', specificCallback );

// genericCallback is fired.
myEmitter.fire( 'myGroup' );
// both genericCallback and specificCallback are fired.
myEmitter.fire( 'myGroup:myEvent' );
// genericCallback is fired even though there are no callbacks for "foo".
myEmitter.fire( 'myGroup:foo' );

    An event callback can stop the event and set the return value of the fire method.

    Type parameters

    TEvent : extends BaseEvent

    The type describing the event. See BaseEvent.

    Parameters

    emitter : Emitter

    The object that fires the event.

    event : TEvent[ 'name' ]

    The name of the event.

    callback : GetCallback<TEvent>

    The function to be called on event.

    [ options ] : GetCallbackOptions<TEvent>

    Additional options.

    Returns

    void

  • inherited

    off( event, callback ) → void

    See source

    Stops executing the callback on the given event. Shorthand for this.stopListening( this, event, callback ).

    Parameters

    event : string

    The name of the event.

    callback : Function

    The function to stop being called.

    Returns

    void

  • inherited

    on( event, callback, [ options ] ) → void

    See source

    Registers a callback function to be executed when an event is fired.

    Shorthand for this.listenTo( this, event, callback, options ) (it makes the emitter listen on itself).

    Type parameters

    TEvent : extends BaseEvent

    The type descibing the event. See BaseEvent.

    Parameters

    event : TEvent[ 'name' ]

    The name of the event.

    callback : GetCallback<TEvent>

    The function to be called on event.

    [ options ] : GetCallbackOptions<TEvent>

    Additional options.

    Returns

    void

  • inherited

    once( event, callback, [ options ] ) → void

    See source

    Registers a callback function to be executed on the next time the event is fired only. This is similar to calling on followed by off in the callback.

    Type parameters

    TEvent : extends BaseEvent

    The type descibing the event. See BaseEvent.

    Parameters

    event : TEvent[ 'name' ]

    The name of the event.

    callback : GetCallback<TEvent>

    The function to be called on event.

    [ options ] : GetCallbackOptions<TEvent>

    Additional options.

    Returns

    void

  • inherited

    set( values ) → void

    See source

    Creates and sets the value of an observable properties of this object. Such a property becomes a part of the state and is observable.

    It accepts a single object literal containing key/value pairs with properties to be set.

    This method throws the observable-set-cannot-override error if the observable instance already has a property with the given property name. This prevents from mistakenly overriding existing properties and methods, but means that foo.set( 'bar', 1 ) may be slightly slower than foo.bar = 1.

    In TypeScript, those properties should be declared in class using declare keyword. In example:

    public declare myProp1: number;
public declare myProp2: string;

constructor() {
	this.set( {
		'myProp1: 2,
		'myProp2: 'foo'
	} );
}

    Parameters

    values : object

    An object with name=>value pairs.

    Returns

    void

  • inherited

    set( name, value ) → void

    See source

    Creates and sets the value of an observable property of this object. Such a property becomes a part of the state and is observable.

    This method throws the observable-set-cannot-override error if the observable instance already has a property with the given property name. This prevents from mistakenly overriding existing properties and methods, but means that foo.set( 'bar', 1 ) may be slightly slower than foo.bar = 1.

    In TypeScript, those properties should be declared in class using declare keyword. In example:

    public declare myProp: number;

constructor() {
	this.set( 'myProp', 2 );
}

    Type parameters

    K

    Parameters

    name : K

    The property's name.

    value : ResizeState[ K ]

    The property's value.

    Returns

    void

  • inherited

    stopDelegating( [ event ], [ emitter ] ) → void

    See source

    Stops delegating events. It can be used at different levels:

    • To stop delegating all events.
    • To stop delegating a specific event to all emitters.
    • To stop delegating a specific event to a specific emitter.

    Parameters

    [ event ] : string

    The name of the event to stop delegating. If omitted, stops it all delegations.

    [ emitter ] : Emitter

    (requires event) The object to stop delegating a particular event to. If omitted, stops delegation of event to all emitters.

    Returns

    void

  • inherited

    stopListening( [ emitter ], [ event ], [ callback ] ) → void

    See source

    Stops listening for events. It can be used at different levels:

    • To stop listening to a specific callback.
    • To stop listening to a specific event.
    • To stop listening to all events fired by a specific object.
    • To stop listening to all events fired by all objects.

    Parameters

    [ emitter ] : Emitter

    The object to stop listening to. If omitted, stops it for all objects.

    [ event ] : string

    (Requires the emitter) The name of the event to stop listening to. If omitted, stops it for all events from emitter.

    [ callback ] : Function

    (Requires the event) The function to be removed from the call list for the given event.

    Returns

    void

  • inherited

    unbind( unbindProperties ) → void

    See source

    Removes the binding created with bind.

    // Removes the binding for the 'a' property.
A.unbind( 'a' );

// Removes bindings for all properties.
A.unbind();

    Parameters

    unbindProperties : Array<'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'update' | 'activeHandlePosition' | 'proposedWidthPercents' | 'proposedWidth' | 'proposedHeight' | 'proposedHandleHostWidth' | 'proposedHandleHostHeight' | '_referenceCoordinates' | 'originalWidth' | 'originalHeight' | 'originalWidthPercents' | 'aspectRatio' | 'begin'>

    Observable properties to be unbound. All the bindings will be released if no properties are provided.

    Returns

    void

  • update( newSize = { newSize.handleHostHeight, newSize.handleHostWidth, newSize.height, newSize.width, newSize.widthPercents } ) → void

    See source

    Parameters

    newSize : object
    Properties
    newSize.handleHostHeight : number
    newSize.handleHostWidth : number
    newSize.height : number
    newSize.width : number
    newSize.widthPercents : number

    Returns

    void

Events

  • change:activeHandlePosition( eventInfo, name, value, oldValue )

    See source

    Fired when the activeHandlePosition property changed value.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (activeHandlePosition).

    value : null | string

    New value of the activeHandlePosition property with given key or null, if operation should remove property.

    oldValue : null | string

    Old value of the activeHandlePosition property with given key or null, if property was not set before.

  • change:proposedHandleHostHeight( eventInfo, name, value, oldValue )

    See source

    Fired when the proposedHandleHostHeight property changed value.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (proposedHandleHostHeight).

    value : null | number

    New value of the proposedHandleHostHeight property with given key or null, if operation should remove property.

    oldValue : null | number

    Old value of the proposedHandleHostHeight property with given key or null, if property was not set before.

  • change:proposedHandleHostWidth( eventInfo, name, value, oldValue )

    See source

    Fired when the proposedHandleHostWidth property changed value.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (proposedHandleHostWidth).

    value : null | number

    New value of the proposedHandleHostWidth property with given key or null, if operation should remove property.

    oldValue : null | number

    Old value of the proposedHandleHostWidth property with given key or null, if property was not set before.

  • change:proposedHeight( eventInfo, name, value, oldValue )

    See source

    Fired when the proposedHeight property changed value.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (proposedHeight).

    value : null | number

    New value of the proposedHeight property with given key or null, if operation should remove property.

    oldValue : null | number

    Old value of the proposedHeight property with given key or null, if property was not set before.

  • change:proposedWidth( eventInfo, name, value, oldValue )

    See source

    Fired when the proposedWidth property changed value.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (proposedWidth).

    value : null | number

    New value of the proposedWidth property with given key or null, if operation should remove property.

    oldValue : null | number

    Old value of the proposedWidth property with given key or null, if property was not set before.

  • change:proposedWidthPercents( eventInfo, name, value, oldValue )

    See source

    Fired when the proposedWidthPercents property changed value.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (proposedWidthPercents).

    value : null | number

    New value of the proposedWidthPercents property with given key or null, if operation should remove property.

    oldValue : null | number

    Old value of the proposedWidthPercents property with given key or null, if property was not set before.

  • inherited

    change:{property}( eventInfo, name, value, oldValue )

    See source

    Fired when a property changed value.

    observable.set( 'prop', 1 );

observable.on<ObservableChangeEvent<number>>( 'change:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `${ propertyName } has changed from ${ oldValue } to ${ newValue }` );
} );

observable.prop = 2; // -> 'prop has changed from 1 to 2'

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    The property name.

    value : TValue

    The new property value.

    oldValue : TValue

    The previous property value.

  • set:activeHandlePosition( eventInfo, name, value, oldValue )

    See source

    Fired when the activeHandlePosition property is going to be set but is not set yet (before the change event is fired).

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (activeHandlePosition).

    value : null | string

    New value of the activeHandlePosition property with given key or null, if operation should remove property.

    oldValue : null | string

    Old value of the activeHandlePosition property with given key or null, if property was not set before.

  • set:proposedHandleHostHeight( eventInfo, name, value, oldValue )

    See source

    Fired when the proposedHandleHostHeight property is going to be set but is not set yet (before the change event is fired).

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (proposedHandleHostHeight).

    value : null | number

    New value of the proposedHandleHostHeight property with given key or null, if operation should remove property.

    oldValue : null | number

    Old value of the proposedHandleHostHeight property with given key or null, if property was not set before.

  • set:proposedHandleHostWidth( eventInfo, name, value, oldValue )

    See source

    Fired when the proposedHandleHostWidth property is going to be set but is not set yet (before the change event is fired).

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (proposedHandleHostWidth).

    value : null | number

    New value of the proposedHandleHostWidth property with given key or null, if operation should remove property.

    oldValue : null | number

    Old value of the proposedHandleHostWidth property with given key or null, if property was not set before.

  • set:proposedHeight( eventInfo, name, value, oldValue )

    See source

    Fired when the proposedHeight property is going to be set but is not set yet (before the change event is fired).

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (proposedHeight).

    value : null | number

    New value of the proposedHeight property with given key or null, if operation should remove property.

    oldValue : null | number

    Old value of the proposedHeight property with given key or null, if property was not set before.

  • set:proposedWidth( eventInfo, name, value, oldValue )

    See source

    Fired when the proposedWidth property is going to be set but is not set yet (before the change event is fired).

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (proposedWidth).

    value : null | number

    New value of the proposedWidth property with given key or null, if operation should remove property.

    oldValue : null | number

    Old value of the proposedWidth property with given key or null, if property was not set before.

  • set:proposedWidthPercents( eventInfo, name, value, oldValue )

    See source

    Fired when the proposedWidthPercents property is going to be set but is not set yet (before the change event is fired).

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    Name of the changed property (proposedWidthPercents).

    value : null | number

    New value of the proposedWidthPercents property with given key or null, if operation should remove property.

    oldValue : null | number

    Old value of the proposedWidthPercents property with given key or null, if property was not set before.

  • inherited

    set:{property}( eventInfo, name, value, oldValue )

    See source

    Fired when a property value is going to be set but is not set yet (before the change event is fired).

    You can control the final value of the property by using the event's return property.

    observable.set( 'prop', 1 );

observable.on<ObservableSetEvent<number>>( 'set:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `Value is going to be changed from ${ oldValue } to ${ newValue }` );
	console.log( `Current property value is ${ observable[ propertyName ] }` );

	// Let's override the value.
	evt.return = 3;
} );

observable.on<ObservableChangeEvent<number>>( 'change:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `Value has changed from ${ oldValue } to ${ newValue }` );
} );

observable.prop = 2; // -> 'Value is going to be changed from 1 to 2'
                     // -> 'Current property value is 1'
                     // -> 'Value has changed from 1 to 3'

    Note: The event is fired even when the new value is the same as the old value.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : string

    The property name.

    value : TValue

    The new property value.

    oldValue : TValue

    The previous property value.