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.
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.
static
label next to the
method name. *See Static below.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).
Let's look at each part of the member row:
lookupComponent
in this example)( item )
in this example)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
).PROTECTED
in
this example - see the Flags section below)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.view source
in the example)item : Object
in the example).undefined
a "Returns" section
will note the type of class or object returned and a description (Ext.Component
in the
example)Available since 3.4.0
- not pictured in
the example) just after the member descriptionDefaults to: false
)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.
classInstance.method1().method2().etc();
false
is returned from
an event handler- 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
- 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
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.
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.
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.
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, inheritance, and read only. This is done using the checkboxes at the top of the page.
The checkbox at the bottom of the API class navigation tree filters the class list to include or exclude private classes.
Clicking on an empty search field will show your last 10 searches for quick navigation.
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:
Ext.button.Button
class has an alternate class name of Ext.Button
). Alternate class
names are commonly maintained for backward compatibility.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.
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:
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.
Contains information about features supported in the current environment as well as bugs detected.
Accessibility features.
Defaults to:
'accessibility'
Images : Boolean
true
if the browser is configured
to display images.
BackgroundImages : Boolean
true
if the browser
is configured to display background images.
BorderColors : Boolean
true
if the browser
is configured to honor CSS styling for border colors.
LightOnDark : Boolean
true
if the browser
is currently using reverse colors in light-on-dark accessibility mode.
true
if the browser fires focus events (focus, blur, focusin, focusout)
asynchronously, i.e. in a separate event loop invocation. This is only true
for all versions Internet Explorer; Microsoft Edge and other browsers fire
focus events synchronously.
Defaults to:
'AsyncFocusEvents'
true
if the device supports the HTML5 audio
tag.
This property is available at application boot time, before document ready.
true
if the device supports the HTML5 audio
tag.
Defaults to:
[ 'Audio', 'AudioTag' ]
Deprecated since version 5.0.0
Use Audio instead.
true
if the browser supports the getBoundingClientRect
method on elements
This property is available at application boot time, before document ready.
Defaults to:
'BoundingClientRect'
Feature detect the support of browsers that are unable to scroll elements that are the same height as the native scrollbar height.
Defaults to:
'CannotScrollExactHeight'
true
if the device supports Canvas.
This property is available at application boot time, before document ready.
Defaults to:
'Canvas'
true
if created child elements
lose their innerHTML when modifying the innerHTML of the parent element.
This property is NOT available at application boot time. Only after the document ready event.
Defaults to:
'ChildContentClearedWhenSettingInnerHTML'
true
if document environment supports the HTML5
classList API.
This property is available at application boot time, before document ready.
Defaults to:
'ClassList'
true
if the native DOM cloneNode method copies
expando properties to the newly cloned node.
This property is available at application boot time, before document ready.
Defaults to:
'CloneNodeCopiesExpando'
true
if the browser supports
document.defaultView.getComputedStyle().
This property is NOT available at application boot time. Only after the document ready event.
Defaults to:
'ComputedStyle'
true
if browser support CreateContextualFragment
range native methods.
See https://developer.mozilla.org/en/DOM/range.createContextualFragment
This property is available at application boot time, before document ready.
Defaults to:
'CreateContextualFragment'
true
if the device supports CSS3 border radius.
This property is NOT available at application boot time. Only after the document ready event.
Defaults to:
'CSS3BorderRadius'
true
if document environment supports the CSS3
box-shadow style.
This property is available at application boot time, before document ready.
Defaults to:
'CSS3BoxShadow'
true
if the device supports CSS3DTransform.
This property is available at application boot time, before document ready.
Defaults to:
'Css3dTransforms'
true
if the device supports CSS3 linear gradients.
This property is available at application boot time, before document ready.
Defaults to:
'CSS3LinearGradient'
true
if document environment supports the CSS3
pointer-events style.
This property is available at application boot time, before document ready.
Defaults to:
'CSSPointerEvents'
true
if the device supports device motion (acceleration
and rotation rate).
This property is available at application boot time, before document ready.
Defaults to:
'DeviceMotion'
true
if when asking for an element's dimension via offsetWidth
or offsetHeight, getBoundingClientRect, etc. the browser returns the subpixel width
rounded to the nearest pixel.
This property is available at application boot time, before document ready.
Defaults to:
'Direct2DBug'
true
if INPUT elements lose their
selection when their display style is changed. Essentially, if a text input
has focus and its display style is changed, the I-beam disappears.
This bug is encountered due to the work around in place for the RightMargin bug. This has been observed in Safari 4.0.4 and older, and appears to be fixed in Safari 5. It's not clear if Safari 4.1 has the bug, but it has the same WebKit version number as Safari 5 (according to http://unixpapa.com/js/gecko.html).
This property is available at application boot time, before document ready.
Defaults to:
'DisplayChangeInputSelectionBug'
true
if TEXTAREA elements lose their
selection when their display style is changed. Essentially, if a text area has
focus and its display style is changed, the I-beam disappears.
This bug is encountered due to the work around in place for the RightMargin bug. This has been observed in Chrome 10 and Safari 5 and older, and appears to be fixed in Chrome 11.
This property is available at application boot time, before document ready.
Defaults to:
'DisplayChangeTextAreaSelectionBug'
True if the browser emulates a mouseover event on tap (mobile safari)
This property is available at application boot time, before document ready.
Defaults to:
'EmulatedMouseOver'
true
if the browser has this bug: https://bugs.webkit.org/show_bug.cgi?id=130239
This property is NOT available at application boot time. Only after the document ready event.
Defaults to:
'FixedTableWidthBug'
Allows align: stretch to align items to the height of the tallest item in an auto-heighted hbox layout. can't use flex-basis: auto everywhere because it breaks percentage-sized children https://bugs.chromium.org/p/chromium/issues/detail?id=680484
Defaults to:
'FlexBoxBasisBug'
true
if the device supports CSS float.
This property is available at application boot time, before document ready.
Defaults to:
'Float'
true
if the browser supports focusin and focusout events:
https://developer.mozilla.org/en-US/docs/Web/Events/focusin
At this point, only Firefox does not, see this bug:
https://bugzilla.mozilla.org/show_bug.cgi?id=687787
This property is available at application boot time, before document ready.
Defaults to:
'FocusinFocusoutEvents'
true
if the device supports GeoLocation.
This property is available at application boot time, before document ready.
true
if the device supports Geo-location.
Defaults to:
[ 'Geolocation', 'GeoLocation' ]
Deprecated since version 5.0.0
Use Geolocation instead (notice the lower-casing of 'L').
true
if the browser will return the
left/top/right/bottom position as a percentage when explicitly set as a percentage value.
This property is NOT available at application boot time. Only after the document ready event.
True if the user agent supports the hashchange event
This property is available at application boot time, before document ready.
true
if the device supports HTML5 history. See
https://developer.mozilla.org/en/DOM/Manipulating_the_browser_history
This property is available at application boot time, before document ready.
Defaults to:
'History'
true
if localStorage is supported.
This property is available at application boot time, before document ready.
Defaults to:
'LocalStorage'
The method name which matches an element against a selector if implemented in this environment.
This property is available at application boot time, before document ready.
Defaults to:
'matchesSelector'
true
if the browser supports mouseenter and mouseleave events
This property is available at application boot time, before document ready.
Defaults to:
'MouseEnterLeave'
true
if the browser supports the mousewheel event
This property is available at application boot time, before document ready.
Defaults to:
'MouseWheel'
true
if the browser supports placeholders
on numeric input fields
This property is available at application boot time, before document ready.
Defaults to:
'NumericInputPlaceHolder'
true
if the browser supports normal css opacity
This property is available at application boot time, before document ready.
Defaults to:
'Opacity'
true
if the device supports different orientations.
This property is available at application boot time, before document ready.
Defaults to:
'Orientation'
true
if the device supports the orientationchange
event.
This property is available at application boot time, before document ready.
Defaults to:
'OrientationChange'
Detects support for the "passive" event listener option
Defaults to:
'PassiveEventListener'
In some browsers (IE quirks, IE6, IE7, IE9, chrome, safari and opera at the time of this writing) a percentage-height element ignores the horizontal scrollbar of its parent element. This method returns true if the browser is affected by this bug.
This property is NOT available at application boot time. Only after the document ready event.
Defaults to:
'PercentageHeightOverflowBug'
Detects https://bugs.webkit.org/show_bug.cgi?id=137730
Defaults to:
'PercentageSizeFlexBug'
true
if the browser supports the HTML5 placeholder attribute
on inputs
This property is available at application boot time, before document ready.
Defaults to:
'Placeholder'
true
If the event system should use pointer events.
Currently only set to true if the browser supports pointer events and does not
also support touch events. Touch events are preferred since they allow run-time
cancellation of browser default behavior such as scrolling by invoking
e.preventDefault()
whereas pointer events require such intentions to be declared
in advance via CSS touch-action.
This means that when pointer events are used, certain interactions are not possible
such as long-press to drag within a scrollable element.
Defaults to:
'PointerEvents'
true
if browser support document.createRange native method.
See https://developer.mozilla.org/en/DOM/range.
This property is available at application boot time, before document ready.
Defaults to:
'Range'
true
if the device supports right margin.
See https://bugs.webkit.org/show_bug.cgi?id=13343 for why this is needed.
This property is NOT available at application boot time. Only after the document ready event.
Defaults to:
'RightMargin'
true
if the BoundingClientRect is
rotated when the element is rotated using a CSS transform.
This property is NOT available at application boot time. Only after the document ready event.
Defaults to:
'RotatedBoundingClientRect'
Safari, in RTL mode keeps the scrollbar at the right side. This means that when two elements must keep their left/right positions synched, if one has no vert scrollbar, it must have some extra padding. See https://sencha.jira.com/browse/EXTJSIV-11245
This property is NOT available at application boot time. Only after the document ready event.
Defaults to:
'rtlVertScrollbarOnRight'
In Chrome, in RTL mode, horizontal overflow only into the vertical scrollbar does NOT trigger horizontal scrollability. See https://code.google.com/p/chromium/issues/detail?id=179332 We need to detect this for when a grid header needs to have exactly the same horizontal scrolling range as its table view. See Ext.grid.ColumnLayout#publishInnerCtSize TODO: Remove this when all supported Chrome versions are fixed.
This property is NOT available at application boot time. Only after the document ready event.
Defaults to:
'rtlVertScrollbarOverflowBug'
In some browsers the right padding of an overflowing element is not accounted for in its scrollWidth. The result can vary depending on whether or not The element contains block-level children. This method tests the effect of padding on scrollWidth when there are no block-level children inside the overflowing element.
This method returns true if the browser is affected by this bug.
This property is NOT available at application boot time. Only after the document ready event.
Defaults to:
'ScrollWidthInlinePaddingBug'
true
if the browser supports the CSS selector API level 2.
https://dev.w3.org/2006/webapi/selectors-api2/
Defaults to:
'Selectors2'
True if the browser fires the keydown event on specialkey autorepeat
note 1: IE fires ONLY the keydown event on specialkey autorepeat note 2: Safari < 3.1, Gecko (Mac/Linux) & Opera fire only the keypress event on specialkey autorepeat (research done by Jan Wolter at http://unixpapa.com/js/key.html) note 3: Opera 12 behaves like other modern browsers so this workaround does not work anymore
This property is available at application boot time, before document ready.
Defaults to:
'SpecialKeyDownRepeat'
true
if the device supports SVG.
This property is available at application boot time, before document ready.
Defaults to:
'Svg'
true
if the browser supports maxlength on textareas.
This property is available at application boot time, before document ready.
Defaults to:
'TextAreaMaxLength'
true
if the browser supports touch input.
This property is available at application boot time, before document ready.
Defaults to:
'Touch'
A bit flag representing which property values the browser recognizes as valid
values of the CSS touch-action
property.
panX 1 "00000001"
panY 2 "00000010"
pinchZoom 4 "00000100"
doubleTapZoom 8 "00001000"
Defaults to:
'TouchAction'
true
if the device supports touch events (touchstart
, touchmove
, touchend
).
This property is available at application boot time, before document ready.
Defaults to:
'TouchEvents'
true
if the device supports CSS3 Transitions.
This property is available at application boot time, before document ready.
Defaults to:
[ 'CssTransitions', 'Transitions' ]
Bug for Edge logged here: https://developer.microsoft.com/en-us/microsoft-edge/platform/issues/9743268/
Defaults to:
'TranslateYCausesHorizontalScroll'
true
if the device supports transparent color.
This property is NOT available at application boot time. Only after the document ready event.
Defaults to:
'TransparentColor'
true
if the device supports the HTML5 video
tag.
This property is available at application boot time, before document ready.
Defaults to:
'Video'
true
if the device supports VML.
This property is available at application boot time, before document ready.
Defaults to:
'Vml'
Detects the following bug: https://bugs.webkit.org/show_bug.cgi?id=137693
Feb 22, 2017: This bug used to affect chrome as well, but appears to be fixed in Chrome 56. The issue still exists in safari 10
Defaults to:
'WebKitInputTableBoxModelBug'
true
if the browser supports XMLHttpRequest
This property is available at application boot time, before document ready.
Defaults to:
'XHR2'
true
if the browser supports XMLHttpRequest
upload progress info
This property is available at application boot time, before document ready.
Defaults to:
'XHRUploadProgress'
true
if the browsers supports querySelector
and querySelectorAll methods on XML nodes.
This property is available at application boot time, before document ready.
Defaults to:
'XmlQuerySelector'
In Chrome 24.0, an RTL element which has vertical overflow positions its right X origin incorrectly. It skips a non-existent scrollbar which has been moved to the left edge due to the RTL setting.
http://code.google.com/p/chromium/issues/detail?id=174656
This method returns true if the browser is affected by this bug.
This property is NOT available at application boot time. Only after the document ready event.
Defaults to:
'xOriginBug'