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 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.
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.
SecureSql Database.
This class should not be created directly but instead should be obtained via
Ext.space.SecureSql.get
Callback function that runs when the database is dropped or closed
Defaults to: null
True if the database has been dropped or closed, in which case object methods will no longer work
Defaults to: false
The most recent transaction promise to have been queued for execution.
Defaults to: null
Promise that fulfills once the database is initialized.
Defaults to: null
table : Object
fields : Object
values : Object
Do any necessary cleanup and mark the object as expired (i.e., any promise-returning methods will immediately reject).
Close this database.
promise that will resolve when the db has been closed.
options : Object< / a>
Database configuration options
name : String
Database name
displayName : String (optional)
Database display name
skipVersionTracking : Boolean (optional)
Set to true to skip creating the schema version table
cleanup : Function (optional)
Function to run after the database is either dropped or closed
Convert results from a normal SQLite result set to a JavaScript array.
results : Object
SQLite result set
array-ified result set
Creates a new Transaction.
Add queries, then execute them in a single database transaction.
var tx = testDatabase.createTransaction();
tx.query("select * from test where id = ?",[2]).then(function(rows) {
// statement done
}).error(function(e) {
Ext.space.Logger.error("Error with query?",e);
});
tx.query("select * from test where id = ?",[1]).then(function(rows) {
// statement done
}).error(function(e) {
Ext.space.Logger.error("Error with query?",e);
});
tx.execute().then(function() {
// transaction done
}).error(function(e) {
Ext.space.Logger.error("Error with TX?",e);
});
Transaction object, or null if the database has been closed or dropped
Permanently delete this database. This operation cannot be undone. All data in this database will be lost.
promise that will resolve when the db has been deleted.
Import data from the file system into the database. The data can either be in CSV (or similar) format, or in the form of a script full of SQL statements.
fileKey : Number
File key of the file from which to import data
type : String
"csv" for delimited text records
tableName : String
Name of the database table to populate (for CSV)
fields : Array
Array of string names of the columns in the file (for CSV)
delimiter : String (optional)
Field delimiter (for CSV), defaults to ","
progressCallback : Function (optional)
Callback function to execute as the import process proceeds; will be passed a single parameter: the number of rows inserted
progressCount : Number (optional)
Interval in milliseconds at which to call the progressCallback
Insert a single record into a table.
You can pass either an array or object into this function:
Array Example:
testDatabase.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
INSERT INTO TABLE test (id, name) VALUES (1, 'one');
Object Example:
testDatabase.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
INSERT INTO TABLE test (id, name) VALUES (2, 'two');
table : String
the name of the table the record will be inserted into
fields : Array
an array of field names to insert.
promise that will resolve when the insert is complete.
Insert a multiple records in a single transaction into a table. Either an array of arrays or objects can be passed into this function
Because this is a transaction either all of inserts will be inserted or no records will be inserted. In the event of a failure the promise will reject with the sql statement that caused the error.
Insert 500 records in a single transaction:
var records = [];
for(var i = 1, l = 500; i <= l; i++){
records.push([i, "row "+ i]);
}
testDatabase.insertMany(TEST_TABLE1, ["id", "name"], records).then(function() {
//Insert complete.
}).error(function(e) {
Ext.space.Logger.error("Error with insert",e);
});
table : String
the name of the table the record will be inserted into
fields : Array
an array of field names to insert.
values : Array
An array of either arrays or objects to insert.
promise that will resolve when the insert is complete.
Generate a list of tables in the current database.
Promise that resolves with an array of table names.
Execute a query against the database in a single transaction.
The returned promise will return 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.
testDatabase.query("select id, name from " + TEST_TABLE1 + " 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);
});
query : String
The SQL statement
fields : Array
The fields of the statement.
promise that will resolve when the query completes
transaction : Object
transactionComplete : Object
Sencha Web Application Manager 6.0.0 | Terms of Use