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.calendar.model.Event 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.calendar.model.Event

### Hierarchy

Ext.Base
Ext.data.Model
Ext.calendar.model.Event

### Mixins

Ext.calendar.model.EventBase

### Inherited Mixins

Ext.Mixin
Ext.calendar.model.EventBase

### Requires

Ext.data.field.String
Ext.data.field.Integer
Ext.data.field.Date
Ext.data.field.Boolean

## Summary

The default implementation for am event model. All fields are accessed via the getter/setter API to allow for custom model implementations.

## Fields

The following fields are provided:

- title : {String} - Maps to getTitle and setTitle.
- calendarId : {Object} - Maps to getCalendarId and setCalendarId.
- description : {String} - Maps to getDescription and setDescription.
- startDate : {Date} - Maps to getStartDate and getStartDate.
- endDate : {Date} - Maps to getEndDate and getEndDate.
- allDay : {Boolean} - Maps to getAllDay and setAllDay.

No members found using the current filters

## configs

Ext.data.Model
view source

## associations : Object[]
deprecated dep

An array of Ext.data.schema.Association for this model.

For further documentation, see Ext.data.schema.Association.

Deprecated: 6.2.0
Use `hasMany/hasOne/belongsTo`.

Ext.data.Model
view source

## belongsTo : String / Object / String[] / Object[]

One or more `Ext.data.schema.BelongsTo` associations for this model.

Ext.data.Model
view source

## clientIdProperty : String

The name of the property a server will use to send back a client-generated id in a create or `update` Ext.data.operation.Operation.

If specified, this property cannot have the same name as any other field.

For example:

Sample Code

     Ext.define('Person', {
         idProperty: 'id',  // this is the default value (for clarity)

         clientIdProperty: 'clientId',

         identifier: 'negative', // to generate -1, -2 etc on the client

         fields: [ 'name' ]
     });

     var person = new Person({
         // no id provided, so -1 is generated
         name: 'Clark Kent'
     });

The server is given this data during the create:

Sample Code

     {
         id: -1,
         name: 'Clark Kent'
     }

The server allocates a real id and responds like so:

Sample Code

     {
         id: 427,
         clientId: -1
     }

This property is most useful when creating multiple entities in a single call to the server in a Ext.data.operation.Create. Alternatively, the server could respond with records that correspond one-to-one to those sent in the `operation`.

For example the client could send a create with this data:

Sample Code

     [ { id: -1, name: 'Clark Kent' },
       { id: -2, name: 'Peter Parker' },
       { id: -3, name: 'Bruce Banner' } ]

And the server could respond in the same order:

Sample Code

     [ { id: 427 },      // updates id = -1
       { id: 428 },      // updates id = -2
       { id: 429 } ]     // updates id = -3

Or using clientIdProperty the server could respond in arbitrary order:

Sample Code

     [ { id: 427, clientId: -3 },
       { id: 428, clientId: -1 },
       { id: 429, clientId: -2 } ]

IMPORTANT: When upgrading from previous versions be aware that this property used to perform the role of Ext.data.writer.Writer#clientIdProperty as well as that described above. To continue send a client-generated id as other than the idProperty, set clientIdProperty on the `writer`. A better solution, however, is most likely a properly configured identifier as that would work better with associations.

Defaults to: null

Ext.data.Model
view source

## convertOnSet : Boolean

Set to `false` to prevent any converters from being called on fields specified in a set operation.

Note: Setting the config to `false` will only prevent the convert / calculate call when the set `fieldName` param matches the field's name. In the following example the calls to set `salary` will not execute the convert method on set while the calls to set `vested` will execute the convert method on the initial read as well as on set.

Example model definition:

Sample Code

    Ext.define('MyApp.model.Employee', {
        extend: 'Ext.data.Model',
        fields: ['yearsOfService', {
            name: 'salary',
            convert: function (val) {
                var startingBonus = val * .1;
                return val + startingBonus;
            }
        }, {
            name: 'vested',
            convert: function (val, record) {
                return record.get('yearsOfService') >= 4;
            },
            depends: 'yearsOfService'
        }],
        convertOnSet: false
    });

    var tina = Ext.create('MyApp.model.Employee', {
        salary: 50000,
        yearsOfService: 3
    });

    console.log(tina.get('salary')); // logs 55000
    console.log(tina.get('vested')); // logs false

    tina.set({
        salary: 60000,
        yearsOfService: 4
    });
    console.log(tina.get('salary')); // logs 60000
    console.log(tina.get('vested')); // logs true

Defaults to: true

Ext.data.Model
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.

Ext.data.Model
view source

## getFields : Ext.data.field.Field[]

Get the fields array for this model.

### Returns

:Ext.data.field.Field[]

The fields array

Ext.data.Model
view source

## hasMany : String / Object / String[] / Object[]

One or more Ext.data.schema.HasMany associations for this model.

Ext.data.Model
view source

## hasOne : String / Object / String[] / Object[]

One or more Ext.data.schema.HasOne associations for this model.

Ext.data.Model
view source

## identifier : String / Object

The id generator to use for this model. The identifier generates values for the idProperty when no value is given. Records with client-side generated values for idProperty are called phantom records since they are not yet known to the server.

This can be overridden at the model level to provide a custom generator for a model. The simplest form of this would be:

