Ext JS 4.1.3 Sencha Docs

Ext.draw.Surface

Hierarchy

Ext.Base
Ext.draw.Surface

Mixins

Requires

Subclasses

Uses

Files

A Surface is an interface to render methods inside Ext.draw.Component.

Most of the Surface methods are abstract and they have a concrete implementation in VML or SVG engines.

A Surface contains methods to render sprites, get bounding boxes of sprites, add sprites to the canvas, initialize other graphic components, etc.

Adding sprites to surface

One of the most used methods for this class is the add method, to add Sprites to the surface. For example:

drawComponent.surface.add({
    type: 'circle',
    fill: '#ffc',
    radius: 100,
    x: 100,
    y: 100
});

The configuration object passed in the add method is the same as described in the Ext.draw.Sprite class documentation.

Sprites can also be added to surface by setting their surface config at creation time:

var sprite = Ext.create('Ext.draw.Sprite', {
    type: 'circle',
    fill: '#ff0',
    surface: drawComponent.surface,
    radius: 5
});

In order to properly apply properties and render the sprite we have to show the sprite setting the option redraw to true:

sprite.show(true);

Available since: 4.0.0

Defined By

Config options

Ext.draw.Surface
view source
: Number

The height of this component in pixels (defaults to auto).

The height of this component in pixels (defaults to auto).

Available since: 4.0.0

Ext.draw.Surface
view source
: Ext.draw.Sprite[]

Array of sprites or sprite config objects to add initially to the surface.

Array of sprites or sprite config objects to add initially to the surface.

Available since: 4.1.1

A config object containing one or more event handlers to be added to this object during initialization. ...

A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once.

DOM events from Ext JS Components

While some Ext JS Component classes export selected DOM events (e.g. "click", "mouseover" etc), this is usually only done when extra value can be added. For example the DataView's itemclick event passing the node clicked on. To access DOM events directly from a child element of a Component, we need to specify the element option to identify the Component property to add a DOM listener to:

new Ext.panel.Panel({
    width: 400,
    height: 200,
    dockedItems: [{
        xtype: 'toolbar'
    }],
    listeners: {
        click: {
            element: 'el', //bind to the underlying el property on the panel
            fn: function(){ console.log('click el'); }
        },
        dblclick: {
            element: 'body', //bind to the underlying body property on the panel
            fn: function(){ console.log('dblclick body'); }
        }
    }
});

Available since: 1.1.0

Ext.draw.Surface
view source
: Number

The width of this component in pixels (defaults to auto).

The width of this component in pixels (defaults to auto).

Available since: 4.0.0

Properties

Defined By

Instance properties

...

Defaults to: 'Ext.Base'

Available since: 4.1.1

Ext.draw.Surface
view source
: Objectprivate
...

Defaults to: {blur: 0, "clip-rect": "0 0 1e9 1e9", cursor: "default", cx: 0, cy: 0, 'dominant-baseline': 'auto', fill: "none", "fill-opacity": 1, font: '10px "Arial"', "font-family": '"Arial"', "font-size": "10", "font-style": "normal", "font-weight": 400, gradient: "", height: 0, hidden: false, href: "http://sencha.com/", opacity: 1, path: "M0,0", radius: 0, rx: 0, ry: 0, scale: "1 1", src: "", stroke: "none", "stroke-dasharray": "", "stroke-linecap": "butt", "stroke-linejoin": "butt", "stroke-miterlimit": 0, "stroke-opacity": 1, "stroke-width": 1, target: "_blank", text: "", "text-anchor": "middle", title: "Ext Draw", width: 0, x: 0, y: 0, zIndex: 0}

Available since: 4.0.0

...

Defaults to: {}

Available since: 4.1.1

Ext.draw.Surface
view source
: Arrayprivate
...

Defaults to: ['Svg', 'Vml']

Available since: 4.1.2

Initial suspended call count. ...

Initial suspended call count. Incremented when suspendEvents is called, decremented when resumeEvents is called.

Defaults to: 0

Available since: 4.1.1

This object holds a key for any event that has a listener. ...

This object holds a key for any event that has a listener. The listener may be set directly on the instance, or on its class or a super class (via observe) or on the MVC EventBus. The values of this object are truthy (a non-zero number) and falsy (0 or undefined). They do not represent an exact count of listeners. The value for an event is truthy if the event must be fired and is falsy if there is no need to fire the event.

The intended use of this property is to avoid the expense of fireEvent calls when there are no listeners. This can be particularly helpful when one would otherwise have to call fireEvent hundreds or thousands of times. It is used like this:

 if (this.hasListeners.foo) {
     this.fireEvent('foo', this, arg1);
 }

Available since: 4.1.0

Ext.draw.Surface
view source
: Numberprivate
...

Defaults to: 352

Available since: 4.0.0

...

Defaults to: []

Available since: 4.1.1

...

Defaults to: {}

Available since: 4.1.1

...

Defaults to: true

Available since: 4.1.1

true in this class to identify an object as an instantiated Observable, or subclass thereof. ...

true in this class to identify an object as an instantiated Observable, or subclass thereof.

Defaults to: true

Available since: 4.0.0

Ext.draw.Surface
view source
: Booleanprivate
Flag indicating that the surface implementation requires sprites to be maintained in order of their zIndex. ...

Flag indicating that the surface implementation requires sprites to be maintained in order of their zIndex. Impls that don't require this can set it to false.

Defaults to: true

Available since: 4.0.4

Get the reference to the current class from which this object was instantiated. ...

Get the reference to the current class from which this object was instantiated. Unlike statics, this.self is scope-dependent and it's meant to be used for dynamic inheritance. See statics for a detailed comparison

