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


top

NPM Package

@extjs/ext-react-exporter
NOTE: This is a private utility class for internal use by the framework. Don't rely on its existence.

Summary

Represent a single field in the PivotCache. This definition contains information about the field, such as its source, data type, and location within a level or hierarchy. The sharedItems element stores additional information about the data in this field. If there are no shared items, then values are stored directly in the pivotCacheRecords part.

(CT_CacheField)

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

caption : String

Specifies the caption of the cache field.

Defaults to:

null

getCaption : String

Returns the value of caption

Returns

String

setCaption (caption)

Sets the value of caption

Parameters

caption :  String

databaseField : Boolean

Specifies a boolean value that indicates whether this field came from the source database rather having been created by the application.

A value of 1 or true indicates the field is from the source database.

A value of 0 or false indicates the field was created by the application.

Note: This attribute could be used for a defined grouped or calculated field. In this case, source database fields should precede defined grouped or calculated fields.

Defaults to:

null

getDatabaseField : Boolean

Returns the value of databaseField

Returns

Boolean

setDatabaseField (databaseField)

Sets the value of databaseField

Parameters

databaseField :  Boolean

formula : String

Specifies the formula for the calculated field. This formula is specified by the end-user. Calculated fields can perform calculations by using the contents of other fields in the PivotTable.

In formulas you create for calculated fields or calculated items, you can use operators and expressions as you do in other worksheet formulas. You can use constants and refer to data from the PivotTable, but you cannot use cell references or defined names. You cannot use worksheet functions that require cell references or defined names as arguments, and you cannot use array functions.

Further behaviors and restrictions apply to formulas for calculated fields:

  • Formulas for calculated fields operate on the sum of the underlying data for any fields in the formula. [Example: The formula =Sales * 1.2 multiplies the sum of the sales for each type and region by 1.2; it does not multiply each individual sale by 1.2 and then sum the multiplied amounts. end example]
  • Formulas cannot refer to totals.

Defaults to:

null

getFormula : String

Returns the value of formula

Returns

String

setFormula (formula)

Sets the value of formula

Parameters

formula :  String

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

hierarchy : Number

Specifies the hierarchy that this field is part of.

Defaults to:

null

getHierarchy : Number

Returns the value of hierarchy

Returns

Number

setHierarchy (hierarchy)

Sets the value of hierarchy

Parameters

hierarchy :  Number

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

level : Number

Specifies the hierarchy level that this field is part of.

Defaults to:

null

getLevel : Number

Returns the value of level

Returns

Number

setLevel (level)

Sets the value of level

Parameters

level :  Number

mappingCount : Number

Specifies the number of property mappings for this field.

Defaults to:

null

getMappingCount : Number

Returns the value of mappingCount

Returns

Number

setMappingCount (mappingCount)

Sets the value of mappingCount

Parameters

mappingCount :  Number

memberPropertyField : Boolean

Specifies a boolean value that indicates whether the field contains OLAP member property information.

A value of 1 or true indicates this field contains OLAP member property information.

A value of 0 or false indicates this field does not contain OLAP member property information.

Defaults to:

null

getMemberPropertyField : Boolean

Returns the value of memberPropertyField

Returns

Boolean

setMemberPropertyField (memberPropertyField)

Sets the value of memberPropertyField

Parameters

memberPropertyField :  Boolean

name : String

Specifies the name of the cache field.

Defaults to:

null

getName : String

Returns the value of name

Returns

String

setName (name)

Sets the value of name

Parameters

name :  String

numFmtId : Number

Specifies the number format that is applied to all items in the field. Number formats are written to the styles part.

Note: Formatting information provided by cell table and by PivotTable need not agree. If the two formats differ, the cell-level formatting takes precedence. If you change the layout of the PivotTable, the PivotTable formatting will then take precedence.

Defaults to:

null

getNumFmtId : Number

Returns the value of numFmtId

Returns

Number

setNumFmtId (numFmtId)

Sets the value of numFmtId

Parameters

numFmtId :  Number

propertyName : String

Specifies the name of the property if this field is an OLAP property field.

