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.
Defines a 3D axis for charts.
A 3D axis has the same properties as the regular Ext.chart.axis.Axis, plus a notion of depth. The depth of the 3D axis is determined automatically based on the depth of the bound series.
This type of axis has the following limitations compared to the regular axis class:
At the present moment only bar3d series can make use of the 3D axis.
Whether to make the auto-calculated minimum and maximum of the axis a multiple of the interval between the major ticks of the axis. If majorTickSteps, minimum or maximum configs have been set, this config will be ignored. Defaults to 'true'.
Defaults to:
true
Sets the value of adjustByMajorUnit
adjustByMajorUnit : Boolean
An array containing the names of the record fields which should be mapped along the axis. This is optional if the binding between series and fields is clear.
Defaults to:
[]
If floating is a number, then it's a percentage displacement of the axis from its initial position
in the direction opposite to the axis' direction. For instance, '{position:"left", floating:75}' displays a vertical
axis at 3/4 of the chart, starting from the left. It is equivalent to '{position:"right", floating:25}'.
If floating is an object, then floating.value is the position of this axis along another axis,
defined by floating.alongAxis, where alongAxis is an ID, an Ext.chart.AbstractChart#axes config index,
or the other axis itself. alongAxis must have an opposite alignment.
For example:
axes: [
{
title: 'Average Temperature (F)',
type: 'numeric',
position: 'left',
id: 'temperature-vertical-axis',
minimum: -30,
maximum: 130
},
{
title: 'Month (2013)',
type: 'category',
position: 'bottom',
floating: {
value: 32,
alongAxis: 'temperature-vertical-axis'
}
}
]
Defaults to:
null
The grid configuration object for the Axis style. Can contain stroke or fill attributes.
Also may contain an odd or even property in which you only style things on odd or even rows.
For example:
grid {
odd: {
stroke: '#555'
},
even: {
stroke: '#ccc'
}
}
Defaults to:
false
Given a minimum and maximum bound for the series to be rendered (that can be obtained
automatically or by manually setting minimum and maximum) tick marks will be added
on each increment from the minimum value to the maximum one.
Defaults to:
0.5
The label configuration object for the Axis. This object may include style attributes
like spacing, padding, font that receives a string or number and
returns a new string with the modified values.
For more supported values, see the configurations for Ext.chart.sprite.Label.
Defaults to:
undefined
The axis layout config. See Ext.chart.axis.layout.Layout
Defaults to:
'continuous'
Sets the value of layout
layout : Object / Ext.chart.axis.layout.Layout
The limit lines configuration for the axis. For example:
limits: [{
value: 50,
line: {
strokeStyle: 'red',
lineDash: [6, 3],
title: {
text: 'Monthly minimum',
fontSize: 14
}
}
}]
Defaults to:
null
Axis (itself, its ID or index) that this axis is linked to. When an axis is linked to a master axis, it will use the same data as the master axis. It can be used to show additional info, or to ease reading the chart by duplicating the scales.
Defaults to:
null
Sets the value of linkedTo
linkedTo : Ext.chart.axis.Axis / String / Number
Forces the number of major ticks to the specified value. Both minimum and maximum should be specified.
Defaults to:
0
Sets the value of majorTickSteps
majorTickSteps : Number
The margin of the axis. Used to control the spacing between axes in charts with multiple axes.
Unlike CSS where the margin is added on all 4 sides of an element, the margin is the total space
that is added horizontally for a vertical axis, vertically for a horizontal axis,
and radially for an angular axis.
Defaults to:
0
The maximum value drawn by the axis. If not set explicitly, the axis maximum will be calculated automatically.
Defaults to:
NaN
The minimum value drawn by the axis. If not set explicitly, the axis minimum will be calculated automatically.
Defaults to:
NaN
The number of small ticks between two major ticks.
Defaults to:
0
Sets the value of minorTickSteps
minorTickSteps : Number
Indicates that the axis needs high precision surface implementation. See Ext.draw.engine.Canvas#highPrecision
Defaults to:
false
Sets the value of needHighPrecision
needHighPrecision : Boolean
If 'true' the range of the axis will be a union of ranges of all the axes with the same direction. Defaults to 'false'.
Defaults to:
false
Sets the value of reconcileRange
reconcileRange : Boolean
Allows to change the text shown next to the tick.
Defaults to:
null
axis : Ext.chart.axis.Axis
The axis.
label : String/Number
The label.
layoutContext : Object
The object that holds calculated positions of axis' ticks based on current layout, segmenter, axis length and configuration.
lastLabel : String/Number/null
The last label (if any).
The label to display.
The segmenter config. See Ext.chart.axis.segmenter.Segmenter
Defaults to:
'numeric'
Sets the value of segmenter
segmenter : Object / Ext.chart.axis.segmenter.Segmenter
The style for the axis line and ticks. Refer to the Ext.chart.axis.sprite.Axis
Defaults to:
null
The title for the Axis. If given a String, the 'text' attribute of the title sprite will be set, otherwise the style will be set.
Defaults to:
null
The margin around the axis title. Unlike CSS where the margin is added on all 4
sides of an element, the titleMargin is the total space that is added horizontally
for a vertical title and vertically for an horizontal title, with half the titleMargin
being added on either side.
Defaults to:
4
Specify the proportion of the axis to be rendered. The series bound to this axis will be synchronized and transformed accordingly.
Defaults to:
[0, 1]
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
Fires when the range of the axis changes.
axis : Ext.chart.axis.Axis
range : Array
oldRange : Array
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fires when the visibleRange of the axis changes.
axis : Ext.chart.axis.Axis
visibleRange : Array
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
ExtAngular | Terms of Use