Docs Help

## Terms, Icons, and Labels

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

### Access Levels

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

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

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

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

### Member Types

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

### Member Syntax

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

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

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

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

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

Parameters

item : Object

The config object being added.

Returns
Ext.Component

The component to be added.

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

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

### Member Flags

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

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

### Class Icons

- Indicates a framework class

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

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

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

### Member Icons

- Indicates a class member of type `config`

- Indicates a class member of type `property`

- Indicates a class member of type `method`

- Indicates a class member of type `event`

- Indicates a class member of type `theme variable`

- Indicates a class member of type `theme mixin`

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

## Navigation and Features

### Class Member Quick-Nav Menu

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

### Getter and Setter Methods

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

### History Bar

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

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

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

### Search and Filters

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

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

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

### API Doc Class Metadata

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

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

### Expanding and Collapsing Examples and Class Members

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

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

### Desktop -vs- Mobile View

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

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

### Viewing the Class Source

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

Ext.chart.CartesianChart Classic Toolkit

##
Ext JS 6.2.0 - Modern Toolkit

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

# Ext.chart.CartesianChart xtype: cartesian

### Hierarchy

Ext.chart.AbstractChart
Ext.chart.CartesianChart

## Summary

Represents a chart that uses cartesian coordinates. A cartesian chart has two directions, X direction and Y direction. The series and axes are coordinated along these directions. By default the x direction is horizontal and y direction is vertical, You can swap the direction by setting the flipXY config to `true`.

Cartesian series often treats x direction an y direction differently. In most cases, data on x direction are assumed to be monotonically increasing. Based on this property, cartesian series can be trimmed and summarized properly to gain a better performance.

No members found using the current filters

## configs

Ext.chart.AbstractChart
view source

## animation : Boolean / Object

`true` for the default animation (easing: 'ease' and duration: 500) or a standard animation config object to be used for default chart animations.

Defaults to: !Ext.isIE8

Ext.chart.AbstractChart
view source

## axes : Ext.chart.axis.Axis / Array / Object

Array of Ext.chart.axis.Axis instances or config objects. For example:

Sample Code

    axes: [{
        type: 'numeric',
        position: 'left',
        title: 'Number of Hits',
        minimum: 0
    }, {
        type: 'category',
        position: 'bottom',
        title: 'Month of the Year'
    }]

Defaults to: []

Ext.chart.AbstractChart
view source

## background : Object

Set the chart background. This can be a gradient object, image, or color.

For example, if background were to be a color we could set the object as

Sample Code

    background: '#ccc'

You can specify an image by using:

Sample Code

    background: {
        type: 'image',
        src: 'http://path.to.image/'
    }

Also you can specify a gradient by using the gradient object syntax:

Sample Code

    background: {
        type: 'linear',
        degrees: 0,
        stops: [
            {
                offset: 0,
                color: 'white'
            },
            {
                offset: 1,
                color: 'blue'
            }
        ]
    }

Defaults to: null

Ext.chart.AbstractChart
view source

## colors : Array

Array of colors/gradients to override the color of items and legends.

Defaults to: null

Ext.draw.Container
view source

## engine : String

Defines the engine (type of surface) used to render draw container contents.

The render engine is selected automatically depending on the platform used. Priority is given to the Ext.draw.engine.Canvas engine due to its performance advantage.

You may also set the engine config to be Ext.draw.engine.Svg if so desired.

Defaults to: "Ext.draw.engine.Canvas"

Ext.chart.CartesianChart
view source

## flipXY : Boolean

Flip the direction of X and Y axis. If flipXY is `true`, the X axes will be vertical and Y axes will be horizontal. Note that positions of chart axes have to be updated accordingly: axes positioned to the `top` and `bottom` should be positioned to the `left` or `right` and vice versa.

Defaults to: false

Ext.draw.Container
view source

## gradients : Object[]

Defines a set of gradients that can be used as color properties (fillStyle and strokeStyle, but not shadowColor) in sprites. The gradients array is an array of objects with the following properties:

- id - string - The unique name of the gradient.
- type - string, optional - The type of the gradient. Available types are: 'linear', 'radial'. Defaults to 'linear'.
- angle - number, optional - The angle of the gradient in degrees.
- stops - array - An array of objects with 'color' and 'offset' properties, where 'offset' is a real number from 0 to 1.

