Docs Help

## Terms, Icons, and Labels

Many classes have shortcut names used when creating (instantiating) a class with a configuration object. The shortcut name is referred to as an `alias` (or `xtype` if the class extends Ext.Component). The alias/xtype is listed next to the class name of applicable classes for quick reference.

### Access Levels

Framework classes or their members may be specified as `private` or `protected`. Else, the class / member is `public`. `Public`, `protected`, and `private` are access descriptors used to convey how and when the class or class member should be used.

- Public classes and class members are available for use by any other class or application code and may be relied upon as a stable and persistent within major product versions. Public classes and members may safely be extended via a subclass.

- Protected class members are stable `public` members intended to be used by the owning class or its subclasses. Protected members may safely be extended via a subclass.

- Private classes and class members are used internally by the framework and are not intended to be used by application developers. Private classes and members may change or be omitted from the framework at any time without notice and should not be relied upon in application logic.

### Member Types

- Config - The configuration options for a class.
- Property - Set once a class is instantiated. *See Read Only below.
- Method - Actions that can be performed by a class. Methods should be read as instance methods and can only be called from a instance of a given class. Static methods that can be called directly from the class itself will have a `static` label next to the method name. *See Static below.
- Event - Events are specific to the framework event system allowing for classes to programmatically raise an event to be handled by one or more event handler methods. DOM events, while handled by the framework event system, are not specifically described within the API documentation. *For DOM events refer to the event reference page from MDN.
- Theme Variable - Variables used by the visual theme engine employed by the framework.
- Theme Mixin - Functions used by the visual theme engine employed by the framework and may use values set in various Theme Variables.

### Member Syntax

Below is an example class member that we can disect to show the syntax of a class member (the lookupComponent method as viewed from the Ext.button.Button class in this case).

Ext.container.Container
view source
lookupComponent ( item ) : Ext.Component
protected