Ext.define('My.Cat', {
    statics: {
        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
    },

    constructor: function() {
        alert(this.self.speciesName); // dependent on 'this'
    },

    clone: function() {
        return new this.self();
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',
    statics: {
        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'
    }
});

var cat = new My.Cat();                     // alerts 'Cat'
var snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'

var clone = snowLeopard.clone();
alert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'

Available since: 4.0.0

Ext.draw.Surface
view source
: RegExpprivate
...

Defaults to: /[, ]+/

Available since: 4.0.0

Ext.draw.Surface
view source
: Numberprivate
...

Defaults to: 512

Available since: 4.0.0

Ext.draw.Surface
view source
: Numberprivate
...

Defaults to: 0

Available since: 4.0.0

Ext.draw.Surface
view source
: Numberprivate
...

Defaults to: 0

Available since: 4.0.0

Defined By

Static properties

...

Defaults to: []

Available since: 4.1.1

Methods

Defined By

Instance methods

Ext.draw.Surface
view source
new( [config] ) : Ext.draw.Surface
Creates new Surface. ...

Creates new Surface.

Available since: 4.0.0

Parameters

  • config : Object (optional)

    Config object.

Returns

Fires

    Ext.draw.Surface
    view source
    ( args ) : Ext.draw.Sprite[]/Ext.draw.Sprite
    Adds a Sprite to the surface. ...

    Adds a Sprite to the surface. See Ext.draw.Sprite for the configuration object to be passed into this method.

    For example:

    drawComponent.surface.add({
        type: 'circle',
        fill: '#ffc',
        radius: 100,
        x: 100,
        y: 100
    });
    

    Available since: 4.0.0

    Parameters

    Returns

    Fires

      Ext.draw.Surface
      view source
      ( sprite, className )
      Adds one or more CSS classes to the element. ...

      Adds one or more CSS classes to the element. Duplicate classes are automatically filtered out.

      For example:

      drawComponent.surface.addCls(sprite, 'x-visible');
      

      Available since: 4.0.0

      Parameters

      • sprite : Object

        The sprite to add the class to.

      • className : String/String[]

        The CSS class to add, or an array of classes

      Adds the specified events to the list of events which this Observable may fire. ...

      Adds the specified events to the list of events which this Observable may fire.

      Available since: 1.1.0

      Parameters

      • eventNames : Object/String...

        Either an object with event names as properties with a value of true. For example:

        this.addEvents({
            storeloaded: true,
            storecleared: true
        });
        

        Or any number of event names as separate parameters. For example:

        this.addEvents('storeloaded', 'storecleared');
        
      Ext.draw.Surface
      view source
      ( gradient )
      Adds a gradient definition to the Surface. ...

      Adds a gradient definition to the Surface. Note that in some surface engines, adding a gradient via this method will not take effect if the surface has already been rendered. Therefore, it is preferred to pass the gradients as an item to the surface config, rather than calling this method, especially if the surface is rendered immediately (e.g. due to 'renderTo' in its config). For more information on how to create gradients in the Chart configuration object please refer to Ext.chart.Chart.

      The gradient object to be passed into this method is composed by:

      • id - string - The unique name of the gradient.
      • angle - number, optional - The angle of the gradient in degrees.
      • stops - object - An object with numbers as keys (from 0 to 100) and style objects as values.

      For example:

      drawComponent.surface.addGradient({

         id: 'gradientId',
         angle: 45,
         stops: {
             0: {
                 color: '#555'
             },
             100: {
                 color: '#ddd'
             }
         }
      

      });

      Available since: 4.0.0

      Parameters

      • gradient : Object

        A gradient config.

      ( eventName, [fn], [scope], [options] ) : Object
      Appends an event handler to this object. ...

      Appends an event handler to this object. For example:

      myGridPanel.on("mouseover", this.onMouseOver, this);
      

      The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:

      myGridPanel.on({
          cellClick: this.onCellClick,
          mouseover: this.onMouseOver,
          mouseout: this.onMouseOut,
          scope: this // Important. Ensure "this" is correct during handler execution
      });
      

      One can also specify options for each event handler separately:

      myGridPanel.on({
          cellClick: {fn: this.onCellClick, scope: this, single: true},
          mouseover: {fn: panel.onMouseOver, scope: panel}
      });
      

      Names of methods in a specified scope may also be used. Note that scope MUST be specified to use this option:

      myGridPanel.on({
          cellClick: {fn: 'onCellClick', scope: this, single: true},
          mouseover: {fn: 'onMouseOver', scope: panel}
      });
      

      Available since: 1.1.0

      Parameters

      • eventName : String/Object

        The name of the event to listen for. May also be an object who's property names are event names.

      • fn : Function (optional)

        The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to fireEvent plus the options parameter described below.

      • scope : Object (optional)

        The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

      • options : Object (optional)

        An object containing handler configuration.

        Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.

        This object may contain any of the following properties:

        • scope : Object

          The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

        • delay : Number

          The number of milliseconds to delay the invocation of the handler after the event fires.

        • single : Boolean

          True to add a handler to handle just the next firing of the event, and then remove itself.

        • buffer : Number

          Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.

        • target : Ext.util.Observable

          Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.

        • element : String

          This option is only valid for listeners bound to Components. The name of a Component property which references an element to add a listener to.

          This option is useful during Component construction to add DOM event listeners to elements of Components which will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:

            new Ext.panel.Panel({
                title: 'The title',
                listeners: {
                    click: this.handlePanelClick,
                    element: 'body'
                }
            });
          
        • destroyable : Boolean (optional)

          When specified as true, the function returns A Destroyable object. An object which implements the destroy method which removes all listeners added in this call.

          Combining Options

          Using the options argument, it is possible to combine different types of listeners:

          A delayed, one-time listener.

          myPanel.on('hide', this.handleClick, this, {
              single: true,
              delay: 100
          });
          

          Defaults to: false

      Returns

      • Object

        Only when the destroyable option is specified.

        A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

        this.btnListeners =  = myButton.on({
            destroyable: true
            mouseover:   function() { console.log('mouseover'); },
            mouseout:    function() { console.log('mouseout'); },
            click:       function() { console.log('click'); }
        });
        

        And when those listeners need to be removed:

        Ext.destroy(this.btnListeners);
        

        or

        this.btnListeners.destroy();
        

      Fires

        Overrides: Ext.AbstractComponent.addListener

        ( item, ename, [fn], [scope], [options] ) : Object
        Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is destr...

        Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is destroyed.

        Available since: 4.0.0

        Parameters

        • item : Ext.util.Observable/Ext.Element

          The item to which to add a listener/listeners.

        • ename : Object/String

          The event name, or an object containing event name properties.

        • fn : Function (optional)

          If the ename parameter was an event name, this is the handler function.

        • scope : Object (optional)

          If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

        • options : Object (optional)

          If the ename parameter was an event name, this is the addListener options.

        Returns

        • Object

          Only when the destroyable option is specified.

          A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

          this.btnListeners =  = myButton.mon({
              destroyable: true
              mouseover:   function() { console.log('mouseover'); },
              mouseout:    function() { console.log('mouseout'); },
              click:       function() { console.log('click'); }
          });
          

          And when those listeners need to be removed:

          Ext.destroy(this.btnListeners);
          

          or

          this.btnListeners.destroy();
          

        Fires

          Ext.draw.Surface
          view source
          ( sprite, onlyMatrix )private
          ...

          Available since: 4.0.0

          Parameters

          Fires

            Ext.draw.Surface
            view source
            ( )private
            Using the current viewBox property and the surface's width and height, calculate the appropriate viewBoxShift that wi...

            Using the current viewBox property and the surface's width and height, calculate the appropriate viewBoxShift that will be applied as a persistent transform to all sprites.

            Available since: 4.0.7

            ( args ) : Objectdeprecatedprotected
            Call the original method that was previously overridden with override Ext.define('My.Cat', { constructor: functi...

            Call the original method that was previously overridden with override

            Ext.define('My.Cat', {
                constructor: function() {
                    alert("I'm a cat!");
                }
            });
            
            My.Cat.override({
                constructor: function() {
                    alert("I'm going to be a cat!");
            
                    this.callOverridden();
            
                    alert("Meeeeoooowwww");
                }
            });
            
            var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                                      // alerts "I'm a cat!"
                                      // alerts "Meeeeoooowwww"
            

            Available since: 4.0.0

            This method has been deprecated

            as of 4.1. Use callParent instead.

            Parameters

            • args : Array/Arguments

              The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments)

            Returns

            • Object

              Returns the result of calling the overridden method

            Call the "parent" method of the current method. ...

            Call the "parent" method of the current method. That is the method previously overridden by derivation or by an override (see Ext.define).

             Ext.define('My.Base', {
                 constructor: function (x) {
                     this.x = x;
                 },
            
                 statics: {
                     method: function (x) {
                         return x;
                     }
                 }
             });
            
             Ext.define('My.Derived', {
                 extend: 'My.Base',
            
                 constructor: function () {
                     this.callParent([21]);
                 }
             });
            
             var obj = new My.Derived();
            
             alert(obj.x);  // alerts 21
            

            This can be used with an override as follows:

             Ext.define('My.DerivedOverride', {
                 override: 'My.Derived',
            
                 constructor: function (x) {
                     this.callParent([x*2]); // calls original My.Derived constructor
                 }
             });
            
             var obj = new My.Derived();
            
             alert(obj.x);  // now alerts 42
            

            This also works with static methods.

             Ext.define('My.Derived2', {
                 extend: 'My.Base',
            
                 statics: {
                     method: function (x) {
                         return this.callParent([x*2]); // calls My.Base.method
                     }
                 }
             });
            
             alert(My.Base.method(10);     // alerts 10
             alert(My.Derived2.method(10); // alerts 20
            

            Lastly, it also works with overridden static methods.

             Ext.define('My.Derived2Override', {
                 override: 'My.Derived2',
            
                 statics: {
                     method: function (x) {
                         return this.callParent([x*2]); // calls My.Derived2.method
                     }
                 }
             });
            
             alert(My.Derived2.method(10); // now alerts 40
            

            To override a method and replace it and also call the superclass method, use callSuper. This is often done to patch a method to fix a bug.

            Available since: 4.0.0

            Parameters

            • args : Array/Arguments

              The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments)

            Returns

            • Object

              Returns the result of calling the parent method

            ( args ) : Objectprotected
            This method is used by an override to call the superclass method but bypass any overridden method. ...

            This method is used by an override to call the superclass method but bypass any overridden method. This is often done to "patch" a method that contains a bug but for whatever reason cannot be fixed directly.

            Consider:

             Ext.define('Ext.some.Class', {
                 method: function () {
                     console.log('Good');
                 }
             });
            
             Ext.define('Ext.some.DerivedClass', {
                 method: function () {
                     console.log('Bad');
            
                     // ... logic but with a bug ...
            
                     this.callParent();
                 }
             });
            

            To patch the bug in DerivedClass.method, the typical solution is to create an override:

             Ext.define('App.paches.DerivedClass', {
                 override: 'Ext.some.DerivedClass',
            
                 method: function () {
                     console.log('Fixed');
            
                     // ... logic but with bug fixed ...
            
                     this.callSuper();
                 }
             });
            

            The patch method cannot use callParent to call the superclass method since that would call the overridden method containing the bug. In other words, the above patch would only produce "Fixed" then "Good" in the console log, whereas, using callParent would produce "Fixed" then "Bad" then "Good".

            Available since: Ext JS 4.1.3

            Parameters

            • args : Array/Arguments

              The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments)

            Returns

            • Object

              Returns the result of calling the superclass method

            Removes all listeners for this object including the managed listeners ...

            Removes all listeners for this object including the managed listeners

            Available since: 4.0.0

            Fires

              Removes all managed listeners for this object. ...

              Removes all managed listeners for this object.

              Available since: 4.0.0

              Fires

                ...

                Available since: 4.1.1

                ( eventName, args, bubbles )private
                Continue to fire event. ...

                Continue to fire event.

                Available since: 4.0.7

                Parameters

                Fires

                  Ext.draw.Surface
                  view source
                  ( id )private
                  ...

                  Available since: 4.0.0

                  Parameters

                  Ext.draw.Surface
                  view source
                  ( )private
                  Creates an item and appends it to the surface. ...

                  Creates an item and appends it to the surface. Called as an internal method when calling add.

                  Available since: 4.0.0

                  Creates an event handling function which refires the event from this object as the passed event name. ...

                  Creates an event handling function which refires the event from this object as the passed event name.

                  Available since: 4.0.0

                  Parameters

                  • newName : Object
                  • beginEnd : Array (optional)

                    The caller can specify on which indices to slice

                  Returns

                  Ext.draw.Surface
                  view source
                  ( )
                  Destroys the surface. ...

                  Destroys the surface. This is done by removing all components from it and also removing its reference to a DOM element.

                  For example:

                   drawComponent.surface.destroy();
                  

                  Available since: 4.0.0

                  Fires

                    Overrides: Ext.Base.destroy, Ext.draw.Surface.destroy

                    Ext.draw.Surface
                    view source
                    ( x, y, rx, ry )private
                    ...

                    Available since: 4.0.0

                    Parameters

                    Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present. ...

                    Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present. There is no implementation in the Observable base class.

                    This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly.

                    Example:

                    Ext.define('Ext.overrides.form.field.Base', {
                        override: 'Ext.form.field.Base',
                    
                        //  Add functionality to Field's initComponent to enable the change event to bubble
                        initComponent: function () {
                            this.callParent();
                            this.enableBubble('change');
                        }
                    });
                    
                    var myForm = Ext.create('Ext.form.Panel', {
                        title: 'User Details',
                        items: [{
                            ...
                        }],
                        listeners: {
                            change: function() {
                                // Title goes red if form has been modified.
                                myForm.header.setStyle('color', 'red');
                            }
                        }
                    });
                    

                    Available since: 3.4.0

                    Parameters

                    • eventNames : String/String[]

                      The event name to bubble, or an Array of event names.

                    Fires the specified event with the passed parameters (minus the event name, plus the options object passed to addList...

                    Fires the specified event with the passed parameters (minus the event name, plus the options object passed to addListener).

                    An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by calling enableBubble.

                    Available since: 1.1.0

                    Parameters

                    • eventName : String

                      The name of the event to fire.

                    • args : Object...

                      Variable number of parameters are passed to handlers.

                    Returns

                    • Boolean

                      returns false if any of the handlers return false otherwise it returns true.

                    Fires

                      Ext.draw.Surface
                      view source
                      ( sprite, isWithoutTransform )private
                      ...

                      Available since: 4.1.0

                      Parameters

                      Fires

                        Gets the bubbling parent for an Observable ...

                        Gets the bubbling parent for an Observable

                        Available since: 4.0.7

                        Returns

                        Fires

                          ...

                          Available since: 4.1.0

                          Parameters

                          Ext.draw.Surface
                          view source
                          ( id ) : Object
                          Returns a new group or an existent group associated with the current surface. ...

                          Returns a new group or an existent group associated with the current surface. The group returned is a Ext.draw.CompositeSprite group.

                          For example:

                          var spriteGroup = drawComponent.surface.getGroup('someGroupId');
                          

                          Available since: 4.0.0

                          Parameters

                          • id : String

                            The unique identifier of the group.

                          Returns

                          Fires

                            Ext.draw.Surface
                            view source
                            ( )
                            Retrieves the id of this component. ...

                            Retrieves the id of this component. Will autogenerate an id if one has not already been set.

                            Available since: 4.0.0

                            Returns the initial configuration passed to constructor when instantiating this class. ...

                            Returns the initial configuration passed to constructor when instantiating this class.

                            Available since: 4.1.0

                            Parameters

                            • name : String (optional)

                              Name of the config option to return.

                            Returns

                            • Object/Mixed

                              The full config object or a single config value when name parameter specified.

                            Ext.draw.Surface
                            view source
                            ( el )private
                            ...

                            Available since: 4.0.0

                            Parameters

                            Fires

                              Ext.draw.Surface
                              view source
                              ( el )private
                              ...

                              Available since: 4.0.0

                              Parameters

                              Fires

                                Ext.draw.Surface
                                view source
                                ( el )private
                                ...

                                Available since: 4.0.0

                                Parameters

                                Fires

                                  Ext.draw.Surface
                                  view source
                                  ( el )private
                                  ...

                                  Available since: 4.0.0

                                  Parameters

                                  Ext.draw.Surface
                                  view source
                                  ( el )private
                                  ...

                                  Available since: 4.0.0

                                  Parameters

                                  Fires

                                    Ext.draw.Surface
                                    view source
                                    ( el )private
                                    ...

                                    Available since: 4.0.0

                                    Parameters

                                    Fires

                                      ...

                                      Available since: 4.1.0

                                      Parameters

                                      Checks to see if this object has any listeners for a specified event, or whether the event bubbles. ...

                                      Checks to see if this object has any listeners for a specified event, or whether the event bubbles. The answer indicates whether the event needs firing or not.

                                      Available since: 1.1.0

                                      Parameters

                                      • eventName : String

                                        The name of the event to check for

                                      Returns

                                      • Boolean

                                        true if the event is being listened for or bubbles, else false

                                      Ext.draw.Surface
                                      view source
                                      ( config )private
                                      ...

                                      Available since: 4.0.0

                                      Parameters

                                      Fires

                                        ( config ) : Ext.Basechainableprotected
                                        Initialize configuration for this class. ...

                                        Initialize configuration for this class. a typical example:

                                        Ext.define('My.awesome.Class', {
                                            // The default config
                                            config: {
                                                name: 'Awesome',
                                                isAwesome: true
                                            },
                                        
                                            constructor: function(config) {
                                                this.initConfig(config);
                                            }
                                        });
                                        
                                        var awesome = new My.awesome.Class({
                                            name: 'Super Awesome'
                                        });
                                        
                                        alert(awesome.getName()); // 'Super Awesome'
                                        

                                        Available since: 4.0.0

                                        Parameters

                                        Returns

                                        Ext.draw.Surface
                                        view source
                                        ( )private
                                        ...

                                        Available since: 4.0.0

                                        Fires

                                          Ext.draw.Surface
                                          view source
                                          ( )private
                                          ...

                                          Available since: 4.0.0

                                          Fires

                                            Ext.draw.Surface
                                            view source
                                            ( )private
                                            called to initialize components in the surface this is dependent on the underlying implementation. ...

                                            called to initialize components in the surface this is dependent on the underlying implementation.

                                            Available since: 4.0.0

                                            Ext.draw.Surface
                                            view source
                                            ( sprite ) : Numberprivate
                                            Inserts a given sprite into the correct position in the items collection, according to its zIndex. ...

                                            Inserts a given sprite into the correct position in the items collection, according to its zIndex. It will be inserted at the end of an existing series of sprites with the same or lower zIndex. By ensuring sprites are always ordered, this allows surface subclasses to render the sprites in the correct order for proper z-index stacking.

                                            Available since: 4.0.4

                                            Parameters

                                            Returns

                                            • Number

                                              the sprite's new index in the list

                                            ( item, ename, [fn], [scope], [options] ) : Object
                                            Shorthand for addManagedListener. ...

                                            Shorthand for addManagedListener.

                                            Available since: 4.0.2

                                            Parameters

                                            • item : Ext.util.Observable/Ext.Element

                                              The item to which to add a listener/listeners.

                                            • ename : Object/String

                                              The event name, or an object containing event name properties.

                                            • fn : Function (optional)

                                              If the ename parameter was an event name, this is the handler function.

                                            • scope : Object (optional)

                                              If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

                                            • options : Object (optional)

                                              If the ename parameter was an event name, this is the addListener options.

                                            Returns

                                            • Object

                                              Only when the destroyable option is specified.

                                              A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

                                              this.btnListeners =  = myButton.mon({
                                                  destroyable: true
                                                  mouseover:   function() { console.log('mouseover'); },
                                                  mouseout:    function() { console.log('mouseout'); },
                                                  click:       function() { console.log('click'); }
                                              });
                                              

                                              And when those listeners need to be removed:

                                              Ext.destroy(this.btnListeners);
                                              

                                              or

                                              this.btnListeners.destroy();
                                              
                                            ( item, ename, [fn], [scope] )
                                            Shorthand for removeManagedListener. ...

                                            Shorthand for removeManagedListener.

                                            Available since: 4.0.2

                                            Parameters

                                            • item : Ext.util.Observable/Ext.Element

                                              The item from which to remove a listener/listeners.

                                            • ename : Object/String

                                              The event name, or an object containing event name properties.

                                            • fn : Function (optional)

                                              If the ename parameter was an event name, this is the handler function.

                                            • scope : Object (optional)

                                              If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

                                            ( eventName, [fn], [scope], [options] ) : Object
                                            Shorthand for addListener. ...

                                            Shorthand for addListener.

                                            Available since: 1.1.0

                                            Parameters

                                            • eventName : String/Object

                                              The name of the event to listen for. May also be an object who's property names are event names.

                                            • fn : Function (optional)

                                              The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to fireEvent plus the options parameter described below.

                                            • scope : Object (optional)

                                              The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

                                            • options : Object (optional)

                                              An object containing handler configuration.

                                              Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.

                                              This object may contain any of the following properties:

                                              • scope : Object

                                                The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

                                              • delay : Number

                                                The number of milliseconds to delay the invocation of the handler after the event fires.

                                              • single : Boolean

                                                True to add a handler to handle just the next firing of the event, and then remove itself.

                                              • buffer : Number

                                                Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.

                                              • target : Ext.util.Observable

                                                Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.

                                              • element : String

                                                This option is only valid for listeners bound to Components. The name of a Component property which references an element to add a listener to.

                                                This option is useful during Component construction to add DOM event listeners to elements of Components which will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:

                                                  new Ext.panel.Panel({
                                                      title: 'The title',
                                                      listeners: {
                                                          click: this.handlePanelClick,
                                                          element: 'body'
                                                      }
                                                  });
                                                
                                              • destroyable : Boolean (optional)

                                                When specified as true, the function returns A Destroyable object. An object which implements the destroy method which removes all listeners added in this call.

                                                Combining Options

                                                Using the options argument, it is possible to combine different types of listeners:

                                                A delayed, one-time listener.

                                                myPanel.on('hide', this.handleClick, this, {
                                                    single: true,
                                                    delay: 100
                                                });
                                                

                                                Defaults to: false

                                            Returns

                                            • Object

                                              Only when the destroyable option is specified.

                                              A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

                                              this.btnListeners =  = myButton.on({
                                                  destroyable: true
                                                  mouseover:   function() { console.log('mouseover'); },
                                                  mouseout:    function() { console.log('mouseout'); },
                                                  click:       function() { console.log('click'); }
                                              });
                                              

                                              And when those listeners need to be removed:

                                              Ext.destroy(this.btnListeners);
                                              

                                              or

                                              this.btnListeners.destroy();
                                              
                                            Ext.draw.Surface
                                            view source
                                            ( sprite )private
                                            ...

                                            Available since: 4.0.0

                                            Parameters

                                            Fires

                                              Ext.draw.Surface
                                              view source
                                              ( e )private
                                              ...

                                              Available since: 4.0.0

                                              Parameters

                                              Fires

                                                ( names, callback, scope )private
                                                ...

                                                Available since: 4.1.0

                                                Parameters

                                                Ext.draw.Surface
                                                view source
                                                ( e )private
                                                ...

                                                Available since: 4.1.0

                                                Parameters

                                                Fires

                                                  Ext.draw.Surface
                                                  view source
                                                  ( )private
                                                  ...

                                                  Available since: 4.0.0

                                                  Ext.draw.Surface
                                                  view source
                                                  ( e )private
                                                  ...

                                                  Available since: 4.0.0

                                                  Parameters

                                                  Fires

                                                    Ext.draw.Surface
                                                    view source
                                                    ( )private
                                                    ...

                                                    Available since: 4.0.0

                                                    Ext.draw.Surface
                                                    view source
                                                    ( )private
                                                    ...

                                                    Available since: 4.0.0

                                                    Ext.draw.Surface
                                                    view source
                                                    ( e )private
                                                    ...

                                                    Available since: 4.0.0

                                                    Parameters

                                                    Fires

                                                    Ext.draw.Surface
                                                    view source
                                                    ( e )private
                                                    ...

                                                    Available since: 4.0.0

                                                    Parameters

                                                    Fires

                                                      Ext.draw.Surface
                                                      view source
                                                      ( e )private
                                                      ...

                                                      Available since: 4.0.0

                                                      Parameters

                                                      Fires

                                                        Ext.draw.Surface
                                                        view source
                                                        ( e )private
                                                        ...

                                                        Available since: 4.0.0

                                                        Parameters

                                                        Fires

                                                          Ext.draw.Surface
                                                          view source
                                                          ( )private
                                                          ...

                                                          Available since: 4.0.0

                                                          Prepares a given class for observable instances. ...

                                                          Prepares a given class for observable instances. This method is called when a class derives from this class or uses this class as a mixin.

                                                          Available since: 4.1.2

                                                          Parameters

                                                          • T : Function

                                                            The class constructor to prepare.

                                                          Ext.draw.Surface
                                                          view source
                                                          ( items, applyDefaults )private
                                                          ...

                                                          Available since: 4.0.0

                                                          Parameters

                                                          Fires

                                                            Ext.draw.Surface
                                                            view source
                                                            ( x, y, w, h, r )private
                                                            ...

                                                            Available since: 4.0.0

                                                            Parameters

                                                            Relays selected events from the specified Observable as if the events were fired by this. ...

                                                            Relays selected events from the specified Observable as if the events were fired by this.

                                                            For example if you are extending Grid, you might decide to forward some events from store. So you can do this inside your initComponent:

                                                            this.relayEvents(this.getStore(), ['load']);
                                                            

                                                            The grid instance will then have an observable 'load' event which will be passed the parameters of the store's load event and any function fired with the grid's load event would have access to the grid using the this keyword.

                                                            Available since: 2.3.0

                                                            Parameters

                                                            • origin : Object

                                                              The Observable whose events this object is to relay.

                                                            • events : String[]

                                                              Array of event names to relay.

                                                            • prefix : String (optional)

                                                              A common prefix to prepend to the event names. For example:

                                                              this.relayEvents(this.getStore(), ['load', 'clear'], 'store');
                                                              

                                                              Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'.

                                                            Returns

                                                            • Object

                                                              A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example:

                                                              this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store');
                                                              

                                                              Can be undone by calling

                                                              Ext.destroy(this.storeRelayers);
                                                              

                                                              or

                                                              this.store.relayers.destroy();
                                                              

                                                            Fires

                                                              Ext.draw.Surface
                                                              view source
                                                              ( sprite, destroySprite )
                                                              Removes a given sprite from the surface, optionally destroying the sprite in the process. ...

                                                              Removes a given sprite from the surface, optionally destroying the sprite in the process. You can also call the sprite own remove method.

                                                              For example:

                                                              drawComponent.surface.remove(sprite);
                                                              //or...
                                                              sprite.remove();
                                                              

                                                              Available since: 4.0.0

                                                              Parameters

                                                              Ext.draw.Surface
                                                              view source
                                                              ( destroySprites )
                                                              Removes all sprites from the surface, optionally destroying the sprites in the process. ...

                                                              Removes all sprites from the surface, optionally destroying the sprites in the process.

                                                              For example:

                                                              drawComponent.surface.removeAll();
                                                              

                                                              Available since: 4.0.0

                                                              Parameters

                                                              • destroySprites : Boolean

                                                                Whether to destroy all sprites when removing them.

                                                              Fires

                                                                Ext.draw.Surface
                                                                view source
                                                                ( sprite, className )
                                                                Removes one or more CSS classes from the element. ...

                                                                Removes one or more CSS classes from the element.

                                                                For example:

                                                                drawComponent.surface.removeCls(sprite, 'x-visible');
                                                                

                                                                Available since: 4.0.0

                                                                Parameters

                                                                • sprite : Object

                                                                  The sprite to remove the class from.

                                                                • className : String/String[]

                                                                  The CSS class to remove, or an array of classes

                                                                Removes an event handler. ...

                                                                Removes an event handler.

                                                                Available since: 1.1.0

                                                                Parameters

                                                                • eventName : String

                                                                  The type of event the handler was associated with.

                                                                • fn : Function

                                                                  The handler to remove. This must be a reference to the function passed into the addListener call.

                                                                • scope : Object (optional)

                                                                  The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.

                                                                Fires

                                                                  Removes listeners that were added by the mon method. ...

                                                                  Removes listeners that were added by the mon method.

                                                                  Available since: 4.0.0

                                                                  Parameters

                                                                  • item : Ext.util.Observable/Ext.Element

                                                                    The item from which to remove a listener/listeners.

                                                                  • ename : Object/String

                                                                    The event name, or an object containing event name properties.

                                                                  • fn : Function (optional)

                                                                    If the ename parameter was an event name, this is the handler function.

                                                                  • scope : Object (optional)

                                                                    If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

                                                                  Fires

                                                                    Remove a single managed listener item ...

                                                                    Remove a single managed listener item

                                                                    Available since: 4.0.1

                                                                    Parameters

                                                                    • isClear : Boolean

                                                                      True if this is being called during a clear

                                                                    • managedListener : Object

                                                                      The managed listener item See removeManagedListener for other args

                                                                    Overrides: Ext.AbstractComponent.removeManagedListenerItem

                                                                    Ext.draw.Surface
                                                                    view source
                                                                    ( )private
                                                                    called to setup the surface to render an item this is dependent on the underlying implementation. ...

                                                                    called to setup the surface to render an item this is dependent on the underlying implementation.

                                                                    Available since: 4.0.0

                                                                    Ext.draw.Surface
                                                                    view source
                                                                    ( )private
                                                                    ...

                                                                    Available since: 4.0.0

                                                                    Resumes firing events (see suspendEvents). ...

                                                                    Resumes firing events (see suspendEvents).

                                                                    If events were suspended using the queueSuspended parameter, then all events fired during event suspension will be sent to any listeners now.

                                                                    Available since: 2.3.0

                                                                    Ext.draw.Surface
                                                                    view source
                                                                    ( sprite )private
                                                                    ...

                                                                    Available since: 4.0.0

                                                                    Parameters

                                                                    Fires

                                                                      Ext.draw.Surface
                                                                      view source
                                                                      ( sprite )private
                                                                      ...

                                                                      Available since: 4.0.0

                                                                      Parameters

                                                                      Fires

                                                                        Ext.draw.Surface
                                                                        view source
                                                                        ( sprite )private
                                                                        ...

                                                                        Available since: 4.0.0

                                                                        Parameters

                                                                        ( config, applyIfNotSet ) : Ext.Basechainableprivate
                                                                        ...

                                                                        Available since: 4.0.0

                                                                        Parameters

                                                                        Returns

                                                                        Ext.draw.Surface
                                                                        view source
                                                                        ( w, h )
                                                                        Sets the size of the surface. ...

                                                                        Sets the size of the surface. Accomodates the background (if any) to fit the new size too.

                                                                        For example:

                                                                        drawComponent.surface.setSize(500, 500);
                                                                        

                                                                        This method is generally called when also setting the size of the draw Component.

                                                                        Available since: 4.0.0

                                                                        Parameters

                                                                        • w : Number

                                                                          The new width of the canvas.

                                                                        • h : Number

                                                                          The new height of the canvas.

                                                                        Fires

                                                                          Ext.draw.Surface
                                                                          view source
                                                                          ( sprite, styles )
                                                                          Sets CSS style attributes to an element. ...

                                                                          Sets CSS style attributes to an element.

                                                                          For example:

                                                                          drawComponent.surface.setStyle(sprite, {
                                                                              'cursor': 'pointer'
                                                                          });
                                                                          

                                                                          Available since: 4.0.0

                                                                          Parameters

                                                                          • sprite : Object

                                                                            The sprite to add, or an array of classes to

                                                                          • styles : Object

                                                                            An Object with CSS styles.

                                                                          Ext.draw.Surface
                                                                          view source
                                                                          ( sprite, text )
                                                                          Changes the text in the sprite element. ...

                                                                          Changes the text in the sprite element. The sprite must be a text sprite. This method can also be called from Ext.draw.Sprite.

                                                                          For example:

                                                                          var spriteGroup = drawComponent.surface.setText(sprite, 'my new text');
                                                                          

                                                                          Available since: 4.0.0

                                                                          Parameters

                                                                          • sprite : Object

                                                                            The Sprite to change the text.

                                                                          • text : String

                                                                            The new text to be set.

                                                                          Ext.draw.Surface
                                                                          view source
                                                                          ( x, y, width, height )private
                                                                          ...

                                                                          Available since: 4.0.0

                                                                          Parameters

                                                                          Fires

                                                                            Get the reference to the class from which this object was instantiated. ...

                                                                            Get the reference to the class from which this object was instantiated. Note that unlike self, this.statics() is scope-independent and it always returns the class from which it was called, regardless of what this points to during run-time

                                                                            Ext.define('My.Cat', {
                                                                                statics: {
                                                                                    totalCreated: 0,
                                                                                    speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
                                                                                },
                                                                            
                                                                                constructor: function() {
                                                                                    var statics = this.statics();
                                                                            
                                                                                    alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to
                                                                                                                    // equivalent to: My.Cat.speciesName
                                                                            
                                                                                    alert(this.self.speciesName);   // dependent on 'this'
                                                                            
                                                                                    statics.totalCreated++;
                                                                                },
                                                                            
                                                                                clone: function() {
                                                                                    var cloned = new this.self;                      // dependent on 'this'
                                                                            
                                                                                    cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName
                                                                            
                                                                                    return cloned;
                                                                                }
                                                                            });
                                                                            
                                                                            
                                                                            Ext.define('My.SnowLeopard', {
                                                                                extend: 'My.Cat',
                                                                            
                                                                                statics: {
                                                                                    speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'
                                                                                },
                                                                            
                                                                                constructor: function() {
                                                                                    this.callParent();
                                                                                }
                                                                            });
                                                                            
                                                                            var cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'
                                                                            
                                                                            var snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'
                                                                            
                                                                            var clone = snowLeopard.clone();
                                                                            alert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'
                                                                            alert(clone.groupName);                 // alerts 'Cat'
                                                                            
                                                                            alert(My.Cat.totalCreated);             // alerts 3
                                                                            

                                                                            Available since: 4.0.0

                                                                            Returns

                                                                            Suspends the firing of all events. ...

                                                                            Suspends the firing of all events. (see resumeEvents)

                                                                            Available since: 2.3.0

                                                                            Parameters

                                                                            • queueSuspended : Boolean

                                                                              Pass as true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events.

                                                                            Ext.draw.Surface
                                                                            view source
                                                                            ( x, y )private
                                                                            ...

                                                                            Available since: 4.0.7

                                                                            Parameters

                                                                            Ext.draw.Surface
                                                                            view source
                                                                            ( sprite )private
                                                                            ...

                                                                            Available since: 4.0.0

                                                                            Parameters

                                                                            ( eventName, fn, [scope] )
                                                                            Shorthand for removeListener. ...

                                                                            Shorthand for removeListener.

                                                                            Available since: 1.1.0

                                                                            Parameters

                                                                            • eventName : String

                                                                              The type of event the handler was associated with.

                                                                            • fn : Function

                                                                              The handler to remove. This must be a reference to the function passed into the addListener call.

                                                                            • scope : Object (optional)

                                                                              The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.

                                                                            Defined By

                                                                            Static methods

                                                                            ( config )privatestatic
                                                                            ...

                                                                            Available since: 4.1.1

                                                                            Parameters

                                                                            ( members )chainableprivatestatic
                                                                            ...

                                                                            Available since: 4.1.1

                                                                            Parameters

                                                                            ( name, member )chainableprivatestatic
                                                                            ...

                                                                            Available since: 4.1.1

                                                                            Parameters

                                                                            ( members )chainablestatic
                                                                            Add methods / properties to the prototype of this class. ...

                                                                            Add methods / properties to the prototype of this class.

                                                                            Ext.define('My.awesome.Cat', {
                                                                                constructor: function() {
                                                                                    ...
                                                                                }
                                                                            });
                                                                            
                                                                             My.awesome.Cat.addMembers({
                                                                                 meow: function() {
                                                                                    alert('Meowww...');
                                                                                 }
                                                                             });
                                                                            
                                                                             var kitty = new My.awesome.Cat;
                                                                             kitty.meow();
                                                                            

                                                                            Available since: 4.1.0

                                                                            Parameters

                                                                            ( members ) : Ext.Basechainablestatic
                                                                            Add / override static properties of this class. ...

                                                                            Add / override static properties of this class.

                                                                            Ext.define('My.cool.Class', {
                                                                                ...
                                                                            });
                                                                            
                                                                            My.cool.Class.addStatics({
                                                                                someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'
                                                                                method1: function() { ... },    // My.cool.Class.method1 = function() { ... };
                                                                                method2: function() { ... }     // My.cool.Class.method2 = function() { ... };
                                                                            });
                                                                            

                                                                            Available since: 4.0.2

                                                                            Parameters

                                                                            Returns

                                                                            ( xtype )chainableprivatestatic
                                                                            ...

                                                                            Available since: 4.1.1

                                                                            Parameters

                                                                            ( fromClass, members ) : Ext.Basechainableprivatestatic
                                                                            Borrow another class' members to the prototype of this class. ...

                                                                            Borrow another class' members to the prototype of this class.

                                                                            Ext.define('Bank', {
                                                                                money: '$$$',
                                                                                printMoney: function() {
                                                                                    alert('$$$$$$$');
                                                                                }
                                                                            });
                                                                            
                                                                            Ext.define('Thief', {
                                                                                ...
                                                                            });
                                                                            
                                                                            Thief.borrow(Bank, ['money', 'printMoney']);
                                                                            
                                                                            var steve = new Thief();
                                                                            
                                                                            alert(steve.money); // alerts '$$$'
                                                                            steve.printMoney(); // alerts '$$$$$$$'
                                                                            

                                                                            Available since: 4.0.2

                                                                            Parameters

                                                                            • fromClass : Ext.Base

                                                                              The class to borrow members from

                                                                            • members : Array/String

                                                                              The names of the members to borrow

                                                                            Returns

                                                                            Ext.draw.Surface
                                                                            view source
                                                                            ( config, [enginePriority] ) : Objectstatic
                                                                            Creates and returns a new concrete Surface instance appropriate for the current environment. ...

                                                                            Creates and returns a new concrete Surface instance appropriate for the current environment.

                                                                            Available since: 4.0.0

                                                                            Parameters

                                                                            • config : Object

                                                                              Initial configuration for the Surface instance

                                                                            • enginePriority : String[] (optional)

                                                                              order of implementations to use; the first one that is available in the current environment will be used. Defaults to ['Svg', 'Vml'].

                                                                            Returns

                                                                            • Object

                                                                              The created Surface or false.

                                                                            Overrides: Ext.Base.create

                                                                            ( alias, origin )static
                                                                            Create aliases for existing prototype methods. ...

                                                                            Create aliases for existing prototype methods. Example:

                                                                            Ext.define('My.cool.Class', {
                                                                                method1: function() { ... },
                                                                                method2: function() { ... }
                                                                            });
                                                                            
                                                                            var test = new My.cool.Class();
                                                                            
                                                                            My.cool.Class.createAlias({
                                                                                method3: 'method1',
                                                                                method4: 'method2'
                                                                            });
                                                                            
                                                                            test.method3(); // test.method1()
                                                                            
                                                                            My.cool.Class.createAlias('method5', 'method3');
                                                                            
                                                                            test.method5(); // test.method3() -> test.method1()
                                                                            

                                                                            Available since: 4.0.2

                                                                            Parameters

                                                                            ( config )privatestatic
                                                                            ...

                                                                            Available since: 4.1.1

                                                                            Parameters

                                                                            Get the current class' name in string format. ...

                                                                            Get the current class' name in string format.

                                                                            Ext.define('My.cool.Class', {
                                                                                constructor: function() {
                                                                                    alert(this.self.getName()); // alerts 'My.cool.Class'
                                                                                }
                                                                            });
                                                                            
                                                                            My.cool.Class.getName(); // 'My.cool.Class'
                                                                            

                                                                            Available since: 4.0.4

                                                                            Returns

                                                                            ( )deprecatedstatic
                                                                            Adds members to class. ...

                                                                            Adds members to class.

                                                                            Available since: 4.0.2

                                                                            This method has been deprecated since 4.1

                                                                            Use addMembers instead.

                                                                            ( name, mixinClass )chainableprivatestatic
                                                                            Used internally by the mixins pre-processor ...

                                                                            Used internally by the mixins pre-processor

                                                                            Available since: 4.1.1

                                                                            Parameters

                                                                            ( fn, scope )chainableprivatestatic
                                                                            ...

                                                                            Available since: 4.1.1

                                                                            Parameters

                                                                            ( members ) : Ext.Basechainabledeprecatedstatic
                                                                            Override members of this class. ...

                                                                            Override members of this class. Overridden methods can be invoked via callParent.

                                                                            Ext.define('My.Cat', {
                                                                                constructor: function() {
                                                                                    alert("I'm a cat!");
                                                                                }
                                                                            });
                                                                            
                                                                            My.Cat.override({
                                                                                constructor: function() {
                                                                                    alert("I'm going to be a cat!");
                                                                            
                                                                                    this.callParent(arguments);
                                                                            
                                                                                    alert("Meeeeoooowwww");
                                                                                }
                                                                            });
                                                                            
                                                                            var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                                                                                                      // alerts "I'm a cat!"
                                                                                                      // alerts "Meeeeoooowwww"
                                                                            

                                                                            As of 4.1, direct use of this method is deprecated. Use Ext.define instead:

                                                                            Ext.define('My.CatOverride', {
                                                                                override: 'My.Cat',
                                                                                constructor: function() {
                                                                                    alert("I'm going to be a cat!");
                                                                            
                                                                                    this.callParent(arguments);
                                                                            
                                                                                    alert("Meeeeoooowwww");
                                                                                }
                                                                            });
                                                                            

                                                                            The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).

                                                                            Available since: 4.0.2

                                                                            This method has been deprecated since 4.1.0

                                                                            Use Ext.define instead

                                                                            Parameters

                                                                            • members : Object

                                                                              The properties to add to this class. This should be specified as an object literal containing one or more properties.

                                                                            Returns

                                                                            Ext.draw.Surface
                                                                            view source
                                                                            ( surface, [config] ) : Objectstatic
                                                                            Exports a surface in a different format. ...

                                                                            Exports a surface in a different format. The surface may be exported to an SVG string, using the Ext.draw.engine.SvgExporter. It may also be exported as an image using the ImageExporter. Note that this requires sending data to a remote server to process the SVG into an image, see the Ext.draw.engine.ImageExporter for more details.

                                                                            Available since: 4.1.0

                                                                            Parameters

                                                                            • surface : Ext.draw.Surface

                                                                              The surface to export.

                                                                            • config : Object (optional)

                                                                              The configuration to be passed to the exporter. See the export method for the appropriate exporter for the relevant configuration options

                                                                            Returns

                                                                            • Object

                                                                              See the return types for the appropriate exporter

                                                                            ...

                                                                            Available since: 4.1.1

                                                                            Defined By

                                                                            Events

                                                                            Ext.draw.Surface
                                                                            view source
                                                                            ( e, eOpts )
                                                                            Fires when a click is detected within the surface. ...

                                                                            Fires when a click is detected within the surface.

                                                                            Available since: 4.1.1

                                                                            Parameters

                                                                            Ext.draw.Surface
                                                                            view source
                                                                            ( e, eOpts )
                                                                            Fires when a dblclick is detected within the surface. ...

                                                                            Fires when a dblclick is detected within the surface.

                                                                            Available since: 4.1.1

                                                                            Parameters

                                                                            Ext.draw.Surface
                                                                            view source
                                                                            ( e, eOpts )
                                                                            Fires when a mousedown is detected within the surface. ...

                                                                            Fires when a mousedown is detected within the surface.

                                                                            Available since: 4.1.1

                                                                            Parameters

                                                                            Ext.draw.Surface
                                                                            view source
                                                                            ( e, eOpts )
                                                                            Fires when a mouseenter is detected within the surface. ...

                                                                            Fires when a mouseenter is detected within the surface.

                                                                            Available since: 4.1.1

                                                                            Parameters

                                                                            Ext.draw.Surface
                                                                            view source
                                                                            ( e, eOpts )
                                                                            Fires when a mouseleave is detected within the surface. ...

                                                                            Fires when a mouseleave is detected within the surface.

                                                                            Available since: 4.1.1

                                                                            Parameters

                                                                            Ext.draw.Surface
                                                                            view source
                                                                            ( e, eOpts )
                                                                            Fires when a mousemove is detected within the surface. ...

                                                                            Fires when a mousemove is detected within the surface.

                                                                            Available since: 4.1.1

                                                                            Parameters

                                                                            Ext.draw.Surface
                                                                            view source
                                                                            ( e, eOpts )
                                                                            Fires when a mouseout is detected within the surface. ...

                                                                            Fires when a mouseout is detected within the surface.

                                                                            Available since: 4.1.1

                                                                            Parameters

                                                                            Ext.draw.Surface
                                                                            view source
                                                                            ( e, eOpts )
                                                                            Fires when a mouseover is detected within the surface. ...

                                                                            Fires when a mouseover is detected within the surface.

                                                                            Available since: 4.1.1

                                                                            Parameters

                                                                            Ext.draw.Surface
                                                                            view source
                                                                            ( e, eOpts )
                                                                            Fires when a mouseup is detected within the surface. ...

                                                                            Fires when a mouseup is detected within the surface.

                                                                            Available since: 4.1.1

                                                                            Parameters