For example:

Sample Code

    gradients: [{
        id: 'gradientId1',
        type: 'linear',
        angle: 45,
        stops: [{
            offset: 0,
            color: 'red'
        }, {
           offset: 1,
           color: 'yellow'
        }]
    }, {
       id: 'gradientId2',
       type: 'radial',
       stops: [{
           offset: 0,
           color: '#555',
       }, {
           offset: 1,
           color: '#ddd',
       }]
    }]

Then the sprites can use 'gradientId1' and 'gradientId2' by setting the color attributes to those ids, for example:

Sample Code

    sprite.setAttributes({
        fillStyle: 'url(#gradientId1)',
        strokeStyle: 'url(#gradientId2)'
    });

Defaults to: []

Ext.chart.AbstractChart
view source

## highlightItem : Object

The current highlight item in the chart. The object must be the one that you get from item events.

Note that series can also own highlight items. This notion is separate from this one and should not be used at the same time.

Defaults to: null

Ext.chart.CartesianChart
view source

## innerPadding : Object

The amount of inner padding in pixels. Inner padding is the padding from the innermost axes to the series.

Defaults to: { top: 0, left: 0, right: 0, bottom: 0 }

Ext.chart.AbstractChart
view source

## insetPadding : Object / Number / String

The amount of inset padding in pixels for the chart. Inset padding is the padding from the boundary of the chart to any of its contents.

Defaults to: { top: 10, left: 10, right: 10, bottom: 10 }

Ext.chart.AbstractChart
view source

## interactions : Array

Interactions are optional modules that can be plugged in to a chart to allow the user to interact with the chart and its data in special ways. The interactions config takes an Array of Object configurations, each one corresponding to a particular interaction class identified by a `type` property:

Sample Code

    new Ext.chart.AbstractChart({
        renderTo: Ext.getBody(),
        width: 800,
        height: 600,
        store: store1,
        axes: [
            // ...some axes options...
        ],
        series: [
            // ...some series options...
        ],
        interactions: [{
            type: 'interactiontype'
            // ...additional configs for the interaction...
        }]
    });

When adding an interaction which uses only its default configuration (no extra properties other than `type`), you can alternately specify only the type as a String rather than the full Object:

Sample Code

    interactions: ['reset', 'rotate']

The current supported interaction types include:

- Ext.chart.interactions.PanZoom - allows pan and zoom of axes
- Ext.chart.interactions.ItemHighlight - allows highlighting of series data points
- Ext.chart.interactions.ItemInfo - allows displaying details of a data point in a popup panel
- Ext.chart.interactions.Rotate - allows rotation of pie and radar series

See the documentation for each of those interaction classes to see how they can be configured.

Additional custom interactions can be registered using `'interactions.'` alias prefix.

Defaults to: []

Ext.chart.AbstractChart
view source

## legend : Ext.chart.legend.Legend / Ext.chart.legend.SpriteLegend / Boolean

The legend config for the chart. If specified, a legend block will be shown next to the chart. Each legend item displays the title of the series, the color of the series and allows to toggle the visibility of the series (at least one series should remain visible).

Sencha Charts support two types of legends: DOM based and sprite based.

The sprite based legend can be shown in chart preview and is a part of the downloaded chart image. The sprite based legend is always displayed in full and takes as much space as necessary, the legend items are split into columns to use the available space efficiently. The sprite based legend is styled via a Ext.chart.theme.Base.

The DOM based legend supports RTL. It occupies a fixed width or height and scrolls when the content overflows. The DOM based legend is styled via CSS rules.

By default the DOM legend is used. The type can be explicitly specified:

Sample Code

    legend: {
        type: 'sprite', // 'dom' is another possible value
        docked: 'top'
    }

If the legend config is set to `true`, the DOM legend will be used docked to the bottom.

Defaults to: null

Ext.chart.AbstractChart
view source

## mainRect
private pri

The main area of the chart where grid and series are drawn.

Defaults to: null

Ext.chart.AbstractChart
view source

## resizeHandler
private pri

Override value.

Defaults to: null

Ext.chart.AbstractChart
view source

## series : Ext.chart.series.Series / Array

Array of Ext.chart.series.Series instances or config objects. For example:

Sample Code

    series: [{
        type: 'column',
        axis: 'left',
        listeners: {
            'afterrender': function() {
                console.log('afterrender');
            }
        },
        xField: 'category',
        yField: 'data1'
    }]

