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.
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.
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.
ExtReact component classes display
configuration options as props
ExtReact component classes do not list
properties as a dedicated member type, but rather as
read only props
static label next to the
method name. *See Static below.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).
Let's look at each part of the member row:
lookupComponent in this example)( item ) in this example)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).PROTECTED in
this example - see the Flags section below)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.view source in the example)item : Object in the example).undefined a "Returns" section
will note the type of class or object returned and a description (Ext.Component in the
example)Available since 3.4.0 - not pictured in
the example) just after the member descriptionDefaults to: false)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.
All ExtReact props are bindable
unless decorated as immutable
Immutable ExtReact props may not be use as a configurable prop when instantiating a component
classInstance.method1().method2().etc();false is returned from
an event handler- 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
- 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
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.
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
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.
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.
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:
Ext.button.Button class has an alternate class name of Ext.Button). Alternate class
names are commonly maintained for backward compatibility.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.
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:
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.
Represents a single field in the PivotTable. This element contains information about the field, including the collection of items in the field.
(CT_PivotField)
Specifies a boolean value that indicates whether all items in the field are expanded. Applies only to OLAP PivotTables.
A value of 1 or true indicates all items in the field are expanded.
A value of 0 or false indicates all items are not expanded. However some items might be expanded.
Set to true to auto generate an id if none is defined.
Defaults to:
true
Sets the value of autoGenerateId
autoGenerateId : Boolean
Specifies a boolean value that indicates whether an "AutoShow" filter is applied to this field. This attribute depends on the implementation of filtering in the application.
A value of 1 or true indicates an "AutoShow" filter is applied to the field.
A value of 0 or false indicates an "AutoShow" filter is not applied.
Represents the sorting scope for the PivotTable.
Returns the value of autoSortScope
Sets the value of autoSortScope
autoSortScope : Ext.exporter.file.ooxml.excel.AutoSortScope
Specifies a boolean value that indicates whether to apply the 'Average' aggregation function in the subtotal of this field.
A value of 1 or true indicates the subtotal for this field is 'Average.'
A value of 0 or false indicates a different aggregation function is applied to the subtotal for this field.
Specifies the region of the PivotTable that this field is displayed.
Possible values:
axisCol: Column axisaxisPage: Page axisaxisRow: Row axisaxisValues: Values axisSpecifies a boolean value that indicates whether the application will display fields compactly in the sheet on which this PivotTable resides.
A value of 1 or true indicates the next field should be displayed in the same column of the sheet.
A value of 0 or false indicates each pivot field will display in its own column in the sheet.
Specifies a boolean value that indicates whether to apply the 'countA' aggregation function in the subtotal of this field.
A value of 1 or true indicates the subtotal for this field is 'countA.'
A value of 0 or false indicates a different aggregation function is applied to the subtotal for this field.
Sets the value of countASubtotal
countASubtotal : Boolean
Specifies a boolean value that indicates whether to apply the 'count' aggregation function in the subtotal of this field.
A value of 1 or true indicates the subtotal for this field is 'count.'
A value of 0 or false indicates a different aggregation vfunction is applied to the subtotal for this field.
Specifies a boolean value that indicates whether this field appears in the data region of the PivotTable.
A value of 1 or true indicates this field appears in the data region of the PivotTable.
A value of 0 or false indicates this field appears in another region of the PivotTable.
Specifies a boolean value that indicates whether sort is applied to this field in the data source.
A value of 1 or true indicates this field is sorted in the data source.
A value of 0 or false indicates this field is not sorted in the data source.
Sets the value of dataSourceSort
dataSourceSort : Boolean
Specifies a boolean value that indicates the drill state of the attribute hierarchy in an OLAP-based PivotTable.
A value of 1 or true indicates the attribute hierarchy is expanded.
A value of 0 or false indicates the attribute hierarchy is collapsed.
This attribute is designed to allow the application to issue more optimized queries when all items of each field have the same drill state.
Sets the value of defaultAttributeDrillState
defaultAttributeDrillState : Boolean
Specifies a boolean value that indicates whether the default subtotal aggregation function is displayed for this field.
A value of 1 or true indicates the default subtotal aggregation function is displayed for this field.
A value of 0 or false indicates the default aggregation function is not displayed.
Sets the value of defaultSubtotal
defaultSubtotal : Boolean
Specifies a boolean value that indicates whether the field can be removed from the PivotTable.
A value of 1 or true indicates the field can be removed from the PivotTable.
A value of 0 or false indicates the field cannot be removed from the PivotTable.
Specifies a boolean value that indicates whether the field can be dragged to the column axis.
A value of 1 or true indicates the field can be dragged to the column axis.
A value of 0 or false indicates the field cannot be dragged to the column axis.
Specifies a boolean value that indicates whether the field can be dragged to the data region.
A value of 1 or true indicates the field can be dragged to the data region.
A value of 0 or false indicates the field cannot be dragged to the data region.
Specifies a boolean value that indicates whether the field can be dragged to the page region.
A value of 1 or true indicates the field can be dragged to the page region.
A value of 0 or false indicates the field cannot be dragged to the page region.
Specifies a boolean value that indicates whether the field can be dragged to the row axis.
A value of 1 or true indicates the field can be dragged to the row axis.
A value of 0 or false indicates the field cannot be dragged to the row axis.
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
Specifies a boolean value that indicates whether new items that appear after a refresh should be hidden by default.
A value of 1 or true indicates that items that appear after a refresh should be hidden by default.
A value of 0 or false indicates that items that appear after a refresh should be shown by default.
Specifies a boolean value that indicates whether manual filter is in inclusive mode.
A value of 1 or true indicates the manual filter is inclusive.
A value of 0 or false indicates the manual filter is not inclusive.
Sets the value of includeNewItemsInFilter
includeNewItemsInFilter : Boolean
Specifies a boolean value that indicates whether to insert a blank row after each item.
A value of 1 or true indicates that a blank row is inserted after each item.
A value of 0 or false indicates no additional rows are inserted after each item.
Sets the value of insertBlankRow
insertBlankRow : Boolean
Specifies a boolean value that indicates whether to insert a page break after each item.
A value of 1 or true indicates that a page break is inserted after each item.
A value of 0 or false indicates no page breaks are inserted after items.
Sets the value of insertPageBreak
insertPageBreak : Boolean
Represents the collection of items in a PivotTable field. The items in the collection are ordered by index.
Items represent the unique entries from the field in the source data.
Specifies a boolean value that indicates whether to apply the 'max' aggregation function in the subtotal of this field.
A value of 1 or true indicates that the 'max' aggregation function is applied in the subtotal for this field.
A value of 0 or false indicates another aggregation function is applied in the subtotal for this field.
Specifies a boolean value that indicates whether field has a measure based filter.
A value of 1 or true indicates the field has a measure-based filter.
A value of 0 or false indicates does not have a measure-based filter.
Specifies a boolean value that indicates whether to apply the 'min' aggregation function in the subtotal of this field.
A value of 1 or true indicates that the 'min' aggregation function is applied in the subtotal for this field.
A value of 0 or false indicates another aggregation function is applied in the subtotal for this field.
Specifies a boolean value that indicates whether the field can have multiple items selected in the page field.
A value of 1 or true indicates the PivotTable can have multiple items selected in the page field.
A value of 0 or false indicates the PivotTable cannot have multiple items selected in the page field. This attribute depends on the application support for selecting multiple items in page fields.
Sets the value of multipleItemSelectionAllowed
multipleItemSelectionAllowed : Boolean
Specifies a boolean value that indicates whether sort operation that is applied to field should be AutoSort operation or simple data sort operation.
A value of 1 or true indicates that an AutoSort operation is applied to the field.
A value of 0 or false indicates a simple data sort operation is applied to the field.
Sets the value of nonAutoSortDefault
nonAutoSortDefault : Boolean
Specifies the identifier of the number format to apply to this field. Number formats are written to the styles part. See the Styles section (§18.8) for more information on number formats.
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 the PivotTable, the PivotTable formatting will then take precedence.
Specifies a boolean value that indicates whether the items in this field should be shown in Outline form.
A value of 1 or true indicates the items in this field is shown in Outline form.
A value of 0 or false indicates the items in this field will not be shown in Outline form.
This attribute depends on the application support for displaying items in Outline form.
Specifies a boolean value that indicates whether to apply 'product' aggregation function in the subtotal of this field.
A value of 1 or true indicates that the 'product' aggregation function is applied in the subtotal for this field.
A value of 0 or false indicates another aggregation function is applied in the subtotal for this field.
Sets the value of productSubtotal
productSubtotal : Boolean
Specifies a boolean value that indicates whether this is a server-based page field.
A value of 1 or true indicates this is a server-based page field.
A value of 0 or false indicates this is a local page field.
Specifies a boolean value that indicates whether to show all items for this field.
A value of 1 or true indicates that all items be shown.
A value of 0 or false indicates items be shown according to user specified criteria.
Specifies a boolean value that indicates whether to hide drop down buttons on PivotField headers. This attribute depends on the application implementation for filtering in the user interface.
A value of 1 or true indicates the application will display some mechanism for selecting and applying filters – [Example: A dropdown menu end example] – in the user interface.
A value of 0 or false indicates for mechanism for applying a filter is displayed in the user interface.
Specifies a boolean value that indicates whether to show the property as a member caption.
A value of 1 or true indicates the property is shown as a member caption.
A value of 0 or false indicates the property will not be shown as a member caption.
Sets the value of showPropAsCaption
showPropAsCaption : Boolean
Specifies a boolean value that indicates whether to show the member property value in a PivotTable cell.
A value of 1 or true indicates the property value is shown in a PivotTable cell.
A value of 0 or false indicates the property value will not be shown in a PivotTable cell.
Specifies a boolean value that indicates whether to show the member property value in a tooltip on the appropriate PivotTable cells.
A value of 1 or true indicates the property value is shown in a tooltip in the user interface.
A value of 0 or false indicates the property will not be shown in a tooltip. This attribute depends on whether the application employs tooltips or similar mechanism in the user interface.
Specifies the type of sort that is applied to this field.
Possible values:
ascending: Indicates the field is sorted in ascending order.descending: Indicates the field is sorted in descending order.manual: Indicates the field is sorted manually.Specifies a boolean value that indicates whether to apply the 'stdDevP' aggregation function in the subtotal of this field.
A value of 1 or true indicates that the 'stdDevP' aggregation function is applied in the subtotal for this field.
A value of 0 or false indicates another aggregation function is applied in the subtotal for this field.
Sets the value of stdDevPSubtotal
stdDevPSubtotal : Boolean
Specifies a boolean value that indicates whether to use 'stdDev' in the subtotal of this field.
A value of 1 or true indicates that the 'stdDev' aggregation function is applied in the subtotal for this field.
A value of 0 or false indicates another aggregation function is applied in the subtotal for this field.
Sets the value of stdDevSubtotal
stdDevSubtotal : Boolean
Specifies the custom text that is displayed for the subtotals label.
Sets the value of subtotalCaption
subtotalCaption : String
Specifies a boolean value that indicates whether to display subtotals at the top of the group. Applies only when Outline its true.
A value of 1 or true indicates a subtotal is display at the top of the group.
A value of 0 or false indicates subtotal will not be displayed at the top of the group.
Specifies a boolean value that indicates whether apply the 'sum' aggregation function in the subtotal of this field.
A value of 1 or true indicates the 'sum' aggregation function is applied in the subtotal of this field.
A value of 0 or false indicates another aggregation function is applied in the subtotal of this field.
Specifies a boolean value that indicates whether an AutoShow filter applied to this field is set to show the top ranked values.
A value of 1 or true indicates whether an AutoShow filter will show top values for this field.
A value of 0 or false indicates bottom ranked values are shown.
Specifies the unique name of the member property to be used as a caption for the field and field items.
Sets the value of uniqueMemberProperty
uniqueMemberProperty : String
Specifies a boolean value that indicates whether to apply the 'varP' aggregation function in the subtotal of this field.
A value of 1 or true indicates the 'varP' aggregation function is applied in the subtotal of this field.
A value of 0 or false indicates another aggregation function is applied in the subtotal of this field.
Specifies a boolean value that indicates whether to apply the 'variance' aggregation function in the subtotal of this field.
A value of 1 or true indicates the 'variance' aggregation function is applied in the subtotal of this field.
A value of 0 or false indicates another aggregation function is applied in the subtotal of this field.
This method could be used in config appliers that need to initialize a Collection that has items of type className.
data : Object
dataCollection : Object
className : Object
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).
members : Object
The properties to add to this class. This should be specified as an object literal containing one or more properties.
this class
ExtReact | Terms of Use