BalloonPanelView (ui/panel/balloon)

@ckeditor/ckeditor5-ui/src/panel/balloon/balloonpanelview

The balloon panel view class.

A floating container which can pin to any target in the DOM and remain in that position e.g. when the web page is scrolled.

The balloon panel can be used to display contextual, non-blocking UI like forms, toolbars and the like in its content view collection.

There is a number of defaultPositions that the balloon can use, automatically switching from one to another when the viewport space becomes scarce to keep the balloon visible to the user as long as it is possible. The balloon will also accept any custom position set provided by the user compatible with the options.

const panel = new BalloonPanelView( locale );
const childView = new ChildView();
const positions = BalloonPanelView.defaultPositions;

panel.render();

// Add a child view to the panel's content collection.
panel.content.add( childView );

// Start pinning the panel to an element with the "target" id DOM.
// The balloon will remain pinned until unpin() is called.
panel.pin( {
	target: document.querySelector( '#target' ),
	positions: [
		positions.northArrowSouth,
		positions.southArrowNorth
	]
} );

Filtering

Public
Inherited
Mixed
Protected
Private
Deprecated

Properties

class : String

observable

An additional CSS class added to the element.

See source
content : ViewCollection

readonly

A collection of the child views that creates the balloon panel contents.

See source

`element : HTMLElement`

inherited

An HTML element of the view. null until rendered from the template.

See source

class SampleView extends View {
	constructor() {
		super();

		// A template instance the #element will be created from.
		this.setTemplate( {
			tag: 'p'

			// ...
		} );
	}
}

const view = new SampleView();

// Renders the #template.
view.render();

// Append the HTML element of the view to <body>.
document.body.appendChild( view.element );

Note: The element of the view can also be assigned directly:

view.element = document.querySelector( '#my-container' );

isRendered : Boolean

readonly inherited

Set true when the view has already been rendered.

See source
isVisible : Boolean

observable

Controls whether the balloon panel is visible or not.

See source

Defaults to false
left : Number

observable

The absolute left position of the balloon panel in pixels.

See source

Defaults to 0
locale : Locale

readonly inherited

A set of tools to localize the user interface.

See source

Also see locale.
position : 'arrow_nw' | 'arrow_ne' | 'arrow_sw' | 'arrow_se'

observable

The balloon panel's current position. The position name is reflected in the CSS class set to the balloon, i.e. .ck-balloon-panel_arrow_nw for the "arrow_nw" position. The class controls the minor aspects of the balloon's visual appearance like the placement of an arrow. To support a new position, an additional CSS must be created.

See source

Default position names correspond with defaultPositions.

See the attachTo and pin methods to learn about custom balloon positions.

Defaults to 'arrow_nw'
template : Template

inherited

Template of this view. It provides the element representing the view in DOM, which is rendered.

See source
top : Number

observable

The absolute top position of the balloon panel in pixels.

See source

Defaults to 0
withArrow : Boolean

observable

Controls whether the balloon panel has an arrow. The presence of the arrow is reflected in the ck-balloon-panel_with-arrow CSS class.

See source

Defaults to true
_unboundChildren : ViewCollection

protected inherited

A collection of view instances, which have been added directly into the children.

See source
_viewCollections : Set.<ViewCollection>

protected inherited

Collections registered with createCollection.

See source
_bindTemplate : Object

private inherited

Cached bind chain object created by the template. See bindTemplate.

See source
_pinWhenIsVisibleCallback : function

private

A callback that starts pinning the panel when isVisible gets true. Used by pin.

See source

Static properties

arrowHorizontalOffset : Number

static
A horizontal offset of the arrow tip from the edge of the balloon. Controlled by CSS.

See source
```
	 +-----|---------...
	 |     |
	 |     |
	 |     |
	 |     |
	 +--+  |  +------...
	     \ | /
	      \|/
    >|-----|<---------------- horizontal offset
```
Defaults to 25

`arrowVerticalOffset : Number`

static

A vertical offset of the arrow from the edge of the balloon. Controlled by CSS.

See source

 +-------------...
 |
 |
 |                      /-- vertical offset
 |                     V
 +--+    +-----...    ---------
     \  /              |
      \/               |
-------------------------------
                       ^

Defaults to 10

`defaultPositions : Object.<String, positioningFunction>`

static

A default set of positioning functions used by the balloon panel view when attaching using the attachTo method.

See source