Defaults to: []

Ext.draw.Container
view source

## sprites : Object[]

Defines a set of sprites to be added to the drawContainer surface.

For example:

Sample Code

     sprites: [{
          type: 'circle',
          fillStyle: '#79BB3F',
          r: 100,
          x: 100,
          y: 100
     }]

Defaults to: null

Ext.chart.AbstractChart
view source

## store : Ext.data.Store / String / Object

The data source to which the chart is bound. Acceptable values for this property are:

- any Ext.data.Store class / subclass
- an ID of a store
- a Ext.data.Store config object. When passing a config you can specify the store type by alias. Passing a config object with a store type will dynamically create a new store of that type when the chart is instantiated.

For example:

Sample Code

    Ext.define('MyApp.store.Customer', {
        extend: 'Ext.data.Store',
        alias: 'store.customerstore',

        fields: ['name', 'value']
    });

    Ext.create({
        xtype: 'cartesian',
        renderTo: document.body,
        height: 400,
        width: 400,
        store: {
            type: 'customerstore',
            data: [{
                name: 'metric one',
                value: 10
            }]
        },
        axes: [{
            type: 'numeric',
            position: 'left',
            title: {
                text: 'Sample Values',
                fontSize: 15
            },
            fields: 'value'
        }, {
            type: 'category',
            position: 'bottom',
            title: {
                text: 'Sample Values',
                fontSize: 15
            },
            fields: 'name'
        }],
        series: {
            type: 'bar',
            xField: 'name',
            yField: 'value'
        }
    });

Defaults to: 'ext-empty-store'

Ext.chart.AbstractChart
view source

## style : Object

The style for the chart component.

Defaults to: null

Ext.chart.AbstractChart
view source

## theme : String

The name of the theme to be used. A theme defines the colors and styles used by the series, axes, markers and other chart components. Please see the documentation for the Ext.chart.theme.Base class for more information. Possible theme values are:

- 'green', 'sky', 'red', 'purple', 'blue', 'yellow'
- 'category1' to 'category6'
- and the above theme names with the '-gradients' suffix, e.g. 'green-gradients'

Defaults to: "default"

## properties

Ext.chart.AbstractChart
view source

## animationSuspendCount
private pri

Toggle for chart interactions that require animation to be suspended.

Defaults to: 0

Ext.chart.AbstractChart
view source

## axisThicknessSuspendCount
private pri

Defaults to: 0

Ext.chart.AbstractChart
view source

## chartLayoutSuspendCount
private pri

Defaults to: 0

Ext.draw.Container
view source

## defaultDownloadServerUrl : String

The default URL used by download.

Defaults to: "http://svg.sencha.io"

Ext.chart.AbstractChart
view source

## isThicknessChanged
private pri

Indicates that thickness of one or more axes has changed, at the time of performLayout call. I.e. 'performLayout' should be called again when current layout is done.

Defaults to: false

Ext.chart.AbstractChart
view source

## recordCount
private pri

The number of records in the chart's store last time the data was changed.

Defaults to: 0

Ext.draw.Container
view source

## supportedFormats : Array
private pri

A list of export types supported by the server.

Defaults to: ["png", "pdf", "jpeg", "gif"]

Ext.chart.AbstractChart
view source

## surfaceZIndexes
private pri

The z-indexes to use for the various surfaces

