Docs Help

Terms, Icons, and Labels Access Levels Member Types Member Syntax Member Flags Class Icons Member Icons Navigation and Features Class Member Quick-Nav Menu Getter and Setter Methods History Bar Search and Filters API Doc Class Metadata Expanding and Collapsing Examples and Class Members Desktop -vs- Mobile View Viewing the Class Source

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

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

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 JS 6.6.0 - Modern Toolkit

Show private classes

top

RegExp

Hierarchy

RegExp

Summary

Creates a regular expression object for matching text according to a pattern.

When using the constructor function, the normal string escape rules (preceding special characters with \ when included in a string) are necessary. For example, the following are equivalent:

var re = new RegExp("\\w+");
var re = /\w+/;

Notice that the parameters to the literal format do not use quotation marks to indicate strings, while the parameters to the constructor function do use quotation marks. So the following expressions create the same regular expression:

/ab+c/i;
new RegExp("ab+c", "i");

Special characters in regular expressions

Character	Meaning
`\`	For characters that are usually treated literally, indicates that the next character
	is special and not to be interpreted literally.
	For example, `/b/` matches the character 'b'. By placing a backslash in front of b, that
	is by using `/\b/`, the character becomes special to mean match a word boundary.

	or

	For characters that are usually treated specially, indicates that the next character is
	not special and should be interpreted literally.

	For example, `*` is a special character that means 0 or more occurrences of the preceding
	character should be matched; for example, `/a\/` means match 0 or more "a"s. To match
	literally, precede it with a backslash; for example, `/a\\/` matches 'a'.

`^`	Matches beginning of input. If the multiline flag is set to true, also matches
	immediately after a line break character.

	For example, `/^A/` does not match the 'A' in "an A", but does match the first 'A' in
	"An A".

`$`	Matches end of input. If the multiline flag is set to true, also matches immediately
	before a line break character.

	For example, `/t$/` does not match the 't' in "eater", but does match it in "eat".

`*`	Matches the preceding item 0 or more times.

	For example, `/bo*\/` matches 'boooo' in "A ghost booooed" and 'b' in "A bird warbled",
	but nothing in "A goat grunted".

`+`	Matches the preceding item 1 or more times. Equivalent to `{1,}`.

	For example, `/a+/` matches the 'a' in "candy" and all the a's in "caaaaaaandy".

`?`	Matches the preceding item 0 or 1 time.

	For example, `/e?le?/` matches the 'el' in "angel" and the 'le' in "angle."

	If used immediately after any of the quantifiers `*`, `+`, `?`, or `{}`, makes the quantifier
	non-greedy (matching the minimum number of times), as opposed to the default, which is
	greedy (matching the maximum number of times).

	Also used in lookahead assertions, described under `(?=)`, `(?!)`, and `(?:)` in this table.

`.`	(The decimal point) matches any single character except the newline characters: \n \r
	\u2028 or \u2029. (`[\s\S]` can be used to match any character including new lines.)

	For example, `/.n/` matches 'an' and 'on' in "nay, an apple is on the tree", but not 'nay'.

`(x)`	Matches `x` and remembers the match. These are called capturing parentheses.

	For example, `/(foo)/` matches and remembers 'foo' in "foo bar." The matched substring can
	be recalled from the resulting array's elements `[1], ..., [n]` or from the predefined RegExp
	object's properties `$1, ..., $9`.

`(?:x)`	Matches `x` but does not remember the match. These are called non-capturing parentheses.
	The matched substring can not be recalled from the resulting array's elements `[1], ..., [n]`
	or from the predefined RegExp object's properties `$1, ..., $9`.

`x(?=y)`	Matches `x` only if `x` is followed by `y`. For example, `/Jack(?=Sprat)/` matches 'Jack' only if
	it is followed by 'Sprat'. `/Jack(?=Sprat	Frost)/` matches 'Jack' only if it is followed by
	'Sprat' or 'Frost'. However, neither 'Sprat' nor 'Frost' is part of the match results.

`x(?!y)`	Matches `x` only if `x` is not followed by `y`. For example, `/\d+(?!\.)/` matches a number only
	if it is not followed by a decimal point.

	`/\d+(?!\.)/.exec("3.141")` matches 141 but not 3.141.

`x\|y`	Matches either `x` or `y`.

	For example, `/green	red/` matches 'green' in "green apple" and 'red' in "red apple."

`{n}`	Where `n` is a positive integer. Matches exactly n occurrences of the preceding item.

	For example, `/a{2}/` doesn't match the 'a' in "candy," but it matches all of the a's
	in "caandy," and the first two a's in "caaandy."

`{n,}`	Where `n` is a positive integer. Matches at least n occurrences of the preceding item.

	For example, `/a{2,}/` doesn't match the 'a' in "candy", but matches all of the a's in
	"caandy" and in "caaaaaaandy."

`{n,m}`	Where `n` and `m` are positive integers. Matches at least `n` and at most `m` occurrences of the
	preceding item.

	For example, `/a{1,3}/` matches nothing in "cndy", the 'a' in "candy," the first two a's
	in "caandy," and the first three a's in "caaaaaaandy". Notice that when matching
	"caaaaaaandy", the match is "aaa", even though the original string had more a's in it.

`[xyz]`	A character set. Matches any one of the enclosed characters. You can specify a range of
	characters by using a hyphen.

	For example, `[abcd]` is the same as `[a-d]`. They match the 'b' in "brisket" and the 'c'
	in "chop".

`[^xyz]`	A negated or complemented character set. That is, it matches anything that is not
	enclosed in the brackets. You can specify a range of characters by using a hyphen.

	For example, `[^abc]` is the same as `[^a-c]`. They initially match 'r' in "brisket" and
	'h' in "chop."

`[\b]`	Matches a backspace. (Not to be confused with `\b`.)

`\b`	Matches a word boundary, such as a space. (Not to be confused with `[\b]`.)

	For example, `/\bn\w/` matches the 'no' in "noonday"; `/\wy\b/` matches the 'ly' in
	"possibly yesterday."

`\B`	Matches a non-word boundary.

	For example, `/\w\Bn/` matches 'on' in "noonday", and `/y\B\w/` matches 'ye' in "possibly
	yesterday."

`\cX`	Where X is a letter from A - Z. Matches a control character in a string.

	For example, `/\cM/` matches control-M in a string.

`\d`	Matches a digit character in the basic Latin alphabet. Equivalent to `[0-9]`.

	For example, `/\d/` or `/[0-9]/` matches '2' in "B2 is the suite number."

`\D`	Matches any non-digit character in the basic Latin alphabet. Equivalent to `[^0-9]`.

	For example, `/\D/` or `/[^0-9]/` matches 'B' in "B2 is the suite number.

`\f`	Matches a form-feed.

`\n`	Matches a linefeed.

`\r`	Matches a carriage return.

`\s`	Matches a single white space character, including space, tab, form feed, line feed and
	other unicode spaces. Equivalent to:

	`[\t\n\v\f\r \u00a0\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u200b\u2028\u2029\u3000]`

	For example, `/\s\w*\/` matches ' bar' in "foo bar."

`\S`	Matches a single character other than white space. Equivalent to:

	`[^\t\n\v\f\r \u00a0\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u200b\u2028\u2029\u3000]`

	For example, `/\S\w*\/` matches 'foo' in "foo bar."

`\t`	Matches a tab.

`\v`	Matches a vertical tab.

`\w`	Matches any alphanumeric character from the basic Latin alphabet, including the
	underscore. Equivalent to `[A-Za-z0-9_]`.

	For example, `/\w/` matches 'a' in "apple," '5' in "$5.28," and '3' in "3D."

`\W`	Matches any character that is not a word character from the basic Latin alphabet. Equivalent
	to `[^A-Za-z0-9_]`.

	For example, `/\W/` or `/[^A-Za-z0-9_]/` matches '%' in "50%."

`\n`	Where `n` is a positive integer. A back reference to the last substring matching the n
	parenthetical in the regular expression (counting left parentheses).

	For example, `/apple(,)\sorange\1/` matches 'apple, orange,' in "apple, orange, cherry,
	peach." A more complete example follows this table.

`\0`	Matches a NULL character. Do not follow this with another digit.

`\xhh`	Matches the character with the code `hh` (two hexadecimal digits)

`\uhhhh`	Matches the character with the Unicode value `hhhh` (four hexadecimal digits)

The literal notation provides compilation of the regular expression when the expression is evaluated. Use literal notation when the regular expression will remain constant. For example, if you use literal notation to construct a regular expression used in a loop, the regular expression won't be recompiled on each iteration.

The constructor of the regular expression object, for example, new RegExp("ab+c"), provides runtime compilation of the regular expression. Use the constructor function when you know the regular expression pattern will be changing, or you don't know the pattern and are getting it from another source, such as user input.

Documentation for this class comes from [MDN](https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/RegExp) and is available under [Creative Commons: Attribution-Sharealike license](http://creativecommons.org/licenses/by-sa/2.0/).

No members found using the current filters

properties

Instance Properties

RegExp

view source

global : Boolean

Whether to test the regular expression against all possible matches in a string, or only against the first.

global is a property of an individual regular expression object.

The value of global is true if the "g" flag was used; otherwise, false. The "g" flag indicates that the regular expression should be tested against all possible matches in a string.

You cannot change this property directly.

RegExp

view source

ignoreCase : Boolean

Whether to ignore case while attempting a match in a string.

ignoreCase is a property of an individual regular expression object.

The value of ignoreCase is true if the "i" flag was used; otherwise, false. The "i" flag indicates that case should be ignored while attempting a match in a string.

You cannot change this property directly.

RegExp

view source

lastIndex : Number

The index at which to start the next match. A read/write integer property that specifies the index at which to start the next match.

lastIndex is a property of an individual regular expression object.

This property is set only if the regular expression used the "g" flag to indicate a global search. The following rules apply:

If lastIndex is greater than the length of the string, regexp.test and regexp.exec fail, and lastIndex is set to 0.
If lastIndex is equal to the length of the string and if the regular expression matches the empty string, then the regular expression matches input starting at lastIndex.
If lastIndex is equal to the length of the string and if the regular expression does not match the empty string, then the regular expression mismatches input, and lastIndex is reset to 0.
Otherwise, lastIndex is set to the next position following the most recent match.

For example, consider the following sequence of statements:

re = /(hi)?/g Matches the empty string.
re("hi") Returns ["hi", "hi"] with lastIndex equal to 2.
re("hi") Returns [""], an empty array whose zeroth element is the match string. In this case, the empty string because lastIndex was 2 (and still is 2) and "hi" has length 2.

RegExp

view source

multiline : Boolean

Whether or not to search in strings across multiple lines.

multiline is a property of an individual regular expression object..

The value of multiline is true if the "m" flag was used; otherwise, false. The "m" flag indicates that a multiline input string should be treated as multiple lines. For example, if "m" is used, "^" and "$" change from matching at only the start or end of the entire string to the start or end of any line within the string.

You cannot change this property directly.

RegExp

view source

source : String

The text of the pattern.

A read-only property that contains the text of the pattern, excluding the forward slashes.

source is a property of an individual regular expression object.

You cannot change this property directly.

methods

Instance Methods

RegExp

view source

constructor ( pattern, flags )

Creates new regular expression object.

Parameters

pattern : String

The text of the regular expression.

flags : String

If specified, flags can have any combination of the following values:

"g" - global match
"i" - ignore case
"m" - Treat beginning and end characters (^ and $) as working over multiple lines (i.e., match the beginning or end of each line (delimited by \n or \r), not only the very beginning or end of the whole input string)

RegExp

view source

exec ( str ) : Array

Executes a search for a match in its string parameter.

If the match succeeds, the exec method returns an array and updates properties of the regular expression object. The returned array has the matched text as the first item, and then one item for each capturing parenthesis that matched containing the text that was captured. If the match fails, the exec method returns null.

If you are executing a match simply to find true or false, use the test method or the String search method.

Consider the following example:

// Match one d followed by one or more b's followed by one d
// Remember matched b's and the following d
// Ignore case
var re = /d(b+)(d)/ig;
var result = re.exec("cdbBdbsbz");

The following table shows the results for this script:

Object	Property/Index	Description	Example
`result`		The content of myArray.	`["dbBd", "bB", "d"]`
	`index`	The 0-based index of the match in the string	`1`
	`input`	The original string.	`cdbDdbsbz`
	`[0]`	The last matched characters.	`dbBd`
	`[1], ...[n]`	The parenthesized substring matches, if any. The number of possible	`[1] = bB`
		parenthesized substrings is unlimited.	`[2] = d`
`re`	`lastIndex`	The index at which to start the next match.	`5`
	`ignoreCase`	Indicates the "`i`" flag was used to ignore case.	`true`
	`global`	Indicates the "`g`" flag was used for a global match.	`true`
	`multiline`	Indicates the "`m`" flag was used to search in strings across	`false`
		multiple lines.
	`source`	The text of the pattern.	d(b+)(d)

If your regular expression uses the "g" flag, you can use the exec method multiple times to find successive matches in the same string. When you do so, the search starts at the substring of str specified by the regular expression's lastIndex property (test will also advance the lastIndex property). For example, assume you have this script:

var myRe = /ab*\/g;
var str = "abbcdefabh";
var myArray;
while ((myArray = myRe.exec(str)) != null)
{
    var msg = "Found " + myArray[0] + ".  ";
    msg += "Next match starts at " + myRe.lastIndex;
print(msg);
}

This script displays the following text:

Found abb. Next match starts at 3
Found ab. Next match starts at 9

You can also use exec() without creating a RegExp object:

var matches = /(hello \S+)/.exec('This is a hello world!');
alert(matches[1]);

This will display an alert containing 'hello world!';

Parameters

str : String

The string against which to match the regular expression.

Returns

:Array

Array of results or NULL.

RegExp

view source

test ( str ) : Boolean

Tests for a match in its string parameter.

When you want to know whether a pattern is found in a string use the test method (similar to the String.search method); for more information (but slower execution) use the exec method (similar to the String.match method). As with exec (or in combination with it), test called multiple times on the same global regular expression instance will advance past the previous match.

The following example prints a message which depends on the success of the test:

function testinput(re, str){
    if (re.test(str))
        midstring = " contains ";
    else
        midstring = " does not contain ";
    document.write (str + midstring + re.source);
}

Parameters

str : String

The string against which to match the regular expression.

Returns

:Boolean

true if string contains any matches, otherwise returns false.

RegExp

view source

toString String

Returns a string representing the specified object. Overrides the Object.prototype.toString method.

The RegExp object overrides the toString method of the Object object; it does not inherit Object.toString. For RegExp objects, the toString method returns a string representation of the regular expression.

The following example displays the string value of a RegExp object:

myExp = new RegExp("a+b+c");
alert(myExp.toString());       // displays "/a+b+c/"

Returns

:String

Regular expression as a string.

Contents

Terms, Icons, and Labels

Access Levels

Member Types

Member Syntax

Member Flags

Class Icons

Member Icons

Navigation and Features

Class Member Quick-Nav Menu

Getter and Setter Methods

History Bar

Search and Filters

API Doc Class Metadata

Expanding and Collapsing Examples and Class Members

Desktop -vs- Mobile View

Viewing the Class Source

Ext JS 6.6.0 - Modern Toolkit

RegExp

Hierarchy

Summary

Special characters in regular expressions

properties

global : Boolean

ignoreCase : Boolean

lastIndex : Number

multiline : Boolean

source : String

methods

constructor ( pattern, flags )

Parameters

exec ( str ) : Array

Parameters

Returns

test ( str ) : Boolean

Parameters

Returns

toString String

Returns

Ext JS 6.6.0 - Modern Toolkit