The available positioning functions are as follows:

North west

northWestArrowSouthWest

+-----------------+
|     Balloon     |
+-----------------+
 V
 [ Target ]

northWestArrowSouthMiddleWest

+-----------------+
|     Balloon     |
+-----------------+
    V
    [ Target ]

northWestArrowSouth

+-----------------+
|     Balloon     |
+-----------------+
         V
         [ Target ]

northWestArrowSouthMiddleEast

+-----------------+
|     Balloon     |
+-----------------+
             V
             [ Target ]

northWestArrowSouthEast

+-----------------+
|     Balloon     |
+-----------------+
                 V
                 [ Target ]

North

northArrowSouthWest

    +-----------------+
    |     Balloon     |
    +-----------------+
     V
[ Target ]

northArrowSouthMiddleWest

 +-----------------+
 |     Balloon     |
 +-----------------+
     V
[ Target ]

northArrowSouth

+-----------------+
|     Balloon     |
+-----------------+
         V
    [ Target ]

northArrowSouthMiddleEast

+-----------------+
|     Balloon     |
+-----------------+
             V
        [ Target ]

northArrowSouthEast

+-----------------+
|     Balloon     |
+-----------------+
                V
           [ Target ]

North east

northEastArrowSouthWest

        +-----------------+
        |     Balloon     |
        +-----------------+
         V
[ Target ]

northEastArrowSouthMiddleWest

     +-----------------+
     |     Balloon     |
     +-----------------+
         V
[ Target ]

northEastArrowSouth

+-----------------+
|     Balloon     |
+-----------------+
         V
[ Target ]

northEastArrowSouthMiddleEast

+-----------------+
|     Balloon     |
+-----------------+
             V
    [ Target ]

northEastArrowSouthEast

+-----------------+
|     Balloon     |
+-----------------+
                 V
        [ Target ]

South

southArrowNorthWest

[ Target ]
     ^
    +-----------------+
    |     Balloon     |
    +-----------------+

southArrowNorthMiddleWest

[ Target ]
     ^
 +-----------------+
 |     Balloon     |
 +-----------------+

southArrowNorth

    [ Target ]
         ^
+-----------------+
|     Balloon     |
+-----------------+

southArrowNorthMiddleEast

         [ Target ]
              ^
+-----------------+
|     Balloon     |
+-----------------+

southArrowNorthEast

            [ Target ]
                 ^
+-----------------+
|     Balloon     |
+-----------------+

South west

southWestArrowNorthWest

 [ Target ]
 ^
+-----------------+
|     Balloon     |
+-----------------+

southWestArrowNorthMiddleWest

    [ Target ]
    ^
+-----------------+
|     Balloon     |
+-----------------+

southWestArrowNorth

         [ Target ]
         ^
+-----------------+
|     Balloon     |
+-----------------+

southWestArrowNorthMiddleEast

              [ Target ]
              ^
+-----------------+
|     Balloon     |
+-----------------+

southWestArrowNorthEast

                 [ Target ]
                 ^
+-----------------+
|     Balloon     |
+-----------------+

South east

southEastArrowNorthWest

[ Target ]
         ^
        +-----------------+
        |     Balloon     |
        +-----------------+

southEastArrowNorthMiddleWest

[ Target ]
         ^
     +-----------------+
     |     Balloon     |
     +-----------------+

southEastArrowNorth

[ Target ]
         ^
+-----------------+
|     Balloon     |
+-----------------+

southEastArrowNorthMiddleEast

     [ Target ]
              ^
+-----------------+
|     Balloon     |
+-----------------+

southEastArrowNorthEast

        [ Target ]
                 ^
+-----------------+
|     Balloon     |
+-----------------+

viewportStickyNorth

    +---------------------------+
    |        [ Target ]         |
    |                           |
+-----------------------------------+
|   |    +-----------------+    |   |
|   |    |     Balloon     |    |   |
|   |    +-----------------+    |   |
|   |                           |   |
|   |                           |   |
|   |                           |   |
|   |                           |   |
|   +---------------------------+   |
|             Viewport              |
+-----------------------------------+

See attachTo.

Positioning functions must be compatible with Position.

Default positioning functions with customized offsets can be generated using generatePositions.

The name that the position function returns will be reflected in the balloon panel's class that controls the placement of the "arrow". See position to learn more.

`stickyVerticalOffset : Number`

static

