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.data.JsonStore 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.data.JsonStore store: store.json

### Hierarchy

Ext.Base
Ext.data.AbstractStore
Ext.data.ProxyStore
Ext.data.Store
Ext.data.JsonStore

### Inherited Mixins

Ext.Mixin
Ext.data.LocalStore
Ext.mixin.Factoryable
Ext.mixin.Identifiable
Ext.mixin.Observable

### Requires

Ext.data.proxy.Ajax
Ext.data.reader.Json
Ext.data.writer.Json

## Summary

Small helper class to make creating Ext.data.Stores from JSON data easier. A JsonStore will be automatically configured with a Ext.data.reader.Json.

A store configuration would be something like:

Sample Code

    var store = new Ext.data.JsonStore({
        // store configs
        storeId: 'myStore',

        proxy: {
            type: 'ajax',
            url: 'get-images.php',
            reader: {
                type: 'json',
                rootProperty: 'images'
            }
        },

        //alternatively, a Model name can be given (see Ext.data.Store for an example)
        fields: ['name', 'url', {name:'size', type: 'float'}, {name:'lastmod', type:'date'}]
    });

This store is configured to consume a returned object of the form:

Sample Code

    {
        images: [
            {name: 'Image one', url:'/GetImage.php?id=1', size:46.5, lastmod: new Date(2007, 10, 29)},
            {name: 'Image Two', url:'/GetImage.php?id=2', size:43.2, lastmod: new Date(2007, 10, 30)}
        ]
    }

An object literal of this form could also be used as the data config option.

No members found using the current filters

## configs

Ext.data.Store
view source

## associatedEntity : Ext.data.Model
private pri

The owner of this store if the store is used as part of an association.

Defaults to: null

Ext.data.ProxyStore
view source

## asynchronousLoad : Boolean

This defaults to `true` when this store's proxy is asynchronous, such as an Ext.data.proxy.Ajax.

When the proxy is synchronous, such as a Ext.data.proxy.Memory memory proxy, this defaults to `false`.

NOTE: This does not cause synchronous Ajax requests if configured `false` when an Ajax proxy is used. It causes immediate issuing of an Ajax request when load is called rather than issuing the request at the end of the current event handler run.

What this means is that when using an Ajax proxy, calls to load do not fire the request to the remote resource immediately, but schedule a request to be made. This is so that multiple requests are not fired when mutating a store's remote filters and sorters (as happens during state restoration). The request is made only once after all relevant store state is fully set.

Available since: 6.0.1

Ext.data.AbstractStore
view source

## autoDestroy : Boolean

When a Store is used by only one DataView, and should only exist for the lifetime of that view, then configure the autoDestroy flag as `true`. This causes the destruction of the view to trigger the destruction of its Store.

Ext.data.ProxyStore
view source

## autoLoad : Boolean / Object

If data is not specified, and if autoLoad is true or an Object, this store's load method is automatically called after creation. If the value of autoLoad is an Object, this Object will be passed to the store's load method.

It's important to note that Ext.data.TreeStore will load regardless of autoLoad's value if expand is set to true on the root node.

Available since: 2.3.0

Ext.data.AbstractStore
view source

## autoSort : Boolean
private pri

`true` to maintain sorted order when records are added regardless of requested insertion point, or when an item mutation results in a new sort position.

This does not affect a ChainedStore's reaction to mutations of the source Store. If sorters are present when the source Store is mutated, this ChainedStore's sort order will always be maintained.

Defaults to: true

Ext.data.ProxyStore
view source

## autoSync : Boolean

True to automatically sync the Store with its Proxy after every edit to one of its Records. Defaults to false.

Defaults to: false

Ext.data.ProxyStore
view source

## batchUpdateMode : String

Sets the updating behavior based on batch synchronization. 'operation' (the default) will update the Store's internal representation of the data after each operation of the batch has completed, 'complete' will wait until the entire batch has been completed before updating the Store's data. 'complete' is a good choice for local storage proxies, 'operation' is better for remote proxies, where there is a comparatively high latency.

Defaults to: 'operation'

Ext.data.Store
view source

## clearOnPageLoad : Boolean

True to empty the store when loading another page via loadPage, nextPage or previousPage. Setting to false keeps existing records, allowing large data sets to be loaded one page at a time but rendered all together.

Defaults to: true

Ext.data.Store
view source

## clearRemovedOnLoad : Boolean

`true` to clear anything in the removed record collection when the store loads.

Defaults to: true

Ext.data.Store
view source

## data : Object[] / Ext.data.Model[]
bindable bind

Array of Model instances or data objects to load locally. See "Inline data" above for details.

Defaults to: 0

Ext.data.Store
view source

## getData : Ext.util.Collection

Returns the store's records.