Sample Code

     Ext.define('MyApp.data.MyModel', {
         extend: 'Ext.data.Model',
         requires: ['Ext.data.identifier.Sequential'],
         identifier: 'sequential',
         ...
     });

The above would generate Ext.data.identifier.Sequential id's such as 1, 2, 3 etc..

Another useful id generator is Ext.data.identifier.Uuid:

Sample Code

     Ext.define('MyApp.data.MyModel', {
         extend: 'Ext.data.Model',
         requires: ['Ext.data.identifier.Uuid'],
         identifier: 'uuid',
         ...
     });

An id generator can also be further configured:

Sample Code

     Ext.define('MyApp.data.MyModel', {
         extend: 'Ext.data.Model',
         identifier: {
             type: 'sequential',
             seed: 1000,
             prefix: 'ID_'
         }
     });

The above would generate id's such as ID_1000, ID_1001, ID_1002 etc..

If multiple models share an id space, a single generator can be shared:

Sample Code

     Ext.define('MyApp.data.MyModelX', {
         extend: 'Ext.data.Model',
         identifier: {
             type: 'sequential',
             id: 'xy'
         }
     });

     Ext.define('MyApp.data.MyModelY', {
         extend: 'Ext.data.Model',
         identifier: {
             type: 'sequential',
             id: 'xy'
         }
     });

For more complex, shared id generators, a custom generator is the best approach. See Ext.data.identifier.Generator for details on creating custom id generators.

Defaults to: null

Ext.data.Model
view source

## idProperty : String

The name of the field treated as this Model's unique id.

If changing the idProperty in a subclass, the generated id field will replace the one generated by the superclass, for example;

Sample Code

     Ext.define('Super', {
         extend: 'Ext.data.Model',
         fields: ['name']
     });

     Ext.define('Sub', {
         extend: 'Super',
         idProperty: 'customId'
     });

     var fields = Super.getFields();
     // Has 2 fields, "name" & "id"
     console.log(fields[0].name, fields[1].name, fields.length);

     fields = Sub.getFields();
     // Has 2 fields, "name" & "customId", "id" is replaced
     console.log(fields[0].name, fields[1].name, fields.length);

The data values for this field must be unique or there will be id value collisions in the Ext.data.Store.

Defaults to: 'id'

Ext.data.Model
view source

## getIdProperty : String

Get the idProperty for this model.

### Returns

:String

The idProperty

Ext.data.Model
view source

## manyToMany : Object

A config object for a Ext.data.schema.ManyToMany association. See the class description for Ext.data.schema.ManyToMany for configuration examples.

Defaults to: null

Ext.data.Model
view source

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

The Ext.data.proxy.Proxy to use for this class.

Ext.data.Model
view source

## getProxy : Ext.data.proxy.Proxy

Returns the configured Proxy for this Model.

### Returns

:Ext.data.proxy.Proxy

The proxy

Ext.data.Model
view source

## schema : String / Object

The name of the Ext.data.schema.Schema to which this entity and its associations belong. For details on custom schemas see Ext.data.schema.Schema.

Defaults to: 'default'

Ext.data.Model
view source

## validationSeparator : String

If specified this property is used to concatenate multiple errors for each field as reported by the validators.

Defaults to: null

Ext.data.Model
view source

## validators : Object[]

An array of Ext.data.validator.Validator for this model.

Ext.data.Model
view source

## versionProperty : String

If specified, this is the name of the property that contains the entity "version". The version property is used to manage a long-running transaction and allows the detection of simultaneous modification.

The way a version property is used is that the client receives the version as it would any other entity property. When saving an entity, this property is always included in the request and the server uses the value in a "conditional update". If the current version of the entity on the server matches the version property sent by the client, the update is allowed. Otherwise, the update fails.

On successful update, both the client and server increment the version. This is done on the server in the conditional update and on the client when it receives a success on its update request.

Defaults to: null

## properties

Ext.Base
view source

## $className
private pri

Defaults to: 'Ext.Base'

Ext.Base
view source

## $configPrefixed : Boolean
private pri

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

Defaults to: true

Available since: 5.0.0

Ext.Base
view source

## $configStrict : Boolean
private pri

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

Defaults to: true

Available since: 5.0.0

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

## crudState : "C" / "R" / "U" / "D"
readonly ro protected pro

This value is initially "R" or "C" indicating the initial CRUD state. As the record changes and the various joined parties (stores, sessions, etc.) are notified this value is updated prior to these calls. In other words, the joined parties are notified after the crudState is updated. This means that the crudState property may be briefly out of sync with underlying changes if this state is used outside of these notifications.

The possible states have these meanings:

- "R" - The record is in a cleanly retrieved (unmodified) state.
- "C" - The record is in a newly created (phantom) state.
- "U" - The record is in an updated, modified (dirty) state.
- "D" - The record is in a dropped state.

Defaults to: 'R'

Available since: 6.2.0

Ext.data.Model
view source

## crudStateWas : "C" / "R" / "U" / "D"
readonly ro protected pro

This value is initially `null` indicating there is no previous CRUD state. As the record changes and the various joined parties (stores, sessions, etc.) are notified this value is updated for the subsequent calls. In other words, the joined parties are notified and then crudStateWas is modified for the next update.

The value of this property has the same meaning as crudState.

Defaults to: null

