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


top

NPM Package

@extjs/ext-react-exporter

Hierarchy

NOTE: This is a private utility class for internal use by the framework. Don't rely on its existence.

Summary

Represents a set of selected fields and selected items within those fields.

(CT_PivotAreaReference)

No members found using the current filters

configs

Optional Configs

autoGenerateId : Boolean

Set to true to auto generate an id if none is defined.

Defaults to:

true

getAutoGenerateId : Boolean

Returns the value of autoGenerateId

Returns

Boolean

setAutoGenerateId (autoGenerateId)

Sets the value of autoGenerateId

Parameters

autoGenerateId :  Boolean

avgSubtotal : Boolean

Specifies a boolean value that indicates whether the 'average' aggregate function is included in the filter.

A value of 1 or true indicates the average aggregation function is included in the filter.

A value of 0 or false indicates another aggregation function is included in the filter.

Defaults to:

null

getAvgSubtotal : Boolean

Returns the value of avgSubtotal

Returns

Boolean

setAvgSubtotal (avgSubtotal)

Sets the value of avgSubtotal

Parameters

avgSubtotal :  Boolean

byPosition : Boolean

Specifies a boolean value that indicates whether the item is referred to by position rather than item index.

A value of 1 or true indicates the item is referred to by position.

A value of 0 or false indicates the item is referred to by index.

Defaults to:

null

getByPosition : Boolean

Returns the value of byPosition

Returns

Boolean

setByPosition (byPosition)

Sets the value of byPosition

Parameters

byPosition :  Boolean

count : Number

Specifies the number of item indexes in the collection of indexes (x tags).

Defaults to:

null

getCount : Number

Returns the value of count

Returns

Number

setCount (count)

Sets the value of count

Parameters

count :  Number

countASubtotal : Boolean

Specifies a boolean value that indicates whether the 'countA' subtotal is included in the filter.

A value of 1 or true indicates the count aggregation function is included in the filter.

A value of 0 or false indicates another aggregation function is included in the filter.

Defaults to:

null

getCountASubtotal : Boolean

Returns the value of countASubtotal

Returns

Boolean

setCountASubtotal (countASubtotal)

Sets the value of countASubtotal

Parameters

countASubtotal :  Boolean

countSubtotal : Boolean

Specifies a boolean value that indicates whether the count aggregate function is included in the filter.

A value of 1 or true indicates the count aggregation function is included in the filter.

A value of 0 or false indicates another aggregation function is included in the filter.

Defaults to:

null

getCountSubtotal : Boolean

Returns the value of countSubtotal

Returns

Boolean

setCountSubtotal (countSubtotal)

Sets the value of countSubtotal

Parameters

countSubtotal :  Boolean

defaultSubtotal : Boolean

Specifies a boolean value that indicates whether the default subtotal is included in the filter.

A value of 1 or true indicates the default subtotal is included in the filter. The default is to display the total or the grand total.

A value of 0 or false indicates another subtotal or aggregation function is included in the filter.

Defaults to:

null

getDefaultSubtotal : Boolean

Returns the value of defaultSubtotal

Returns

Boolean

setDefaultSubtotal (defaultSubtotal)

Sets the value of defaultSubtotal

Parameters

defaultSubtotal :  Boolean

field : Number

Specifies the index of the field to which this filter refers. A value of -2 indicates the 'data' field.

Defaults to:

null

getField : Number

Returns the value of field

Returns

Number

setField (field)

Sets the value of field

Parameters

field :  Number

generateTplAttributes

Note Do not rename the config names that are part of the attributes since they are mapped to the xml attributes needed by the template.

Defaults to:

true

id : String

Unique id for this object. Auto generated when missing.

Defaults to:

null

getId : String

Returns the value of id

Returns

String

setId (id)

Sets the value of id

Parameters

id :  String

items : Number[]

Selected items within the selected fields.

Defaults to:

[]

getItems : Number[]

Returns the value of items

Returns

Number[]

setItems (items)

Sets the value of items

Parameters

items :  Number[]

maxSubtotal : Boolean

Specifies a boolean value that indicates whether the 'maximum' aggregate function is included in the filter.

A value of 1 or true indicates the maximum aggregation function is included in the filter.

A value of 0 or false indicates another aggregation function is included in the filter.

Defaults to:

null

getMaxSubtotal : Boolean

Returns the value of maxSubtotal

Returns

Boolean

setMaxSubtotal (maxSubtotal)

Sets the value of maxSubtotal

Parameters

maxSubtotal :  Boolean

minSubtotal : Boolean

Specifies a boolean value that indicates whether the 'minimum' aggregate function is included in the filter.

A value of 1 or true indicates the minimum aggregation function is included in the filter.

