Ext.sparkline.Line xtype: sparklineline

bind : Object / String

bindable bind

Setting this config option adds or removes data bindings for other configs. For example, to bind the title config:

 var panel = Ext.create({
     xtype: 'panel',
     bind: {
         title: 'Hello {user.name}'
     }
 });

To dynamically add bindings:

 panel.setBind({
     title: 'Greetings {user.name}!'
 });

To remove bindings:

 panel.setBind({
     title: null
 });

The bind expressions are presented to Ext.app.ViewModel#bind. The ViewModel instance is determined by lookupViewModel.

Note: If bind is passed as a string, it will use the Ext.Component#property-defaultBindProperty for the binding

Defaults to:

null

bubbleEvents : String / String[]

bindable bind

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

Defaults to:

null

controller : String / Object / Ext.app.ViewController

bindable bind

A string alias, a configuration object or an instance of a ViewController for this container. Sample usage:

Ext.define('MyApp.UserController', {
    alias: 'controller.user'
});

Ext.define('UserContainer', {
    extend: 'Ext.container.container',
    controller: 'user'
});
// Or
Ext.define('UserContainer', {
    extend: 'Ext.container.container',
    controller: {
        type: 'user',
        someConfig: true
    }
});

// Can also instance at runtime
var ctrl = new MyApp.UserController();
var view = new UserContainer({
    controller: ctrl
});

Defaults to:

null

defaultListenerScope : Boolean

bindable bind

If true, this component will be the default scope (this pointer) for events specified with string names so that the scope can be dynamically resolved. The component will automatically become the defaultListenerScope if a controller is specified.

See the introductory docs for Ext.container.Container for some sample usages.

NOTE: This value can only be reliably set at construction time. Setting it after that time may not correctly rewire all of the potentially effected listeners.

Defaults to:

false

eventedConfig : Object

Config options defined within eventedConfig will auto-generate the setter / getter methods (see config for more information on auto-generated getter / setter methods). Additionally, when an eventedConfig is set it will also fire a before{cfg}change and {cfg}change event when the value of the eventedConfig is changed from its originally defined value.

Note: When creating a custom class you'll need to extend Ext.Evented

Example custom class:

Ext.define('MyApp.util.Test', {
    extend: 'Ext.Evented',

    eventedConfig: {
        foo: null
    }
});

In this example, the foo config will initially be null. Changing it via setFoo will fire the beforefoochange event. The call to the setter can be halted by returning false from a listener on the before event.

var test = Ext.create('MyApp.util.Test', {
    listeners: {
        beforefoochange: function (instance, newValue, oldValue) {
            return newValue !== 'bar';
        },
        foochange: function (instance, newValue, oldValue) {
           console.log('foo changed to:', newValue);
        }
    }
});

test.setFoo('bar');

The before event handler can be used to validate changes to foo. Returning false will prevent the setter from changing the value of the config. In the previous example the beforefoochange handler returns false so foo will not be updated and foochange will not be fired.

test.setFoo('baz');

Setting foo to 'baz' will not be prevented by the before handler. Foo will be set to the value: 'baz' and the foochange event will be fired.

fillColor : String

bindable bind

The hex value for fill color in graphs which fill areas (Ext.sparkline.Line).

Defaults to:

#def

height : Number / String

bindable bind

The height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. By default, if this is not explicitly set, this Component's element will simply have its own natural size. If set to auto, it will set the width to null meaning it will have its own natural size.

Defaults to:

null

highlightColor : String

bindable bind

The hex value for the highlight color to use when mouseing over a graph segment.

Defaults to:

null

highlightLighten : Number

bindable bind

How much to lighten the highlight color by when mouseing over a graph segment.

Defaults to:

1.4

lineColor : String

bindable bind

The hex value for line colors in graphs which display lines (Ext.sparkline.Box, Ext.sparkline.Discrete).

Defaults to:

#157fcc

listeners : Object

bindable bind

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.

See the Event guide for more

Note: It is bad practice to specify a listener's config when you are defining a class using Ext.define(). Instead, only specify listeners when you are instantiating your class with Ext.create().