Available since: 6.2.0

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.Model
view source

## dirty : Boolean
readonly ro

True if this record has been modified.

Defaults to: false

Ext.data.Model
view source

## dropped : Boolean
readonly ro

True if this record is pending delete on the server. This is set by the drop method and transmitted to the server by the save method.

Defaults to: false

Ext.data.Model
view source

## editing : Boolean
readonly ro

Internal flag used to track whether or not the model instance is currently being edited.

Defaults to: false

Ext.data.Model
view source

## entityName : String

The short name of this entity class. This name is derived from the `namespace` of the associated `schema` and this class name. By default, a class is not given a shortened name.

All entities in a given `schema` must have a unique entityName.

For more details see "Relative Naming" in Ext.data.schema.Schema.

Ext.data.Model
view source

## erased : Boolean
readonly ro

True if this record has been erased on the server. This flag is set of the erase method.

Defaults to: false

Ext.data.Model
view source

## fieldOrdinals : Object
readonly ro private pri

This property is indexed by field name and contains the ordinal of that field. The ordinal often has meaning to servers and is derived based on the position in the `fields` array.

This can be used like so:

Sample Code

     Ext.define('MyApp.models.User', {
         extend: 'Ext.data.Model',

         fields: [
             { name: 'name' }
         ]
     });

     var nameOrdinal = MyApp.models.User.fieldOrdinals.name;

     // or, if you have an instance:

     var user = new MyApp.models.User();
     var nameOrdinal = user.fieldOrdinals.name;

Ext.data.Model
view source

## fields : Ext.data.field.Field[]
readonly ro private pri

An array fields defined for this Model (including fields defined in superclasses) in ordinal order; that is in declaration order.

Ext.data.Model
view source

## generation : Number
readonly ro

This property is incremented on each modification of a record.

Defaults to: 1

Available since: 5.0.0

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

## isEntity : Boolean
readonly ro

The value `true` to identify this class and its subclasses.

Defaults to: true

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

## isModel : Boolean
readonly ro

The value `true` to identify this class and its subclasses.

Defaults to: true

Ext.data.Model
view source

## modified : Object

A hash of field values which holds the initial values of fields before a set of edits are committed.

Ext.data.Model
view source

## onIdChanged
private pri

Called when the model id is changed.

Defaults to: Ext.privateFn

### Parameters

id : Object

The new id.

oldId : Object

The old id.

Ext.data.Model
view source

## phantom : Boolean

True when the record does not yet exist in a server-side database. Any record which has a real database identity set as its idProperty is NOT a phantom -- it's real.

Defaults to: false

Ext.data.Model
view source

## previousValues : Object
readonly ro private pri

This object is similar to the modified object except it holds the data values as they were prior to the most recent change.

Ext.data.Model
view source

## schema : Ext.data.schema.Schema
readonly ro

The Ext.data.schema.Schema to which this entity and its associations belong.

Defaults to: 'default'

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.Model
view source

## session : Ext.data.Session
readonly ro

The Ext.data.Session for this record.

Defaults to: null

Ext.data.Model
view source

## store : Ext.data.Store

The Ext.data.Store to which this instance belongs.

Note: If this instance is bound to multiple stores, this property will reference only the first.

Defaults to: item

Ext.Base
view source

## $onExtended
static sta private pri

Defaults to: []

## methods

Ext.data.Model
view source

## abort

Aborts a pending load operation. If the record is not loading, this does nothing.

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.Model
view source

## beginEdit

Begins an edit. While in edit mode, no events (e.g.. the `update` event) are relayed to the containing store. When an edit has begun, it must be followed by either endEdit or cancelEdit.

Ext.data.Model
view source

## callJoined ( funcName , [args] )
private pri

Helper function used by afterEdit, afterReject and afterCommit. Calls the given method on the Ext.data.Store that this instance has joined, if any. The store function will always be called with the model instance as its single argument. If this model is joined to a Ext.data.NodeStore, then this method calls the given method on the NodeStore and the associated Ext.data.TreeStore.

### Parameters

funcName : String

The name function to call on each store.

args : Array (optional)

The arguments to pass to the method. This instance is always inserted as the first argument.

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.Model
view source

## cancelEdit

Cancels all changes made in the current edit operation.

Ext.data.Model
view source

## clone ( [session] ) : Ext.data.Model

Creates a clone of this record. States like dropped, phantom and dirty are all preserved in the cloned record.

### Parameters

session : Ext.data.Session (optional)

The session to which the new record belongs.

### Returns

:Ext.data.Model

The cloned record.

Ext.data.Model
view source

## commit ( [silent] , [modifiedFieldNames] )

Usually called by the Ext.data.Store which owns the model instance. Commits all changes made to the instance since either creation or the last commit operation.

Developers should subscribe to the Ext.data.Store#update event to have their code notified of commit operations.

### Parameters

silent : Boolean (optional)

Pass `true` to skip notification of the owning store of the change.

Defaults to: false

modifiedFieldNames : String[] (optional)

Array of field names changed during sync with server if known. Omit or pass `null` if unknown. An empty array means that it is known that no fields were modified by the server's response. Defaults to false.

Ext.calendar.model.EventBase
view source

## containsRange ( end ) : Boolean

Checks if this event fully contains a date range.

### Parameters

end : Date

