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

NPM Package

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

Summary

Represents the collection of unique items for a field in the PivotCacheDefinition. The sharedItems complex type stores data type and formatting information about the data in a field. Items in the PivotCacheDefinition can be shared in order to reduce the redundancy of those values that are referenced in multiple places across all the PivotTable parts. [Example: A value might be part of a filter, it might appear on a row or column axis, and will appear in the pivotCacheRecords definition as well. However, because of the performance cost of creating the optimized shared items, items are only shared if they are actually in use in the PivotTable. Therefore, depending on user actions on the PivotTable layout, the pivotCacheDefinition and underlying PivotCacheRecords part can be updated. end example]

If there are no shared items, then field values are stored directly in the pivotCacheRecords part.

(CT_SharedItems)

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

containsBlank : Boolean

Specifies a boolean value that indicates whether this field contains a blank value.

A value of 1 or true indicates this field contains one or more blank values.

A value of 0 or false indicates this field does not contain blank values.

Defaults to:

null

getContainsBlank : Boolean

Returns the value of containsBlank

Returns

Boolean

setContainsBlank (containsBlank)

Sets the value of containsBlank

Parameters

containsBlank :  Boolean

containsDate : Boolean

Specifies a boolean value that indicates that the field contains at least one date.

A value of 1 or true indicates the field contains at least one date value.

A value of 0 or false indicates the field does not contain any date values.

Defaults to:

null

getContainsDate : Boolean

Returns the value of containsDate

Returns

Boolean

setContainsDate (containsDate)

Sets the value of containsDate

Parameters

containsDate :  Boolean

containsInteger : Boolean

Specifies a boolean value that indicates whether this field contains integer values.

A value of 1 or true indicates this field contains integer values.

A value of 0 or false indicates non-integer or mixed values.

Defaults to:

null

getContainsInteger : Boolean

Returns the value of containsInteger

Returns

Boolean

setContainsInteger (containsInteger)

Sets the value of containsInteger

Parameters

containsInteger :  Boolean

containsMixedTypes : Boolean

Specifies a boolean value that indicates whether this field contains more than one data type.

A value of 1 or true indicates this field contains more than one data type.

A value of 0 or false indicates contains only one data type. The field can still contain blank values.

Defaults to:

null

getContainsMixedTypes : Boolean

Returns the value of containsMixedTypes

Returns

Boolean

setContainsMixedTypes (containsMixedTypes)

Sets the value of containsMixedTypes

Parameters

containsMixedTypes :  Boolean

containsNonDate : Boolean

Specifies a boolean value that indicates that the field contains at least one value that is not a date.

A value of 1 or true indicates the field contains at least one non-date values.

A value of 0 or false indicates this field contains no date fields.

Defaults to:

null

getContainsNonDate : Boolean

Returns the value of containsNonDate

Returns

Boolean

setContainsNonDate (containsNonDate)

Sets the value of containsNonDate

Parameters

containsNonDate :  Boolean

containsNumber : Boolean

Specifies a boolean value that indicates whether this field contains numeric values.

A value of 1 or true indicates this field contains at least one numeric value.

A value of 0 or false indicates this field contains no numeric values.

Defaults to:

null

getContainsNumber : Boolean

Returns the value of containsNumber

Returns

Boolean

setContainsNumber (containsNumber)

Sets the value of containsNumber

Parameters

containsNumber :  Boolean

containsSemiMixedTypes : Boolean

Specifies a boolean value that indicates that this field contains text values. The field can also contain a mix of other data type and blank values.

A value of 1 or true indicates at least one text value, and can also contain a mix of other data types and blank values.

A value of 0 or false indicates the field does not have a mix of text and other values.

Defaults to:

null

getContainsSemiMixedTypes : Boolean

Returns the value of containsSemiMixedTypes

Returns

Boolean

setContainsSemiMixedTypes (containsSemiMixedTypes)

Sets the value of containsSemiMixedTypes

Parameters

containsSemiMixedTypes :  Boolean

containsString : Boolean

Specifies a boolean value that indicates whether this field contains a text value.

A value of 1 or true indicates this field contains at least one text value.

A value of 0 or false indicates this field does not contain any text values.

Defaults to:

null

getContainsString : Boolean

Returns the value of containsString

Returns

Boolean

setContainsString (containsString)

Sets the value of containsString

Parameters

containsString :  Boolean

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 : Boolean / Number / Date / String[]

Unique values for the CacheField.

Defaults to:

null

getItems : Boolean / Number / Date / String[]

Returns the value of items

Returns

Boolean / Number / Date / String[]

setItems (items)

Sets the value of items

Parameters

items :  Boolean / Number / Date / String[]

longText : Boolean

Specifies a boolean value that indicates whether this field contains a long text value. A string is considered long if it is over 255 Unicode scalar values.

A value of 1 or true indicates the value contains more than 255 Unicode scalar valuesof text.

A value of 0 or false indicates the value contains less than 255 Unicode scalar values.

Note: This is used as many legacy spreadsheet application support a limit of 255 characters for text values.

Defaults to:

null

getLongText : Boolean

Returns the value of longText

Returns

Boolean

setLongText (longText)

Sets the value of longText

Parameters

longText :  Boolean

maxDate : Date

Specifies the maximum date/time value found in a date field.

Defaults to:

null

getMaxDate : Date

Returns the value of maxDate

Returns

Date

setMaxDate (maxDate)

Sets the value of maxDate

Parameters

maxDate :  Date

maxValue : Number

Specifies the maximum numeric value found in a numeric field.

Defaults to:

null

getMaxValue : Number

Returns the value of maxValue

Returns

Number

setMaxValue (maxValue)

Sets the value of maxValue

Parameters

maxValue :  Number

minDate : Date

Specifies the minimum date/time value found in a date field.

Defaults to:

null

getMinDate : Date

Returns the value of minDate

Returns

Date

setMinDate (minDate)

Sets the value of minDate

Parameters

minDate :  Date

minValue : Number

Specifies the minimum numeric value found in a numeric field.

Defaults to:

null

getMinValue : Number

Returns the value of minValue

Returns

Number

setMinValue (minValue)

Sets the value of minValue

Parameters

minValue :  Number

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