A vertical offset of the balloon panel from the edge of the viewport if sticky. It helps in accessing toolbar buttons underneath the balloon panel.

See source

  +---------------------------------------------------+
  |                      Target                       |
  |                                                   |
  |                            /-- vertical offset    |
+-----------------------------V-------------------------+
| Toolbar            +-------------+                    |
+--------------------|   Balloon   |--------------------+
| |                  +-------------+                  | |
| |                                                   | |
| |                                                   | |
| |                                                   | |
| +---------------------------------------------------+ |
|                        Viewport                       |
+-------------------------------------------------------+

Defaults to 20

_getOptimalPosition : function

protected static

Function used to calculate the optimal position for the balloon.

See source

Methods

constructor( [ locale ] )

inherited

Creates an instance of the View class.

See source

Also see render.

Parameters

[ locale ] : Locale

The localization services instance.
attachTo( options )
Attaches the panel to a specified target with a smart positioning heuristics that chooses from available positions to make sure the panel is visible to the user i.e. within the limits of the viewport.

See source
This method accepts configuration options to set the target, optional limiter and positions the balloon should choose from.
```
const panel = new BalloonPanelView( locale );
const positions = BalloonPanelView.defaultPositions;

panel.render();

// Attach the panel to an element with the "target" id DOM.
panel.attachTo( {
	target: document.querySelector( '#target' ),
	positions: [
		positions.northArrowSouth,
		positions.southArrowNorth
	]
} );
```
Note: Attaching the panel will also automatically show it.

Note: An attached panel will not follow its target when the window is scrolled or resized. See the pin method for a more permanent positioning strategy.

Parameters

options : Options

Positioning options compatible with getOptimalPosition. Default positions array is defaultPositions.
bind( bindProperties ) → Object

mixed
Binds observable properties to other objects implementing the Observable interface.

See source
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 : String

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

Returns

Object

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

`bindTemplate()`

inherited

Shorthand for bind, a binding interface pre–configured for the view instance.

See source

It provides to() and if() methods that initialize bindings with observable attributes and attach DOM listeners.

class SampleView extends View {
	constructor( locale ) {
		super( locale );

		const bind = this.bindTemplate;

		// These observable attributes will control
		// the state of the view in DOM.
		this.set( {
			elementClass: 'foo',
		 	isEnabled: true
		 } );

		this.setTemplate( {
			tag: 'p',

			attributes: {
				// The class HTML attribute will follow elementClass
				// and isEnabled view attributes.
				class: [
					bind.to( 'elementClass' )
					bind.if( 'isEnabled', 'present-when-enabled' )
				]
			},

			on: {
				// The view will fire the "clicked" event upon clicking <p> in DOM.
				click: bind.to( 'clicked' )
			}
		} );
	}
}

`createCollection( [ views ] ) → ViewCollection`

inherited

Creates a new collection of views, which can be used as children of this view.

See source

class SampleView extends View {
	constructor( locale ) {
		super( locale );

		const child = new ChildView( locale );
		this.items = this.createCollection( [ child ] );

		this.setTemplate( {
			tag: 'p',

			// `items` collection will render here.
			children: this.items
		} );
	}
}

const view = new SampleView( locale );
view.render();

// It will append <p><child#element></p> to the <body>.
document.body.appendChild( view.element );

Parameters

[ views ] : Iterable.<View>: Initial views of the collection.

Returns

ViewCollection: A new collection of view instances.

decorate( methodName )

mixed
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.