The end date. This is not required if a range is passed for start.

### Returns

:Boolean

`true` if this event contains a date range.

Ext.data.Model
view source

## copy ( [newId] , [session] ) : Ext.data.Model

Creates a clean copy of this record. The returned record will not consider any its fields as modified.

To generate a phantom instance with a new id pass `null`:

Sample Code

    var rec = record.copy(null); // clone the record but no id (one is generated)

### Parameters

newId : String (optional)

A new id, defaults to the id of the instance being copied. See idProperty.

session : Ext.data.Session (optional)

The session to which the new record belongs.

### Returns

:Ext.data.Model
Ext.data.Model
view source

## copyFrom ( sourceRecord ) : String[]
private pri

Copies data from the passed record into this record. If the passed record is undefined, does nothing.

If this is a phantom record (represented only in the client, with no corresponding database entry), and the source record is not a phantom, then this record acquires the id of the source record.

### Parameters

sourceRecord : Ext.data.Model

The record to copy data from.

### Returns

:String[]

The names of the fields which changed value.

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.Model
view source

## drop ( [cascade] )

Marks this record as dropped and waiting to be deleted on the server. When a record is dropped, it is automatically removed from all association stores and any child records associated to this record are also dropped (a "cascade delete") depending on the `cascade` parameter.

Available since: 5.0.0

### Parameters

cascade : Boolean (optional)

Pass `false` to disable the cascade to drop child records.

Defaults to: true

Ext.data.Model
view source

## endEdit ( [silent] , [modifiedFieldNames] )