Called when a raw config object is added to this container either during initialization of the items config, or when new items are added), or {@link #insert inserted.

This method converts the passed object into an instanced child component.

This may be overridden in subclasses when special processing needs to be applied to child creation.

Parameters

item : Object

The config object being added.

Returns
Ext.Component

The component to be added.

Let's look at each part of the member row:

- Expand/Collapse - On the left-hand size of the member row is a control used to expand and collapse each member row to show / hide member details.
- Member Name - The name of the class member (`lookupComponent` in this example)
- Method Param - Any required or optional params used by a method (or passed to an event handler method) will be listed next to the method name within parenthesis (`( item )` in this example)
- Return type - The class instance or javascript object returned by the method or property (`Ext.Component` in this case). This may be omitted for methods that do not return anything other than `undefined` or may display as multiple possible values separated by a forward slash `/` signifying that what is returned may depend on the results of the method call (i.e. a method may return a Component if a get method calls is successful or `false` if unsuccessful which would be displayed as `Ext.Component/Boolean`).
- Flags - Any flags applicable to the member will be displayed next (`PROTECTED` in this example - see the Flags section below)
- Member Origin - On the right-hand side of the member row is the class where the member was initially described (`Ext.container.Container` in this example). The source class will be displayed as a blue link if the member originates from the current class and gray if it is inherited from an ancestor or mixed-in class.
- Member Source - On the right-hand side below the member origin class is a link to view the member's source (`view source` in the example)
- Params List - Each param for a class method will be listed using the same name found above in parenthesis, the type of class or object expected, and a description of the param (`item : Object` in the example).
- Returns - If a class returns a value other than `undefined` a "Returns" section will note the type of class or object returned and a description (`Ext.Component` in the example)
- Since (not shown in the example) - Some members will show which version of the product the member was first introduced (i.e. `Available since 3.4.0` - not pictured in the example) just after the member description
- Default (not shown in the example) - Configs often show the default config value to be applied to a class instance if not overridden (i.e. `Defaults to: false`)

### Member Flags

The API documentation uses a number of flags to further commnicate the class member's function and intent. The label may be represented by a text label, an abbreviation, or an icon.

- Required - Required config when instantiating a class
- Bindable - The config has a setter which allows this config to be set via ViewModel binding
- Read Only - The property may be read, but cannot be used to configure / re-configure a class instance at runtime
- Singleton - Singleton classes are instantiated immediately once defined and may not be instantiated manually
- Static - A static method or property is a method or property belonging to the class itself, not an instance of the class
- Chainable - Refers to methods that return the class instance back when called.
  This enables chained method calls like: `classInstance.method1().method2().etc();`
- Deprecated - A class or member that is scheduled for removal in a future framework version and is provided in the current version for backwards compatibility.
  Deprecated classes and members will have a message directing you to the preferred class / method going forward.
- Removed - A removed class or member that exists in documentation only as a reference for users upgrading between framework versions
- Template - A method defined within a base class designed to be overridden by subclasses
- Abstract - A class or member may be be defined as abstract. Abstract classes and members establish a class structure and provide limited, if any, code. Class-specific code will be furnished via overrides in subclasses.
- Preventable - Events marked preventable will not fire if `false` is returned from an event handler

### Class Icons

- Indicates a framework class

- A singleton framework class. *See the singleton flag for more information

- A component-type framework class (any class within the Ext JS framework that extends Ext.Component)

- Indicates that the class, member, or guide is new in the currently viewed version

### Member Icons

- Indicates a class member of type `config`

- Indicates a class member of type `property`

- Indicates a class member of type `method`

- Indicates a class member of type `event`

- Indicates a class member of type `theme variable`

- Indicates a class member of type `theme mixin`

- Indicates that the class, member, or guide is new in the currently viewed version

## Navigation and Features

### Class Member Quick-Nav Menu

Just below the class name on an API doc page is a row of buttons corresponding to the types of members owned by the current class. Each button shows a count of members by type (this count is updated as filters are applied). Clicking the button will navigate you to that member section. Hovering over the member-type button will reveal a popup menu of all members of that type for quick navigation.

### Getter and Setter Methods

Getting and setter methods that correlate to a class config option will show up in the methods section as well as in the configs section of both the API doc and the member-type menus just beneath the config they work with. The getter and setter method documentation will be found in the config row for easy reference.

### History Bar

Your page history is kept in localstorage and displayed (using the available real estate) just below the top title bar. By default, the only search results shown are the pages matching the product / version you're currently viewing. You can expand what is displayed by clicking on the button on the right-hand side of the history bar and choosing the "All" radio option. This will show all recent pages in the history bar for all products / versions.

Within the history config menu you will also see a listing of your recent page visits. The results are filtered by the "Current Product / Version" and "All" radio options. Clicking on the button will clear the history bar as well as the history kept in local storage.

If "All" is selected in the history config menu the checkbox option for "Show product details in the history bar" will be enabled. When checked, the product/version for each historic page will show alongside the page name in the history bar. Hovering the cursor over the page names in the history bar will also show the product/version as a tooltip.

### Search and Filters

Both API docs and guides can be searched for using the search field at the top of the page.

On API doc pages there is also a filter input field that filters the member rows using the filter string. In addition to filtering by string you can filter the class members by access level and inheritance. This is done using the checkboxes at the top of the page. Note that filtering out `private` members also filters the API class navigation tree.

Clicking on an empty search field will show your last 10 searches for quick navigation.

### API Doc Class Metadata

Each API doc page (with the exception of Javascript primitives pages) has a menu view of metadata relating to that class. This metadata view will have one or more of the following:

- Alternate Name - One or more additional class name synonymns (in Ext JS 6.0.0 the `Ext.button.Button` class has an alternate class name of `Ext.Button`). Alternate class names are commonly maintained for backward compatibility.
- Hierarchy - The hierararchy view lists the inheritance chain of the current class up through its ancestor classes up to the root base class.
- Mixins - A list of classes that are mixed into the current class
- Inherited Mixins - A list of classes that are mixed into an ancestor of the current class
- Requires - All classes required to be defined for the class to be instantiated
- Uses - A list of classes potentially used by the class at some point in its lifecycle, but not necessarily requried for the class to initially be instantiated
- Subclasses - Classes that extend the current class

### Expanding and Collapsing Examples and Class Members

Runnable examples (Fiddles) are expanded on a page by default. You can collapse and expand example code blocks individually using the arrow on the top-left of the code block. You can also toggle the collapse state of all examples using the toggle button on the top-right of the page. The toggle-all state will be remembered between page loads.

Class members are collapsed on a page by default. You can expand and collapse members using the arrow icon on the left of the member row or globally using the expand / collapse all toggle button top-right.

### Desktop -vs- Mobile View

Viewing the docs on narrower screens or browsers will result in a view optimized for a smaller form factor. The primary differences between the desktop and "mobile" view are:

- Global navigation will be located in a menu on the left-hand side accessible via the hamburger menu icon. The menu houses the following (on most pages):
  - The name of the current product (as a link to the product landing page)
  - The Sencha icon used to navigate back to the documentation home page
  - The product menu drop-down button
  - Tabs of navigation trees for the API docs and guides
- Current context navigation and tools is located on the right-hand side accessible via the gear icon. The context menu houses teh following:
  - The global search input field
  - (API doc) A "Filters" tab with the member filter, expand / collapse all examples button, expand / collapse all member rows button, the access level filter checkboxes, and the counts of each member
  - (API doc) A "Related Classes" tab containing the menu of metadata related to the current class
  - (Guides) The table of contents for the guide

### Viewing the Class Source

The class source can be viewed by clicking on the class name at the top of an API doc page. The source for class members can be viewed by clicking on the "view source" link on the right-hand side of the member row.

Ext.chart.series.Line Classic Toolkit

##
Ext JS 6.2.0 - Modern Toolkit

Guides
API
▸ Ext
▸ app
▸ bind
▸ AbstractStub
▸ BaseBinding
▸ Binding
▸ Formula
▸ LinkStub
▸ Multi
▸ Parser
▸ RootStub
▸ Stub
▸ Template
▸ TemplateBinding
▸ domain
▸ Component
▸ Controller
▸ Direct
▸ Global
▸ Store
▸ View
▸ route
▸ Queue
▸ Route
▸ Router
▸ Application
▸ BaseController
▸ Controller
▸ EventBus
▸ EventDomain
▸ Profile
▸ Util
▸ ViewController
▸ ViewModel
▸ behavior
▸ Behavior
▸ Draggable
▸ Translatable
▸ calendar
▸ date
▸ Range
▸ Util
▸ dd
▸ DaysAllDaySource
▸ DaysAllDayTarget
▸ DaysBodySource
▸ DaysBodyTarget
▸ DaysProxy
▸ WeeksProxy
▸ WeeksSource
▸ WeeksTarget
▸ form
▸ AbstractForm
▸ Add
▸ Base
▸ CalendarPicker
▸ Edit
▸ Form
▸ header
▸ Base
▸ Days
▸ Weeks
▸ model
▸ Calendar
▸ CalendarBase
▸ Event
▸ EventBase
▸ panel
▸ AbstractBase
▸ AbstractPanel
▸ Base
▸ Day
▸ Days
▸ Month
▸ Panel
▸ Week
▸ Weeks
▸ store
▸ Calendars
▸ Events
▸ EventSource
▸ theme
▸ Palette
▸ Theme
▸ util
▸ Dom
▸ view
▸ Base
▸ Day
▸ Days
▸ DaysRenderer
▸ Month
▸ Multi
▸ Week
▸ Weeks
▸ WeeksRenderer
▸ AbstractList
▸ Event
▸ EventBase
▸ List
▸ carousel
▸ Carousel
▸ Indicator
▸ Infinite
▸ Item
▸ chart
▸ axis
▸ layout
▸ CombineDuplicate
▸ Continuous
▸ Discrete
▸ Layout
▸ segmenter
▸ Names
▸ Numeric
▸ Segmenter
▸ Time
▸ sprite
▸ Axis
▸ Axis3D
▸ Axis
▸ Axis3D
▸ Category
▸ Category3D
▸ Numeric
▸ Numeric3D
▸ Time
▸ Time3D
▸ grid
▸ CircularGrid
▸ HorizontalGrid
▸ HorizontalGrid3D
▸ RadialGrid
▸ VerticalGrid
▸ VerticalGrid3D
▸ interactions
▸ Abstract
▸ Crosshair
▸ CrossZoom
▸ ItemEdit
▸ ItemHighlight
▸ ItemInfo
▸ PanZoom
▸ Rotate
▸ RotatePie3D
▸ label
▸ Callout
▸ legend
▸ sprite
▸ Border
▸ Item
▸ store
▸ Item
▸ Store
▸ Legend
▸ LegendBase
▸ SpriteLegend
▸ plugin
▸ ItemEvents
▸ series
▸ sprite
▸ Aggregative
▸ Area
▸ Bar
▸ Bar3D
▸ Box
▸ CandleStick
▸ Cartesian
▸ Line
▸ Pie3DPart
▸ PieSlice
▸ Polar
▸ Radar
▸ Scatter
▸ Series
▸ StackedCartesian
▸ Area
▸ Bar
▸ Bar3D
▸ CandleStick
▸ Cartesian
▸ Gauge
▸ Line
▸ Pie
▸ Pie3D
▸ Polar
▸ Radar
▸ Scatter
▸ Series
▸ StackedCartesian
▸ sprite
▸ Label
▸ theme
▸ Base
▸ Default
▸ AbstractChart
▸ CartesianChart
▸ MarkerHolder
▸ Markers
▸ PolarChart
▸ SpaceFillingChart
▸ d3
▸ axis
▸ Axis
▸ Color
▸ Data
▸ canvas
▸ Canvas
▸ HiDPI
▸ hierarchy
▸ partition
▸ Icicle
▸ Partition
▸ Sunburst
▸ tree
▸ HorizontalTree
▸ Tree
▸ Hierarchy
▸ Pack
▸ Partition
▸ Tree
▸ TreeMap
▸ interaction
▸ Abstract
▸ PanZoom
▸ legend
▸ Color
▸ Legend
▸ mixin
▸ Detached
▸ ToolTip
▸ svg
▸ Svg
▸ Component
▸ HeatMap
▸ Helpers
▸ data
▸ amf
▸ Encoder
▸ Packet
▸ Proxy
▸ Reader
▸ RemotingMessage
▸ XmlDecoder
▸ XmlEncoder
▸ field
▸ Boolean
▸ Date
▸ Field
▸ Integer
▸ Number
▸ String
▸ flash
▸ BinaryXhr
▸ identifier
▸ Generator
▸ Negative
▸ Sequential
▸ Uuid
▸ matrix
▸ Matrix
▸ Side
▸ Slice
▸ operation
▸ Create
▸ Destroy
▸ Operation
▸ Read
▸ Update
▸ proxy
▸ Ajax
▸ Client
▸ Direct
▸ JsonP
▸ LocalStorage
▸ Memory
▸ Proxy
▸ Rest
▸ Server
▸ SessionStorage
▸ WebStorage
▸ reader
▸ Array
▸ Json
▸ Reader
▸ Xml
▸ request
▸ Ajax
▸ Base
▸ Form
▸ schema
▸ Association
▸ HasMany
▸ HasOne
▸ ManyToMany
▸ ManyToOne
▸ Namer
▸ OneToOne
▸ Reference
▸ Role
▸ Schema
▸ session
▸ BatchVisitor
▸ ChangesVisitor
▸ ChildChangesVisitor
▸ soap
▸ Proxy
▸ Reader
▸ validator
▸ Bound
▸ Email
▸ Exclusion
▸ Format
▸ Inclusion
▸ Length
▸ List
▸ Presence
▸ Range
▸ Validator
▸ writer
▸ Json
▸ Writer
▸ Xml
▸ AbstractStore
▸ ArrayStore
▸ Batch
▸ BufferedStore
▸ ChainedStore
▸ Connection
▸ DirectStore
▸ Error
▸ ErrorCollection
▸ JsonP
▸ JsonPStore
▸ JsonStore
▸ LocalStore
▸ Model
▸ ModelManager
▸ NodeInterface
▸ NodeStore
▸ PageMap
▸ ProxyStore
▸ Request
▸ ResultSet
▸ Session
▸ SortTypes
▸ Store
▸ StoreManager
▸ TreeModel
▸ TreeStore
▸ Types
▸ Validation
▸ XmlStore
▸ dataview
▸ component
▸ Container
▸ DataItem
▸ element
▸ Container
▸ List
▸ plugin
▸ ItemTip
▸ DataView
▸ IndexBar
▸ ItemHeader
▸ List
▸ ListItem
▸ ListItemBody
▸ ListItemDisclosure
▸ NestedList
▸ SimpleListItem
▸ direct
▸ AmfRemotingProvider
▸ Event
▸ ExceptionEvent
▸ JsonProvider
▸ Manager
▸ PollingProvider
▸ Provider
▸ RemotingEvent
▸ RemotingMethod
▸ RemotingProvider
▸ Transaction
▸ dom
▸ CompositeElement
▸ CompositeElementLite
▸ Element
▸ ElementEvent
▸ Fly
▸ GarbageCollector
▸ Helper
▸ Query
▸ Shadow
▸ Shim
▸ TouchAction
▸ Underlay
▸ UnderlayPool
▸ drag
▸ proxy
▸ None
▸ Original
▸ Placeholder
▸ Constraint
▸ Info
▸ Item
▸ Manager
▸ Source
▸ Target
▸ draw
▸ engine
▸ SvgContext
▸ Gradient
▸ Canvas
▸ excanvas
▸ Svg
▸ gradient
▸ Gradient
▸ GradientDefinition
▸ Linear
▸ Radial
▸ modifier
▸ Animation
▸ Highlight
▸ Modifier
▸ Target
▸ overrides
▸ hittest
▸ sprite
▸ Instancing
▸ Path
▸ Path
▸ Surface
▸ plugin
▸ SpriteEvents
▸ sprite
▸ AnimationParser
▸ Arc
▸ Arrow
▸ AttributeDefinition
▸ AttributeParser
▸ Circle
▸ Composite
▸ Cross
▸ Diamond
▸ Ellipse
▸ EllipticalArc
▸ Image
▸ Instancing
▸ Line
▸ Path
▸ Plus
▸ Rect
▸ Sector
▸ Sprite
▸ Square
▸ Text
▸ Tick
▸ Triangle
▸ Animator
▸ Container
▸ Draw
▸ LimitedCache
▸ Matrix
▸ Path
▸ PathUtil
▸ Point
▸ SegmentTree
▸ Surface
▸ SurfaceBase
▸ TextMeasurer
▸ TimingFunctions
▸ env
▸ Browser
▸ OS
▸ Ready
▸ event
▸ gesture
▸ DoubleTap
▸ Drag
▸ EdgeSwipe
▸ LongPress
▸ MultiTouch
▸ Pinch
▸ Recognizer
▸ Rotate
▸ SingleTouch
▸ Swipe
▸ Tap
▸ publisher
▸ Dom
▸ ElementPaint
▸ ElementSize
▸ Focus
▸ Gesture
▸ Publisher
▸ Event
▸ exporter
▸ data
▸ Base
▸ Cell
▸ Column
▸ Group
▸ Row
▸ Table
▸ excel
▸ Xlsx
▸ Xml
▸ file
▸ excel
▸ Cell
▸ Column
▸ Row
▸ Style
▸ Table
▸ Workbook
▸ Worksheet
▸ html
▸ Doc
▸ Style
▸ ooxml
▸ excel
▸ Border
▸ BorderPr
▸ Cell
▸ CellAlignment
▸ CellStyleXf
▸ CellXf
▸ Column
▸ Fill
▸ Font
▸ NumberFormat
▸ Row
▸ SharedStrings
▸ Sheet
▸ Stylesheet
▸ Workbook
▸ Worksheet
▸ Base
▸ ContentType
▸ ContentTypes
▸ CoreProperties
▸ Excel
▸ Relationship
▸ Relationships
▸ zip
▸ Archive
▸ File
▸ Folder
▸ Base
▸ Style
▸ text
▸ CSV
▸ Html
▸ TSV
▸ Base
▸ File
▸ Plugin
▸ field
▸ trigger
▸ Clear
▸ Date
▸ Expand
▸ Reveal
▸ Search
▸ SpinDown
▸ SpinUp
▸ Trigger
▸ Checkbox
▸ DatePicker
▸ DatePickerNative
▸ Email
▸ Field
▸ File
▸ FileInput
▸ Hidden
▸ Input
▸ Number
▸ Password
▸ Picker
▸ Radio
▸ Search
▸ Select
▸ SingleSlider
▸ Slider
▸ Spinner
▸ Text
▸ TextArea
▸ TextAreaInput
▸ TextInput
▸ Toggle
▸ Url
▸ form
▸ FieldContainer
▸ FieldSet
▸ Panel
▸ fx
▸ animation
▸ Abstract
▸ Cube
▸ Fade
▸ FadeOut
▸ Flip
▸ Pop
▸ PopOut
▸ Slide
▸ SlideOut
▸ Wipe
▸ WipeOut
▸ easing
▸ Abstract
▸ Bounce
▸ BoundMomentum
▸ EaseIn
▸ EaseOut
▸ Easing
▸ Linear
▸ Momentum
▸ layout
▸ card
▸ Abstract
▸ Cover
▸ Cube
▸ Fade
▸ Flip
▸ Pop
▸ Reveal
▸ Scroll
▸ ScrollCover
▸ ScrollReveal
▸ Slide
▸ Style
▸ Card
▸ runner
▸ Css
▸ CssAnimation
▸ CssTransition
▸ Animation
▸ Runner
▸ State
▸ google
▸ data
▸ AbstractProxy
▸ CalendarsProxy
▸ EventsProxy
▸ ux
▸ Client
▸ grid
▸ cell
▸ Base
▸ Boolean
▸ Cell
▸ Check
▸ Date
▸ Expander
▸ Number
▸ RowNumberer
▸ Summary
▸ Text
▸ Tree
▸ Widget
▸ column
▸ Boolean
▸ Check
▸ Column
▸ Date
▸ Number
▸ RowNumberer
▸ Selection
▸ Tree
▸ plugin
▸ ColumnResizing
▸ Editable
▸ Exporter
▸ MultiSelection
▸ PagingToolbar
▸ RowExpander
▸ SummaryRow
▸ ViewOptions
▸ Grid
▸ HeaderContainer
▸ HeaderGroup
▸ PagingToolbar
▸ Row
▸ RowBody
▸ RowHeader
▸ Tree
▸ layout
▸ wrapper
▸ BoxDock
▸ Dock
▸ Inner
▸ Abstract
▸ Box
▸ Card
▸ Default
▸ Fit
▸ FlexBox
▸ Float
▸ HBox
▸ VBox
▸ list
▸ AbstractTreeItem
▸ RootTreeItem
▸ Tree
▸ TreeItem
▸ mixin
▸ Accessible
▸ Bindable
▸ ComponentDelegation
▸ ConfigState
▸ Container
▸ Dirty
▸ Factoryable
▸ Hookable
▸ Identifiable
▸ Inheritable
▸ Keyboard
▸ Mashup
▸ Observable
▸ Pluggable
▸ Progressable
▸ Queryable
▸ Responsive
▸ Selectable
▸ StyleCacher
▸ Templatable
▸ Traversable
▸ panel
▸ Header
▸ Title
▸ Tool
▸ parse
▸ symbol
▸ Constant
▸ Infix
▸ InfixRight
▸ Paren
▸ Prefix
▸ Parser
▸ Symbol
▸ Tokenizer
▸ perf
▸ Accumulator
▸ Monitor
▸ picker
▸ Date
▸ Picker
▸ Slot
▸ pivot
▸ axis
▸ Base
▸ Item
▸ Local
▸ cell
▸ Cell
▸ Group
▸ dimension
▸ Item
▸ feature
▸ PivotStore
▸ filter
▸ Base
▸ Label
▸ Value
▸ matrix
▸ Base
▸ Local
▸ Remote
▸ plugin
▸ configurator
▸ model
▸ Select
▸ store
▸ Select
▸ Column
▸ Container
▸ DragZone
▸ DropZone
▸ Field
▸ FieldSettings
▸ Form
▸ FormController
▸ Panel
▸ PanelController
▸ rangeeditor
▸ Panel
▸ PanelController
▸ Configurator
▸ DrillDown
▸ Exporter
▸ RangeEditor
▸ result
▸ Base
▸ Collection
▸ Local
▸ update
▸ Base
▸ Increment
▸ Overwrite
▸ Percentage
▸ Uniform
▸ Aggregators
▸ Grid
▸ MixedCollection
▸ Row
▸ plugin
▸ field
▸ PlaceHolderLabel
▸ Abstract
▸ LazyItems
▸ ListPaging
▸ MouseEnter
▸ PullRefresh
▸ Responsive
▸ SortableList
▸ promise
▸ Consequence
▸ Deferred
▸ Promise
▸ scroll
▸ Scroller
▸ slider
▸ Slider
▸ Thumb
▸ Toggle
▸ sparkline
▸ Bar
▸ BarBase
▸ Base
▸ Box
▸ Bullet
▸ CanvasBase
▸ CanvasCanvas
▸ Discrete
▸ Line
▸ Pie
▸ RangeMap
▸ Shape
▸ TriState
▸ VmlCanvas
▸ tab
▸ Bar
▸ Panel
▸ Tab
▸ table
▸ Table
▸ tip
▸ Manager
▸ Tip
▸ ToolTip
▸ util
▸ paintmonitor
▸ Abstract
▸ CssAnimation
▸ OverflowChange
▸ sizemonitor
▸ Abstract
▸ OverflowChange
▸ Scroll
▸ TaskRunner
▸ Task
▸ translatable
▸ Abstract
▸ CssPosition
▸ CssTransform
▸ Dom
▸ ScrollParent
▸ ScrollPosition
▸ AbstractMixedCollection
▸ Audio
▸ Bag
▸ Base64
▸ BufferedCollection
▸ Cache
▸ Collection
▸ CollectionKey
▸ Color
▸ CSS
▸ CSV
▸ DelayedTask
▸ DelimitedValue
▸ Draggable
▸ Droppable
▸ Event
▸ Filter
▸ FilterCollection
▸ Fly
▸ Format
▸ Geolocation
▸ Group
▸ GroupCollection
▸ Grouper
▸ HashMap
▸ History
▸ Inflector
▸ InputBlocker
▸ ItemCollection
▸ LineSegment
▸ LocalStorage
▸ LruCache
▸ MixedCollection
▸ ObjectTemplate
▸ Observable
▸ Offset
▸ Operators
▸ PaintMonitor
▸ Point
▸ Positionable
▸ PositionMap
▸ Region
▸ Schedulable
▸ Scheduler
▸ SizeMonitor
▸ Sortable
▸ Sorter
▸ SorterCollection
▸ TapRepeater
▸ TaskManager
▸ TextMetrics
▸ Translatable
▸ TranslatableGroup
▸ TranslatableList
▸ TSV
▸ Wrapper
▸ XTemplateCompiler
▸ XTemplateParser
▸ ux
▸ ajax
▸ DataSimlet
▸ JsonSimlet
▸ PivotSimlet
▸ Simlet
▸ SimManager
▸ SimXhr
▸ XmlSimlet
▸ event
▸ Driver
▸ Maker
▸ Player
▸ Recorder
▸ google
▸ Api
▸ Feeds
▸ Gauge
▸ viewport
▸ Android
▸ Default
▸ Ios
▸ Viewport
▸ WindowsPhone
▸ AbstractComponent
▸ AbstractManager
▸ ActionSheet
▸ Ajax
▸ Anim
▸ AnimationQueue
▸ anims
▸ Array
▸ Assert
▸ Audio
▸ Base
▸ browser
▸ Button
▸ Class
▸ ClassManager
▸ Component
▸ ComponentManager
▸ ComponentQuery
▸ Config
▸ Configurator
▸ Container
▸ Date
▸ Decorator
▸ Deferred
▸ Error
▸ Evented
▸ Factory
▸ feature
▸ Function
▸ GlobalEvents
▸ Glyph
▸ Img
▸ Inventory
▸ JSON
▸ Label
▸ Loader
▸ LoadMask
▸ Mask
▸ Media
▸ MessageBox
▸ Mixin
▸ Msg
▸ Number
▸ Object
▸ os
▸ Panel
▸ Progress
▸ ProgressBase
▸ Promise
▸ SegmentedButton
▸ Sheet
▸ Sortable
▸ Spacer
▸ String
▸ supports
▸ TaskQueue
▸ Template
▸ Title
▸ Titlebar
▸ TitleBar
▸ Toast
▸ Toolbar
▸ Version
▸ Video
▸ Viewport
▸ Widget
▸ XTemplate
▸ Array
▸ Boolean
▸ CanvasRenderingContext2D
▸ CanvasRenderingContext2D_
▸ Date
▸ Function
▸ Global_CSS
▸ Number
▸ Object
▸ RegExp
▸ String
▸ Getting Started
▸ Setup & Getting Started
▸ Ext JS - FAQ
▸ Sample Login App
▸ API Diffs
▸ Modern - 6.0.2 and 6.2.0
▸ Classic - 6.0.2 and 6.2.0
▸ Examples
▸ 6.2.0 Examples
▸ What's New?
▸ Release Notes
▸ Core Concepts
▸ The Class System
▸ Layouts and Containers
▸ Components
▸ Data Package
▸ Events and Gestures
▸ Drag and Drop
▸ Theming System
▸ Material Theme
▸ Memory Management
▸ Draw Package
▸ Draw Package
▸ Creating Images - Pt 1
▸ Creating Images - Pt 2
▸ Creating Images - Pt 3
▸ Accessibility
▸ Localization
▸ Right to Left in Ext JS
▸ Sencha Font Packages
▸ Tablet Support
▸ Architecture
▸ Intro to App Architecture
▸ Multiple Screens
▸ View Controllers
▸ View Models & Binding
▸ View Model Internals
▸ Using the Router
▸ UI Components
▸ Carousel
▸ Forms
▸ Introduction to Charting
▸ Trees
▸ Grids
▸ Pivot Grid
▸ Widgets and Widget Cols
▸ Backend Connectors
▸ SOAP Services
▸ AMF Data Sources
▸ Ext Direct
▸ Ext Direct Specification
▸ Using MySQL and PHP
▸ Other Resources
▸ Basics of OOP
▸ Ext JS Ecosystem
▸ From the Sencha Blog
▸ Supported Browsers
top

# Ext.chart.series.Line series: series.line

### Hierarchy

Ext.Base
Ext.chart.series.Series
Ext.chart.series.Cartesian
Ext.chart.series.Line

### Inherited Mixins

Ext.Mixin
Ext.mixin.Bindable
Ext.mixin.Identifiable
Ext.mixin.Observable

### Requires

Ext.chart.series.sprite.Line

## Summary

Creates a Line Chart. A Line Chart is a useful visualization technique to display quantitative information for different categories or other real values (as opposed to the bar chart), that can show some progression (or regression) in the dataset. As with all other series, the Line Series must be appended in the series Chart array configuration. See the Chart documentation for more information. A typical configuration object for the line series could be:

Ext.create({ xtype: 'cartesian', renderTo: document.body, width: 600, height: 400, insetPadding: 40, store: { fields: ['name', 'data1', 'data2'], data: [{ 'name': 'metric one', 'data1': 10, 'data2': 14 }, { 'name': 'metric two', 'data1': 7, 'data2': 16 }, { 'name': 'metric three', 'data1': 5, 'data2': 14 }, { 'name': 'metric four', 'data1': 2, 'data2': 6 }, { 'name': 'metric five', 'data1': 27, 'data2': 36 }] }, axes: [{ type: 'numeric', position: 'left', fields: ['data1'], title: { text: 'Sample Values', fontSize: 15 }, grid: true, minimum: 0 }, { type: 'category', position: 'bottom', fields: ['name'], title: { text: 'Sample Values', fontSize: 15 } }], series: [{ type: 'line', style: { stroke: '#30BDA7', lineWidth: 2 }, xField: 'name', yField: 'data1', marker: { type: 'path', path: ['M', - 4, 0, 0, 4, 4, 0, 0, - 4, 'Z'], stroke: '#30BDA7', lineWidth: 2, fill: 'white' } }, { type: 'line', fill: true, style: { fill: '#96D4C6', fillOpacity: .6, stroke: '#0A3F50', strokeOpacity: .6, }, xField: 'name', yField: 'data2', marker: { type: 'circle', radius: 4, lineWidth: 2, fill: 'white' } }] });

In this configuration we're adding two series (or lines), one bound to the `data1` property of the store and the other to `data3`. The type for both configurations is `line`. The xField for both series is the same, the `name` property of the store. Both line series share the same axis, the left axis. You can set particular marker configuration by adding properties onto the marker object. Both series have an object as highlight so that markers animate smoothly to the properties in highlight when hovered. The second series has `fill = true` which means that the line will also have an area below it of the same color.

Note: In the series definition remember to explicitly set the axis to bind the values of the line series to. This can be done by using the `axis` configuration property.

No members found using the current filters

## configs

Ext.chart.series.Series
view source

## animation : Object

The series animation configuration.

Defaults to: null

Ext.chart.series.Series
view source

## background : Object

Sets the background of the surface the series is attached.

Defaults to: null

Ext.mixin.Bindable
view source

## bind : Object

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

Sample Code

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

To dynamically add bindings:

Sample Code

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

To remove bindings:

Sample Code

     panel.setBind({
         title: null
     });

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

Defaults to: null

Ext.chart.series.Series
view source

## chart : Object
private pri

The chart that the series is bound.

Defaults to: null

Ext.chart.series.Series
view source

## colors : Array

An array of color values which is used, in order of appearance, by the series. Each series can request one or more colors from the array. Radar, Scatter or Line charts require just one color each. Candlestick and OHLC require two (1 for drops + 1 for rises). Pie charts and Stacked charts (like Bar or Pie charts) require one color for each data category they represent, so one color for each slice of a Pie chart or each segment (not bar) of a Bar chart. It overrides the colors that are provided by the current theme.

Defaults to: null

Ext.mixin.Bindable
view source

## controller : String / Object / Ext.app.ViewController

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

Sample Code

    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

Ext.mixin.Bindable
view source

## getController : Ext.app.ViewController

Returns the Ext.app.ViewController instance associated with this component via the controller config or setController method.

### Returns

:Ext.app.ViewController

Returns this component's ViewController or null if one was not configured

Ext.mixin.Bindable
view source

## defaultListenerScope : Boolean

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

Ext.chart.series.Line
view source

## fill : Boolean

If set to `true`, the area underneath the line is filled with the color defined as follows, listed by priority:

- The color that is configured for this series (Ext.chart.series.Series#colors).
- The color that is configured for this chart (Ext.chart.AbstractChart#colors).
- The fill color that is set in the style config.
- The stroke color that is set in the style config, or the same color as the line.

Note: Do not confuse `series.config.fill` (which is a boolean) with `series.style.fill' (which is an alias for the`fillStyle`property and contains a color). For compatibility with previous versions of the API, if`config.fill`is undefined but a`style.fill' color is provided, `config.fill` is considered true. So the default value below must be undefined, not false.

Ext.chart.series.Series
view source

## hidden : Boolean / Array

Defaults to: false

Ext.chart.series.Series
view source

## highlight : Boolean / Object

The sprite attributes that will be applied to the highlighted items in the series. If set to 'true', the default highlight style from highlightCfg will be used. If the value of this config is an object, it will be merged with the highlightCfg. In case merging of 'highlight' and 'highlightCfg' configs in not the desired behavior, provide the 'highlightCfg' instead.

Defaults to: false

Ext.chart.series.Series
view source

## highlightCfg : Object
protected pro

The default style for the highlighted item. Used when highlight config was simply set to 'true' instead of specifying a style.

Defaults to: { fillStyle: 'yellow', strokeStyle: 'red' }

Ext.chart.series.Series
view source

## highlightItem : Object

The item currently highlighted in the series.

Defaults to: null

Ext.chart.series.Series
view source

## itemInstancing : Object
protected pro

The sprite template used to create sprite instances in the series.

Defaults to: null

Ext.chart.series.Series
view source

## label : Object

Object with the following properties:

Defaults to: {}

### Properties

display : String

Specifies the presence and position of the labels. The possible values depend on the series type. For Line and Scatter series: 'under' | 'over' | 'rotate'. For Bar and 3D Bar series: 'insideStart' | 'insideEnd' | 'outside'. For Pie series: 'outside' | 'rotate' | 'horizontal' | 'vertical'. Area, Radar and Candlestick series don't support labels. For Area and Radar series please consider using tooltips instead. 3D Pie series currently always display labels 'outside'. For all series: 'none' hides the labels.

Default value: 'none'.

color : String

The color of the label text.

Default value: '#000' (black).

field : String/String[]

The name(s) of the field(s) to be displayed in the labels. If your chart has 3 series that correspond to the fields 'a', 'b', and 'c' of your model, and you only want to display labels for the series 'c', you must still provide an array `[null, null, 'c']`.

Default value: null.

font : String

The font used for the labels.

Default value: '14px Helvetica'.

orientation : String

Either 'horizontal' or 'vertical'. If not set (default), the orientation is inferred from the value of the flipXY property of the series.

Default value: ''.

renderer : Function

Optional function for formatting the label into a displayable value.

The arguments to the method are:

- `text`, `sprite`, `config`, `rendererData`, `index`

  Label's renderer is passed the same arguments as renderer plus one extra 'text' argument which comes first.

### Returns

:Object / String

The attributes that have been changed or added, or the text for the label. Example to enclose every other label in parentheses:

Sample Code

     renderer: function (text) {
         if (index % 2 == 0) {
             return '(' + text + ')'
         }
     }

Default value: null.

Ext.chart.series.Series
view source

## labelOverflowPadding : Number

Extra distance value for which the labelOverflow listener is triggered.

Defaults to: null

Ext.mixin.Observable
view source

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

DOM events from Ext JS Ext.Component

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 DataViews 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:

Sample Code

    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'); }
            }
        }
    });