See source
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 {
	constructor() {
		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 : String

Name of the method to decorate.
delegate( events ) → EmitterMixinDelegateChain

mixed
Delegates selected events to another Emitter. For instance:

See source
```
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 : String

Event names that will be delegated to another emitter.

Returns

EmitterMixinDelegateChain
deregisterChild( children )

inherited
The opposite of registerChild. Removes a child view from this view instance. Once removed, the child is no longer managed by its parent, e.g. it can safely become a child of another parent view.

See source
Parameters

children : View | Iterable.<View>

Child views to be removed.

Related:
- View#registerChild
destroy()

inherited
Recursively destroys the view instance and child views added by registerChild and residing in collections created by the createCollection.

See source
Destruction disables all event listeners:
- created on the view, e.g. view.on( 'event', () => {} ),
- defined in the template for DOM events.
extendTemplate( definition )

inherited
Extends the template of the view with with given definition.

See source
A shorthand for:
```
Template.extend( view.template, definition );
```
Note: Is requires the template to be already set. See setTemplate.

Parameters

definition : TemplateDefinition

Definition which extends the template.
fire( eventOrInfo, [ args ] ) → *

mixed

Fires an event, executing all callbacks registered for it.

See source

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

Parameters

eventOrInfo : String | EventInfo

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

[ args ] : *

Additional arguments to be passed to the callbacks.

Returns

*

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).
hide()

Hides the panel.

See source

See isVisible.
listenTo( emitter, event, callback, [ options ] = { [options.priority] } )

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

See source
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.

Parameters

emitter : Emitter

The object that fires the event.

event : String

The name of the event.

callback : function

The function to be called on event.

[ options ] : Object

Additional options.

Properties

[ options.priority ] : PriorityString | Number

The priority of this event callback. The higher the priority value the sooner the callback will be fired. Events having the same priority are called in the order they were added.

Defaults to 'normal'

Defaults to {}
off( event, callback )

mixed

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

See source

Parameters

event : String

The name of the event.

callback : function

The function to stop being called.
on( event, callback, [ options ] = { [options.priority] } )

mixed

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

See source

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

Parameters

event : String

The name of the event.

callback : function

The function to be called on event.

[ options ] : Object

Additional options.

Properties

[ options.priority ] : PriorityString | Number

The priority of this event callback. The higher the priority value the sooner the callback will be fired. Events having the same priority are called in the order they were added.

Defaults to 'normal'

Defaults to {}
once( event, callback, [ options ] = { [options.priority] } )

mixed

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.

See source

Parameters

event : String

The name of the event.

callback : function

The function to be called on event.

[ options ] : Object

Additional options.

Properties

[ options.priority ] : PriorityString | Number

The priority of this event callback. The higher the priority value the sooner the callback will be fired. Events having the same priority are called in the order they were added.

Defaults to 'normal'

Defaults to {}
pin( options )
Works the same way as the attachTo method except that the position of the panel is continuously updated when:

See source
- any ancestor of the target or limiter is scrolled,
- the browser window gets resized or scrolled.
Thanks to that, the panel always sticks to the target and is immune to the changing environment.
```
const panel = new BalloonPanelView( locale );
const positions = BalloonPanelView.defaultPositions;

panel.render();

// Pin the panel to an element with the "target" id DOM.
panel.pin( {
	target: document.querySelector( '#target' ),
	positions: [
		positions.northArrowSouth,
		positions.southArrowNorth
	]
} );
```
To leave the pinned state, use the unpin method.

Note: Pinning the panel will also automatically show it.

Parameters

options : Options

Positioning options compatible with getOptimalPosition. Default positions array is defaultPositions.

`registerChild( children )`

inherited

Registers a new child view under the view instance. Once registered, a child view is managed by its parent, including rendering and destruction.

See source

To revert this, use deregisterChild.

class SampleView extends View {
	constructor( locale ) {
		super( locale );

		this.childA = new SomeChildView( locale );
		this.childB = new SomeChildView( locale );

		this.setTemplate( { tag: 'p' } );

		// Register the children.
		this.registerChild( [ this.childA, this.childB ] );
	}

	render() {
		super.render();

		this.element.appendChild( this.childA.element );
		this.element.appendChild( this.childB.element );
	}
}

const view = new SampleView( locale );

view.render();

// Will append <p><childA#element><b></b><childB#element></p>.
document.body.appendChild( view.element );

Note: There's no need to add child views if they're already referenced in the template:

class SampleView extends View {
	constructor( locale ) {
		super( locale );

		this.childA = new SomeChildView( locale );
		this.childB = new SomeChildView( locale );

		this.setTemplate( {
			tag: 'p',

			// These children will be added automatically. There's no
			// need to call registerChild for any of them.
			children: [ this.childA, this.childB ]
		} );
	}

	// ...
}

Parameters

children : View | Iterable.<View>: Children views to be registered.

`render()`

inherited

Recursively renders the view.

See source

Once the view is rendered:

the element becomes an HTML element out of template,
the isRendered flag is set true.

Note: The children of the view:

defined directly in the template
residing in collections created by the createCollection method,
and added by registerChild are also rendered in the process.

In general, render() method is the right place to keep the code which refers to the element and should be executed at the very beginning of the view's life cycle.

It is possible to extend the template before the view is rendered. To allow an early customization of the view (e.g. by its parent), such references should be done in render().

class SampleView extends View {
	constructor() {
		this.setTemplate( {
			// ...
		} );
	},

	render() {
		// View#element becomes available.
		super.render();

		// The "scroll" listener depends on #element.
		this.listenTo( window, 'scroll', () => {
			// A reference to #element would render the #template and make it non-extendable.
			if ( window.scrollY > 0 ) {
				this.element.scrollLeft = 100;
			} else {
				this.element.scrollLeft = 0;
			}
		} );
	}
}

const view = new SampleView();

// Let's customize the view before it gets rendered.
view.extendTemplate( {
	attributes: {
		class: [
			'additional-class'
		]
	}
} );

// Late rendering allows customization of the view.
view.render();

set( name, [ value ] )

mixed

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

See source

It accepts also 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.

Parameters

name : String | Object

The property's name or object with name=>value pairs.

[ value ] : *

The property's value (if name was passed in the first parameter).
setTemplate( definition )

inherited
Sets the template of the view with with given definition.

See source
A shorthand for:
```
view.setTemplate( definition );
```
Parameters

definition : TemplateDefinition

Definition of view's template.
show()

Shows the panel.

See source

See isVisible.
stopDelegating( [ event ], [ emitter ] )

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

See source
- 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.
stopListening( [ emitter ], [ event ], [ callback ] )

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

See source
- 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.
t()

inherited
Shorthand for t.

See source
Note: If locale instance hasn't been passed to the view this method may not be available.

Related:
- Locale#t
unbind( [ unbindProperties ] )

mixed
Removes the binding created with bind.

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

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

[ unbindProperties ] : String

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

Stops pinning the panel, as set up by pin.

See source
_addEventListener( event, callback, [ options ] = { [options.priority] } )

protected mixed

Adds callback to emitter for given event.

See source

Parameters

event : String

The name of the event.

callback : function

The function to be called on event.

[ options ] : Object

Additional options.

Properties

[ options.priority ] : PriorityString | Number

The priority of this event callback. The higher the priority value the sooner the callback will be fired. Events having the same priority are called in the order they were added.

Defaults to 'normal'

Defaults to {}
_removeEventListener( event, callback )

protected mixed

Removes callback from emitter for given event.

See source

Parameters

event : String

The name of the event.

callback : function

The function to stop being called.
_startPinning( options )

private

Starts managing the pinned state of the panel. See pin.

See source

Parameters

options : Options

Positioning options compatible with getOptimalPosition.
_stopPinning()

private

Stops managing the pinned state of the panel. See pin.

See source

Events

change:class( eventInfo, name, value, oldValue )

Fired when the class property changed value.

See source

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : String

Name of the changed property (class).

value : String

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

oldValue : String

Old value of the class property with given key or null, if property was not set before.
change:isVisible( eventInfo, name, value, oldValue )

Fired when the isVisible property changed value.

See source

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : String

Name of the changed property (isVisible).

value : Boolean

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

oldValue : Boolean

Old value of the isVisible property with given key or null, if property was not set before.
change:left( eventInfo, name, value, oldValue )

Fired when the left property changed value.

See source

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : String

Name of the changed property (left).

value : Number

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

oldValue : Number

Old value of the left property with given key or null, if property was not set before.
change:position( eventInfo, name, value, oldValue )

Fired when the position property changed value.

See source

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : String

Name of the changed property (position).

value : 'arrow_nw' | 'arrow_ne' | 'arrow_sw' | 'arrow_se'

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

oldValue : 'arrow_nw' | 'arrow_ne' | 'arrow_sw' | 'arrow_se'

Old value of the position property with given key or null, if property was not set before.
change:top( eventInfo, name, value, oldValue )

Fired when the top property changed value.

See source

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : String

Name of the changed property (top).

value : Number

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

oldValue : Number

Old value of the top property with given key or null, if property was not set before.
change:withArrow( eventInfo, name, value, oldValue )

Fired when the withArrow property changed value.

See source

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : String

Name of the changed property (withArrow).

value : Boolean

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

oldValue : Boolean

Old value of the withArrow property with given key or null, if property was not set before.
change:{property}( eventInfo, name, value, oldValue )

mixed
Fired when a property changed value.

See source
```
observable.set( 'prop', 1 );

observable.on( '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 : *

The new property value.

oldValue : *

The previous property value.
render( eventInfo )

inherited

Event fired by the render method. Actual rendering is executed as a listener to this event with the default priority.

See source

See decorate for more information and samples.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

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

mixed

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

See source

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

observable.set( 'prop', 1 );

observable.on( '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( '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 : *: The new property value.
oldValue : *: The previous property value.

Every day, we work hard to keep our documentation complete. Have you spotted an outdated information? Is something missing? Please report it via our issue tracker.

BalloonPanelView (ui/panel/balloon)

Filtering

Properties

class : Stringmodule:ui/panel/balloon/balloonpanelview~BalloonPanelView#class

content : ViewCollectionmodule:ui/panel/balloon/balloonpanelview~BalloonPanelView#content

element : HTMLElementmodule:ui/panel/balloon/balloonpanelview~BalloonPanelView#element

isRendered : Booleanmodule:ui/panel/balloon/balloonpanelview~BalloonPanelView#isRendered

isVisible : Booleanmodule:ui/panel/balloon/balloonpanelview~BalloonPanelView#isVisible

left : Numbermodule:ui/panel/balloon/balloonpanelview~BalloonPanelView#left

locale : Localemodule:ui/panel/balloon/balloonpanelview~BalloonPanelView#locale

position : 'arrow_nw' | 'arrow_ne' | 'arrow_sw' | 'arrow_se'module:ui/panel/balloon/balloonpanelview~BalloonPanelView#position

template : Templatemodule:ui/panel/balloon/balloonpanelview~BalloonPanelView#template

top : Numbermodule:ui/panel/balloon/balloonpanelview~BalloonPanelView#top

withArrow : Booleanmodule:ui/panel/balloon/balloonpanelview~BalloonPanelView#withArrow

_unboundChildren : ViewCollectionmodule:ui/panel/balloon/balloonpanelview~BalloonPanelView#_unboundChildren

_viewCollections : Set.<ViewCollection>module:ui/panel/balloon/balloonpanelview~BalloonPanelView#_viewCollections

_bindTemplate : Objectmodule:ui/panel/balloon/balloonpanelview~BalloonPanelView#_bindTemplate

_pinWhenIsVisibleCallback : functionmodule:ui/panel/balloon/balloonpanelview~BalloonPanelView#_pinWhenIsVisibleCallback

Static properties

arrowHorizontalOffset : Numbermodule:ui/panel/balloon/balloonpanelview~BalloonPanelView.arrowHorizontalOffset

arrowVerticalOffset : Numbermodule:ui/panel/balloon/balloonpanelview~BalloonPanelView.arrowVerticalOffset

defaultPositions : Object.<String, positioningFunction>module:ui/panel/balloon/balloonpanelview~BalloonPanelView.defaultPositions

stickyVerticalOffset : Numbermodule:ui/panel/balloon/balloonpanelview~BalloonPanelView.stickyVerticalOffset

_getOptimalPosition : functionmodule:ui/panel/balloon/balloonpanelview~BalloonPanelView._getOptimalPosition

Methods

constructor( [ locale ] )module:ui/panel/balloon/balloonpanelview~BalloonPanelView#constructor

Parameters

attachTo( options )module:ui/panel/balloon/balloonpanelview~BalloonPanelView#attachTo

Parameters

bind( bindProperties ) → Objectmodule:ui/panel/balloon/balloonpanelview~BalloonPanelView#bind

Parameters

Returns

bindTemplate()module:ui/panel/balloon/balloonpanelview~BalloonPanelView#bindTemplate

createCollection( [ views ] ) → ViewCollectionmodule:ui/panel/balloon/balloonpanelview~BalloonPanelView#createCollection

Parameters

Returns

decorate( methodName )module:ui/panel/balloon/balloonpanelview~BalloonPanelView#decorate

Parameters

delegate( events ) → EmitterMixinDelegateChainmodule:ui/panel/balloon/balloonpanelview~BalloonPanelView#delegate

Parameters

Returns

deregisterChild( children )module:ui/panel/balloon/balloonpanelview~BalloonPanelView#deregisterChild

Parameters

Related:

destroy()module:ui/panel/balloon/balloonpanelview~BalloonPanelView#destroy

extendTemplate( definition )module:ui/panel/balloon/balloonpanelview~BalloonPanelView#extendTemplate

Parameters

fire( eventOrInfo, [ args ] ) → *module:ui/panel/balloon/balloonpanelview~BalloonPanelView#fire

Parameters

Returns

hide()module:ui/panel/balloon/balloonpanelview~BalloonPanelView#hide

listenTo( emitter, event, callback, [ options ] = { [options.priority] } )module:ui/panel/balloon/balloonpanelview~BalloonPanelView#listenTo

Parameters

off( event, callback )module:ui/panel/balloon/balloonpanelview~BalloonPanelView#off

Parameters

on( event, callback, [ options ] = { [options.priority] } )module:ui/panel/balloon/balloonpanelview~BalloonPanelView#on

Parameters

once( event, callback, [ options ] = { [options.priority] } )module:ui/panel/balloon/balloonpanelview~BalloonPanelView#once

Parameters

pin( options )module:ui/panel/balloon/balloonpanelview~BalloonPanelView#pin

Parameters

registerChild( children )module:ui/panel/balloon/balloonpanelview~BalloonPanelView#registerChild

Parameters

render()module:ui/panel/balloon/balloonpanelview~BalloonPanelView#render

set( name, [ value ] )module:ui/panel/balloon/balloonpanelview~BalloonPanelView#set

Parameters

setTemplate( definition )module:ui/panel/balloon/balloonpanelview~BalloonPanelView#setTemplate

Parameters

show()module:ui/panel/balloon/balloonpanelview~BalloonPanelView#show

stopDelegating( [ event ], [ emitter ] )module:ui/panel/balloon/balloonpanelview~BalloonPanelView#stopDelegating

Parameters

stopListening( [ emitter ], [ event ], [ callback ] )module:ui/panel/balloon/balloonpanelview~BalloonPanelView#stopListening

Parameters

t()module:ui/panel/balloon/balloonpanelview~BalloonPanelView#t

Related:

unbind( [ unbindProperties ] )module:ui/panel/balloon/balloonpanelview~BalloonPanelView#unbind

Parameters

unpin()module:ui/panel/balloon/balloonpanelview~BalloonPanelView#unpin

_addEventListener( event, callback, [ options ] = { [options.priority] } )module:ui/panel/balloon/balloonpanelview~BalloonPanelView#_addEventListener

Parameters

`class : String`

`content : ViewCollection`

`element : HTMLElement`

`isRendered : Boolean`

`isVisible : Boolean`

`left : Number`

`locale : Locale`

`position : 'arrow_nw' | 'arrow_ne' | 'arrow_sw' | 'arrow_se'`

`template : Template`

`top : Number`

`withArrow : Boolean`

`_unboundChildren : ViewCollection`

`_viewCollections : Set.<ViewCollection>`

`_bindTemplate : Object`

`_pinWhenIsVisibleCallback : function`

`arrowHorizontalOffset : Number`

`arrowVerticalOffset : Number`

`defaultPositions : Object.<String, positioningFunction>`

`stickyVerticalOffset : Number`

`_getOptimalPosition : function`

`constructor( [ locale ] )`

`attachTo( options )`

`bind( bindProperties ) → Object`

`bindTemplate()`

`createCollection( [ views ] ) → ViewCollection`

`decorate( methodName )`

`delegate( events ) → EmitterMixinDelegateChain`

`deregisterChild( children )`

`destroy()`

`extendTemplate( definition )`

`fire( eventOrInfo, [ args ] ) → *`

`hide()`

`listenTo( emitter, event, callback, [ options ] = { [options.priority] } )`

`off( event, callback )`

`on( event, callback, [ options ] = { [options.priority] } )`

`once( event, callback, [ options ] = { [options.priority] } )`

`pin( options )`

`registerChild( children )`

`render()`

`set( name, [ value ] )`

`setTemplate( definition )`

`show()`

`stopDelegating( [ event ], [ emitter ] )`

`stopListening( [ emitter ], [ event ], [ callback ] )`

`t()`

`unbind( [ unbindProperties ] )`

`unpin()`

`_addEventListener( event, callback, [ options ] = { [options.priority] } )`

`_removeEventListener( event, callback )`

`_startPinning( options )`

`_stopPinning()`

`change:class( eventInfo, name, value, oldValue )`

`change:isVisible( eventInfo, name, value, oldValue )`

`change:left( eventInfo, name, value, oldValue )`

`change:position( eventInfo, name, value, oldValue )`

`change:top( eventInfo, name, value, oldValue )`

`change:withArrow( eventInfo, name, value, oldValue )`

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

`render( eventInfo )`

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