Defaults to:

null

publishes : String / String[] / Object

bindable bind

One or more names of config properties that this component should publish to its ViewModel. Some components override this and publish their most useful configs by default.

This config uses the cfg-reference to determine the name of the data object to place in the ViewModel. If reference is not set then this config is ignored.

By using this config and cfg-reference you can bind configs between components. For example:

 ...
     items: [{
         xtype: 'textfield',
         reference: 'somefield',  // component's name in the ViewModel
         publishes: 'value' // value is not published by default
     },{
         ...
     },{
         xtype: 'displayfield',
         bind: 'You have entered "{somefield.value}"'
     }]
 ...

Classes must provide this config as an Object:

 Ext.define('App.foo.Bar', {
     publishes: {
         foo: true,
         bar: true
     }
 });

This is required for the config system to properly merge values from derived classes.

For instances this value can be specified as a value as show above or an array or object as follows:

 {
     xtype: 'textfield',
     reference: 'somefield',
     publishes: [
         'value',
         'rawValue',
         'dirty'
     ]
 }

 // This achieves the same result as the above array form.
 {
     xtype: 'textfield',
     reference: 'somefield',
     publishes: {
         value: true,
         rawValue: true,
         dirty: true
     }
 }

Defaults to:

null

Available since: 5.0.0

reference : String

bindable bind

Specifies a name for this component inside its component hierarchy. This name must be unique within its view or its Ext.app.ViewController. See the documentation in Ext.container.Container for more information about references.

Note: Valid identifiers start with a letter or underscore and are followed by zero or more additional letters, underscores or digits. References are case sensitive.

Defaults to:

null

session : Boolean / Object / Ext.data.Session

bindable bind

If provided this creates a new Session instance for this component. If this is a Container, this will then be inherited by all child components.

To create a new session you can specify true:

 Ext.create({
     xtype: 'viewport',
     session: true,

     items: [{
         ...
     }]
 });

Alternatively, a config object can be provided:

 Ext.create({
     xtype: 'viewport',
     session: {
         ...
     },

     items: [{
         ...
     }]
 });

Defaults to:

null

tipTpl : String / Ext.XTemplate

bindable bind

An XTemplate used to display the value or values in a tooltip when hovering over a Sparkline.

The implemented subclases all define their own tipTpl, but it can be overridden.

Defaults to:

null

tooltipSkipNull : Boolean

bindable bind

Null values will not have a tooltip displayed.

Defaults to:

true

values : Number[]

bindable bind

An array of numbers which define the chart.

Defaults to:

null

viewModel : String / Object / Ext.app.ViewModel

bindable bind

The ViewModel is a data provider for this component and its children. The data contained in the ViewModel is typically used by adding bind configs to the components that want present or edit this data.

When set, the ViewModel is created and links to any inherited viewModel instance from an ancestor container as the "parent". The ViewModel hierarchy, once established, only supports creation or destruction of children. The parent of a ViewModel cannot be changed on the fly.

If this is a root-level ViewModel, the data model connection is made to this component's associated Ext.data.Session. This is determined by calling getInheritedSession.

Defaults to:

null

width : Number / String

bindable bind

The width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. By default, if this is not explicitly set, this Component's element will simply have its own natural size. If set to auto, it will set the width to null meaning it will have its own natural size.

Defaults to:

null

hasListeners : Object

readonly ro

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 or on the Ext.app.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);
 }

addAfterListener ( eventName, fn, [scope], [options] )

Appends an after-event handler.

Same as addListener with order set to 'after'.

Parameters

addBeforeListener ( eventName, fn, [scope], [options] )

Appends a before-event handler. Returning false from the handler will stop the event.

Same as addListener with order set to 'before'.

Parameters

addListener ( eventName, fn, [scope], [options], [order] )

Appends an event handler to this object. You can review the available handlers by looking at the 'events' section of the documentation for the component you are working with.

Combining Options

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

A delayed, one-time listener:

container.addListener('tap', this.handleTap, this, {
    single: true,
    delay: 100
});

Attaching multiple handlers in 1 call

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