A value of 0 or false indicates another aggregation function is included in the filter.

Defaults to:

null

getMinSubtotal : Boolean

Returns the value of minSubtotal

Returns

Boolean

setMinSubtotal (minSubtotal)

Sets the value of minSubtotal

Parameters

minSubtotal :  Boolean

productSubtotal : Boolean

Specifies a boolean value that indicates whether the 'product' aggregate function is included in the filter.

A value of 1 or true indicates the product aggregation function is included in the filter.

A value of 0 or false indicates another aggregation function is included in the filter.

Defaults to:

null

getProductSubtotal : Boolean

Returns the value of productSubtotal

Returns

Boolean

setProductSubtotal (productSubtotal)

Sets the value of productSubtotal

Parameters

productSubtotal :  Boolean

relative : Boolean

Specifies a boolean value that indicates whether the item is referred to by a relative reference rather than an absolute reference. This attribute is used if posRef is set to true.

A value of 1 or true indicates the item is referred to by a relative reference.

A value of 0 or false indicates the item is referred to by an absolute reference.

Defaults to:

null

getRelative : Boolean

Returns the value of relative

Returns

Boolean

setRelative (relative)

Sets the value of relative

Parameters

relative :  Boolean

selected : Boolean

Specifies a boolean value that indicates whether this field has selection. This attribute is used when the PivotTable is in Outline view. It is also used when both header and data cells have selection.

A value of 1 or true indicates the field has selection.

A value of 0 or false indicates the field does not have selection.

Defaults to:

null

getSelected : Boolean

Returns the value of selected

Returns

Boolean

setSelected (selected)

Sets the value of selected

Parameters

selected :  Boolean

stdDevPSubtotal : Boolean

Specifies a boolean value that indicates whether the population standard deviation aggregate function is included in the filter.

A value of 1 or true indicates the population standard deviation aggregation function is included in the filter.

A value of 0 or false indicates another aggregation function is included in the filter.

Defaults to:

null

getStdDevPSubtotal : Boolean

Returns the value of stdDevPSubtotal

Returns

Boolean

setStdDevPSubtotal (stdDevPSubtotal)

Sets the value of stdDevPSubtotal

Parameters

stdDevPSubtotal :  Boolean

stdDevSubtotal : Boolean

Specifies a boolean value that indicates whether the standard deviation aggregate function is included in the filter.

A value of 1 or true indicates the standard deviation aggregation function is included in the filter.

A value of 0 or false indicates another aggregation function is included in the filter.

Defaults to:

null

getStdDevSubtotal : Boolean

Returns the value of stdDevSubtotal

Returns

Boolean

setStdDevSubtotal (stdDevSubtotal)

Sets the value of stdDevSubtotal

Parameters

stdDevSubtotal :  Boolean

sumSubtotal : Boolean

Specifies a boolean value that indicates whether the sum aggregate function is included in the filter.

A value of 1 or true indicates the sum aggregation function is included in the filter.

A value of 0 or false indicates another aggregation function is included in the filter.

Defaults to:

null

getSumSubtotal : Boolean

Returns the value of sumSubtotal

Returns

Boolean

setSumSubtotal (sumSubtotal)

Sets the value of sumSubtotal

Parameters

sumSubtotal :  Boolean

varPSubtotal : Boolean

Specifies a boolean value that indicates whether the population variance aggregate function is included in the filter.

A value of 1 or true indicates the population variance aggregation function is included in the filter.

A value of 0 or false indicates another aggregation function is included in the filter.

Defaults to:

null

getVarPSubtotal : Boolean

Returns the value of varPSubtotal

Returns

Boolean

setVarPSubtotal (varPSubtotal)

Sets the value of varPSubtotal

Parameters

varPSubtotal :  Boolean

varSubtotal : Boolean

Specifies a boolean value that indicates whether the variance aggregate function is included in the filter.

A value of 1 or true indicates the variance aggregation function is included in the filter.

A value of 0 or false indicates another aggregation function is included in the filter.

Defaults to:

null

getVarSubtotal : Boolean

Returns the value of varSubtotal

Returns

Boolean

setVarSubtotal (varSubtotal)

Sets the value of varSubtotal

Parameters

varSubtotal :  Boolean

properties

methods

Instance Methods

checkCollection ( data, dataCollection, className ) : Ext.util.Collection

This method could be used in config appliers that need to initialize a Collection that has items of type className.

Parameters

data :  Object

dataCollection :  Object

className :  Object

Returns

:Ext.util.Collection

getRenderData Object

Return the data used when rendering the template

Returns

:Object

render String

Renders the content according to the template provided to the class

Returns

:String
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.5.0