Ext.mixin.Observable
view source

## setListeners ( listeners )

An alias for addListener. In versions prior to 5.1, listeners had a generated setter which could be called to add listeners. In 5.1 the listeners config is not processed using the config system and has no generated setter, so this method is provided for backward compatibility. The preferred way of adding listeners is to use the on method.

### Parameters

listeners : Object

The listeners

Ext.chart.series.Series
view source

## marker : Object / Boolean

The sprite template used by marker instances on the series. If the value of the marker config is set to `true` or the type of the sprite instance is not specified, the Ext.draw.sprite.Circle sprite will be used.

Examples:

Sample Code

    marker: true

    marker: {
        radius: 8
    }

    marker: {
        type: 'arrow',
        fx: {
            duration: 200,
            easing: 'backOut'
        }
    }

Defaults to: null

Ext.chart.series.Series
view source

## markerSubStyle : Object

This is cyclic used if series have multiple marker sprites.

Defaults to: null

Ext.chart.series.Line
view source

## nullStyle : "gap" / "connect" / "origin"

Possible values: 'gap' - null points are rendered as gaps. 'connect' - non-null points are connected across null points, so that there is no gap, unless null points are at the beginning/end of the line. Only the visible data points are connected - if a visible data point is followed by a series of null points that go off screen and eventually terminate with a non-null point, the connection won't be made. 'origin' - null data points are rendered at the origin, which is the y-coordinate of a point where the x and y axes meet. This requires that at least the x-coordinate of a point is a valid value.

