ExtReact Docs Help

Introduction

The documentation for the ExtReact product diverges somewhat from the documentation of other Sencha products. The sections below describe documentation for all products except where indicated as unique to ExtReact.

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.

ExtReact component classes list the configurable name prominently at the top of the API class doc followed by the fully-qualified class name.

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

Or in the case of an ExtReact component class this indicates a member of type prop

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

ExtReact component classes do not hoist the getter / setter methods into the prop. All methods will be described in the Methods section

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:

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.

ExtReact 6.7.0


top

Ext.util.TaskRunner

NPM Package

@sencha/ext-react

Hierarchy

Ext.Base
Ext.util.TaskRunner

Summary

Provides the ability to execute one or more arbitrary tasks in an asynchronous manner.

Generally, you can use the singleton Ext.TaskManager. Or you can create separate TaskRunner instances to start and stop unique tasks independent of one another.

To end a running task:

 task.destroy();

If a task needs to be started and stopped repeated over time, you can create a Ext.util.TaskRunner.Task instance.

var runner = new Ext.util.TaskRunner(),
    task;

task = runner.newTask({
    run: function() {
        // useful code
    },
    interval: 1000
});

task.start();

// ...

task.stop();

// ...

task.start();

A re-usable, single-run task can be managed similar to the above:

var runner = new Ext.util.TaskRunner(),
    task;

task = runner.newTask({
    run: function() {
        // useful code
    },
    interval: 1000,
    repeat: 1
});

task.start();

// ...

task.stop();

// ...

task.start();

See the start method for details about how to configure a Task.

Also see Ext.util.DelayedTask.

No members found using the current filters

configs

Optional Configs

fireIdleEvent : Boolean

This may be configured false to inhibit firing of the idle event after task invocation. By default the tasks run in a given tick determine whether idle events fire.

Defaults to:

null

fireIdleEvent : Boolean

This may be configured false to inhibit firing of the idle event after task invocation.

Defaults to:

true

interval : Number

How often to run the task in milliseconds. Defaults to every 10ms.

Defaults to:

10

interval : Number

How often to run the task in milliseconds. Defaults to every 10ms.

Defaults to:

10

properties

Instance Properties

timerId
private pri

The id of the current timer.

Defaults to:

null

methods

Instance Methods

constructor ( [interval] )

Parameters

interval :  Number/Object (optional)

The minimum precision in milliseconds supported by this TaskRunner instance. Alternatively, a config object to apply to the new instance.

Defaults to: 10

constructor ( [interval] )

Parameters

interval :  Number/Object (optional)

The minimum precision in milliseconds supported by this TaskRunner instance. Alternatively, a config object to apply to the new instance.

Defaults to: 10

destroy

Destroys this instance, stopping all tasks that are currently running.

destroy

Destroys this instance, stopping all tasks that are currently running.

newTask ( config ) : Ext.util.TaskRunner.Task

Creates a new Ext.util.TaskRunner.Task instance. These instances can be easily started and stopped.

Parameters

config :  Object

The config object. For details on the supported properties, see start.

Returns

:Ext.util.TaskRunner.Task

Ext.util.TaskRunner.Task instance, which can be useful for method chaining.

newTask ( config ) : Ext.util.TaskRunner.Task

Creates a new Ext.util.TaskRunner.Task instance. These instances can be easily started and stopped.

Parameters

config :  Object

The config object. For details on the supported properties, see start.

Returns

:Ext.util.TaskRunner.Task

Ext.util.TaskRunner.Task instance, which can be useful for method chaining.

start ( task )

Starts a new task.

Before each invocation, Ext injects the property taskRunCount into the task object so that calculations based on the repeat count can be performed.

The returned task will contain a destroy method that can be used to destroy the task and cancel further calls. This is equivalent to the stop method.

Parameters

task :  Object

A config object that supports the following properties:

run :  Function

The function to execute each time the task is invoked. The function will be called at each interval and passed the args argument if specified, and the current invocation count if not.

If a particular scope (this reference) is required, be sure to specify it using the scope argument.

return :  Boolean

false from this function to terminate the task.

onError :  Function

The function to execute in case of unhandled error on task.run.

interval :  Number

The frequency in milliseconds with which the task should be invoked.