Defaults to: { background: 0, // Contains the backround 'rect' sprite. main: 1, // Contains grid lines and CrossZoom overlay 'rect' sprite. grid: 2, // Reserved (unused). series: 3, // Contains series sprites. axis: 4, // Reserved. chart: 5, // Covers whole chart, minus the legend area. overlay: 6, // This surface will typically contain chart labels // and interaction sprites like crosshair lines. legend: 7, // SpriteLegend surface. title: 8 }

## methods

Ext.chart.AbstractChart
view source

## addSeries ( newSeries )

Adds a Ext.chart.series.Series to this chart.

The Series (or array) passed will be added to the existing series. If an `id` is specified in a new Series, any existing Series of that `id` will be updated.

The chart will be redrawn in response to the change.

### Parameters

newSeries : Object / Object[] / Ext.chart.series.Series / Ext.chart.series.Series[]

A config object describing the Series to add, or an instantiated Series object. Or an array of these.

Ext.chart.AbstractChart
view source

## bindStore ( store )

Changes the data store bound to this chart and refreshes it.

### Parameters

store : Ext.data.Store

The store to bind to this chart.

Ext.chart.AbstractChart
view source

## cancelChartLayout

Cancel a scheduled layout.

Ext.draw.Container
view source

## download ( [config] ) : Boolean

Downloads an image or PDF of the chart / drawing or opens it in a separate browser tab/window if the download can't be triggered. The exact behavior is platform and browser specific. For more consistent results on mobile devices use the preview method instead. This method doesn't work in IE8.

### Parameters

config : Object< / a> (optional)

The following config options are supported:

url : String

The url to post the data to. Defaults to the defaultDownloadServerUrl configuration on the class.

format : String

The format of image to export. See the supportedFormats. Defaults to 'png' on the Sencha IO server. Note that you can't export to 'svg' format if the Ext.draw.engine.Canvas engine is used.

width : Number

A width to send to the server for configuring the image width. Defaults to natural image width on the Sencha IO server.

height : Number

A height to send to the server for configuring the image height. Defaults to natural image height on the Sencha IO server.

filename : String

The filename of the downloaded image. Defaults to 'chart' on the Sencha IO server. The config.format is used as a filename extension.

scale : Number

The scaling of the downloaded image. Defaults to 1 on the Sencha IO server. The server will try to determine the natural size of the image unless the width/height configs have been set. If the Ext.draw.engine.Canvas engine is used the natural image size will depend on the value of the window.devicePixelRatio. For example, for devices with devicePixelRatio of 2 the produced image will be two times larger than for devices with devicePixelRatio of 1 for the same drawing. This is done so that the users with devices with HiDPI screens get a downloaded image that looks as crisp on their device as the original drawing. If you want image size to be consistent across devices with different device pixel ratios, you can set the value of this config to 1/devicePixelRatio. This parameter is ignored by the Sencha IO server if config.format is set to 'svg'.

pdf : Object

PDF specific options. This config is only used if config.format is set to 'pdf'. The given object should be in either this format:

Sample Code

    {
                              width: '200px',
                              height: '300px',
                              border: '0px'
                            }

or this format:

Sample Code

    {
                              format: 'A4',
                              orientation: 'portrait',
                              border: '1cm'
                            }

Supported dimension units are: 'mm', 'cm', 'in', 'px'. No unit means 'px'. Supported formats are: 'A3', 'A4', 'A5', 'Legal', 'Letter', 'Tabloid'. Orientation ('portrait', 'landscape') is optional and defaults to 'portrait'.

jpeg : Object

JPEG specific options. This config is only used if config.format is set to 'jpeg'. The given object should be in this format:

Sample Code

    {
                              quality: 80
                            }

Where quality is an integer between 0 and 100.

### Returns

:Boolean

True if request was successfully sent to the server.

Ext.chart.AbstractChart
view source

## getAxis ( axis ) : Ext.chart.axis.Axis

Returns an axis instance based on the type of data passed.

### Parameters

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

You may request an axis by passing an id, the number of the array key returned by getAxes, or an axis instance.

### Returns

:Ext.chart.axis.Axis

The axis requested.

Ext.chart.AbstractChart
view source

## getChartRect ( isRecompute )
private pri

The area of the chart minus the legend. Cache chart rect as element.getSize() results in a relatively expensive call to the getComputedStyle().

### Parameters

isRecompute : Object

Ext.draw.Container
view source

## getImage ( [format] ) : Object< / a>

Produces an image of the chart / drawing.

### Parameters

format : String (optional)

Possible options are 'image' (the method will return an Image object) and 'stream' (the method will return the image as a byte stream). If missing, the data URI of the drawing's (or chart's) image will be returned. Note: for an SVG based drawing/chart in IE/Edge browsers the method will always return SVG markup instead of a data URI, as 'img' elements won't accept a data URI anyway in those browsers.

### Returns

:Object< / a>

data : String

Image element, byte stream or DataURL.

type : String

The type of the data (e.g. 'png' or 'svg').

Ext.chart.AbstractChart
view source

## getInteraction ( type ) : Ext.chart.interactions.Abstract

Get an interaction by type.

### Parameters

type : String

The type of the interaction.

### Returns

:Ext.chart.interactions.Abstract