Defaults to: "gap"

Ext.chart.series.Series
view source

## overlaySurface : Object
protected pro

The surface used to render series labels.

Defaults to: null

Ext.mixin.Bindable
view source

## publishes : String / String[] / Object

One or more names of config properties that this component should publish to its ViewModel. Generally speaking, only properties defined in a class config block (including ancestor config blocks and mixins) are eligible for publishing to the viewModel. Some components override this and publish their most useful configs by default.

Note: We'll discuss publishing properties not found in the config block below.

Values determined to be invalid by component (often form fields and model validations) will not be published to the ViewModel.

This config uses the 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 reference you can bind configs between components. For example:

Sample Code

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

Sample Code

     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:

Sample Code

     {
         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
         }
     }

In some cases, users may want to publish a property to the viewModel that is not found in a class config block. In these situations, you may utilize publishState if the property has a setter method. Let's use setFieldLabel as an example:

Sample Code

      setFieldLabel: function(fieldLabel) {
          this.callParent(arguments);
          this.publishState('fieldLabel', fieldLabel);
      }

With the above chunk of code, fieldLabel may now be published to the viewModel.

Defaults to: null

Available since: 5.0.0

Ext.mixin.Bindable
view source

## reference : String

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

Ext.chart.series.Series
view source

## renderer : Function

A function that can be provided to set custom styling properties to each rendered element. It receives `(sprite, config, rendererData, index)` as parameters.

Defaults to: null

### Parameters

sprite : Object

The sprite affected by the renderer. The visual attributes are in `sprite.attr`. The data field is available in `sprite.getField()`.

config : Object

The sprite configuration. It varies with the series and the type of sprite: for instance, a Line chart sprite might have just the `x` and `y` properties while a Bar chart sprite also has `width` and `height`. A type might be present too. For instance to draw each marker and each segment of a Line chart, the renderer is called with the `config.type` set to either marker or `line`.

rendererData : Object

A record with different properties depending on the type of chart. The only guaranteed property is `rendererData.store`, the store used by the series. In some cases, a store may not exist: for instance a Gauge chart may read its value directly from its configuration; in this case rendererData.store is null and the value is available in rendererData.value.

index : Number

The index of the sprite. It is usually the index of the store record associated with the sprite, in which case the record can be obtained with `store.getData().items[index]`. If the chart is not associated with a store, the index represents the index of the sprite within the series. For instance a Gauge chart may have as many sprites as there are sectors in the background of the gauge, plus one for the needle.

### Returns

:Object

The attributes that have been changed or added. Note: it is usually possible to add or modify the attributes directly into the `config` parameter and not return anything, but returning an object with only those attributes that have been changed may allow for optimizations in the rendering of some series. Example to draw every other marker in red:

Sample Code

     renderer: function (sprite, config, rendererData, index) {
         if (config.type === 'marker') {
             return { strokeStyle: (index % 2 === 0 ? 'red' : 'black') };
         }
     }

Ext.chart.series.Line
view source

## selectionTolerance : Number

The offset distance from the cursor position to the line series to trigger events (then used for highlighting series, etc).

Defaults to: 20

Ext.mixin.Bindable
view source

