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.

Member Types

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).

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:

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.

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

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:

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:

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.

Sencha Web Application Manager 6.0.0

Guides
API
top
Filters
Related Classes

Summary

A SecureSQL database transaction. See Ext.space.securesql.Database.createTransaction

Queries added to a transaction will be executed as part of a single transaction. Each query returns a promise with the data for the query. The execute statement returns a promise that will resolve when the transaction is complete.

If any of the queries generate an error then the transaction will be rolled back and any data mutations will not be applied to the database. The promise of the query that failed will reject. And the promise returned by execute will also reject.

Sample Code
 var tx = testDatabase.createTransaction();

 tx.query("select * from test where id = ?",[2]).then(function(rows){
     //
 }).error(function(e){
     Ext.space.Logger.error("Error with query?",e);
 });

 tx.query("select * from test where id = ?",[1]).then(function(rows){
     //
 }).error(function(e){
     Ext.space.Logger.error("Error with query?",e);
 });

 tx.execute().then(function(){
     //
 }).error(function(e){
     Ext.space.Logger.error("Error with TX?",e);
 });
No members found using the current filters

properties

began
private pri

Defaults to: false

id
private pri

Defaults to: null

queries
private pri

Defaults to: null

methods

begin : Ext.space.Promise
private pri

Begin executing the transaction.

Returns

:Ext.space.Promise

Promise that resolves when the transaction is ready to begin executing SQL queries.

commit
private pri

Commit the transaction.

create ( config ) : Ext.space.Promise

Create the transaction in the native client.

Parameters

Returns

:
Ext.space.Promise

Promise that resolves when the transaction is created.

execute : Ext.space.Promise

Execute the queries in the transaction.

Returns

:Ext.space.Promise

Promise that resolves if all the queries are successful or rejects if any query fails.

executeStatements
private pri

Execute the SQL statements in this transaction in sequence.

insert ( table , fields , values ) : Ext.space.Promise

Insert a single record into a table. Pass this function an array or object:

  • If an array, then the order of elements in the array must match the order of the fields.
  • If an object, then the field names will be extracted from the properties

Array Example:

Sample Code
 tx.insert('test', ["id", "name"], [1, "one"]).then(function(insertId) {
     //done with insert
     //insertId will be 1 or the auto increment value of the id of the table if the table has one.
 }).error(function(e) {
     Ext.space.Logger.error("Error with insert",e);
 });

would be equivalent to

Sample Code
 INSERT INTO TABLE test (id, name) VALUES (1, 'one');

Object Example:

Sample Code
 tx.insert('test', ["id", "name"], {id: 2, name:"two"}).then(function() {
     //done with insert
     //insertId will be 2 or the auto increment value of the id of the table if the table has one.
 }).error(function(e) {
     Ext.space.Logger.error("Error with insert",e);
 });

would be equivalent to

Sample Code
 INSERT INTO TABLE test (id, name) VALUES (2, 'two');

Parameters

table :  String

the name of the table the record will be inserted into

fields :  Array

an array of field names to insert.

values :  Array / Object

either an array or object to insert.

Returns

:Ext.space.Promise

promise that will resolve when the insert is complete.

query ( query , fields ) : Ext.space.Promise

Add a query this transaction.

The returned promise will provide an array of records that match the query. Each array value will be an object; the object properties will match field names in the query. If the query uses column aliases then the alias will be returned as the field name.

Sample Code
 testDatabase.query("select id, name from test where id = ?",[1]).then(function(rows) {
     var row = rows[0];
     Ext.space.Logger.log("record ",row.id, row.name);
 }).error(function(e) {
     Ext.space.Logger.error("Error with query?",e);
 });

 testDatabase.query("select count(*) as countOfTest from test").then(function(rows) {
     var row = rows[0];
     Ext.space.Logger.log("Count of rows in test ", row.countOfTest);
 }).error(function(e) {
     Ext.space.Logger.error("Error with query?",e);
 });

Parameters

query :  String

The SQL statement

fields :  Array

The fields of the statement.

Returns

:Ext.space.Promise

promise that will resolve when the query completes

rollback ( e )
private pri

Roll back the transaction

Parameters

e :  Object

run : Ext.space.Promise
private pri

Batch executes all queued Sql statements inside a transaction, handling errors and commit/rollback automatically.

Returns

:Ext.space.Promise

The promise that is resolved when the transaction has been committed or rolled back.

sql ( sql , args ) : Ext.space.Promise
private pri

Add a raw SQL statement to this transaction.

This differs from query() in that it will not do any processing on the results returned by the query.

Parameters

sql :  String

The SQL statement to execute. This is required.

args :  Array

The arguments array to bind each "?" placeholder in the Sql statement. This is optional.

Returns

:Ext.space.Promise

The promise that is resolved when the SQL statement has finished executing.

Sencha Web Application Manager 6.0.0

Ext JS
Sencha Test
Cmd
GXT
IDE Plugins
Sencha Inspector
Architect
Touch
Web Application Manager

Sencha Test

Sencha Test

Cmd

Cmd

GXT

4.x 3.x

IDE Plugins

IDE Plugins

Sencha Inspector

Sencha Inspector

Web Application Manager

Web Application Manager