The interaction. `null` if not found.

Ext.chart.AbstractChart
view source

## getItemForPoint ( x , y ) : Object

Given an x/y point relative to the chart, find and return the first series item that matches that point.

### Parameters

x : Number

y : Number

### Returns

:Object

An object with series and `item` properties, or `false` if no item found.

Ext.chart.AbstractChart
view source

## getItemsForPoint ( x , y ) : Array

Given an x/y point relative to the chart, find and return all series items that match that point.

### Parameters

x : Number

y : Number

### Returns

:Array

An array of objects with series and `item` properties.

Ext.chart.AbstractChart
view source

## getLegendStore : Ext.chart.legend.store.Store

Return the legend store that contains all the legend information. This information is collected from all the series.

### Returns

:Ext.chart.legend.store.Store
Ext.chart.AbstractChart
view source

## getRefItems ( deep ) : Array
private pri

### Parameters

deep : Boolean

### Returns

:Array
Ext.draw.Container
view source

## getSurface ( [id] ) : Ext.draw.Surface

Get a surface by the given id or create one if it doesn't exist. This will automatically call the resizeHandler. Which means that, if no custom resize handler has been provided, the surface will be sized to match the container. If the add method is used, it is the responsibility of the user to call the handleResize method, to update the size of all added surfaces.

### Parameters

id : String (optional)

Defaults to: "main"

### Returns

:Ext.draw.Surface
Ext.draw.Container
view source

## handleResize ( size , instantly )

Triggers the resizeHandler with the size of the draw container element as the parameter.

### Parameters

size : Object

instantly : Object

Ext.chart.AbstractChart
view source

## onDataChanged
private pri

Ext.chart.CartesianChart
view source

## performLayout

Layout the axes and series.

Ext.draw.Container
view source

## preview

Displays an image of a Ext.draw.Container on screen. On mobile devices this lets users tap-and-hold to bring up the menu with image saving options. Notes:

- some browsers won't save the preview image if it's SVG based (i.e. generated from a draw container that uses 'Ext.draw.engine.Svg' engine);
- some platforms may not have the means of viewing successfully saved SVG images;
- this method does not work on IE8.

Ext.chart.AbstractChart
view source

## processData
private pri

Ext.chart.AbstractChart
view source

## redraw

Redraw the chart. If animations are set this will animate the chart too.

Ext.chart.AbstractChart
view source

## refreshBackground ( surface , newBackground , oldBackground ) : Ext.draw.sprite.Rect / Ext.draw.sprite.Sprite
private pri

The background updater. Used by both the chart and the sprite legend.

### Parameters

surface : Object

The surface to put the background in.

newBackground : Object

oldBackground : Object

### Returns

:Ext.draw.sprite.Rect / Ext.draw.sprite.Sprite
Ext.chart.AbstractChart
view source

## removeSeries ( series )

Remove a Ext.chart.series.Series from this chart. The Series (or array) passed will be removed from the existing series.

The chart will be redrawn in response to the change.

### Parameters

series : Ext.chart.series.Series / String

The Series or the `id` of the Series to remove. May be an array.

Ext.draw.Container
view source

## renderFrame

Render all the surfaces in the container.

Ext.chart.AbstractChart
view source

## resumeChartLayout

Decrements chart's layout suspend count. When the suspend count is decremented to zero, a layout is scheduled.

Ext.chart.AbstractChart
view source

## resumeThicknessChanged

Decrements axis thickness suspend count. When axis thickness suspend count is decremented to zero, chart layout is performed.

Ext.chart.AbstractChart
view source

## scheduleLayout

Schedule a layout at next frame.

Ext.chart.AbstractChart
view source

## suspendChartLayout

Suspends chart's layout.

Ext.chart.AbstractChart
view source

## suspendThicknessChanged

Prevent axes from triggering chart layout when their thickness changes. E.g. during an interaction that makes changes to the axes, or when chart layout was triggered by something else, for example a chart resize event.

## events

Ext.chart.AbstractChart
view source

## beforerefresh ( this , eOpts )

Fires before a refresh to the chart data is called. If the beforerefresh handler returns `false` the refresh action will be canceled.

### Parameters

this : Ext.chart.AbstractChart

eOpts : Object

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

Ext.draw.Container
view source

## bodyresize ( size , eOpts )

