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.
Date: Dec 06 2018 Version Number: 2.2.1.83
ORION-2382 - Add "getRecord" API under ST.future.Item for DataViews
ORION-2393 - Add "doubleClick" API for Elements and Components
ORION-2394 - Add "rightClick" API for Elements and Components
ORION-1545 - dblclick event is not played in Ext JS Modern
ORION-1897 - "click()" method is not correctly executed on menuradioitem in IE 11
ORION-2145 - Future API ST.select() and ST.select().expanded() doesn't work with Ext JS 6.5 Modern Toolkit
ORION-2202 - First digit is overwritten when typing more than one digit into inputMask field
ORION-2290 - "timedout" Future API throws TypeError when no events in "player"
ORION-2295 - Assertions after "timedout" Future API are not executed
ORION-2391 - Unable to use "select" or "deselect" APIs on Grids or DataViews in Ext JS 6.5+ Modern Toolkit apps
ORION-2395 - Using "click" API to perform a right-click action doesn't work on WebDriver scenario
ORION-2444 - Using "ST.select().collapse()" API on Ext JS 6.5+ Modern Toolkit app throws "cmp.getUsePicker" error
ORION-2451 - Using "get" Future API on a component can sometimes return value of previous properties when they have no getter
ORION-2454 - Unable to click or double-click on rows/cells in ExtReact grids
ORION-1600 - Update Sauce Labs/BrowserStack API calls to pull in only valid browser/OS combinations
ORION-2369 - Tests failing to run on most Internet Explorer browsers on BrowserStack
ORION-81 - Installing the Sencha Test Archive Server
ORION-83 - Managing Browser Farms and Pools
ORION-84 - Running and reviewing code coverage
ORION-87 - Taking Screenshots and Visual Testing
ORION-90 - Introduction to Unit Testing
ORION-91 - Introduction to Functional Testing
ORION-992 - Sample code of "selected" method is not working within docs
ORION-1313 - Docs needs new screenshots of Sencha Test
ORION-1316 - Code Coverage is not fully documented
ORION-1317 - Carets are not documented
ORION-1318 - Documentation on creating a new scenario is outdated
ORION-1319 - Browser farms are not fully documented
ORION-2438 - Document that scenarios can share the same folder
ORION-2439 - Explain core concepts like "Parking Lot URL", "Test Subject URL", "Project Location URL" in documentation
ORION-2440 - Screenshot API should clearly explain tolerance setting measurement unit
ORION-2442 - Document how additional local browsers can be added
ORION-2463 - Required and Optional flags for STC in documentation are incorrect
ORION-1864 - ST cannot play back a recorded scrollbar box/thumb sequence
ORION-1965 - Scroll on timeField list is not playable
ORION-2049 - IE num-pad operator keys are recorded but need converted in order to playback
ORION-2289 - Unable to set date in Ext JS 4 Date Picker
ORION-2322 - In-Browser Event Recorder does not capture all steps for text-based column filter menu actions
ORION-2345 - Event Recorder screen takes a long time to respond when interacting with lots of components in web browser
ORION-2310 - Some components show as "0 matches" when using Inspect
ORION-2374 - Inspect generates invalid locator when locator attribute value has a comma
ORION-2396 - Upgrade to WebdriverIO 4.13.2
ORION-2399 - Unable to open projects in Sencha Studio or use STC on macOS after installing Safari 12 on High Sierra
ORION-548 - Summary shows pass if I test only failed node
ORION-768 - Project .json parts are deleted randomly
ORION-860 - 'Activate' and 'Start Trial' buttons aren't visible on the reduced size window
ORION-2368 - Unable to create new project with framework included
ORION-2379 - Debugging WebDriver test suite shows an error "Dropping unused variable i" in Dev Tools console
ORION-2415 - Clear the red "Sorry, an error occurred" message bar when clicking "Clear" button
ORION-2422 - Improve the usability of the local browsers screen and address layout inconsistencies
ORION-2450 - Clicking "Save Page Object" button multiple times on a new page object creates duplicate entries in project.json
ORION-270 - Unable to play right-click event on WebDriver scenario
ORION-1059 - Cannot playback right-click event for In-Browser scenario
ORION-2361 - Playback of 'right click' is not working
ORION-2383 - Always show associated element/component locator when a failure occurs during Future API usage
Date: May 30 2018
Version Number: 2.2.0.148
ORION-2074 - itemAt not working correctly with modern infinite lists in Ext JS 6.5.0+
ORION-2207 - ST scripts don't load in Internet Explorer version 9 mode
ORION-2235 - Add Custom Strategy to Core API
ORION-1726 - PivotGrid rowAt() will not work for grids with a large number of rows and buffered rendering
ORION-2052 - ST.future.Element.expect() retrieves value from textfield too early after type()
ORION-2072 - Add displayValue() method for ComboBox
ORION-2136 - "node.up is not a function" fail is observed, when you use rowWith()
ORION-2210 - WebDriver doesn't load ST scripts synchronously
ORION-2269 - reveal() does not always scroll items into view when used multiple times
ORION-2088 - Add Futures API for Slider
ORION-2103 - Add HTML Table API
ORION-2233 - Row/Cell indexes should not depend on "grouping" within table
ORION-2234 - Row/Cell xpath queries don't start from correct context node
ORION-2046 - Implement new styling for Code Tree
ORION-2047 - Add "table of contents" for Code Tree structure
ORION-2105 - Disable Tree view button for non .js files
ORION-2117 - Code completion not turned on when using tree view
ORION-2166 - Code Editor not available on error
ORION-2169 - Functions in test files duplicate items in Code Tree
ORION-2171 - Uncaught error thrown to log when editor fails to show code tree
ORION-2096 - Scroll tree items into view when selected
ORION-2097 - Add indication that "done" needs to be used when async is true
ORION-2115 - Add search for nav tree
ORION-2134 - System error when switching to Tree view
ORION-2144 - Move async checkbox to editor
ORION-2165 - Error banner not dismissed between loads of code tree
ORION-2175 - Allow disabled suites and pending specs
ORION-2133 - Code tree editor will freeze when user delete all text in file and switch to code tree view
ORION-2146 EventRecorder hangs when recording after bad step
ORION-1869 - Incorrect locators for radio group causing multiple items error
ORION-2090 - Error appears when user use InBrowser Event Recorder
ORION-2257 - Interacting with modern grid menus throws errors in Event Recorder
ORION-2270 - Event Recorder doesn't work properly with Ext.ux.form.ItemSelector
ORION-2297 - Scroll on Combo is not playable
ORION-1481 - Recording of slider change doesn't work
ORION-1751 - Locator for colorpicker is not stable in inBrowser event recorder.
ORION-1893 - Header checkbox click coordinates are miscalculated when recording
ORION-1964 - Select day on calendar is not playable
ORION-1977 - dblclick doesn't trigger grid cell editing
ORION-2068 - Grid trigger is not recorded properly for IE and Edge
ORION-2305 - Using In-Browser event recorder can cause Ajax requests in app to slow down or timeout
ORION-2320 - Event Recorder not generating specific enough locator for Combobox's Boundlist on Ext JS 4.2.0 app
ORION-2323 - Event Recorder and Inspect not always using custom locator builders for some components
ORION-2131 - Event recorder does not handle some React elements
ORION-2321 - Inspecting or recording CheckBoxField doesn't always create a specific enough locator
ORION-2079 - Determine UX for different inspector scenarios
ORION-2107 - ReferenceError while using Inspector
ORION-2170 - Inspect hierarchy tree steals focus
ORION-2172 - Unavailable pageobject component shows error in tooltip and doesn't show component type
ORION-2173 - inspector does not properly higlights components on IE11 and throws error
ORION-2176 - Inspector doesn't work with Microsoft webdriver on react app
ORION-2179 - Inspector sometimes return Unavailable component
ORION-2232 - Inspect has fatal error when transitioning from non-ext app to ext app
ORION-2268 - Inspector does not load hierarchy until some component is inspected
ORION-2112 - Error when clicking some elements for DomTree
ORION-2114 - Error when refreshing DomTree hierarchy
ORION-2132 - DOM inspector always return "Nothing matches or visible"
ORION-2150 - DOM elements are highlighted on hierarchy tree only on non ExtJS pages/examples
ORION-2154 - Bad wizard query throws error when no matches are found
ORION-2155 - find() and batchQuery() do not account for widgets
ORION-2164 - Inspect doesn't notice when browser being inspected is closed.
ORION-2178 - Inspect returns bad xpath locators in some circumstances
ORION-2187 - Fast clicking elements for Inspect causes freeze in Studio
ORION-2199 - Improve Inspect performance with IE/WebDriver on Windows
ORION-1857 - Inspector window size is too big on Mac
ORION-2160 - Element.getClassMap() fails when the node is a non-HTML element
ORION-2194 - Duplicated component is incorrectly verified
ORION-2212 - Inspect PageObject items dirty, clicking "Insert API Code" button doesn't warn of changes.
ORION-2317 - Inspect grid and Event Recorder combobox are rendering HTML tags within generated locators
ORION-1763 - Error when Inspector is launched and cursor is not placed at "IT"
ORION-2032 - Support ExtReact component casing in Strategy
ORION-2152 - Inspector doesn't highlight elements on keyboard navigation in hierarchy tree
ORION-2158 - Table, slider futures missing in Inspector future type
ORION-2159 - Inspector wizard hierarchy view is not scrolled into selected component on some ReactApp
ORION-2174 - Wrong pop up message is displayed
ORION-2025 - Errors appears when user clicks on Project list before its loaded
ORION-2073 - Cannot open Sencha Studio
ORION-2113 - Specs duplicated when switching between Code and Tree view
ORION-2282 - Highlighting has disappeared on Scenario Results grid
ORION-223 - First run of app asks to update and reload
ORION-2156 - xpath() incorrectly returns an array of elements when ST.options.failOnMultipleMatches is disabled
ORION-2244 - Scrolling in test results during test execution causes errors
ORION-520 - Image miniature is not visible due to unnecesarily long message element
ORION-558 - socket hang up at createHangUpError when running test on remote browsers
ORION-1667 - Error in unit test is not propagate up in studio when run only unit test
ORION-2239 - Links to docs and forum on start page do not direct to external links
ORION-2262 - Test detail isn't removed when "Clear" button is clicked
ORION-2265 - Settings window stays opened when workspace is closed
ORION-2311 - Studio not defaulting to source code view when Developer role selected
ORION-286 - Should prevent generating apps/workspace/themes when no cmd is detected on first start
ORION-336 - Records in Archive Results browser are duplicated after closing and reopening root folder
ORION-1908 - Upgrade Studio to use Ext JS 6.5
ORION-2205 - Upgrade Studio to use Ext JS 6.5.1
ORION-2240 - Runner test results header height is too small
ORION-2241 - Project tree should be wider by default
ORION-2242 - "Continue" button on role selection screen is not visible on default ST window size
ORION-2245 - Prevent project tree toolbar from being hidden
ORION-2261 - Not actual colors of lost connection messagebox
ORION-96 - Orion has 2 shortcuts for Close window
ORION-2264 - Jira integration settings section is stretched
ORION-2267 - Text on Welcome tour is not properly visible
ORION-1260 - Bad global variable fail after test is executed.
ORION-1999 - Disable code coverage button for ExtReact applications
ORION-287 - CLI needs to accept a farm name to resolve ambiguous pool names
ORION-519 - CLI (stc) doesn't show exact version info
ORION-903 - URL must have / at the end of the string
ORION-2231 - Correct the usage of "timer-worker.js"
ORION-489 - Missing framework in workspace navigation tree when generating app in frameworkless workspace
ORION-982 - Unable to build touch app.
ORION-2098 - Development Build process is not generating proper files
ORION-504 - ST wants start app watch although app watch is running
ORION-2253 - App watch task doesn't stop after closing of workspace
ORION-2185 - Special Development Build process is not generating proper files in .sencha/temp/
ORION-2022 - STC creates duplicate Jira tickets when multiple browsers are used in a pool
ORION-2027 - STC includes information about unused -W parameter
ORION-1577 - STC does not scaffold Embedded Farm
ORION-2067 - Include scenario name as top-level suite in TeamCity reports
ORION-2064 - Cannot open Sandbox folder from git as workspace
ORION-2138 - Selenium server does not start
ORION-2012 - Cannot access local archive server results without internet connection
ORION-299 - Can access scenario without URL when tab is pinned
ORION-2034 - Support ExtReact apps in Studio
ORION-2045 - Create icon for ExtReact apps in project tree
ORION-2051 - Upgrade to latest version of webdriverio
ORION-2142 - Keep scenario form open when save occurs because of application blur
ORION-2151 - Disable app watch for ext-react apps in project settings
ORION-1014 - Enable Sencha Cmd or Sencha Test CLI to create ".sencha/temp/app_name" files
ORION-2285 - Google Chrome 62 and 63 compatibility issues
ORION-2286 - Inspector not working with Chrome 62 and 63
ORION-2306 - Using XPath element locator in 2.2.0 throws an error
ORION-2080 - Improve prioritization of locators to always return a unique locator
ORION-2302 - Browser needs to close after the event recorder is finished with
ORION-208 - Settings of browsers pool is not saved if you want to save the setting in workspace folder
ORION-255 - Unable to create/open workspace using Cmd 5.x
ORION-333 - Proxy server is not shown in Tasks tab after clearing results
ORION-1603 - Support require() within WebDriver-based scenario tests
ORION-2089 - Allow extra arguments to be passed to execute()