args :  Object[] (optional)

An array of arguments to be passed to the function specified by run. If not specified, the current invocation count is passed.

addCountToArgs :  Boolean (optional)

True to add the current invocation count as one of the arguments of args. Note: This only takes effect when args is specified.

Defaults to:

false

scope :  Object (optional)

The scope (this reference) in which to execute the run function. Defaults to the task config object.

duration :  Number (optional)

The length of time in milliseconds to invoke the task before stopping automatically (defaults to indefinite).

repeat :  Number (optional)

The number of times to invoke the task before stopping automatically (defaults to indefinite).

fireIdleEvent :  Number (optional)

If all tasks in a TaskRunner's execution sweep are configured with fireIdleEvent: false, then the idle event is not fired when the TaskRunner's execution sweep finishes.

Defaults to:

true

fireOnStart :  Boolean (optional)

True to run the task immediately instead of waiting for the interval's initial pass to call the run function.

Defaults to:

false

start ( task )

Starts a new task.

Before each invocation, Ext injects the property taskRunCount into the task object so that calculations based on the repeat count can be performed.

The returned task will contain a destroy method that can be used to destroy the task and cancel further calls. This is equivalent to the stop method.

Parameters

task :  Object

A config object that supports the following properties:

run :  Function

The function to execute each time the task is invoked. The function will be called at each interval and passed the args argument if specified, and the current invocation count if not.

If a particular scope (this reference) is required, be sure to specify it using the scope argument.

return :  Boolean

false from this function to terminate the task.

onError :  Function

The function to execute in case of unhandled error on task.run.

interval :  Number

The frequency in milliseconds with which the task should be invoked.

args :  Object[] (optional)

An array of arguments to be passed to the function specified by run. If not specified, the current invocation count is passed.

addCountToArgs :  Boolean (optional)

True to add the current invocation count as one of the arguments of args. Note: This only takes effect when args is specified.

Defaults to:

false

scope :  Object (optional)

The scope (this reference) in which to execute the run function. Defaults to the task config object.

duration :  Number (optional)

The length of time in milliseconds to invoke the task before stopping automatically (defaults to indefinite).

repeat :  Number (optional)

The number of times to invoke the task before stopping automatically (defaults to indefinite).

fireIdleEvent :  Number (optional)

If all tasks in a TaskRunner's execution sweep are configured with fireIdleEvent: false, then the idleEvent is not fired when the TaskRunner's execution sweep finishes.

Defaults to:

true

fireOnStart :  Boolean (optional)

True to run the task immediately instead of waiting for the interval's initial pass to call the run function.

Defaults to:

false

startTimer ( timeout, now )
private pri

Parameters

timeout :  Object

now :  Object

stop ( task, andRemove ) : Object

Stops an existing running task.

Parameters

task :  Object

The task to stop.

andRemove :  Boolean

Pass true to also remove the task from the queue.

Returns

:Object

The task

stop ( task, andRemove ) : Object

Stops an existing running task.

Parameters

task :  Object

The task to stop.

andRemove :  Boolean

Pass true to also remove the task from the queue.

Returns

:Object

The task

stopAll ( andRemove )

Stops all tasks that are currently running.

Parameters

andRemove :  Boolean

Pass true to also remove the tasks from the queue.

stopAll ( andRemove )

Stops all tasks that are currently running.

Parameters

andRemove :  Boolean

Pass true to also remove the tasks from the queue.

Static Methods

override ( members ) : Ext.Base
static sta

Override members of this class. Overridden methods can be invoked via Ext.Base#callParent.

Ext.define('My.Cat', {
    constructor: function() {
        alert("I'm a cat!");
    }
});

My.Cat.override({
    constructor: function() {
        alert("I'm going to be a cat!");

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                          // alerts "I'm a cat!"
                          // alerts "Meeeeoooowwww"

Direct use of this method should be rare. Use Ext.define instead:

Ext.define('My.CatOverride', {
    override: 'My.Cat',
    constructor: function() {
        alert("I'm going to be a cat!");

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).

Parameters

members :  Object

The properties to add to this class. This should be specified as an object literal containing one or more properties.

Returns

:Ext.Base

this class

ExtReact 6.7.0