Defaults to:

null

getPropertyName : String

Returns the value of propertyName

Returns

String

setPropertyName (propertyName)

Sets the value of propertyName

Parameters

propertyName :  String

serverField : Boolean

Specifies a boolean value that indicates whether the field is a server-based page field.

A value of 1 or true indicates this field is a server-based page field.

A value of 0 or false indicates this field is not a server-based page field.

This attribute applies to ODBC sources only.

Defaults to:

null

getServerField : Boolean

Returns the value of serverField

Returns

Boolean

setServerField (serverField)

Sets the value of serverField

Parameters

serverField :  Boolean

sharedItems : Ext.exporter.file.ooxml.excel.SharedItems

Represents the collection of unique items for a field in the PivotCacheDefinition.

Defaults to:

null

setSharedItems (sharedItems)

Sets the value of sharedItems

Parameters

sharedItems :  Ext.exporter.file.ooxml.excel.SharedItems

sqlType : Number

Specifies the SQL data type of the field. This attribute stores an ODBC data type and applies to ODBC data sources only. A value is supplied for this attribute only if it is provided to the application.

The following are data types supported by ODBC. For a more information, see the ODBC specification.

  • 0 SQL_UNKNOWN_TYPE
  • 1 SQL_CHAR
  • 2 SQL_VARCHAR
  • -1 SQL_LONGVARCHAR
  • -8 SQL_WCHAR
  • -9 SQL_WVARCHAR
  • -10 SQL_WLONGVARCHAR
  • 3 SQL_DECIMAL
  • 2 SQL_NUMERIC
  • 5 SQL_SMALLINT
  • 4 S`QL_INTEGER
  • 7 SQL_REAL
  • 6 SQL_FLOAT
  • 8 SQL_DOUBLE
  • -7 SQL_BIT
  • -6 SQL_TINYINT
  • -5 SQL_BIGINT
  • -2 SQL_BINARY
  • -3 SQL_VARBINARY
  • -4 SQL_LONGVARBINARY
  • `9`` SQL_TYPE_DATE or SQL_DATE
  • 10 SQL_TYPE_TIME or SQL_TIME
  • 11 SQL_TYPE_TIMESTAMP or SQL_TIMESTAMP
  • 102 SQL_INTERVAL_MONTH
  • 101 SQL_INTERVAL_YEAR
  • 107 SQL_INTERVAL_YEAR_TO_MONTH
  • 103 SQL_INTERVAL_DAY
  • 104 SQL_INTERVAL_HOUR
  • 105 SQL_INTERVAL_MINUTE
  • 106 SQL_INTERVAL_SECOND
  • 108 SQL_INTERVAL_DAY_TO_HOUR
  • 109 SQL_INTERVAL_DAY_TO_MINUTE
  • 110 SQL_INTERVAL_DAY_TO_SECOND
  • 111 SQL_INTERVAL_HOUR_TO_MINUTE
  • 112 SQL_INTERVAL_HOUR_TO_SECOND
  • 113 SQL_INTERVAL_MINUTE_TO_SECOND
  • -11 SQL_GUID
  • -20 SQL_SIGNED_OFFSET`
  • -22 SQL_UNSIGNED_OFFSET

Defaults to:

null

getSqlType : Number

Returns the value of sqlType

Returns

Number

setSqlType (sqlType)

Sets the value of sqlType

Parameters

sqlType :  Number

uniqueList : Boolean

Specifies a boolean value that indicates whether the application was able to get a list of unique items for the field. The attribute only applies to PivotTables that use ODBC and is intended to be used in conjunction with optimization features in the application. [Example: the application can optimize memory usage when populating PivotCache records if it has a list of unique items for a field before all the records are retrieved from ODBC. end example]

A value of 1 or true indicates the application was able to get a list of unique values for the field.

A value of 0 or false indicates the application was unable to get a list of unique values for the field.

Defaults to:

null

getUniqueList : Boolean

Returns the value of uniqueList

Returns

Boolean

setUniqueList (uniqueList)

Sets the value of uniqueList

Parameters

uniqueList :  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.1