## session : Boolean / Object / Ext.data.Session

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`:

Sample Code

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

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

Alternatively, a config object can be provided:

Sample Code

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

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

Defaults to: null

Ext.chart.series.Series
view source

## showInLegend : Boolean

Whether to show this series in the legend.

Defaults to: true

Ext.chart.series.Series
view source

## showMarkers : Boolean

Whether markers should be displayed at the data points along the line. If true, then the marker config item will determine the markers' styling.

Defaults to: true

Ext.chart.series.Line
view source

## smooth : Boolean

`true` if the series' line should be smoothed. Line smoothing only works with gapless data.

Defaults to: false

Ext.chart.series.Line
view source

## step : Boolean

If set to `true`, the line uses steps instead of straight lines to connect the dots. It is ignored if smooth is true.

Defaults to: false

Ext.chart.series.Series
view source

## store : Object

The store to use for this series. If not specified, the series will use the chart's store.

Defaults to: null

Ext.chart.series.Line
view source

## style : Object

An object containing styles for the visualization lines. These styles will override the theme styles. Some options contained within the style object will are described next.

Ext.chart.series.Series
view source

## subStyle : Object

This is the cyclic used if the series has multiple sprites.

Defaults to: {}

Ext.chart.series.Series
view source

## surface : Ext.draw.Surface
protected pro

The chart surface used to render series sprites.

Defaults to: null

Ext.chart.series.Series
view source

## themeStyle : Object
private pri

Style configuration that is provided by the current theme. It is composed of five objects:

Defaults to: {}

### Properties

style : Object

Properties common to all the series, for instance the 'lineWidth'.

subStyle : Object

Cyclic used if the series has multiple sprites.

label : Object

Sprite config for the labels, for instance the font and color.

marker : Object

Sprite config for the markers, for instance the size and stroke color.

markerSubStyle : Object

Cyclic used if series have multiple marker sprites.

Ext.chart.series.Series
view source

## title : String / String[]

The human-readable name of the series (displayed in the legend). If the series is stacked (has multiple components in it) this should be an array, where each string corresponds to a stacked component.

Defaults to: null

Ext.chart.series.Series
view source

## tooltip : Object

Add tooltips to the visualization's markers. The config options for the tooltip are the same configuration used with Ext.tip.ToolTip plus a renderer config option and a `scope` for the renderer. For example:

Sample Code

    tooltip: {
      trackMouse: true,
      width: 140,
      height: 28,
      renderer: function (toolTip, record, ctx) {
          toolTip.setHtml(record.get('name') + ': ' + record.get('data1') + ' views');
      }
    }

Note that tooltips are shown for series markers and won't work if the marker is not configured.

Defaults to: null

### Properties

scope : Object

The scope to use when the renderer function is called. Defaults to the Series instance.

renderer : Function

An 'interceptor' method which can be used to modify the tooltip attributes before it is shown. The renderer function is passed the following params:

toolTip : Ext.tip.ToolTip

The tooltip instance

record : Ext.data.Model

The record instance for the chart item (sprite) currently targeted by the tooltip.

ctx : Object

A data object with values relating to the currently targeted chart sprite

category : String

The type of sprite passed to the renderer function (will be "items", "markers", or "labels" depending on the target sprite of the tooltip)

field : String

The yField for the series

index : Number

The target sprite's index within the series' items

record : Ext.data.Model

The record instance for the chart item (sprite) currently targeted by the tooltip.

series : Ext.chart.series.Series

The series instance containing the tooltip's target sprite

sprite : Ext.draw.sprite.Sprite

The sprite (item) target of the tooltip

Ext.chart.series.Series
view source

## triggerAfterDraw
private pri

Trigger drawlistener flag

Defaults to: false

Ext.mixin.Bindable
view source

## twoWayBindable : String / String[] / Object

This object holds a map of `config` properties that will update their binding as they are modified. For example, `value` is a key added by form fields. The form of this config is the same as publishes.

This config is defined so that updaters are not created and added for all bound properties since most cannot be modified by the end-user and hence are not appropriate for two-way binding.

Defaults to: null

Ext.chart.series.Series
view source

## useDarkerStrokeColor : Boolean / Number

Colors for the series can be set directly through the 'colors' config, or indirectly with the current theme or the 'colors' config that is set onto the chart. These colors are used as "fill color". Set this config to true, if you want a darker color for the strokes. Set it to false if you want to use the same color as the fill color. Alternatively, you can set it to a number between 0 and 1 to control how much darker the strokes should be. Note: this should be initial config and cannot be changed later on.

Defaults to: true

Ext.mixin.Bindable
view source

## viewModel : String / Object / Ext.app.ViewModel

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

Ext.chart.series.Cartesian
view source

## xAxis : Ext.chart.axis.Axis / Number / String

xAxis The chart axis the series is bound to in the 'X' direction. Normally, this would be set automatically by the series. For charts with multiple x-axes, this defines which x-axis is used by the series. It refers to either axis' ID or the (zero-based) index of the axis in the chart's axes config.

Defaults to: null

Ext.chart.series.Cartesian
view source

## xField : String

The field used to access the x axis value from the items from the data source.

Defaults to: null

Ext.chart.series.Cartesian
view source

## yAxis : Ext.chart.axis.Axis / Number / String

yAxis The chart axis the series is bound to in the 'Y' direction. Normally, this would be set automatically by the series. For charts with multiple y-axes, this defines which y-axis is used by the series. It refers to either axis' ID or the (zero-based) index of the axis in the chart's axes config.

Defaults to: null

Ext.chart.series.Cartesian
view source

## yField : String / String[]

The field(s) used to access the y-axis value(s) of the items from the data source.

Defaults to: null

## properties

Ext.Base
view source

## $className
private pri

Defaults to: 'Ext.Base'

Ext.Base
view source

## $configPrefixed : Boolean
private pri

The value `true` causes `config` values to be stored on instances using a property name prefixed with an underscore ("_") character. A value of `false` stores `config` values as properties using their exact name (no prefix).

Defaults to: true

Available since: 5.0.0

Ext.Base
view source

## $configStrict : Boolean
private pri

The value `true` instructs the initConfig method to only honor values for properties declared in the `config` block of a class. When `false`, properties that are not declared in a `config` block will be placed on the instance.

Defaults to: true

Available since: 5.0.0

Ext.mixin.Observable
view source

## $eventOptions
private pri

Matches options property names within a listeners specification object - property names which are never used as event names.

Defaults to: { scope: 1, delay: 1, buffer: 1, onFrame: 1, single: 1, args: 1, destroyable: 1, priority: 1, order: 1 }

Ext.mixin.Observable
view source

## $vetoClearingPrototypeOnDestroy

our destroyObservable handler must be called the very last. It will take care of the prototype after completing Observable destruction sequence.

Defaults to: true

Ext.Base
view source

## callOverridden
deprecated dep protected pro

Call the original method that was previously overridden with Ext.Base#override

Sample Code

    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"

Defaults to: BasePrototype.callParent

### 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

Deprecated: Use
{@link #callParent} instead.

Ext.Base
view source

## clearPropertiesOnDestroy : Boolean / "async"
protected pro

Setting this property to `false` will prevent nulling object references on a Class instance after destruction. Setting this to `"async"` will delay the clearing for approx 50ms.

Defaults to: true

Available since: 6.2.0

Ext.Base
view source

## clearPrototypeOnDestroy : Boolean
private pri

Setting this property to `true` will result in setting the object's prototype to `null` after the destruction sequence is fully completed. After that, most attempts at calling methods on the object instance will result in "method not defined" exception. This can be very helpful with tracking down otherwise hard to find bugs like runaway Ajax requests, timed functions not cleared on destruction, etc.

Note that this option can only work in browsers that support `Object.setPrototypeOf` method, and is only available in debugging mode.

Defaults to: false

Available since: 6.2.0

Ext.mixin.Bindable
view source

## defaultBindProperty : String
protected pro

This property is used to determine the property of a bind config that is just the value. For example, if `defaultBindProperty="value"`, then this shorthand bind config:

Sample Code

     bind: '{name}'

Is equivalent to this object form:

Sample Code

     bind: {
         value: '{name}'
     }

The defaultBindProperty is set to "value" for form fields and to "store" for grids and trees.

Defaults to: null

Ext.chart.series.Line
view source

## defaultSmoothness
private pri

Default numeric smoothing value to be used when smooth = true`.

Defaults to: 3

Ext.Base
view source

## destroyed : Boolean
protected pro

This property is set to `true` after the destroy method is called.

Defaults to: false

Ext.mixin.Observable
view source

## eventsSuspended
private pri

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

Defaults to: 0

Ext.chart.series.Cartesian
view source

## fieldCategoryX
private pri

Tells which store record fields should be used for a specific axis direction. E.g. for

Sample Code

    fieldCategory<direction>: ['<fieldConfig1>', '<fieldConfig2>', ...]

the field names from the following configs will be used:

Sample Code

    series.<fieldConfig1>Field, series.<fieldConfig2>Field, ...

Defaults to: [ 'X' ]

Ext.mixin.Observable
view source

## 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 (via observe) 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:

Sample Code

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

Ext.Base
view source

## isConfiguring : Boolean
readonly ro protected pro

This property is set to `true` during the call to initConfig.

Defaults to: false

Available since: 5.0.0

Ext.Base
view source

## isFirstInstance : Boolean
readonly ro protected pro

This property is set to `true` if this instance is the first of its class.

Defaults to: false

Available since: 5.0.0

Ext.Base
view source

## isInstance : Boolean
readonly ro protected pro

This value is `true` and is used to identify plain objects from instances of a defined class.

Defaults to: true

Ext.mixin.Observable
view source

## isObservable : Boolean

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

Defaults to: true

Ext.chart.series.Series
view source

## isStoreDependantColorCount
private pri

Series, where the number of sprites (an so unique colors they require) depends on the number of records in the store should set this to 'true'.

Defaults to: false

Ext.chart.series.Line
view source

## overflowBuffer
private pri

Size of the buffer area on either side of the viewport to provide seamless zoom/pan transforms. Expressed as a multiple of the viewport length, e.g. 1 will make the buffer on each side equal to the length of the visible axis viewport.

Defaults to: 1

Ext.Base
view source

## self : Ext.Class
protected pro

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

Sample Code

    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'

Defaults to: Base

Ext.chart.series.Series
view source

## seriesType : String

Default series sprite type.

Defaults to: 'sprite'

Ext.chart.series.Series
view source

## type : String
protected pro

The type of series. Set in subclasses.

Defaults to: null

Ext.mixin.Bindable
view source

## validRefRe : RegExp
private pri

Regular expression used for validating reference values.

Defaults to: /^[a-z_][a-z0-9_]*$/i

Ext.Base
view source

## $onExtended
static sta private pri

Defaults to: []

## methods

Ext.mixin.Observable
view source

## _addDeclaredListeners ( listeners ) : Boolean
private pri

Adds declarative listeners as nested arrays of listener objects.

### Parameters

listeners : Array

### Returns

:Boolean

`true` if any listeners were added

Ext.mixin.Observable
view source

## addAfterListener

Alias for onAfter.

Ext.mixin.Observable
view source

## addBeforeListener

Alias for onBefore.

Ext.mixin.Bindable
view source

## addBindableUpdater ( property )
private pri

Ensures that the given property (if it is a Config System config) has a proper "updater" method on this instance to sync changes to the config.

Available since: 5.0.0

### Parameters

property : String

The name of the config property.

Ext.Base
view source

## addDeprecations ( deprecations )
private pri

This method applies a versioned, deprecation declaration to this class. This is typically called by the `deprecated` config.

### Parameters

deprecations : Object

Ext.mixin.Observable
view source

## addListener ( eventName , [fn] , [scope] , [options] , [order] ) : Object
chainable ch

The on method is shorthand for addListener.

Appends an event handler to this object. For example:

Sample Code

    myGridPanel.on("itemclick", this.onItemClick, 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:

Sample Code

    myGridPanel.on({
        cellclick: this.onCellClick,
        select: this.onSelect,
        viewready: this.onViewReady,
        scope: this // Important. Ensure "this" is correct during handler execution
    });

One can also specify options for each event handler separately:

Sample Code

    myGridPanel.on({
        cellclick: {fn: this.onCellClick, scope: this, single: true},
        viewready: {fn: panel.onViewReady, scope: panel}
    });

Names of methods in a specified scope may also be used:

Sample Code

    myGridPanel.on({
        cellclick: {fn: 'onCellClick', scope: this, single: true},
        viewready: {fn: 'onViewReady', scope: panel}
    });

### 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 / String (optional)

The method the event invokes or the name of the method within the specified `scope`. Will be called with arguments given to Ext.util.Observable#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< / a> (optional)

An object containing handler configuration.

Note: 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.

onFrame : Number

Causes the handler to be scheduled to run at the next animation frame event. If the event fires again before that time, the handler is not rescheduled - the handler will only be called once when the next animation frame is fired, with the last set of arguments passed.

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 Ext.Component. The name of a Component property which references an Ext.dom.Element to add a listener to.

This option is useful during Component construction to add DOM event listeners to elements of Ext.Component which will exist only after the Component is rendered.

For example, to add a click listener to a Panel's body:

Sample Code

      var panel = new Ext.panel.Panel({
                                  title: 'The title',
                                  listeners: {
                                      click: this.handlePanelClick,
                                      element: 'body'
                                  }
                              });

In order to remove listeners attached using the element, you'll need to reference the element itself as seen below.

Sample Code

     panel.body.un(...)

delegate : String (optional)

A simple selector to filter the event target or look for a descendant of the target.

The "delegate" option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

See the delegate example below.

capture : Boolean (optional)

When set to `true`, the listener is fired in the capture phase of the event propagation sequence, instead of the default bubble phase.

The capture option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

stopPropagation : Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. `true` to call stopPropagation on the event object before firing the handler.

preventDefault : Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. `true` to call preventDefault on the event object before firing the handler.

stopEvent : Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. `true` to call stopEvent on the event object before firing the handler.

args : Array (optional)

Optional arguments to pass to the handler function. Any additional arguments passed to fireEvent will be appended to these arguments.

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. This syntax can be a helpful shortcut to using un; particularly when removing multiple listeners. NOTE - not compatible when using the element option. See un for the proper syntax for removing listeners added using the element config.

Defaults to: false

priority : Number (optional)

An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handlers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code. A priority must be an integer to be valid. Fractional values are reserved for internal framework use.

order : String (optional)

A legacy option that is provided for backward compatibility. It is recommended to use the `priority` option instead. Available options are:

- `'before'`: equal to a priority of `100`
- `'current'`: equal to a priority of `0` or default priority
- `'after'`: equal to a priority of `-100`

Defaults to: 'current'

order : String (optional)

A shortcut for the `order` event option. Provided for backward compatibility. Please use the `priority` event option instead.

Combining Options

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

A delayed, one-time listener.

Sample Code

    myPanel.on('hide', this.handleClick, 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 handlers and handler configs.

Sample Code

    grid.on({
        itemclick: 'onItemClick',
        itemcontextmenu: grid.onItemContextmenu,
        destroy: {
            fn: function () {
                // function called within the 'altCmp' scope instead of grid
            },
            scope: altCmp // unique scope for the destroy handler
        },
        scope: grid       // default scope - provided for example clarity
    });

Delegate

This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example:

Sample Code

    var panel = Ext.create({
        xtype: 'panel',
        renderTo: document.body,
        title: 'Delegate Handler Example',
        frame: true,
        height: 220,
        width: 220,
        html: '<h1 class="myTitle">BODY TITLE</h1>Body content'
    });

    // The click handler will only be called when the click occurs on the
    // delegate: h1.myTitle ("h1" tag with class "myTitle")
    panel.on({
        click: function (e) {
            console.log(e.getTarget().innerHTML);
        },
        element: 'body',
        delegate: 'h1.myTitle'
     });

Defaults to: 'current'

### 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:

Sample Code

    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:

Sample Code

    Ext.destroy(this.btnListeners);

or

Sample Code

    this.btnListeners.destroy();

Ext.mixin.Observable
view source

## addManagedListener ( item , ename , [fn] , [scope] , [options] ) : Object

The addManagedListener method is used when some object (call it "A") is listening to an event on another observable object ("B") and you want to remove that listener from "B" when "A" is destroyed. This is not an issue when "B" is destroyed because all of its listeners will be removed at that time.

Example:

Sample Code

    Ext.define('Foo', {
        extend: 'Ext.Component',

        initComponent: function () {
            this.addManagedListener(MyApp.SomeGlobalSharedMenu, 'show', this.doSomething);
            this.callParent();
        }
    });

As you can see, when an instance of Foo is destroyed, it ensures that the 'show' listener on the menu (`MyApp.SomeGlobalSharedMenu`) is also removed.

As of version 5.1 it is no longer necessary to use this method in most cases because listeners are automatically managed if the scope object provided to addListener is an Observable instance. However, if the observable instance and scope are not the same object you still need to use mon or addManagedListener if you want the listener to be managed.

### Parameters

item : Ext.util.Observable / Ext.dom.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 / String (optional)

If the `ename` parameter was an event name, this is the handler function or the name of a method on the specified `scope`.

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:

Sample Code

    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:

Sample Code

    Ext.destroy(this.btnListeners);

or

Sample Code

    this.btnListeners.destroy();

Ext.mixin.Bindable
view source

## applyBind ( binds , currentBindings ) : Object
private pri

Available since: 5.0.0

### Parameters

binds : String / Object

currentBindings : Object

### Returns

:Object
Ext.mixin.Bindable
view source

## applySession ( session ) : Ext.data.Session
private pri

Transforms a Session config to a proper instance.

Available since: 5.0.0

### Parameters

session : Object

### Returns

:Ext.data.Session
Ext.mixin.Bindable
view source

## applyViewModel ( viewModel ) : Ext.app.ViewModel
private pri

Transforms a ViewModel config to a proper instance.

Available since: 5.0.0

### Parameters

viewModel : String / Object / Ext.app.ViewModel

### Returns

:Ext.app.ViewModel
Ext.Base
view source

## callParent ( args ) : Object
protected pro

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

Sample Code

     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:

Sample Code

     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 and private methods.

Sample Code

     Ext.define('My.Derived2', {
         extend: 'My.Base',

         // privates: {
         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.

Sample Code

     Ext.define('My.Derived2Override', {
         override: 'My.Derived2',

         // privates: {
         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.

### 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

Ext.Base
view source

## callSuper ( args ) : Object
protected pro

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:

Sample Code

     Ext.define('Ext.some.Class', {
         method: function () {
             console.log('Good');
         }
     });

     Ext.define('Ext.some.DerivedClass', {
         extend: 'Ext.some.Class',

         method: function () {
             console.log('Bad');

             // ... logic but with a bug ...

             this.callParent();
         }
     });

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

Sample Code

     Ext.define('App.patches.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".

### 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

Ext.mixin.Observable
view source

## clearListeners

Removes all listeners for this object including the managed listeners

Ext.mixin.Observable
view source

## clearManagedListeners

Removes all managed listeners for this object.

Ext.chart.series.Cartesian
view source

## constructor

Ext.chart.series.Series
view source

## coordinateData ( items , field , axis ) : Array
private pri

This method will return an array containing data coordinated by a specific axis.

### Parameters

items : Array

Store records.

field : String

The field to fetch from each record.

axis : Ext.chart.axis.Axis

The axis used to lay out the data.

### Returns

:Array
Ext.mixin.Observable
view source

## createRelayer ( newName , [beginEnd] ) : Function
private pri

Creates an event handling function which re-fires the event from this object as the passed event name.

### Parameters

newName : String

The name under which to re-fire the passed parameters.

beginEnd : Array (optional)

The caller can specify on which indices to slice.

### Returns

:Function
Ext.Base
view source

## destroy

This method is called to cleanup an object and its resources. After calling this method, the object should not be used any further in any way, including access to its methods and properties.

To prevent potential memory leaks, all object references will be nulled at the end of destruction sequence, unless clearPropertiesOnDestroy is set to `false`.

Ext.mixin.Observable
view source

## doFireEvent ( eventName , args , bubbles )
private pri

Continue to fire event.

### Parameters

eventName : String

args : Array

bubbles : Boolean

Ext.mixin.Observable
view source

## enableBubble ( eventNames )

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:

Sample Code

    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');
            }
        }
    });

### Parameters

eventNames : String / String[]

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

Ext.chart.series.Series
view source

## findMatchingAxis ( directionAxes , directionFields )
private pri

Given the list of axes in a certain direction and a list of series fields in that direction returns the first matching axis for the series in that direction, or undefined if a match wasn't found.

### Parameters

directionAxes : Object

directionFields : Object

Ext.mixin.Observable
view source

## fireAction ( eventName , args , fn , [scope] , [options] , [order] )
deprecated dep

Fires the specified event with the passed parameters and executes a function (action). By default, the action function will be executed after any "before" event handlers (as specified using the `order` option of addListener), but before any other handlers are fired. This gives the "before" handlers an opportunity to cancel the event by returning `false`, and prevent the action function from being called.

The action can also be configured to run after normal handlers, but before any "after" handlers (as specified using the `order` event option) by passing `'after'` as the `order` parameter. This configuration gives any event handlers except for "after" handlers the opportunity to cancel the event and prevent the action function from being called.

### Parameters

eventName : String

The name of the event to fire.

args : Array

Arguments to pass to handlers and to the action function.

fn : Function

The action function.

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)

Event options for the action function. Accepts any of the options of addListener

order : String (optional)

The order to call the action function relative too the event handlers (`'before'` or `'after'`). Note that this option is simply used to sort the action function relative to the event handlers by "priority". An order of `'before'` is equivalent to a priority of `99.5`, while an order of `'after'` is equivalent to a priority of `-99.5`. See the `priority` option of addListener for more details.

Defaults to: 'before'

Deprecated: 5.5
Use {@link #method!fireEventedAction #fireEventedAction} instead.

Ext.mixin.Observable
view source

## fireEvent ( eventName , args ) : Boolean

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.

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

Ext.mixin.Observable
view source

## 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

eventName : String

The name of the event to fire.

args : Object[]

An array of parameters which are passed to handlers.

### Returns

:Boolean

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

Ext.mixin.Observable
view source

## fireEventedAction ( eventName , args , fn , [scope] , [fnArgs] )

Fires the specified event with the passed parameters and executes a function (action). Evented Actions will automatically dispatch a 'before' event passing. This event will be given a special controller that allows for pausing/resuming of the event flow.

By pausing the controller the updater and events will not run until resumed. Pausing, however, will not stop the processing of any other before events.

### Parameters

eventName : String

The name of the event to fire.

args : Array

Arguments to pass to handlers and to the action function.

fn : Function / String

The action function.

scope : Object (optional)

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

fnArgs : Array / Boolean (optional)

Optional arguments for the action `fn`. If not given, the normal `args` will be used to call `fn`. If `false` is passed, the `args` are used but if the first argument is this instance it will be removed from the args passed to the action function.

Ext.mixin.Observable
view source

## getBubbleParent : Ext.util.Observable
private pri

Gets the bubbling parent for an Observable

### Returns

:Ext.util.Observable

The bubble parent. null is returned if no bubble target exists

Ext.Base
view source

## 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

name : String (optional)

The name of the config property to get.

peek : Boolean (optional)

`true` to peek at the raw value without calling the getter.

Defaults to: false

### Returns

:Object

The config property value.

## getController

see: controller
Ext.Base
view source

## getCurrentConfig
private pri

Ext.chart.series.Line
view source

## getDefaultSpriteConfig
private pri

Override Ext.chart.series.Series#getDefaultSpriteConfig

Ext.mixin.Identifiable
view source

## getId : String

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

### Returns

:String

id

Ext.Base
view source

## getInitialConfig ( [name] ) : Object / Mixed

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

Given this example Ext.button.Button definition and instance:

Sample Code

    Ext.define('MyApp.view.Button', {
        extend: 'Ext.button.Button',
        xtype: 'mybutton',

        scale: 'large',
        enableToggle: true
    });

    var btn = Ext.create({
        xtype: 'mybutton',
        renderTo: Ext.getBody(),
        text: 'Test Button'
    });

Calling `btn.getInitialConfig()` would return an object including the config options passed to the create method:

Sample Code

    xtype: 'mybutton',
    renderTo: // The document body itself
    text: 'Test Button'

Calling `btn.getInitialConfig('text')`returns 'Test Button'.

### 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.chart.series.Series
view source

## getItemByIndex ( index , [category] ) : Object

Returns a series item by index and (optional) category.

### Parameters

index : Number

The index of the item (matches store record index).

category : String (optional)

The category of item, e.g.: 'items', 'markers', 'sprites'.

### Returns

:Object

item

Ext.chart.series.Series
view source

## getItemForPoint ( x , y , [target] ) : Object< / a>

For a given x/y point relative to the main rect, find a corresponding item from this series, if any.

### Parameters

x : Number

y : Number

target : Object (optional)

optional target to receive the result

### Returns

:Object< / a>

An object describing the item, or null if there is no matching item. The exact contents of this object will vary by series type, but should always contain at least the following:

record : Ext.data.Model

the record of the item.

point : Array

the x/y coordinates relative to the chart box of a single point for this data item, which can be used as e.g. a tooltip anchor point.

sprite : Ext.draw.sprite.Sprite

the item's rendering Sprite.

subSprite : Number

the index if sprite is an instancing sprite.

Ext.chart.series.Series
view source

## getSprites

Returns sprites the are used to draw this series.

Ext.Base
view source

## hasConfig ( config )
private pri

### Parameters

config : Object

Ext.mixin.Observable
view source

## hasListener ( eventName ) : Boolean

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.

### 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.mixin.Bindable
view source

## initBindable
private pri

This method triggers the lazy configs and must be called when it is time to fully boot up. The configs that must be initialized are: bind, publishes, session, twoWayBindable and viewModel.

Available since: 5.0.0

Ext.Base
view source

## initConfig ( config ) : Ext.Base
chainable ch protected pro

Initialize configuration for this class. a typical example:

Sample Code

    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'

### Parameters

config : Object

### Returns

:Ext.Base

this

Ext.mixin.Bindable
view source

## initInheritedState ( inheritedState )
protected pro

Called by `getInherited` to initialize the inheritedState the first time it is requested.

### Parameters

inheritedState : Object

Ext.mixin.Observable
view source

## isSuspended ( [event] ) : Boolean

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

### Parameters

event : String (optional)

The name of the specific event to check

### Returns

:Boolean

`true` if events are suspended

Ext.mixin.Bindable
view source

## isSyncing ( name ) : Boolean
private pri

Checks if a particular binding is synchronizing the value.

### Parameters

name : String

The name of the property being bound to.

### Returns

:Boolean

`true` if the binding is syncing.

Ext.Base
view source

## link ( name , value ) : Object
private pri

Adds a "destroyable" object to an internal list of objects that will be destroyed when this instance is destroyed (via destroy).

### Parameters

name : String

value : Object

### Returns

:Object

The `value` passed.

Ext.mixin.Bindable
view source

## 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

skipThis : Boolean (optional)

`true` to not consider the controller directly attached to this view (if it exists).

Defaults to: false

### Returns

:Ext.app.ViewController

The controller. `null` if no controller is found.

Ext.mixin.Bindable
view source

## 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

skipThis : Boolean (optional)

Pass `true` to ignore a session configured on this instance and only consider an inherited session.

Defaults to: false

### Returns

:Ext.data.Session
Ext.mixin.Bindable
view source

## 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

skipThis : Boolean (optional)

Pass `true` to ignore a viewModel configured on this instance and only consider an inherited view model.

Defaults to: false

### Returns

:Ext.app.ViewModel
Ext.mixin.Bindable
view source

## makeBindableUpdater ( cfg ) : Function
private pri

Returns an `update` method for the given Config that will call publishState to ensure two-way bindings (via bind) as well as any publishes are updated. This method is cached on the `cfg` instance for re-use.

Available since: 5.0.0

### Parameters

cfg : Ext.Config

### Returns

:Function

The updater function.

Ext.mixin.Observable
view source

## mon ( item , ename , [fn] , [scope] , [options] ) : Object

Shorthand for addManagedListener. The addManagedListener method is used when some object (call it "A") is listening to an event on another observable object ("B") and you want to remove that listener from "B" when "A" is destroyed. This is not an issue when "B" is destroyed because all of its listeners will be removed at that time.

Example:

Sample Code

    Ext.define('Foo', {
        extend: 'Ext.Component',

        initComponent: function () {
            this.addManagedListener(MyApp.SomeGlobalSharedMenu, 'show', this.doSomething);
            this.callParent();
        }
    });

As you can see, when an instance of Foo is destroyed, it ensures that the 'show' listener on the menu (`MyApp.SomeGlobalSharedMenu`) is also removed.

As of version 5.1 it is no longer necessary to use this method in most cases because listeners are automatically managed if the scope object provided to addListener is an Observable instance. However, if the observable instance and scope are not the same object you still need to use mon or addManagedListener if you want the listener to be managed.

### Parameters

item : Ext.util.Observable / Ext.dom.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 / String (optional)

If the `ename` parameter was an event name, this is the handler function or the name of a method on the specified `scope`.

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:

Sample Code

    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:

Sample Code

    Ext.destroy(this.btnListeners);

or

Sample Code

    this.btnListeners.destroy();

Ext.mixin.Observable
view source

## mun ( item , ename , [fn] , [scope] )

Shorthand for removeManagedListener. Removes listeners that were added by the mon method.

### Parameters

item : Ext.util.Observable / Ext.dom.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.

Ext.mixin.Observable
view source

## on ( eventName , [fn] , [scope] , [options] , [order] ) : Object

The on method is shorthand for addListener.

Appends an event handler to this object. For example:

Sample Code

    myGridPanel.on("itemclick", this.onItemClick, 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:

Sample Code

    myGridPanel.on({
        cellclick: this.onCellClick,
        select: this.onSelect,
        viewready: this.onViewReady,
        scope: this // Important. Ensure "this" is correct during handler execution
    });

One can also specify options for each event handler separately:

Sample Code

    myGridPanel.on({
        cellclick: {fn: this.onCellClick, scope: this, single: true},
        viewready: {fn: panel.onViewReady, scope: panel}
    });

Names of methods in a specified scope may also be used:

Sample Code

    myGridPanel.on({
        cellclick: {fn: 'onCellClick', scope: this, single: true},
        viewready: {fn: 'onViewReady', scope: panel}
    });

### 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 / String (optional)

The method the event invokes or the name of the method within the specified `scope`. Will be called with arguments given to Ext.util.Observable#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< / a> (optional)

An object containing handler configuration.

Note: 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.

onFrame : Number

Causes the handler to be scheduled to run at the next animation frame event. If the event fires again before that time, the handler is not rescheduled - the handler will only be called once when the next animation frame is fired, with the last set of arguments passed.

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 Ext.Component. The name of a Component property which references an Ext.dom.Element to add a listener to.

This option is useful during Component construction to add DOM event listeners to elements of Ext.Component which will exist only after the Component is rendered.

For example, to add a click listener to a Panel's body:

Sample Code

      var panel = new Ext.panel.Panel({
                                  title: 'The title',
                                  listeners: {
                                      click: this.handlePanelClick,
                                      element: 'body'
                                  }
                              });

In order to remove listeners attached using the element, you'll need to reference the element itself as seen below.

Sample Code

     panel.body.un(...)

delegate : String (optional)

A simple selector to filter the event target or look for a descendant of the target.

The "delegate" option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

See the delegate example below.

capture : Boolean (optional)

When set to `true`, the listener is fired in the capture phase of the event propagation sequence, instead of the default bubble phase.

The capture option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

stopPropagation : Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. `true` to call stopPropagation on the event object before firing the handler.

preventDefault : Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. `true` to call preventDefault on the event object before firing the handler.

stopEvent : Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. `true` to call stopEvent on the event object before firing the handler.

args : Array (optional)

Optional arguments to pass to the handler function. Any additional arguments passed to fireEvent will be appended to these arguments.

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. This syntax can be a helpful shortcut to using un; particularly when removing multiple listeners. NOTE - not compatible when using the element option. See un for the proper syntax for removing listeners added using the element config.

Defaults to: false

priority : Number (optional)

An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handlers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code. A priority must be an integer to be valid. Fractional values are reserved for internal framework use.

order : String (optional)

A legacy option that is provided for backward compatibility. It is recommended to use the `priority` option instead. Available options are:

- `'before'`: equal to a priority of `100`
- `'current'`: equal to a priority of `0` or default priority
- `'after'`: equal to a priority of `-100`

Defaults to: 'current'

order : String (optional)

A shortcut for the `order` event option. Provided for backward compatibility. Please use the `priority` event option instead.

Combining Options

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

A delayed, one-time listener.

Sample Code

    myPanel.on('hide', this.handleClick, 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 handlers and handler configs.

Sample Code

    grid.on({
        itemclick: 'onItemClick',
        itemcontextmenu: grid.onItemContextmenu,
        destroy: {
            fn: function () {
                // function called within the 'altCmp' scope instead of grid
            },
            scope: altCmp // unique scope for the destroy handler
        },
        scope: grid       // default scope - provided for example clarity
    });

Delegate

This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example:

Sample Code

    var panel = Ext.create({
        xtype: 'panel',
        renderTo: document.body,
        title: 'Delegate Handler Example',
        frame: true,
        height: 220,
        width: 220,
        html: '<h1 class="myTitle">BODY TITLE</h1>Body content'
    });

    // The click handler will only be called when the click occurs on the
    // delegate: h1.myTitle ("h1" tag with class "myTitle")
    panel.on({
        click: function (e) {
            console.log(e.getTarget().innerHTML);
        },
        element: 'body',
        delegate: 'h1.myTitle'
     });

Defaults to: 'current'

### 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:

Sample Code

    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:

Sample Code

    Ext.destroy(this.btnListeners);

or

Sample Code

    this.btnListeners.destroy();

Ext.mixin.Observable
view source

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

Appends an after-event handler.

Same as addListener with `order` set to `'after'`.

### Parameters

eventName : String / String[] / Object

The name of the event to listen for.

fn : Function / String

The method the event invokes.

scope : Object (optional)

The scope for `fn`.

options : Object (optional)

An object containing handler configuration.

Ext.mixin.Observable
view source

## onBefore ( 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

eventName : String / String[] / Object

The name of the event to listen for.

fn : Function / String

The method the event invokes.

scope : Object (optional)

The scope for `fn`.

options : Object (optional)

An object containing handler configuration.

Ext.chart.series.Series
view source

## provideLegendInfo ( target )

Provide legend information to target array.

### Parameters

target : Array< / a>

The information consists:

name : String

mark : String

disabled : Boolean

series : String

index : Number

Ext.mixin.Bindable
view source

## publishState ( [property] , [value] )
protected pro

Publish this components state to the `ViewModel`. If no arguments are given (or if this is the first call), the entire state is published. This state is determined by the publishes property.

This method is called only by component authors.

Available since: 5.0.0

### Parameters

property : String (optional)

The name of the property to update.

value : Object (optional)

The value of `property`. Only needed if `property` is given.

Ext.mixin.Observable
view source

## relayEvents ( origin , events , [prefix] ) : Object

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:

Sample Code

    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 (unless the event is handled by a controller's control/listen event listener in which case 'this' will be the controller rather than the grid).

### Parameters

origin : Object

The Observable whose events this object is to relay.

events : String[] / Object

Array of event names to relay or an Object with key/value pairs translating to ActualEventName/NewEventName respectively. For example: this.relayEvents(this, {add:'push', remove:'pop'});

Would now redispatch the add event of this as a push event and the remove event as a pop event.

prefix : String (optional)

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

Sample Code

    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:

Sample Code

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

Can be undone by calling

Sample Code

    Ext.destroy(this.storeRelayers);

or this.store.relayers.destroy();

Ext.mixin.Observable
view source

## removeAfterListener

Alias for unAfter.

Ext.mixin.Observable
view source

## removeBeforeListener

Alias for unBefore.

Ext.mixin.Observable
view source

## removeListener ( eventName , fn , [scope] )
chainable ch

Removes an event handler.

### 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 Ext.util.Observable#addListener or the listener will not be removed.

Convenience Syntax

You can use the addListener `destroyable: true` config option in place of calling un(). For example:

Sample Code

    var listeners = cmp.on({
        scope: cmp,
        afterrender: cmp.onAfterrender,
        beforehide: cmp.onBeforeHide,
        destroyable: true
    });

    // Remove listeners
    listeners.destroy();
    // or
    cmp.un(
        scope: cmp,
        afterrender: cmp.onAfterrender,
        beforehide: cmp.onBeforeHide
    );

Exception - DOM event handlers using the element config option

You must go directly through the element to detach an event handler attached using the addListener element option.

Sample Code

    panel.on({
        element: 'body',
        click: 'onBodyCLick'
    });

    panel.body.un({
        click: 'onBodyCLick'
    });

Ext.mixin.Observable
view source

## removeManagedListener ( item , ename , [fn] , [scope] )

Removes listeners that were added by the mon method.

### Parameters

item : Ext.util.Observable / Ext.dom.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.

Ext.mixin.Observable
view source

## removeManagedListenerItem ( isClear , managedListener )
private pri

Remove a single managed listener item

### Parameters

isClear : Boolean

True if this is being called during a clear

managedListener : Object

The managed listener item See removeManagedListener for other args

Ext.mixin.Observable
view source

## resolveListenerScope ( [defaultScope] ) : Object
protected pro

Gets the default scope for firing late bound events (string names with no scope attached) at runtime.

### Parameters

defaultScope : Object (optional)

The default scope to return if none is found.

Defaults to: this

### Returns

:Object

The default event scope

Ext.mixin.Observable
view source

## 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

eventName : String...

Multiple event names to resume.

Ext.mixin.Observable
view source

## resumeEvents ( [discardQueue] )

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.

### Parameters

discardQueue : Boolean (optional)

`true` to prevent any previously queued events from firing while we were suspended. See suspendEvents.

Ext.Base
view source

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

Sets a single/multiple configuration options.

### Parameters

name : String / Object

The name of the property to set, or a set of key value pairs to set.

value : Object (optional)

The value to set for the name parameter.

### Returns

:Ext.Base

this

Ext.chart.series.Series
view source

## setHiddenByIndex ( index , value )

### Parameters

index : Number

value : Boolean

## setListeners

see: listeners
Ext.Base
view source

## statics : Ext.Class
protected pro

Get the reference to the class from which this object was instantiated. Note that unlike Ext.Base#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

Sample Code

    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

### Returns

:Ext.Class
Ext.mixin.Observable
view source

## 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

eventName : String...

Multiple event names to suspend.

Ext.mixin.Observable
view source

## suspendEvents ( queueSuspended )

Suspends the firing of all events. (see resumeEvents)

### Parameters

queueSuspended : Boolean

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

Ext.chart.series.Series
view source

## themeColorCount
private pri

Returns the number of colors this series needs. A Pie chart needs one color per slice while a Stacked Bar chart needs one per segment. An OHLC chart needs 2 colors (one for drops, one for rises), and most other charts need just 1 color.

Ext.chart.series.Series
view source

## themeMarkerCount
private pri

Returns the number of markers this series needs. Currently, only the Line, Scatter and Radar series use markers - and they need just one each.

Ext.mixin.Observable
view source

## un ( eventName , fn , [scope] )

Shorthand for removeListener. Removes an event handler.

### 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 Ext.util.Observable#addListener or the listener will not be removed.

Convenience Syntax

You can use the addListener `destroyable: true` config option in place of calling un(). For example:

Sample Code

    var listeners = cmp.on({
        scope: cmp,
        afterrender: cmp.onAfterrender,
        beforehide: cmp.onBeforeHide,
        destroyable: true
    });

    // Remove listeners
    listeners.destroy();
    // or
    cmp.un(
        scope: cmp,
        afterrender: cmp.onAfterrender,
        beforehide: cmp.onBeforeHide
    );

Exception - DOM event handlers using the element config option

You must go directly through the element to detach an event handler attached using the addListener element option.

Sample Code

    panel.on({
        element: 'body',
        click: 'onBodyCLick'
    });

    panel.body.un({
        click: 'onBodyCLick'
    });

Ext.mixin.Observable
view source

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

Removes a before-event handler.

Same as removeListener with `order` set to `'after'`.

### Parameters

eventName : String / String[] / Object

The name of the event the handler was associated with.

fn : Function / String

The handler to remove.

scope : Object (optional)

The scope originally specified for `fn`.

options : Object (optional)

Extra options object.

Ext.mixin.Observable
view source

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

Removes a before-event handler.

Same as removeListener with `order` set to `'before'`.

### Parameters

eventName : String / String[] / Object

The name of the event the handler was associated with.

fn : Function / String

The handler to remove.

scope : Object (optional)

The scope originally specified for `fn`.

options : Object (optional)

Extra options object.

Ext.Base
view source

## unlink ( names ) : Ext.Base
chainable ch private pri

Destroys a given set of linked objects. This is only needed if the linked object is being destroyed before this instance.

### Parameters

names : String[]

The names of the linked objects to destroy.

### Returns

:Ext.Base

this

Ext.chart.series.Series
view source

## updateChartColors ( colors )
private pri

When the chart's "colors" config changes, these colors are passed onto the series where they are used with the same priority as theme colors, i.e. they do not override the series' "colors" config, nor the series' "style" config, but they do override the colors from the theme's "seriesThemes" config.

### Parameters

colors : Object

Ext.chart.series.Series
view source

## updateLegendStore ( hidden , index )
private pri

Updates chart's legend store when the value of the series' hidden config changes or when the setHiddenByIndex method is called.

### Parameters

hidden : Object

Whether series (or its component) should be hidden or not.

index : Object

Used for stacked series. If present, only the component with the specified index will change visibility.

Ext.mixin.Bindable
view source

## updateSession ( session )
private pri

Updates the session config.

### Parameters

session : Ext.data.Session

Ext.mixin.Bindable
view source

## updateViewModel ( viewModel , oldViewModel )
private pri

Updates the viewModel config.

### Parameters

viewModel : Ext.app.ViewModel

oldViewModel : Ext.app.ViewModel

Ext.Base
view source

## addConfig ( config , [mixinClass] )
static sta private pri

Adds new config properties to this class. This is called for classes when they are declared, then for any mixins that class may define and finally for any overrides defined that target the class.

### Parameters

config : Object

mixinClass : Ext.Class (optional)

The mixin class if the configs are from a mixin.

Ext.Base
view source

## addInheritableStatics ( members )
chainable ch static sta private pri

### Parameters

members : Object

Ext.Base
view source

## addMember ( name , member )
chainable ch static sta private pri

### Parameters

name : Object

member : Object

Ext.Base
view source

## addMembers ( members , [isStatic] , [privacy] )
chainable ch static sta

Add methods / properties to the prototype of this class.

Sample Code

    Ext.define('My.awesome.Cat', {
        constructor: function() {
            ...
        }
    });

     My.awesome.Cat.addMembers({
         meow: function() {
            alert('Meowww...');
         }
     });

     var kitty = new My.awesome.Cat();
     kitty.meow();

### Parameters

members : Object

The members to add to this class.

isStatic : Boolean (optional)

Pass `true` if the members are static.

Defaults to: false

privacy : Boolean (optional)

Pass `true` if the members are private. This only has meaning in debug mode and only for methods.

Defaults to: false

Ext.Base
view source

## addStatics ( members ) : Ext.Base
chainable ch static sta

Add / override static properties of this class.

Sample Code

    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() { ... };
    });

### Parameters

members : Object

### Returns

:Ext.Base

this

Ext.Base
view source

## borrow ( fromClass , members ) : Ext.Base
static sta private pri

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

Sample Code

    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 '$$$$$$$'

### Parameters

fromClass : Ext.Base

The class to borrow members from

members : Array / String

The names of the members to borrow

### Returns

:Ext.Base

this

Ext.Base
view source

## callParent ( args )
static sta protected pro

### Parameters

args : Object

Ext.Base
view source

## callSuper ( args )
static sta protected pro

### Parameters

args : Object

Ext.Base
view source

## create : Object
static sta

Create a new instance of this Class.

Sample Code

    Ext.define('My.cool.Class', {
        ...
    });

    My.cool.Class.create({
        someConfig: true
    });

All parameters are passed to the constructor of the class.

### Returns

:Object

the created instance.

Ext.Base
view source

## createAlias ( alias , origin )
static sta

Create aliases for existing prototype methods. Example:

Sample Code

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

### Parameters

alias : String / Object

The new method name, or an object to set multiple aliases. See flexSetter

origin : String / Object

The original method name

Ext.Base
view source

## extend ( config )
static sta private pri

### Parameters

config : Object

Ext.Base
view source

## getConfigurator : Ext.Configurator
static sta private pri

Returns the Ext.Configurator for this class.

### Returns

:Ext.Configurator
Ext.Base
view source

## getName : String
static sta

Get the current class' name in string format.

Sample Code

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

    My.cool.Class.getName(); // 'My.cool.Class'

### Returns

:String

className

Ext.Base
view source

## mixin ( name , mixinClass )
chainable ch static sta private pri

Used internally by the mixins pre-processor

### Parameters

name : Object

mixinClass : Object

Ext.Base
view source

## onExtended ( fn , scope )
static sta private pri

### Parameters

fn : Object

scope : Object

Ext.Base
view source

## override ( members ) : Ext.Base
chainable ch static sta

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

Sample Code

    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"

Direct use of this method should be rare. Use Ext.define instead:

Sample Code

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

### 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.Base

this class

Ext.Base
view source

## triggerExtended
static sta private pri

## events

Ext.chart.series.Series
view source

## chartattached ( chart , series , eOpts )

Fires when the Ext.chart.AbstractChart has been attached to this series.

### Parameters

chart : Ext.chart.AbstractChart

series : Ext.chart.series.Series

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Ext.chart.series.Series
view source

## chartdetached ( chart , series , eOpts )

Fires when the Ext.chart.AbstractChart has been detached from this series.

### Parameters

chart : Ext.chart.AbstractChart

series : Ext.chart.series.Series

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Ext.chart.series.Series
view source

## itemclick ( series , item , event , eOpts )

Fires when a click event occurs on a series item. Note: This event requires the Ext.chart.plugin.ItemEvents plugin be added to the chart.

### Parameters

series : Ext.chart.series.Series

item : Object

event : Event

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Ext.chart.series.Series
view source

## itemdblclick ( series , item , event , eOpts )

Fires when a double click event occurs on a series item. Note: This event requires the Ext.chart.plugin.ItemEvents plugin be added to the chart.

### Parameters

series : Ext.chart.series.Series

item : Object

event : Event

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Ext.chart.series.Series
view source

## itemmousedown ( series , item , event , eOpts )

Fires when a mousedown event occurs on a series item. Note: This event requires the Ext.chart.plugin.ItemEvents plugin be added to the chart.

### Parameters

series : Ext.chart.series.Series

item : Object

event : Event

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Ext.chart.series.Series
view source

## itemmousemove ( series , item , event , eOpts )

Fires when the mouse is moved on a series item. Note: This event requires the Ext.chart.plugin.ItemEvents plugin be added to the chart.

### Parameters

series : Ext.chart.series.Series

item : Object

event : Event

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Ext.chart.series.Series
view source

## itemmouseout ( series , item , event , eOpts )

Fires when the mouse exits a series item. Note: This event requires the Ext.chart.plugin.ItemEvents plugin be added to the chart.

### Parameters

series : Ext.chart.series.Series

item : Object

event : Event

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Ext.chart.series.Series
view source

## itemmouseover ( series , item , event , eOpts )

Fires when the mouse enters a series item. Note: This event requires the Ext.chart.plugin.ItemEvents plugin be added to the chart.

### Parameters

series : Ext.chart.series.Series

item : Object

event : Event

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Ext.chart.series.Series
view source

## itemmouseup ( series , item , event , eOpts )

Fires when a mouseup event occurs on a series item. Note: This event requires the Ext.chart.plugin.ItemEvents plugin be added to the chart.

### Parameters

series : Ext.chart.series.Series

item : Object

event : Event

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Ext.chart.series.Series
view source

## itemtap ( series , item , event , eOpts )

Fires when a tap event occurs on a series item. Note: This event requires the Ext.chart.plugin.ItemEvents plugin be added to the chart.

### Parameters

series : Ext.chart.series.Series

item : Object

event : Event

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Ext.chart.series.Series
view source

## storechange ( series , newStore , oldStore , eOpts )

Fires when the store of the series changes.

### Parameters

series : Ext.chart.series.Series

newStore : Ext.data.Store

oldStore : Ext.data.Store

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

## Ext JS 6.2.0 - Modern Toolkit

## Ext JS

### 6.x

6.2.0 EA (classic) (modern)
6.0.2 (classic) (modern)
6.0.1 (classic) (modern)
6.0.0 (classic) (modern)

### 5.x

5.1.3 5.1.2 5.1.1 5.1.0 5.0.1 5.0.0

### 4.x

4.2.5 4.1.3 4.0.7

### 3.x

3.4.0

## Sencha Test

Sencha Test

## Cmd

Cmd

## GXT

4.x 3.x

## IDE Plugins

IDE Plugins

## Sencha Inspector

Sencha Inspector

## Architect

Architect 3 Architect 4 EA

## Touch

### 2.x

Touch 2.4 Touch 2.3 Touch 2.2 Touch 2.0

## Web Application Manager

Web Application Manager
Current Product / Version
All
Show product details in the history bar