Fires when the size of the draw container body changes.

### Parameters

size : Object

The object containing 'width' and 'height' of the draw container's body.

eOpts : Object

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

Ext.chart.AbstractChart
view source

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

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

### Parameters

chart : Ext.chart.AbstractChart

item : Object

event : Event

eOpts : Object

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

Ext.chart.AbstractChart
view source

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

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

### Parameters

chart : Ext.chart.AbstractChart

item : Object

event : Event

eOpts : Object

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

Ext.chart.AbstractChart
view source

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

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

### Parameters

chart : Ext.chart.AbstractChart

item : Object

event : Event

eOpts : Object

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

Ext.chart.AbstractChart
view source

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

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

### Parameters

chart : Ext.chart.AbstractChart

item : Object

event : Event

eOpts : Object

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

Ext.chart.AbstractChart
view source

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

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

### Parameters

chart : Ext.chart.AbstractChart

item : Object

event : Event

eOpts : Object

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

Ext.chart.AbstractChart
view source

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

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

### Parameters

chart : Ext.chart.AbstractChart

item : Object

event : Event

eOpts : Object

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

Ext.chart.AbstractChart
view source

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

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

### Parameters

chart : Ext.chart.AbstractChart

item : Object

event : Event

eOpts : Object

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

Ext.chart.AbstractChart
view source

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

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

### Parameters

chart : Ext.chart.AbstractChart

item : Object

event : Event

eOpts : Object

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

Ext.chart.AbstractChart
view source

## redraw ( this , eOpts )

Fires after the chart is redrawn.

### Parameters

this : Ext.chart.AbstractChart

eOpts : Object

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

Ext.chart.AbstractChart
view source

## refresh ( this , eOpts )

Fires after the chart data has been refreshed.

### Parameters

this : Ext.chart.AbstractChart

eOpts : Object

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

Ext.draw.Container
view source

## spriteclick ( sprite , event , eOpts )

Fires when a click event occurs on a sprite.

### Parameters

sprite : Object

event : Event

eOpts : Object

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

Ext.draw.Container
view source

## spritedblclick ( sprite , event , eOpts )

Fires when a double click event occurs on a sprite.

### Parameters

sprite : Object

event : Event

eOpts : Object

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

Ext.draw.Container
view source

## spritemousedown ( sprite , event , eOpts )

Fires when a mousedown event occurs on a sprite.

### Parameters

sprite : Object

event : Event

eOpts : Object

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

Ext.draw.Container
view source

## spritemousemove ( sprite , event , eOpts )

Fires when the mouse is moved on a sprite.

### Parameters

sprite : Object

event : Event

eOpts : Object

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

Ext.draw.Container
view source

## spritemouseout ( sprite , event , eOpts )

Fires when the mouse exits a sprite.

### Parameters

sprite : Object

event : Event

eOpts : Object

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

Ext.draw.Container
view source

## spritemouseover ( sprite , event , eOpts )

Fires when the mouse enters a sprite.

### Parameters

sprite : Object

event : Event

eOpts : Object

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

Ext.draw.Container
view source

## spritemouseup ( sprite , event , eOpts )

Fires when a mouseup event occurs on a sprite.

### Parameters

sprite : Object

event : Event

eOpts : Object

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

Ext.draw.Container
view source

## spritetap ( sprite , event , eOpts )

Fires when a tap event occurs on a sprite.

### Parameters

sprite : Object

event : Event

eOpts : Object

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

Ext.chart.AbstractChart
view source

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

Fires when the store of the chart changes.

### Parameters

chart : Ext.chart.AbstractChart

newStore : Ext.data.Store

oldStore : Ext.data.Store

eOpts : Object

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

## Ext JS 6.2.0 - Modern Toolkit

## Ext JS

### 6.x

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

### 5.x

5.1.3 5.1.2 5.1.1 5.1.0 5.0.1 5.0.0

### 4.x

4.2.5 4.1.3 4.0.7

### 3.x

3.4.0

## Sencha Test

Sencha Test

## Cmd

Cmd

## GXT

4.x 3.x

## IDE Plugins

IDE Plugins

## Sencha Inspector

Sencha Inspector

## Architect

Architect 3 Architect 4 EA

## Touch

### 2.x

Touch 2.4 Touch 2.3 Touch 2.2 Touch 2.0

## Web Application Manager

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