container.addListener({
    tap  : this.onTap,
    swipe: this.onSwipe,

    scope: this // Important. Ensure "this" is correct during handler execution
});

One can also specify options for each event handler separately:

container.addListener({
    tap  : { fn: this.onTap, scope: this, single: true },
    swipe: { fn: button.onSwipe, scope: button }
});

See the Events Guide for more.

Parameters

current

Ext.create('Ext.Component', {
    listeners: {
        element: 'element',
        tap: function() {
            alert('element tap!');
        }
    }
});

// Create a container with a two children; a button and a toolbar
var container = Ext.create('Ext.Container', {
    items: [
        {
            xtype: 'toolbar',
            docked: 'top',
            title: 'My Toolbar'
        },
        {
           xtype: 'button',
           text: 'My Button'
        }
    ]
});

container.addListener({
    // Ext.Buttons have an xtype of 'button', so we use that are a selector for our delegate
    delegate: 'button',

    tap: function() {
        alert('Button tapped!');
    }
});

clearListeners

Removes all listeners for this object.

enableBubble ( events )

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.

Parameters

fireAction ( eventName, args, fn, scope ) : Object

Fires the specified event with the passed parameters and execute a function (action) at the end if there are no listeners that return false.

Parameters

Returns

fireEvent ( eventName, args ) : Boolean

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

The first argument is the name of the event. Every other argument passed will be available when you listen for the event.

Example

Firstly, we set up a listener for our new event.

this.on('myevent', function(arg1, arg2, arg3, arg4, options, e) {
    console.log(arg1); // true
    console.log(arg2); // 2
    console.log(arg3); // { test: 'foo' }
    console.log(arg4); // 14
    console.log(options); // the options added when adding the listener
    console.log(e); // the event object with information about the event
});

And then we can fire off the event.

this.fireEvent('myevent', true, 2, { test: 'foo' }, 14);

An event may be set to bubble up an Observable parent hierarchy by calling enableBubble.

Parameters

Returns

fireEventArgs ( eventName, args ) : Boolean

Fires the specified event with the passed parameter list.

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

Parameters

Returns

getConfig ( [name], [peek] ) : Object

Returns a specified config property value. If the name parameter is not passed, all current configuration options will be returned as key value pairs.

Parameters

Returns

getId String

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

Returns

getInherited ( [inner] ) : Object

This method returns an object containing the inherited properties for this instance.

Available since: 5.0.0

Parameters

Returns

getInheritedConfig ( property, [skipThis] ) : Mixed

This method returns the value of a config property that may be inherited from some ancestor.

In some cases, a config may be explicitly set on a component with the intent of only being presented to its children while that component should act upon the inherited value (see referenceHolder for example). In these cases the skipThis parameter should be specified as true.

Available since: 5.0.0

Parameters

Returns

getInitialConfig ( [name] ) : Object/Mixed

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

Parameters

Returns

getSize Object

Returns the height and width of the Component.

Returns

hasListener ( eventName ) : Boolean

Checks to see if this object has any listeners for a specified event

Parameters

Returns

is ( selector ) : Boolean

Tests whether this Widget matches a Ext.ComponentQuery selector string.

Parameters

Returns

isSuspended ( [eventName] ) : Boolean

Checks if all events, or a specific event, is suspended.

Parameters

Returns

isXType ( xtype, [shallow] ) : Boolean

Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended from the xtype (default) or whether it is directly of the xtype specified (shallow = true). **If using your own subclasses, be aware that a Component must register its own xtype to participate in determination of inherited xtypes.__

For a list of all available xtypes, see the Ext.Component header.

Example usage:

var t = new Ext.field.Text();
var isText = t.isXType('textfield'); // true
var isBoxSubclass = t.isXType('field'); // true, descended from Ext.field.Field
var isBoxInstance = t.isXType('field', true); // false, not a direct Ext.field.Field instance

Parameters

Returns

lookupController ( [skipThis] ) : Ext.app.ViewController

Gets the controller that controls this view. May be a controller that belongs to a view higher in the hierarchy.

Available since: 5.0.1