Note: If your store has been filtered, getData() will return a filtered collection. Use `getData().getSource() to fetch all unfiltered records.

### Returns

:Ext.util.Collection

An Ext.util.Collection of records (an empty Collection if no records are held by the store).

Ext.data.Store
view source

## setData ( data )

Loads an array of data directly into the Store.

setData() is ideal if your data's format is already in its appropriate format (e.g. it doesn't need to be processed by a reader). If your data's structure requires processing, use a Ext.data.proxy.Memory or loadRawData.

Use loadData, add, or insert if records need to be appended to the current recordset.

### Parameters

data : Ext.data.Model[] / Object[]

Array of data to load. Any non-model instances will be cast into model instances first.

Ext.data.ProxyStore
view source

## fields : Object[] / String[]

An Array of Ext.data.field.Field config objects, simply the field name, or a mix of config objects and strings. If just a name is given, the field type defaults to `auto`.

In a Ext.data.field.Field config object you may pass the alias of the `Ext.data.field.*` type using the `type` config option.

Sample Code

    // two fields are set:
    // - an 'auto' field with a name of 'firstName'
    // - and an Ext.data.field.Integer field with a name of 'age'
    fields: ['firstName', {
        type: 'int',
        name: 'age'
    }]

Fields will automatically be created at read time for any for any keys in the data passed to the Model's proxy's Ext.data.reader.Reader whose name is not explicitly configured in the fields config.

Extending a Model class will inherit all the fields from the superclass / ancestor classes. Note: In general, this configuration option should only be used for simple stores like a two-field store of ComboBox. For anything more complicated, such as specifying a particular id property or associations, a Ext.data.Model should be defined and specified for the model config.

Defaults to: null

Available since: 2.3.0

Ext.data.AbstractStore
view source

## filters : Object[] / Function[]

Array of Ext.util.Filter for this store. Can also be passed array of functions which will be used as the filterFn config for filters:

Sample Code

    filters: [
        function(item) {
            return item.weight > 0;
        }
    ]

To filter after the grid is loaded use the filterBy function.

Defaults to: null

Ext.data.AbstractStore
view source

## getFilters ( autoCreate ) : Ext.util.FilterCollection

Gets the filters for this store.

### Parameters

autoCreate : Object

### Returns

:Ext.util.FilterCollection

The filters

Ext.data.AbstractStore
view source

## groupDir : String

The direction in which sorting should be applied when grouping. Supported values are "ASC" and "DESC".

Defaults to: 'ASC'

Ext.data.AbstractStore
view source

## grouper : Object / Ext.util.Grouper

The grouper by which to group the data store. May also be specified by the groupField config, however they should not be used together.

Defaults to: null

Ext.data.AbstractStore
view source

## groupField : String

The field by which to group data in the store. Internally, grouping is very similar to sorting - the groupField and groupDir are injected as the first sorter (see sort). Stores support a single level of grouping, and groups can be fetched via the getGroups method.

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.data.ProxyStore
view source

## model : String / Ext.data.Model

Name of the Ext.data.Model associated with this store. See Ext.data.Model#entityName.

May also be the actual Model subclass.

This config is required for the store to be able to read data unless you have defined the fields config which will create an anonymous Ext.data.Model.

Ext.data.AbstractStore
view source

## pageSize : Number

The number of records considered to form a 'page'. This is used to power the built-in paging using the nextPage and previousPage functions when the grid is paged using a PagingToolbar Defaults to 25.

To disable paging, set the pageSize to `0`.

Defaults to: 25

Ext.data.ProxyStore
view source

## proxy : String / Ext.data.proxy.Proxy / Object

The Proxy to use for this Store. This can be either a string, a config object or a Proxy instance - see setProxy for details.

Available since: 1.1.0

Ext.data.AbstractStore
view source

## remoteFilter : Boolean

`true` to defer any filtering operation to the server. If `false`, filtering is done locally on the client.

Defaults to: false

Ext.data.AbstractStore
view source

## remoteSort : Boolean

`true` if the sorting should be performed on the server side, false if it is local only.

Defaults to: false

Ext.data.Store
view source

## role : Ext.data.schema.Role
private pri

The role for the associatedEntity.

Defaults to: null

Ext.data.Store
view source

## session : Ext.data.Session

The session for this store. By specifying a session, it ensures any records that are added to this store are also included in the session. This store does not become a member of the session itself.

Defaults to: null

Available since: 5.0.0

Ext.data.AbstractStore
view source

## sorters : Ext.util.Sorter[] / Object[]

The initial set of Ext.util.Sorter

Defaults to: null

Ext.data.AbstractStore
view source

## getSorters ( autoCreate ) : Ext.util.SorterCollection

Gets the sorters for this store.

### Parameters

autoCreate : Object

### Returns

:Ext.util.SorterCollection

The sorters

Ext.data.ProxyStore
view source

## sortOnLoad : Boolean

If true, any sorters attached to this Store will be run after loading data, before the datachanged event is fired. Defaults to true, ignored if remoteSort is true

Defaults to: true

Ext.data.AbstractStore
view source

## statefulFilters : Boolean

Configure as `true` to have the filters saved when a client grid saves its state.

Defaults to: false

Ext.data.AbstractStore
view source

## storeId : String

Unique identifier for this store. If present, this Store will be registered with the Ext.data.StoreManager, making it easy to reuse elsewhere.

Note that when a store is instantiated by a Controller, the storeId will default to the name of the store if not specified in the class.

Defaults to: null

Ext.data.ProxyStore
view source

## trackRemoved : Boolean

This config controls whether removed records are remembered by this store for later saving to the server.

Defaults to: true

## 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.data.Store
view source

## addRecordsOptions
private pri

Used as a parameter to loadRecords

Defaults to: { addRecords: true }

Ext.data.ProxyStore
view source

## autoSyncSuspended : Number
private pri

A counter to track suspensions.

Defaults to: 0

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.data.Store
view source

## complete : Boolean
private pri

`true` once the store has loaded data from the server.

Defaults to: false

Ext.data.AbstractStore
view source

## currentPage : Number

The page that the Store has most recently loaded (see loadPage)

Defaults to: 1

Ext.data.Store
view source

## data : Ext.util.Collection
readonly ro private pri

The `data` property is a `Collection` which holds this store's local cache of records.

Ext.Base
view source

## destroyed : Boolean
protected pro

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

Defaults to: false

Ext.data.AbstractStore
view source

## doDestroy

Perform the Store destroying sequence. Override this method to add destruction behaviors to your custom Stores.

Defaults to: Ext.emptyFn

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

## factoryConfig : Object

If this property is specified by the target class of this mixin its properties are used to configure the created Ext.Factory.

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.data.ProxyStore
view source

## implicitModel : Boolean
private pri

The class name of the model that this store uses if no explicit model is given

Defaults to: 'Ext.data.Model'

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.data.AbstractStore
view source

## isStore : Boolean

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

Defaults to: true

Ext.data.ProxyStore
view source

## lastOptions : Object

Property to hold the last options from a load method call. This object is used for the reload to reuse the same options. Please see reload for a simple example on how to use the lastOptions property.

Ext.data.Store
view source

## loadCount : Number
readonly ro

The number of times records have been loaded into the store. This includes loads via loadData & loadRecords.

Defaults to: 0

Ext.data.AbstractStore
view source

## loading : Boolean
private pri

`true` if the Store is currently loading via its Proxy.

Defaults to: false

Ext.data.ProxyStore
view source

## removed : Ext.data.Model[]
protected pro

Temporary cache in which removed model instances are kept until successfully synchronised with a Proxy, at which point this is cleared.

This cache is maintained unless you set trackRemoved to `false`.

Defaults to: []

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.data.AbstractStore
view source

## updating : Number
readonly ro

A counter that is increased by beginUpdate and decreased by endUpdate. When this transitions from 0 to 1 the beginupdate event is fired. When it transitions back from 1 to 0 the endupdate event is fired.

Defaults to: 0

Available since: 5.0.0

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.data.Store
view source

## add ( model ) : Ext.data.Model[]

Adds Model instance to the Store. This method accepts either:

- An array of Model instances or Model configuration objects.
- Any number of Model instance or Model configuration object arguments.

The new Model instances will be added at the end of the existing collection.

Sample usage:

Sample Code

    myStore.add({some: 'data'}, {some: 'other data'});

Note that if this Store is sorted, the new Model instances will be inserted at the correct point in the Store to maintain the sort order.

### Parameters

model : Ext.data.Model[] / Ext.data.Model... / Object[] / Object...

An array of Model instances or Model configuration objects, or variable number of Model instance or config arguments.

### Returns

:Ext.data.Model[]

The model instances that were added

Ext.mixin.Observable
view source

## addAfterListener

Alias for onAfter.

Ext.mixin.Observable
view source

## addBeforeListener

Alias for onBefore.

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.data.AbstractStore
view source

## addFilter ( filters , [suppressEvent] )

Adds a new Filter to this Store's filter set and by default, applies the updated filter set to the Store's unfiltered dataset.

### Parameters

filters : Object[] / Ext.util.Filter[]

The set of filters to add to the current filter set.

suppressEvent : Boolean (optional)

If `true` the filter is cleared silently.

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.data.Store
view source

## addSorted ( record )

(Local sort only) Inserts the passed Record into the Store at the index where it should go based on the current sort information.

### Parameters

record : Ext.data.Model

Ext.data.ProxyStore
view source

## afterCommit ( record )
private pri

A model instance should call this method on the Store it has been joined to.

Available since: 3.4.0

### Parameters

record : Ext.data.Model

The model instance that was edited

Ext.data.ProxyStore
view source

## afterReject ( record )
private pri

A model instance should call this method on the Store it has been joined to..

Available since: 3.4.0

### Parameters

record : Ext.data.Model

The model instance that was edited

Ext.data.Store
view source

## aggregate ( fn , [scope] , [grouped] , field ) : Object

Runs the aggregate function for all the records in the store.

When store is filtered, only items within the filter are aggregated.

### Parameters

fn : Function

The function to execute. The function is called with a single parameter, an array of records for that group.

scope : Object (optional)

The scope to execute the function in. Defaults to the store.

grouped : Boolean (optional)

True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the group average being the value. The grouped parameter is only honored if the store has a groupField.

field : String

The field to get the value from

### Returns

:Object

An object literal with the group names and their appropriate values.

Ext.data.AbstractStore
view source

## applyState ( state )
private pri

Restores state to the passed state

### Parameters

state : Object

Ext.data.Store
view source

## average ( field , [grouped] ) : Object

Gets the average value in the store.

When store is filtered, only items within the filter are aggregated.

### Parameters

field : String

The field in each record

grouped : Boolean (optional)

True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the group average being the value. The grouped parameter is only honored if the store has a groupField.

### Returns

:Object

The average value, if no items exist, 0.

Ext.data.AbstractStore
view source

## beginUpdate

This method may be called to indicate the start of multiple changes to the store.

Automatic synchronization as configured by the autoSync flag is deferred until the endUpdate method is called, so multiple mutations can be coalesced into one synchronization operation.

Internally this method increments a counter that is decremented by endUpdate. It is important, therefore, that if you call beginUpdate directly you match that call with a call to endUpdate or you will prevent the collection from updating properly.

For example:

Sample Code

     var store = Ext.StoreManager.lookup({
         //...
         autoSync: true
     });

     store.beginUpdate();

     record.set('fieldName', 'newValue');

     store.add(item);
     // ...

     store.insert(index, otherItem);
     //...

     // Interested parties will listen for the endupdate event
     store.endUpdate();

Available since: 5.0.0

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.data.Store
view source

## clearData ( isLoad )
private pri

### Parameters

isLoad : Object

Ext.data.AbstractStore
view source

## clearFilter ( [suppressEvent] )

Reverts to a view of the Record cache with no filtering applied.

### Parameters

suppressEvent : Boolean (optional)

If `true` the filter is cleared silently.

For a locally filtered Store, this means that the filter collection is cleared without firing the datachanged event.

For a remotely filtered Store, this means that the filter collection is cleared, but the store is not reloaded from the server.

Ext.data.AbstractStore
view source

## clearGrouping

Clear the store grouping

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.data.Store
view source

## collect ( property , [includeOptions] ) : Object[]

Collects unique values for a particular dataIndex from this store.

Note that the `filtered` option can also be passed as a separate parameter for compatibility with previous versions.

Sample Code

    var store = Ext.create('Ext.data.Store', {
        fields: ['name'],
        data: [{
            name: 'Larry'
        }, {
            name: 'Darryl'
        }, {
            name: 'Darryl'
        }]
    });

    store.collect('name');
    // returns ["Larry", "Darryl"]

### Parameters

property : String

The property to collect

includeOptions : Object< / a> (optional)

An object which contains options which modify how the store is traversed.

allowNull : Boolean (optional)

Pass true to allow null, undefined or empty string values.

filtered : Boolean (optional)

Pass `true` to collect from all records, even ones which are filtered.

### Returns

:Object[]

An array of the unique values

Ext.data.Store
view source

## commitChanges

Commits all Records with outstanding changes. To handle updates for changes, subscribe to the Store's update event, and perform updating when the third parameter is Ext.data.Record.COMMIT.

Ext.data.Store
view source

## constructor ( [config] )

Creates the store.

### Parameters

config : Object (optional)

Config object.

Ext.data.AbstractStore
view source

## contains ( record ) : Boolean

Checks if a record is in the current active data set.

### Parameters

record : Ext.data.Model

The record

### Returns

:Boolean

`true` if the record is in the current active data set.

Ext.data.Store
view source

## count ( [grouped] ) : Number

Gets the count of items in the store.

When store is filtered, only items within the filter are counted.

### Parameters

grouped : Boolean (optional)

True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the count for each group being the value. The grouped parameter is only honored if the store has a groupField.

### Returns

:Number

the count

Ext.data.LocalStore
view source

## createModel ( record ) : Ext.data.Model
private pri

Converts a literal to a model, if it's not a model already

### Parameters

record : Ext.data.Model / Object

The record to create

### Returns

:Ext.data.Model
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.data.ProxyStore
view source

## doDestroy
private pri

Ext.mixin.Observable
view source

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

Continue to fire event.

### Parameters

eventName : String

args : Array

bubbles : Boolean

Ext.data.Store
view source

## each ( fn , [scope] , [includeOptions] )

Calls the specified function for each Ext.data.Model in the store.

When store is filtered, only loops over the filtered records.

### Parameters

fn : Function

The function to call. The Ext.data.Model is passed as the first parameter. Returning `false` aborts and exits the iteration.

scope : Object (optional)

The scope (`this` reference) in which the function is executed. Defaults to the current Ext.data.Model in the iteration.

includeOptions : Object< / a> (optional)

An object which contains options which modify how the store is traversed.

filtered : Boolean (optional)

Pass `true` to include filtered out nodes in the iteration.

Note that the `filtered` option can also be passed as a separate parameter for compatibility with previous versions.

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.data.AbstractStore
view source

## endUpdate

This method is called after modifications are complete on a store. For details see beginUpdate.

Available since: 5.0.0

Ext.data.Store
view source

## fetch ( [options] )
private pri

Similar to a load, however no records are added to the store. This is useful in allowing the developer to decide what to do with the new records.

### Parameters

options : Object (optional)

See load options.

Ext.data.AbstractStore
view source

## filter ( [filters] , [value] )

Filters the data in the Store by one or more fields. Example usage:

Sample Code

    //filter with a single field
    myStore.filter('firstName', 'Don');

    //filtering with multiple filters
    myStore.filter([
        {
            property : 'firstName',
            value    : 'Don'
        },
        {
            property : 'lastName',
            value    : 'Griffin'
        }
    ]);

Internally, Store converts the passed arguments into an array of Ext.util.Filter instances, and delegates the actual filtering to its internal Ext.util.MixedCollection.

### Parameters

filters : String / Ext.util.Filter[] (optional)

Either a string name of one of the fields in this Store's configured Ext.data.Model, or an array of filter configurations.

value : String (optional)

The property value by which to filter. Only applicable if filters is a string.

Ext.data.AbstractStore
view source

## filterBy ( fn , [scope] )

Filters by a function. The specified function will be called for each Record in this Store. If the function returns `true` the Record is included, otherwise it is filtered out.

When store is filtered, most of the methods for accessing store data will be working only within the set of filtered records. The notable exception is getById.

### Parameters

fn : Function< / a>

The function to be called. It will be passed the following parameters:

record : Ext.data.Model

The record to test for filtering. Access field values using Ext.data.Model#get.

scope : Object (optional)

The scope (this reference) in which the function is executed. Defaults to this Store.

Ext.data.ProxyStore
view source

## filterNew ( item )
private pri

Filter function for new records.

### Parameters

item : Object

Ext.data.ProxyStore
view source

## filterUpdated ( item )
private pri

Filter function for updated records.

### Parameters

item : Object

Ext.data.AbstractStore
view source

## find ( property , value , [startIndex] , [anyMatch] , [caseSensitive] , [exactMatch] ) : Number

Finds the index of the first matching Record in this store by a specific field value.

When store is filtered, finds records only within filter.

**IMPORTANT

If this store is Ext.data.BufferedStore, this can ONLY find records which happen to be cached in the page cache. This will be parts of the dataset around the currently visible zone, or recently visited zones if the pages have not yet been purged from the cache.**

### Parameters

property : String

The name of the Record field to test.

value : String / RegExp

Either a string that the field value should begin with, or a RegExp to test against the field.

startIndex : Number (optional)

The index to start searching at

Defaults to: 0

anyMatch : Boolean (optional)

True to match any part of the string, not just the beginning.

Defaults to: false

caseSensitive : Boolean (optional)

True for case sensitive comparison

Defaults to: false

exactMatch : Boolean (optional)

True to force exact match (^ and $ characters added to the regex). Ignored if `anyMatch` is `true`.

Defaults to: false

### Returns

:Number

The matched index or -1

Ext.data.AbstractStore
view source

## findBy ( fn , [scope] , [startIndex] ) : Number

Find the index of the first matching Record in this Store by a function. If the function returns `true` it is considered a match.

When store is filtered, finds records only within filter.

**IMPORTANT

If this store is Ext.data.BufferedStore, this can ONLY find records which happen to be cached in the page cache. This will be parts of the dataset around the currently visible zone, or recently visited zones if the pages have not yet been purged from the cache.**

### Parameters

fn : Function< / a>

The function to be called. It will be passed the following parameters:

record : Ext.data.Model

The record to test for filtering. Access field values using Ext.data.Model#get.

id : Object

The ID of the Record passed.

scope : Object (optional)

The scope (this reference) in which the function is executed. Defaults to this Store.

startIndex : Number (optional)

The index to start searching at

Defaults to: 0

### Returns

:Number

The matched index or -1

Ext.data.AbstractStore
view source

## findExact ( fieldName , value , [startIndex] ) : Number

Finds the index of the first matching Record in this store by a specific field value.

When store is filtered, finds records only within filter.

**IMPORTANT

If this store is Ext.data.BufferedStore, this can ONLY find records which happen to be cached in the page cache. This will be parts of the dataset around the currently visible zone, or recently visited zones if the pages have not yet been purged from the cache.**

### Parameters

fieldName : String

The name of the Record field to test.

value : Object

The value to match the field against.

startIndex : Number (optional)

The index to start searching at

Defaults to: 0

### Returns

:Number

The matched index or -1

Ext.data.AbstractStore
view source

## findRecord ( fieldName , value , [startIndex] , [anyMatch] , [caseSensitive] , [exactMatch] ) : Ext.data.Model

Finds the first matching Record in this store by a specific field value.

When store is filtered, finds records only within filter.

**IMPORTANT

If this store is Ext.data.BufferedStore, this can ONLY find records which happen to be cached in the page cache. This will be parts of the dataset around the currently visible zone, or recently visited zones if the pages have not yet been purged from the cache.**

### Parameters

fieldName : String

The name of the Record field to test.

value : String / RegExp

Either a string that the field value should begin with, or a RegExp to test against the field.

startIndex : Number (optional)

The index to start searching at

Defaults to: 0

anyMatch : Boolean (optional)

True to match any part of the string, not just the beginning.

Defaults to: false

caseSensitive : Boolean (optional)

True for case sensitive comparison

Defaults to: false

exactMatch : Boolean (optional)

True to force exact match (^ and $ characters added to the regex). Ignored if `anyMatch` is `true`.

Defaults to: false

### Returns

:Ext.data.Model

The matched record or null

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.data.Store
view source

## first ( [grouped] ) : Ext.data.Model / undefined

Convenience function for getting the first model instance in the store.

When store is filtered, will return first item within the filter.

### Parameters

grouped : Boolean (optional)

True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the first record being the value. The grouped parameter is only honored if the store has a groupField.

### Returns

:Ext.data.Model / undefined

The first model instance in the store, or undefined

Ext.data.ProxyStore
view source

## flushLoad

Called when the event handler which called the load method exits.

Ext.data.AbstractStore
view source

## getAt ( index ) : Ext.data.Model

Get the Record at the specified index.

The index is effected by filtering.

### Parameters

index : Number

The index of the Record to find.

### Returns

:Ext.data.Model

The Record at the passed index. Returns null if not found.

Ext.data.ProxyStore
view source

## getBatchListeners : Object
private pri

Returns an object which is passed in as the listeners argument to proxy.batch inside this.sync. This is broken out into a separate function to allow for customisation of the listeners

### Returns

:Object

The listeners object

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.data.Store
view source

## getById ( id ) : Ext.data.Model

Get the Record with the specified id.

This method is not affected by filtering, lookup will be performed from all records inside the store, filtered or not.

### Parameters

id : Mixed

The id of the Record to find.

### Returns

:Ext.data.Model

The Record with the passed id. Returns null if not found.

Ext.data.Store
view source

## getByInternalId ( internalId ) : Ext.data.Model

Get the Record with the specified internalId.

This method is not affected by filtering, lookup will be performed from all records inside the store, filtered or not.

### Parameters

internalId : Mixed

The id of the Record to find.

### Returns

:Ext.data.Model

The Record with the passed internalId. Returns null if not found.

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.

Ext.data.AbstractStore
view source

## getCount : Number

Gets the number of records in store.

If using paging, this may not be the total size of the dataset. If the data object used by the Reader contains the dataset size, then the Ext.data.ProxyStore#getTotalCount function returns the dataset size. Note: see the Important note in Ext.data.ProxyStore#load.

When store is filtered, it's the number of records matching the filter.

### Returns

:Number

The number of Records in the Store.

Ext.Base
view source

## getCurrentConfig
private pri

## getData

see: data
Ext.data.LocalStore
view source

## getDataSource
private pri

Returns the complete unfiltered collection.

## getFilters

see: filters
Ext.data.AbstractStore
view source

## getGroups : Ext.util.Collection

Returns a collection of readonly sub-collections of your store's records with grouping applied. These sub-collections are maintained internally by the collection.

See groupField, groupDir. Example for a store containing records with a color field:

Sample Code

    var myStore = Ext.create('Ext.data.Store', {
        groupField: 'color',
        groupDir  : 'DESC'
    });

    myStore.getGroups();

The above should result in the following format:

Sample Code

    [
        {
            name: 'yellow',
            children: [
                // all records where the color field is 'yellow'
            ]
        },
        {
            name: 'red',
            children: [
                // all records where the color field is 'red'
            ]
        }
    ]

Group contents are affected by filtering.

### Returns

:Ext.util.Collection

The grouped data

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.data.ProxyStore
view source

## getModifiedRecords : Ext.data.Model[]

Gets all Ext.data.Model added or updated since the last commit. Note that the order of records returned is not deterministic and does not indicate the order in which records were modified. Note also that removed records are not included (use getRemovedRecords for that).

### Returns

:Ext.data.Model[]

The added and updated Model instances

Ext.data.ProxyStore
view source

## getNewRecords : Ext.data.Model[]

Returns all phantom records in this store.

### Returns

:Ext.data.Model[]

A possibly empty array of `phantom` records.

Ext.data.AbstractStore
view source

## getRange ( start , end ) : Ext.data.Model[]

Gathers a range of Records between specified indices.

This method is affected by filtering.

### Parameters

start : Number

The starting index. Defaults to zero.

end : Number

The ending index. Defaults to the last record. The end index is included.

### Returns

:Ext.data.Model[]

An array of records.

Ext.data.ProxyStore
view source

## getRawRemovedRecords
private pri

Returns the array of records which have been removed since the last time this store was synced.

This is used internally, when purging removed records after a successful sync. This is overridden by TreeStore because TreeStore accumulates deleted records on removal of child nodes from their parent, not on removal of records from its collection. The collection has records added on expand, and removed on collapse.

Ext.data.ProxyStore
view source

## getRemovedRecords : Ext.data.Model[]

Returns any records that have been removed from the store but not yet destroyed on the proxy.

### Returns

:Ext.data.Model[]

The removed Model instances. Note that this is a copy of the store's array, so may be mutated.

## getSorters

see: sorters
Ext.data.AbstractStore
view source

## getState
private pri

Returns the grouping, sorting and filtered state of this Store.

Ext.data.ProxyStore
view source

## getTotalCount : Number

Returns the total number of Ext.data.Model instances that the Ext.data.proxy.Proxy indicates exist. This will usually differ from getCount when using paging - getCount returns the number of records loaded into the Store at the moment, getTotalCount returns the number of records that could be loaded into the Store if the Store contained all data

### Returns

:Number

The total number of Model instances available via the Proxy. 0 returned if no value has been set via the reader.

Ext.data.ProxyStore
view source

## getUpdatedRecords : Ext.data.Model[]

Returns all valid, non-phantom Model instances that have been updated in the Store but not yet synchronized with the Proxy.

### Returns

:Ext.data.Model[]

The updated Model instances

Ext.data.AbstractStore
view source

## group ( grouper , [direction] )

Groups data inside the store.

### Parameters

grouper : String / Object

Either a string name of one of the fields in this Store's configured Ext.data.Model, or an object, or a Ext.util.Grouper configuration object.

direction : String (optional)

The overall direction to group the data by. Defaults to the value of groupDir.

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.data.ProxyStore
view source

## hasPendingLoad : Boolean
private pri

Returns true if the store has a pending load task.

### Returns

:Boolean

`true` if the store has a pending load task.

Ext.data.Store
view source

## indexOf ( record ) : Number

Get the index of the record within the store.

When store is filtered, records outside of filter will not be found.

### Parameters

record : Ext.data.Model

The Ext.data.Model object to find.

### Returns

:Number

The index of the passed Record. Returns -1 if not found.

Ext.data.Store
view source

## indexOfId ( id ) : Number

Get the index within the store of the Record with the passed id.

Like #indexOf, this method is affected by filtering.

### Parameters

id : String

The id of the Record to find.

### Returns

:Number

The index of the Record. Returns -1 if not found.

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.data.Store
view source

## insert ( index , records ) : Ext.data.Model[]

Inserts Model instances into the Store at the given index and fires the add event. See also add.

### Parameters

index : Number

The start index at which to insert the passed Records.

records : Ext.data.Model / Ext.data.Model[] / Object / Object[]

An Ext.data.Model instance, the data needed to populate an instance or an array of either of these.

### Returns

:Ext.data.Model[]

records The added records

Ext.data.AbstractStore
view source

## isFiltered : Boolean

Tests whether the store currently has any active filters.

### Returns

:Boolean

`true` if the store is filtered.

Ext.data.AbstractStore
view source

## isGrouped : Boolean

Tests whether the store currently has an active grouper.

### Returns

:Boolean

`true` if the store is grouped.

Ext.data.ProxyStore
view source

## isLoaded : Boolean

Returns `true` if the Store has been loaded.

### Returns

:Boolean

`true` if the Store has been loaded.

Ext.data.ProxyStore
view source

## isLoading : Boolean

Returns true if the Store is currently performing a load operation

### Returns

:Boolean

`true` if the Store is currently loading

Ext.data.Store
view source

## isMoving ( [records] ) : Number
private pri

Checks whether records are being moved within the store. This can be used in conjunction with the add and remove events to determine whether the records are being removed/added or just having the position changed.

### Parameters

records : Ext.data.Model[] / Ext.data.Model (optional)

The record(s).

### Returns

:Number

The number of records being moved. `0` if no records are moving. If records are passed the number will refer to how many of the passed records are moving.

Ext.data.AbstractStore
view source

## isSorted : Boolean

Tests whether the store currently has any active sorters.

### Returns

:Boolean

`true` if the store is sorted.

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.data.Store
view source

## last ( [grouped] ) : Ext.data.Model / undefined

Convenience function for getting the last model instance in the store.

When store is filtered, will return last item within the filter.

### Parameters

grouped : Boolean (optional)

True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the last record being the value. The grouped parameter is only honored if the store has a groupField.

### Returns

:Ext.data.Model / undefined

The last model instance in the store, or undefined

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.data.ProxyStore
view source

## load ( [options] ) : Ext.data.Store

Marks this store as needing a load. When the current executing event handler exits, this store will send a request to load using its configured proxy.

Upon return of the data from whatever data source the proxy connected to, the retrieved Ext.data.Model will be loaded into this store, and the optional callback will be called. Example usage:

Sample Code

    store.load({
        scope: this,
        callback: function(records, operation, success) {
            // the operation object
            // contains all of the details of the load operation
            console.log(records);
        }
    });

If the callback scope does not need to be set, a function can simply be passed:

Sample Code

    store.load(function(records, operation, success) {
        console.log('loaded records');
    });

Available since: 1.1.0

### Parameters

options : Object< / a> (optional)

This is passed into the Ext.data.operation.Operation object that is created and then sent to the proxy's Ext.data.proxy.Proxy#read function. In addition to the options listed below, this object may contain properties to configure the Ext.data.operation.Operation.

callback : Function (optional)

A function which is called when the response arrives.

records : Ext.data.Model[]

Array of records.

operation : Ext.data.operation.Operation

The Operation itself.

success : Boolean

`true` when operation completed successfully.

addRecords : Boolean (optional)

Specify as `true` to add the incoming records rather than the default which is to have the incoming records replace the existing store contents.

Defaults to: false

### Returns

:Ext.data.Store

this

Ext.data.Store
view source

## loadData ( data , [append] )

Loads an array of data straight into the Store.

Using this method is great if the data is in the correct format already (e.g. it doesn't need to be processed by a reader). If your data requires processing to decode the data structure, use a Ext.data.proxy.Memory or loadRawData.

### Parameters

data : Ext.data.Model[] / Object[]

Array of data to load. Any non-model instances will be cast into model instances first.

append : Boolean (optional)

`true` to add the records to the existing records in the store, `false` to remove the old ones first.

Defaults to: false

Ext.data.Store
view source

## loadPage ( page , [options] )

Loads a given 'page' of data by setting the start and limit values appropriately. Internally this just causes a normal load operation, passing in calculated 'start' and 'limit' params.

### Parameters

page : Number

The number of the page to load.

options : Object (optional)

See options for load.

Ext.data.Store
view source

## loadRawData ( data , [append] ) : Boolean

Loads data via the bound Proxy's reader

Use this method if you are attempting to load data and want to utilize the configured data reader.

As of 4.2, this method will no longer fire the load event.

### Parameters

data : Object[]

The full JSON object you'd like to load into the Data store.

append : Boolean (optional)

`true` to add the records to the existing records in the store, `false` to remove the old ones first.

Defaults to: false

### Returns

:Boolean

`true` if the reader processed the records correctly. See Ext.data.reader.Reader#successProperty. If the reader did not process the records, nothing will be added.

Ext.data.Store
view source

## loadRecords ( records , options )

Loads an array of Ext.data.Model instances into the store, fires the datachanged event. This should only usually be called internally when loading from the Ext.data.proxy.Proxy, when adding records manually use add instead

### Parameters

records : Ext.data.Model[]

The array of records to load

options : Object< / a>

addRecords : Boolean (optional)

Pass `true` to add these records to the existing records, `false` to remove the Store's existing records first.

Defaults to: false

Ext.data.Store
view source

## max ( field , [grouped] ) : Object

Gets the maximum value in the store.

When store is filtered, only items within the filter are aggregated.

### Parameters

field : String

The field in each record

grouped : Boolean (optional)

True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the maximum in the group being the value. The grouped parameter is only honored if the store has a groupField.

### Returns

:Object

The maximum value, if no items exist, undefined.

Ext.data.Store
view source

## min ( field , [grouped] ) : Object

Gets the minimum value in the store.

When store is filtered, only items within the filter are aggregated.

### Parameters

field : String

The field in each record

grouped : Boolean (optional)

True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the minimum in the group being the value. The grouped parameter is only honored if the store has a groupField.

### Returns

:Object

The minimum value, if no items exist, undefined.

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.data.Store
view source

## nextPage ( options )

Loads the next 'page' in the current data set

### Parameters

options : Object

See options for load

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.data.ProxyStore
view source

## onBatchComplete ( batch , operation )
private pri

Attached as the 'complete' event listener to a proxy's Batch object. Iterates over the batch operations and updates the Store's internal data MixedCollection.

### Parameters

batch : Object

operation : Object

Ext.data.ProxyStore
view source

## onBatchException ( batch , operation )
private pri

### Parameters

batch : Object

operation : Object

Ext.data.ProxyStore
view source

## onBatchOperationComplete ( batch , operation )
private pri

Attached as the 'operationcomplete' event listener to a proxy's Batch object. By default just calls through to onProxyWrite.

### Parameters

batch : Object

operation : Object

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.data.ProxyStore
view source

## onDestroyRecords ( records , operation , success )
private pri

Removes any records when a write is returned from the server.

### Parameters

records : Ext.data.Model[]

The array of removed records

operation : Ext.data.operation.Operation

The operation that just completed

success : Boolean

True if the operation was successful

Ext.data.ProxyStore
view source

## onMetaChange ( proxy , meta )
private pri

### Parameters

proxy : Object

meta : Object

Ext.data.Store
view source

## onProxyLoad ( operation )
protected pro

Called internally when a Proxy has completed a load request

### Parameters

operation : Object

Ext.data.ProxyStore
view source

## onProxyWrite ( operation )
private pri

Callback for any write Operation over the Proxy. Updates the Store's MixedCollection to reflect the updates provided by the Proxy

### Parameters

operation : Object

Ext.data.Store
view source

## previousPage ( options )

Loads the previous 'page' in the current data set

### Parameters

options : Object

See options for load

Ext.data.Store
view source

## query ( property , value , [anyMatch] , [caseSensitive] , [exactMatch] ) : Ext.util.Collection

Query all the cached records in this Store by name/value pair. The parameters will be used to generated a filter function that is given to the queryBy method.

This method complements queryBy by generating the query function automatically.

This method is not affected by filtering, it will always search all records in the store regardless of filtering.

### Parameters

property : String

The property to create the filter function for

value : String / RegExp

The string/regex to compare the property value to

anyMatch : Boolean (optional)

True to match any part of the string, not just the beginning.

Defaults to: false

caseSensitive : Boolean (optional)

`true` to create a case-sensitive regex.

Defaults to: false

exactMatch : Boolean (optional)

True to force exact match (^ and $ characters added to the regex). Ignored if `anyMatch` is `true`.

Defaults to: false

### Returns

:Ext.util.Collection

The matched records

Ext.data.Store
view source

## queryBy ( fn , [scope] ) : Ext.util.Collection

Query all the cached records in this Store using a filtering function. The specified function will be called with each record in this Store. If the function returns `true` the record is included in the results.

This method is not affected by filtering, it will always search all records in the store regardless of filtering.

### Parameters

fn : Function< / a>

The function to be called. It will be passed the following parameters:

record : Ext.data.Model

The record to test for filtering. Access field values using Ext.data.Model#get.

id : Object

The ID of the Record passed.

scope : Object (optional)

The scope (this reference) in which the function is executed Defaults to this Store.

### Returns

:Ext.util.Collection

The matched records

Ext.data.LocalStore
view source

## queryRecords ( field , value ) : Ext.data.Model[]
private pri

Query all the cached records in this Store by field.

This method is not affected by filtering, it will always search all records in the store regardless of filtering.

### Parameters

field : String

The field from each record to use.

value : Object

The value to match.

### Returns

:Ext.data.Model[]

The matched records.

Ext.data.LocalStore
view source

## queryRecordsBy ( fn , [scope] ) : Ext.data.Model[]
private pri

Query all the cached records in this Store using a filtering function. The specified function will be called with each record in this Store. If the function returns `true` the record is included in the results.

This method is not affected by filtering, it will always search all records in the store regardless of filtering.

### Parameters

fn : Function< / a>

The function to be called. It will be passed the following parameters:

record : Ext.data.Model

The record to test for filtering.

scope : Object (optional)

The scope (this reference) in which the function is executed Defaults to this Store.

### Returns

:Ext.data.Model[]

The matched records.

Ext.data.AbstractStore
view source

## rangeCached ( start , end )
private pri

Determines if the passed range is available in the page cache.

### Parameters

start : Number

The start index

end : Number

The end index in the range

Ext.data.Store
view source

## rejectChanges

Rejects outstanding changes on all modified records and re-insert any records that were removed locally. Any phantom records will be removed.

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.data.ProxyStore
view source

## reload ( [options] )

Reloads the store using the last options passed to the load method. You can use the reload method to reload the store using the parameters from the last load() call. For example:

Sample Code

    store.load({
        params : {
            userid : 22216
        }
    });

    //...

    store.reload();

The initial load execution will pass the `userid` parameter in the request. The reload execution will also send the same `userid` parameter in its request as it will reuse the `params` object from the last load call.

You can override a param by passing in the config object with the `params` object:

Sample Code

    store.load({
        params : {
            userid : 22216,
            foo    : 'bar'
        }
    });

    //...

    store.reload({
        params : {
            userid : 1234
        }
    });

The initial load execution sends the `userid` and `foo` parameters but in the reload it only sends the `userid` paramter because you are overriding the `params` config not just overriding the one param. To only change a single param but keep other params, you will have to get the last params from the lastOptions property:

Sample Code

    var lastOptions = store.lastOptions,
        lastParams = Ext.clone(lastOptions.params); // make a copy of the last params so we don't affect future reload() calls

    lastParams.userid = 1234;

    store.reload({
        params : lastParams
    });

This will now send the `userid` parameter as `1234` and the `foo` param as `'bar'`.

### Parameters

options : Object (optional)

A config object which contains options which may override the options passed to the previous load call. See the load method for valid configs.

Ext.data.Store
view source

## remove ( records , isMove , silent )

Removes the specified record(s) from the Store, firing the remove event for the removed records.

After all records have been removed a single datachanged is fired.

### Parameters

records : Ext.data.Model / Ext.data.Model[] / Number / Number[]

Model instance or array of instances to remove or an array of indices from which to remove records.

isMove : Object

silent : Object

Ext.mixin.Observable
view source

## removeAfterListener

Alias for unAfter.

Ext.data.Store
view source

## removeAll ( [silent] ) : Ext.data.Model[]

Removes all items from the store.

Individual record remove events are not fired by this method.

### Parameters

silent : Boolean (optional)

Pass `true` to prevent the clear event from being fired.

This method is affected by filtering.

Defaults to: false

### Returns

:Ext.data.Model[]

The removed records.

Ext.data.Store
view source

## removeAt ( index , [count] )

Removes the model instance(s) at the given index

### Parameters

index : Number

The record index

count : Number (optional)

The number of records to delete

Defaults to: 1

Ext.mixin.Observable
view source

## removeBeforeListener

Alias for unBefore.

Ext.data.AbstractStore
view source

## removeFilter ( toRemove , [suppressEvent] )

Removes an individual Filter from the current filter set using the passed Filter/Filter id and by default, applies the updated filter set to the Store's unfiltered dataset.

### Parameters

toRemove : String / Ext.util.Filter

The id of a Filter to remove from the filter set, or a Filter instance to remove.

suppressEvent : Boolean (optional)

If `true` the filter is cleared silently.

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.data.ProxyStore
view source

## resumeAutoSync ( syncNow )

Resumes automatically syncing the Store with its Proxy. Only applicable if autoSync is `true`

### Parameters

syncNow : Boolean

Pass `true` to synchronize now. Only synchronizes with the Proxy if the suspension count has gone to zero (We are not under a higher level of suspension)

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.data.ProxyStore
view source

## save
deprecated dep

Saves all pending changes via the configured proxy. Use sync instead.

Deprecated: 4.0.0
Will be removed in the next major version

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

## setData

see: data
Ext.data.AbstractStore
view source

## setFilters

## setListeners

see: listeners
Ext.data.Store
view source

## setRecords ( records )
private pri

Make a set of records be current in the store. This means that unneeded records will be removed and new records will be added.

### Parameters

records : Ext.data.Model[]

The records to be current in the store.

Ext.data.AbstractStore
view source

## setSorters

Ext.data.AbstractStore
view source

## sort ( [sorters] , [direction] ) : Ext.util.Sorter[]

Sorts the data in the Store by one or more of its properties. Example usage:

Sample Code

    //sort by a single field
    myStore.sort('myField', 'DESC');

    //sorting by multiple fields
    myStore.sort([
        {
            property : 'age',
            direction: 'ASC'
        },
        {
            property : 'name',
            direction: 'DESC'
        }
    ]);

Internally, Store converts the passed arguments into an array of Ext.util.Sorter instances, and delegates the actual sorting to its internal Ext.util.MixedCollection.

When passing a single string argument to sort, Store maintains a ASC/DESC toggler per field, so this code:

Sample Code

    store.sort('myField');
    store.sort('myField');

Is equivalent to this code, because Store handles the toggling automatically:

Sample Code

    store.sort('myField', 'ASC');
    store.sort('myField', 'DESC');

### Parameters

sorters : String / Ext.util.Sorter[] (optional)

Either a string name of one of the fields in this Store's configured Ext.data.Model, or an array of sorter configurations.

direction : String (optional)

The overall direction to sort the data by.

Defaults to: "ASC"

### Returns

:Ext.util.Sorter[]
Ext.data.Store
view source

## splice ( index , toRemove , [toAdd] )
private pri

This method is basically the same as the JavaScript Array splice method.

Negative indexes are interpreted starting at the end of the collection. That is, a value of -1 indicates the last item, or equivalent to `length - 1`.

### Parameters

index : Number

The index at which to add or remove items.

toRemove : Number / Object[]

The number of items to remove or an array of the items to remove.

toAdd : Object[] (optional)

The items to insert at the given `index`.

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.data.Store
view source

## sum ( field , [grouped] ) : Number

Sums the value of `field` for each Ext.data.Model in store and returns the result.

When store is filtered, only sums items within the filter.

### Parameters

field : String

A field in each record

grouped : Boolean (optional)

True to perform the operation for each group in the store. The value returned will be an object literal with the key being the group name and the sum for that group being the value. The grouped parameter is only honored if the store has a groupField.

### Returns

:Number

The sum

Ext.data.ProxyStore
view source

## suspendAutoSync

Suspends automatically syncing the Store with its Proxy. Only applicable if autoSync is `true`

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.data.ProxyStore
view source

## sync ( [options] ) : Ext.data.Store

Synchronizes the store with its proxy. This asks the proxy to batch together any new, updated and deleted records in the store, updating the store's internal representation of the records as each operation completes.

### Parameters

options : Object< / a> (optional)

Object containing one or more properties supported by the sync method (these get passed along to the underlying proxy's batch method):

batch : Ext.data.Batch/Object (optional)

A Ext.data.Batch object (or batch config to apply to the created batch). If unspecified a default batch will be auto-created as needed.

callback : Function (optional)

The function to be called upon completion of the sync. The callback is called regardless of success or failure and is passed the following parameters:

batch : Ext.data.Batch

The Ext.data.Batch that was processed, containing all operations in their current state after processing

options : Object

The options argument that was originally passed into sync

success : Function (optional)

The function to be called upon successful completion of the sync. The success function is called only if no exceptions were reported in any operations. If one or more exceptions occurred then the failure function will be called instead. The success function is called with the following parameters:

batch : Ext.data.Batch

The Ext.data.Batch that was processed, containing all operations in their current state after processing

options : Object

The options argument that was originally passed into sync

failure : Function (optional)

The function to be called upon unsuccessful completion of the sync. The failure function is called when one or more operations returns an exception during processing (even if some operations were also successful). In this case you can check the batch's exceptions array to see exactly which operations had exceptions. The failure function is called with the following parameters:

batch : Ext.data.Batch

The Ext.data.Batch that was processed, containing all operations in their current state after processing

options : Object

The options argument that was originally passed into sync

params : Object (optional)

Additional params to send during the sync Operation(s).

scope : Object (optional)

The scope in which to execute any callbacks (i.e. the `this` object inside the callback, success and/or failure functions). Defaults to the store's proxy.

### Returns

:Ext.data.Store

this

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.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.data.AbstractStore
view source

## add ( store , records , index , eOpts )

Fired when a Model instance has been added to this Store.

Available since: 1.1.0

### Parameters

store : Ext.data.Store

The store.

records : Ext.data.Model[]

The records that were added.

index : Number

The index at which the records were inserted.

eOpts : Object

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

Ext.data.ProxyStore
view source

## beforeload ( store , operation , eOpts )

Fires before a request is made for a new data object. If the beforeload handler returns false the load action will be canceled.

Available since: 1.1.0

### Parameters

store : Ext.data.Store

This Store

operation : Ext.data.operation.Operation

The Ext.data.operation.Operation object that will be passed to the Proxy to load the Store

eOpts : Object

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

Ext.data.Store
view source

## beforeprefetch ( this , operation , eOpts )

Fires before a prefetch occurs. Return `false` to cancel.

### Parameters

this : Ext.data.Store

operation : Ext.data.operation.Operation

The associated operation.

eOpts : Object

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

Ext.data.AbstractStore
view source

## beforesort ( store , sorters , eOpts )

Fires before a store is sorted.

For remotely sorted stores, this will be just before the load operation triggered by changing the store's sorters.

For locally sorted stores, this will be just before the data items in the store's backing collection are sorted.

### Parameters

store : Ext.data.Store

The store being sorted

sorters : Ext.util.Sorter[]

Array of sorters applied to the store

eOpts : Object

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

Ext.data.ProxyStore
view source

## beforesync ( options , eOpts )

Fired before a call to sync is executed. Return false from any listener to cancel the sync

### Parameters

options : Object

Hash of all records to be synchronized, broken down into create, update and destroy

eOpts : Object

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

Ext.data.AbstractStore
view source

## beginupdate

Fires when the beginUpdate method is called. Automatic synchronization as configured by the autoSync flag is deferred until the endUpdate method is called, so multiple mutations can be coalesced into one synchronization operation.

Ext.data.AbstractStore
view source

## clear ( this , eOpts )

Fired after the removeAll method is called.

Available since: 1.1.0

### Parameters

this : Ext.data.Store

eOpts : Object

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

Ext.data.AbstractStore
view source

## datachanged ( this , eOpts )

Fires whenever records are added to or removed from the Store.

To hook into modifications of records in this Store use the update event.

Available since: 1.1.0

### Parameters

this : Ext.data.Store

The data store

eOpts : Object

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

Ext.data.AbstractStore
view source

## endupdate

Fires when the endUpdate method is called. Automatic synchronization as configured by the autoSync flag is deferred until the endUpdate method is called, so multiple mutations can be coalesced into one synchronization operation.

Ext.data.Store
view source

## filterchange ( store , filters , eOpts )

Fired whenever the filter set changes.

### Parameters

store : Ext.data.Store

The store.

filters : Ext.util.Filter[]

The array of Filter objects.

eOpts : Object

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

Ext.data.Store
view source

## groupchange ( store , grouper , eOpts )

Fired whenever the grouping in the grid changes.

### Parameters

store : Ext.data.Store

The store.

grouper : Ext.util.Grouper

The grouper object.

eOpts : Object

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

Ext.data.ProxyStore
view source

## load ( this , records , successful , operation , eOpts )

Fires whenever the store reads data from a remote data source.

Available since: 1.1.0

### Parameters

this : Ext.data.Store

records : Ext.data.Model[]

An array of records

successful : Boolean

True if the operation was successful.

operation : Ext.data.operation.Read

The Ext.data.operation.Read object that was used in the data load call

eOpts : Object

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

Ext.data.ProxyStore
view source

## metachange ( this , meta , eOpts )

Fires when this store's underlying reader (available via the proxy) provides new metadata. Metadata usually consists of new field definitions, but can include any configuration data required by an application, and can be processed as needed in the event handler. This event is currently only fired for JsonReaders.

Available since: 1.1.0

### Parameters

this : Ext.data.Store

meta : Object

The JSON metadata

eOpts : Object

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

Ext.data.Store
view source

## prefetch ( this , records , successful , operation , eOpts )

Fires whenever records have been prefetched.

### Parameters

this : Ext.data.Store

records : Ext.data.Model[]

An array of records.

successful : Boolean

`true` if the operation was successful.

operation : Ext.data.operation.Operation

The associated operation.

eOpts : Object

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

Ext.data.AbstractStore
view source

## refresh ( this , eOpts )

Fires when the data cache has changed in a bulk manner (e.g., it has been sorted, filtered, etc.) and a widget that is using this Store as a Record cache should refresh its view.

### Parameters

this : Ext.data.Store

The data store

eOpts : Object

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

Ext.data.AbstractStore
view source

## remove ( store , records , index , isMove , eOpts )

Fired when one or more records have been removed from this Store.

The signature for this event has changed in 5.0:

Available since: 5.0.0

### Parameters

store : Ext.data.Store

The Store object

records : Ext.data.Model[]

The records that were removed. In previous releases this was a single record, not an array.

index : Number

The index at which the records were removed.

isMove : Boolean

`true` if the child node is being removed so it can be moved to another position in this Store.

eOpts : Object

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

Ext.data.AbstractStore
view source

## sort ( store , eOpts )

Fires after a store is sorted.

For remotely sorted stores, this will be upon the success of a load operation triggered by changing the store's sorters.

For locally sorted stores, this will be just after the data items in the store's backing collection are sorted.

### Parameters

store : Ext.data.Store

The store being sorted

eOpts : Object

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

Ext.data.AbstractStore
view source

## update ( this , record , operation , modifiedFieldNames , details , eOpts )

Fires when a Model instance has been updated.

Available since: 1.1.0

### Parameters

this : Ext.data.Store

record : Ext.data.Model

The Model instance that was updated

operation : String

The update operation being performed. Value may be one of:

Sample Code

    Ext.data.Model.EDIT
    Ext.data.Model.REJECT
    Ext.data.Model.COMMIT

modifiedFieldNames : String[]

Array of field names changed during edit.

details : Object

An object describing the change. See the itemchange event of the store's backing collection

eOpts : Object

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

Ext.data.ProxyStore
view source

## write ( store , operation , eOpts )

Fires whenever a successful write has been made via the configured Proxy

Available since: 3.4.0

### Parameters

store : Ext.data.Store

This Store

operation : Ext.data.operation.Operation

The Ext.data.operation.Operation object that was used in the write

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