Ends an edit. If any data was modified, the containing store is notified (ie, the store's `update` event will fire).

### Parameters

silent : Boolean (optional)

True to not notify any stores of the change.

modifiedFieldNames : String[] (optional)

Array of field names changed during edit.

Ext.data.Model
view source

## erase ( options ) : Ext.data.operation.Destroy

Destroys the model using the configured proxy. The erase action is asynchronous. Any processing of the erased record should be done in a callback.

Sample Code

    Ext.define('MyApp.model.User', {
        extend: 'Ext.data.Model',
        fields: [
            {name: 'id', type: 'int'},
            {name: 'name', type: 'string'}
        ],
        proxy: {
            type: 'ajax',
            url: 'server.url'
        }
    });

    var user = new MyApp.model.User({
        name: 'Foo'
    });

    // pass the phantom record data to the server to be saved
    user.save({
        success: function(record, operation) {
            // do something if the save succeeded
            // erase the created record
            record.erase({
                failure: function(record, operation) {
                    // do something if the erase failed
                },
                success: function(record, operation) {
                    // do something if the erase succeeded
                },
                callback: function(record, operation, success) {
                    // do something if the erase succeeded or failed
                }
            });
        }
    });

NOTE: If a phantom record is erased it will not be processed via the proxy. However, any passed `success` or `callback` functions will be called.

The options param is an Ext.data.operation.Destroy config object containing success, failure and callback functions, plus optional scope.

### Parameters

options : Object

### Returns

:Ext.data.operation.Destroy

The destroy operation

Ext.data.Model
view source

## get ( fieldName ) : Object

Returns the value of the given field.

### Parameters

fieldName : String

The name of the field.

### Returns

:Object

The value of the specified field.

Ext.calendar.model.EventBase
view source

## getAllDay : Boolean
abstract abs

Gets whether this event is an all day event.

### Returns

:Boolean

`true` if this is an all day event.

Ext.data.Model
view source

## getAssociatedData ( [result] , [options] ) : Object

Gets all of the data from this Models loaded associations. It does this recursively. For example if we have a User which hasMany Orders, and each Order hasMany OrderItems, it will return an object like this:

Sample Code

    {
        orders: [
            {
                id: 123,
                status: 'shipped',
                orderItems: [
                    ...
                ]
            }
        ]
    }

### Parameters

result : Object (optional)

The object on to which the associations will be added. If no object is passed one is created. This object is then returned.

options : Boolean< / a> / Object< / a> (optional)

An object containing options describing the data desired.

associated : Boolean (optional)

Pass `true` to include associated data from other associated records.

Defaults to: true

changes : Boolean (optional)

Pass `true` to only include fields that have been modified. Note that field modifications are only tracked for fields that are not declared with `persist` set to `false`. In other words, only persistent fields have changes tracked so passing `true` for this means `options.persist` is redundant.

Defaults to: false

critical : Boolean (optional)

Pass `true` to include fields set as `critical`. This is only meaningful when `options.changes` is `true` since critical fields may not have been modified.

persist : Boolean (optional)

Pass `true` to only return persistent fields. This is implied when `options.changes` is set to `true`.

serialize : Boolean (optional)

Pass `true` to invoke the `serialize` method on the returned fields.

Defaults to: false

### Returns

:Object

The nested data set for the Model's loaded associations.

Ext.calendar.model.EventBase
view source

## getCalendar : Ext.calendar.model.Calendar

Get the calendar for this event.

### Returns

:Ext.calendar.model.Calendar

The calendar, `null` if it does not exist.

Ext.calendar.model.EventBase
view source

## getCalendarId : Object
abstract abs

Get the id for the calendar this event belongs to.

### Returns

:Object

The id.

Ext.data.Model
view source

## getChanges : Object

Gets an object of only the fields that have been modified since this record was created or committed. Only persistent fields are tracked in the modified set so this method will only return changes to persistent fields.

For more control over the returned data, see getData.

### Returns

:Object
Ext.calendar.model.EventBase
view source

## getColor : String
abstract abs

Get a specified color for this event.

### Returns

:String

The color.

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.Model
view source

## getCriticalFields : Ext.data.field.Field[]

Returns the array of fields that are declared as critical (must always send).

### Returns

:Ext.data.field.Field[]
Ext.Base
view source

## getCurrentConfig
private pri

Ext.data.Model
view source

## getData ( [options] ) : Object

Gets all values for each field in this model and returns an object containing the current data. This can be tuned by passing an `options` object with various properties describing the desired result. Passing `true` simply returns all fields and all associated record data.

### Parameters

options : Boolean< / a> / Object< / a> (optional)

An object containing options describing the data desired. If `true` is passed it is treated as an object with `associated` set to `true`.

associated : Boolean (optional)

Pass `true` to include associated data. This is equivalent to pass `true` as the only argument. See getAssociatedData.

Defaults to: false

changes : Boolean (optional)

Pass `true` to only include fields that have been modified. Note that field modifications are only tracked for fields that are not declared with `persist` set to `false`. In other words, only persistent fields have changes tracked so passing `true` for this means `options.persist` is redundant.

Defaults to: false

critical : Boolean (optional)

Pass `true` to include fields set as `critical`. This is only meaningful when `options.changes` is `true` since critical fields may not have been modified.

persist : Boolean (optional)

Pass `true` to only return persistent fields. This is implied when `options.changes` is set to `true`.

serialize : Boolean (optional)

Pass `true` to invoke the `serialize` method on the returned fields.

Defaults to: false

### Returns

:Object

An object containing all the values in this model.

Ext.calendar.model.EventBase
view source

## getDescription : String
abstract abs

Gets the description for this event.

### Returns

:String

The description.

Ext.calendar.model.EventBase
view source

## getDuration : Number
abstract abs

Get the duration of this event in minutes.

### Returns

:Number

The duration of the event in minutes.

Ext.calendar.model.EventBase
view source

## getEndDate : Date
abstract abs

Get the end date for this event (including time). The date should be UTC.

### Returns

:Date

The end date.

## getFields

see: fields
Ext.data.Model
view source

## getId : Number / String

Returns the unique ID allocated to this model instance as defined by idProperty.

### Returns

:Number / String

The id

## getIdProperty

see: idProperty
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.Model
view source

## getModified ( fieldName ) : Object

Returns the original value of a modified field. If there is no modified value, `undefined` will be return. Also see isModified.

### Parameters

fieldName : String

The name of the field for which to return the original value.

### Returns

:Object

modified

Ext.data.Model
view source

## getModifiedFieldNames ( [old] ) : String[]
private pri

Gets the names of all the fields that were modified during an edit.

### Parameters

old : Object (optional)

The saved data from beginEdit.

### Returns

:String[]

The array of modified field names.

Ext.data.Model
view source

## getObservableId
protected pro

Return a unique observable ID. Model is not observable but tree nodes (Ext.data.NodeInterface) are, so they must be globally unique within the observableType.

Ext.data.Model
view source

## getPrevious ( fieldName ) : Object

This method returns the value of a field given its name prior to its most recent change.

### Parameters

fieldName : String

The field's name.

### Returns

:Object

The value of the given field prior to its current value. `undefined` if there is no previous value;

## getProxy

see: proxy
Ext.calendar.model.EventBase
view source

## getRange : Ext.calendar.date.Range

Gets a range for this event,

### Returns

:Ext.calendar.date.Range

The range.

Ext.calendar.model.EventBase
view source

## getStartDate : Date
abstract abs

Get the start date for this event (including time). The date should be UTC.

### Returns

:Date

The start date.

Ext.calendar.model.EventBase
view source

## getTitle : String
abstract abs

Get the title for this event.

### Returns

:String

The title.

Ext.data.Model
view source

## getTransientFields : Ext.data.field.Field[]

Returns the array of fields that are declared as non-persist or "transient".

Available since: 5.0.0

### Returns

:Ext.data.field.Field[]
Ext.data.Model
view source

## getValidation ( [refresh] ) : Ext.data.Validation

Returns the Ext.data.Validation record holding the results of this record's validators. This record is lazily created on first request and is then kept on this record to be updated later.

See the class description for more about validators.

Available since: 5.0.0

### Parameters

refresh : Boolean (optional)

Pass `false` to not call the `refresh` method on the validation instance prior to returning it. Pass `true` to force a `refresh` of the validation instance. By default the returned record is only refreshed if changes have been made to this record.

### Returns

:Ext.data.Validation

The `Validation` record for this record.

Ext.Base
view source

## hasConfig ( config )
private pri

### Parameters

config : Object

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.calendar.model.EventBase
view source

## isContainedByRange ( end ) : Boolean

Checks if this event is fully contained by the passed range.

### Parameters

end : Date

The end date. This is not required if a range is passed for start.

### Returns

:Boolean

`true` if this event is fully contained by the passed range.

Ext.calendar.model.EventBase
view source

## isEditable
abstract abs

Checks if this event is editable. This means that it can be removed or modified via the UI.

Ext.data.Model
view source

## isEqual ( lhs , rhs ) : Boolean
private pri

Checks if two values are equal, taking into account certain special factors, for example dates.

### Parameters

lhs : Object

The first value.

rhs : Object

The second value.

### Returns

:Boolean

True if the values are equal.

Ext.data.Model
view source

## isLoading : Boolean

Checks whether this model is loading data from the proxy.

### Returns

:Boolean

`true` if in a loading state.

Ext.data.Model
view source

## isModified ( fieldName ) : Boolean

Returns true if the passed field name has been modified since the load or last commit.

### Parameters

fieldName : String

The field's name.

### Returns

:Boolean
Ext.calendar.model.EventBase
view source

## isSpan : Boolean

Checks whether this event spans a full day or more.

### Returns

:Boolean

`true` if the event is an all day event or spans over 24 hours or more.

Ext.data.Model
view source

## isValid : Boolean

Checks if the model is valid. See getValidation.

### Returns

:Boolean

True if the model is valid.

Ext.data.Model
view source

## join ( item )

Tells this model instance that an observer is looking at it.

### Parameters

item : Ext.data.Store

The store to which this model has been added.

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.Model
view source

## load ( [options] ) : Ext.data.operation.Read

Loads the model instance using the configured proxy. The load action is asynchronous. Any processing of the loaded record should be done in a callback.

Sample Code

    Ext.define('MyApp.model.User', {
        extend: 'Ext.data.Model',
        fields: [
            {name: 'id', type: 'int'},
            {name: 'name', type: 'string'}
        ],
        proxy: {
            type: 'ajax',
            url: 'server.url'
        }
    });

    var user = new MyApp.model.User();
    user.load({
        scope: this,
        failure: function(record, operation) {
            // do something if the load failed
        },
        success: function(record, operation) {
            // do something if the load succeeded
        },
        callback: function(record, operation, success) {
            // do something whether the load succeeded or failed
        }
    });

The options param is an Ext.data.operation.Read config object containing success, failure and callback functions, plus optional scope.

### Parameters

options : Object< / a> (optional)

Options to pass to the proxy.

success : Function

A function to be called when the model is processed by the proxy successfully. The callback is passed the following parameters:

record : Ext.data.Model

The record.

operation : Ext.data.operation.Operation

The operation.

failure : Function

A function to be called when the model is unable to be processed by the server. The callback is passed the following parameters:

record : Ext.data.Model

The record.

operation : Ext.data.operation.Operation

The operation.

callback : Function

A function to be called whether the proxy transaction was successful or not. The callback is passed the following parameters:

record : Ext.data.Model

The record.

operation : Ext.data.operation.Operation

The operation.

success : Boolean

`true` if the operation was successful.

scope : Object

The scope in which to execute the callback functions. Defaults to the model instance.

### Returns

:Ext.data.operation.Read

The read operation.

Ext.calendar.model.EventBase
view source

## occursInRange ( end ) : Boolean

Checks if any part of this event occurs within the specified date range.

### Parameters

end : Date

The end date. This is not required if a range is passed for start.

### Returns

:Boolean

`true` if any part of this events occurs in the range.

Ext.data.Model
view source

## onAssociatedRecordSet ( record , role )
private pri

Called when an associated record instance has been set.

### Parameters

record : Ext.data.Model

The record.

role : Ext.data.schema.Role

The role.

Ext.data.Model
view source

## onLoad
template tpl protected pro

This method is called by the Ext.data.reader.Reader after loading a model from the server. This is after processing any inline associations that are available.

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

Ext.data.Model
view source

## reject ( [silent] )

Usually called by the Ext.data.Store to which this model instance has been joined. Rejects all changes made to the model instance since either creation, or the last commit operation. Modified fields are reverted to their original values.

Developers should subscribe to the Ext.data.Store#update event to have their code notified of reject operations.

### Parameters

silent : Boolean (optional)

`true` to skip notification of the owning store of the change.

Defaults to: false

Ext.data.Model
view source

## save ( options ) : Ext.data.operation.Create / Ext.data.operation.Update / Ext.data.operation.Destroy

Saves the model instance using the configured proxy. The save action is asynchronous. Any processing of the saved record should be done in a callback.

Create example:

Sample Code

    Ext.define('MyApp.model.User', {
        extend: 'Ext.data.Model',
        fields: [
            {name: 'id', type: 'int'},
            {name: 'name', type: 'string'}
        ],
        proxy: {
            type: 'ajax',
            url: 'server.url'
        }
    });

    var user = new MyApp.model.User({
        name: 'Foo'
    });

    // pass the phantom record data to the server to be saved
    user.save({
        failure: function(record, operation) {
            // do something if the save failed
        },
        success: function(record, operation) {
            // do something if the save succeeded
        },
        callback: function(record, operation, success) {
            // do something whether the save succeeded or failed
        }
    });

The response from a create operation should include the ID for the newly created record:

Sample Code

    // sample response
    {
        success: true,
        id: 1
    }

    // the id may be nested if the proxy's reader has a rootProperty config
    Ext.define('MyApp.model.User', {
        extend: 'Ext.data.Model',
        proxy: {
            type: 'ajax',
            url: 'server.url',
            reader: {
                type: 'ajax',
                rootProperty: 'data'
            }
        }
    });

    // sample nested response
    {
        success: true,
        data: {
            id: 1
        }
    }

(Create + ) Update example:

Sample Code

    Ext.define('MyApp.model.User', {
        extend: 'Ext.data.Model',
        fields: [
            {name: 'id', type: 'int'},
            {name: 'name', type: 'string'}
        ],
        proxy: {
            type: 'ajax',
            url: 'server.url'
        }
    });

    var user = new MyApp.model.User({
        name: 'Foo'
    });
    user.save({
        success: function(record, operation) {
            record.set('name', 'Bar');
            // updates the remote record via the proxy
            record.save();
        }
    });

(Create + ) Destroy example - see also erase:

Sample Code

    Ext.define('MyApp.model.User', {
        extend: 'Ext.data.Model',
        fields: [
            {name: 'id', type: 'int'},
            {name: 'name', type: 'string'}
        ],
        proxy: {
            type: 'ajax',
            url: 'server.url'
        }
    });

    var user = new MyApp.model.User({
        name: 'Foo'
    });
    user.save({
        success: function(record, operation) {
            record.drop();
            // destroys the remote record via the proxy
            record.save();
        }
    });

NOTE: If a phantom record is dropped and subsequently saved it will not be processed via the proxy. However, any passed `success` or `callback` functions will be called.

The options param is an Operation config object containing success, failure and callback functions, plus optional scope. The type of Operation depends on the state of the model being saved.

- phantom model - Ext.data.operation.Create
- modified model - Ext.data.operation.Update
- dropped model - Ext.data.operation.Destroy

### Parameters

options : Object

### Returns

:Ext.data.operation.Create / Ext.data.operation.Update / Ext.data.operation.Destroy

The operation instance for saving this model. The type of operation returned depends on the model state at the time of the action.

- phantom model - Ext.data.operation.Create
- modified model - Ext.data.operation.Update
- dropped model - Ext.data.operation.Destroy

Ext.data.Model
view source

## set ( fieldName , newValue , [options] ) : String[]

Sets the given field to the given value. For example:

Sample Code

     record.set('name', 'value');

This method can also be passed an object containing multiple values to set at once. For example:

Sample Code

     record.set({
         name: 'value',
         age: 42
     });

The following store events are fired when the modified record belongs to a store:

- beginupdate
- update
- endupdate

### Parameters

fieldName : String / Object

The field to set, or an object containing key/value pairs.

newValue : Object

The value for the field (if `fieldName` is a string).

options : Object< / a> (optional)

Options for governing this update.

convert : Boolean (optional)

Set to `false` to prevent any converters from being called during the set operation. This may be useful when setting a large bunch of raw values.

Defaults to: true

dirty : Boolean (optional)

Pass `false` if the field values are to be understood as non-dirty (fresh from the server). When `true`, this change will be reflected in the modified collection.

Defaults to: true

commit : Boolean (optional)

Pass `true` to call the commit method after setting fields. If this option is passed, the usual after change processing will be bypassed. Commit will be called even if there are no field changes.

Defaults to: false

silent : Boolean (optional)

Pass `true` to suppress notification of any changes made by this call. Use with caution.

Defaults to: false

### Returns

:String[]

The array of modified field names or null if nothing was modified.

Ext.calendar.model.EventBase
view source

## setAllDay ( allDay )

Sets the allDay state of this event.

### Parameters

allDay : Boolean

The allDay value

Ext.calendar.model.EventBase
view source

## setCalendar ( calendar , [dirty] )

Sets the calendar of this event. Also sets the underlying calendar id.

### Parameters

calendar : Ext.calendar.model.Calendar

The calendar.

dirty : Boolean (optional)

`false` to not mark this record as dirty. Useful for inferring a calendar id when doing nested loading.

Defaults to: true

Ext.calendar.model.EventBase
view source

## setCalendarId ( calendarId , [dirty] )
abstract abs

Sets the calendar id for this event.

### Parameters

calendarId : Object

The calendar id.

dirty : Boolean (optional)

`false` to not mark this record as dirty. Useful for inferring a calendar id when doing nested loading.

Defaults to: true

Ext.calendar.model.EventBase
view source

## setColor ( color )
abstract abs

Sets the color for this event.

### Parameters

color : String

The color.

Ext.Base
view source

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

Sets a single/multiple configuration options.

### Parameters

name : String / Object

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

value : Object (optional)

The value to set for the name parameter.

### Returns

:Ext.Base

this

Ext.calendar.model.EventBase
view source

## setData ( A )
abstract abs

Sets the data for this event in bulk.

### Parameters

A : Object

set of key value pairs for this event, matching to the property names, eg:

Sample Code

     {
         color: '#FFF',
         startDate: new Date(),
         descrption: 'Foo',
         title: 'Bar'
     }

Ext.calendar.model.EventBase
view source

## setDescription ( The )
abstract abs

Sets the description for this event.

### Parameters

The : String

description.

Ext.calendar.model.EventBase
view source

## setDuration ( duration )
abstract abs

Sets the duration for this event. Leaves the getStartDate unmodified.

### Parameters

duration : Number

The duration in minutes.

Ext.data.Model
view source

## setId ( id , [options] )

Sets the model instance's id field to the given id.

### Parameters

id : Number / String

The new id.

options : Object (optional)

See set.

Ext.calendar.model.EventBase
view source

## setRange ( range , end )
abstract abs

Sets the start and end date for this event.

### Parameters

range : Ext.calendar.date.Range / Date

The range, or the start date.

end : Date

The end date (if the first parameter was not the range).

Ext.data.Model
view source

## setSession ( session )
private pri

Set the session for this record.

### Parameters

session : Ext.data.Session

The session

Ext.calendar.model.EventBase
view source

## setTitle ( title )
abstract abs

Sets the title for this event.

### Parameters

title : String

The title.

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.Model
view source

## toUrl : String

Returns a url-suitable string for this model instance. By default this just returns the name of the Model class followed by the instance ID - for example an instance of MyApp.model.User with ID 123 will return 'user/123'.

### Returns

:String

The url string for this model instance.

Ext.data.Model
view source

## unjoin ( store )

Tells this model instance that it has been removed from the store.

### Parameters

store : Ext.data.Store

The store from which this model has been removed.

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

## validate : Ext.data.ErrorCollection
deprecated dep

Validates the current data against all of its configured validators. The returned collection holds an object for each reported problem from a `validator`.

### Returns

:Ext.data.ErrorCollection

The errors collection.

Deprecated: 5.0
Use `{@link #method!getValidation getValidation}` instead.

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

## addFields ( newFields )
static sta protected pro

This method adds the given set of fields to this model class.

Available since: 5.0.0

### Parameters

newFields : String[] / Object[]

The new fields to add. Based on the `name` of a field this may replace a previous field definition.

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

## createWithId ( id , data , session )
static sta private pri

### Parameters

id : Object

data : Object

session : Object

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

## getField ( name )
static sta private pri

### Parameters

name : Object

Ext.data.Model
view source

## getFields
static sta private pri

Ext.data.Model
view source

## getFieldsMap
static sta private pri

Ext.data.Model
view source

## getIdFromData ( data )
static sta private pri

### Parameters

data : Object

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

## getProxy : Ext.data.proxy.Proxy
static sta

Returns the configured Proxy for this Model.

### Returns

:Ext.data.proxy.Proxy

The proxy

Ext.data.Model
view source

## load ( id , [options] , [session] ) : Ext.data.Model
static sta

Asynchronously loads a model instance by id. Any processing of the loaded record should be done in a callback.

Sample usage:

Sample Code

    Ext.define('MyApp.User', {
        extend: 'Ext.data.Model',
        fields: [
            {name: 'id', type: 'int'},
            {name: 'name', type: 'string'}
        ]
    });

    MyApp.User.load(10, {
        scope: this,
        failure: function(record, operation) {
            //do something if the load failed
        },
        success: function(record, operation) {
            //do something if the load succeeded
        },
        callback: function(record, operation, success) {
            //do something whether the load succeeded or failed
        }
    });

### Parameters

id : Number / String

The ID of the model to load. NOTE: The model returned must have an ID matching the param in the load request.

options : Object< / a> (optional)

The options param is an Ext.data.operation.Read config object containing success, failure and callback functions, plus optional scope.

success : Function

A function to be called when the model is processed by the proxy successfully. The callback is passed the following parameters:

record : Ext.data.Model

The record.

operation : Ext.data.operation.Operation

The operation.

failure : Function

A function to be called when the model is unable to be processed by the server. The callback is passed the following parameters:

record : Ext.data.Model

The record.

operation : Ext.data.operation.Operation

The operation.

callback : Function

A function to be called whether the proxy transaction was successful or not. The callback is passed the following parameters:

record : Ext.data.Model

The record.

operation : Ext.data.operation.Operation

The operation.

success : Boolean

`true` if the operation was successful.

scope : Object

The scope in which to execute the callback functions. Defaults to the model instance.

session : Ext.data.Session (optional)

The session for this record.

### Returns

:Ext.data.Model

The newly created model. Note that the model will (probably) still be loading once it is returned from this method. To do any post-processing on the data, the appropriate place to do see is in the callback.

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

## removeFields ( removeFields )
static sta protected pro

Removes the given set of fields from this model.

Available since: 5.0.0

### Parameters

removeFields : Boolean / String[]

The names of fields to remove or `true` to remove all existing fields. Removes are processed first followed by adds so if a field name appears in `newFields` as well that field will effectively be added (however, in that case there is no need to include the field in this array).

Ext.data.Model
view source

## replaceFields ( newFields , removeFields )
static sta protected pro

This method replaces the specified set of fields with a given set of new fields. Fields should normally be considered immutable, but if the timing is right (that is, before derived classes are declared), it is permissible to change the fields collection.

Available since: 5.0.0

### Parameters

newFields : String[] / Object[]

The new fields to add. Based on the `name` of a field this may replace a previous field definition.

removeFields : Boolean / String[]

The names of fields to remove or `true` to remove all existing fields. Removes are processed first followed by adds so if a field name appears in `newFields` as well that field will effectively be added (however, in that case there is no need to include the field in this array).

Ext.data.Model
view source

## setProxy ( proxy ) : Ext.data.proxy.Proxy
static sta

Sets the Proxy to use for this model. Accepts any options that can be accepted by Ext.createByAlias.

### Parameters

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

The proxy

### Returns

:Ext.data.proxy.Proxy
Ext.Base
view source

## triggerExtended
static sta private pri

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