Parameters

Returns

lookupSession ( [skipThis] ) : Ext.data.Session

Returns the Ext.data.Session for this instance. This property may come from this instance's session or be inherited from this object's parent.

Available since: 5.0.0

Parameters

Returns

lookupViewModel ( [skipThis] ) : Ext.app.ViewModel

Returns the Ext.app.ViewModel for this instance. This property may come from this this instance's viewModel or be inherited from this object's parent.

Available since: 5.0.0

Parameters

Returns

on ( eventName, fn, [scope], [options], [order] )

Alias for addListener. Appends an event handler to this object. You can review the available handlers by looking at the 'events' section of the documentation for the component you are working with.

Combining Options

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

A delayed, one-time listener:

container.addListener('tap', this.handleTap, this, {
    single: true,
    delay: 100
});

Attaching multiple handlers in 1 call

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

container.addListener({
    tap  : this.onTap,
    swipe: this.onSwipe,

    scope: this // Important. Ensure "this" is correct during handler execution
});

One can also specify options for each event handler separately:

container.addListener({
    tap  : { fn: this.onTap, scope: this, single: true },
    swipe: { fn: button.onSwipe, scope: button }
});

See the Events Guide for more.

Parameters

current

Ext.create('Ext.Component', {
    listeners: {
        element: 'element',
        tap: function() {
            alert('element tap!');
        }
    }
});

// Create a container with a two children; a button and a toolbar
var container = Ext.create('Ext.Container', {
    items: [
        {
            xtype: 'toolbar',
            docked: 'top',
            title: 'My Toolbar'
        },
        {
           xtype: 'button',
           text: 'My Button'
        }
    ]
});

container.addListener({
    // Ext.Buttons have an xtype of 'button', so we use that are a selector for our delegate
    delegate: 'button',

    tap: function() {
        alert('Button tapped!');
    }
});

onAfter ( eventName, fn, [scope], [options] )

Alias for addAfterListener. Appends an after-event handler.

Same as addListener with order set to 'after'.

Parameters

onBefore ( eventName, fn, [scope], [options] )

Alias for addBeforeListener. Appends a before-event handler. Returning false from the handler will stop the event.

Same as addListener with order set to 'before'.

Parameters

relayEvents ( object, events ) :

chainable ch

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

Parameters

Returns

removeAfterListener ( eventName, fn, [scope], [options] )

Removes a before-event handler.

Same as removeListener with order set to 'after'.

Parameters

removeBeforeListener ( eventName, fn, [scope], [options] )

Removes a before-event handler.

Same as removeListener with order set to 'before'.

Parameters

removeListener ( eventName, fn, [scope], [options], [order] )

Removes an event handler.

Parameters

resumeEvent ( eventName )

Resumes firing of the named event(s).

After calling this method to resume events, the events will fire when requested to fire.

Note that if the suspendEvent method is called multiple times for a certain event, this converse method will have to be called the same number of times for it to resume firing.

Parameters

resumeEvents ( discardQueuedEvents )

Resumes firing events (see suspendEvents).

Parameters

setConfig ( name, [value] ) : Ext.Base

chainable ch

Sets a single/multiple configuration options.

Parameters

Returns

setSize ( width, height )

Sets the size of the Component.

Parameters

suspendEvent ( eventName )

Suspends firing of the named event(s).

After calling this method to suspend events, the events will no longer fire when requested to fire.

Note that if this is called multiple times for a certain event, the converse method resumeEvent will have to be called the same number of times for it to resume firing.

Parameters

suspendEvents ( queueSuspended )

Suspends the firing of all events. (see resumeEvents)

Parameters

un ( eventName, fn, [scope], [options], [order] )

Alias for removeListener. Removes an event handler.

Parameters

unAfter ( eventName, fn, [scope], [options] )

Alias for removeAfterListener. Removes a before-event handler.

Same as removeListener with order set to 'after'.

Parameters

unBefore ( eventName, fn, [scope], [options] )

Alias for removeBeforeListener. Removes a before-event handler.

Same as removeListener with order set to 'before'.

Parameters