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.
This class represents an Action Message Format (AMF) Packet. It contains all the logic required to decode an AMF Packet from a byte array. To decode a Packet, first construct a Packet:
var packet = Ext.create('Ext.data.amf.Packet');
Then use the decode method to decode an AMF byte array:
packet.decode(bytes);
where "bytes" is a Uint8Array or an array of numbers representing the binary AMF data.
To access the decoded data use the #version, #headers, and #messages properties:
console.log(packet.version, packet.headers, packet.messages);
For more information on working with AMF data please refer to the AMF Guide.
Converters used in converting specific typed Flex classes to JavaScript usable form.
Defaults to:
{
'flex.messaging.io.ArrayCollection': function(obj) {
// array collections have a source var that contains the actual data
return obj.source || [];
}
}
The decoded headers. Each header has the following properties:
name: String
The header name. Typically identifies a remote operation or method to
be invoked by this context header.mustUnderstand: Boolean
If true this flag instructs the endpoint to abort and generate an
error if the header is not understood.byteLength: Number
If the byte-length of a header is known it can be specified to optimize
memory allocation at the remote endpoint.value: Mixed
The header valueThe decoded messages. Each message has the following properties:
targetURI: String
Describes which operation, function, or method is to be remotely
invoked.responseURI: String
A unique operation namebyteLength: Number
Optional byte-length of the message bodybody: Mixed
The message bodyMapping of AMF data types to the names of the methods responsible for reading them.
Defaults to:
{
// AMF0 mapping
0: {
0: 'readDouble',
1: 'readBoolean',
2: 'readAmf0String',
3: 'readAmf0Object',
5: 'readNull',
6: 'readUndefined',
7: 'readReference',
8: 'readEcmaArray',
10: 'readStrictArray',
11: 'readAmf0Date',
12: 'readLongString',
13: 'readUnsupported',
15: 'readAmf0Xml',
16: 'readTypedObject'
},
// AMF3 mapping
3: {
0: 'readUndefined',
1: 'readNull',
2: 'readFalse',
3: 'readTrue',
4: 'readUInt29',
5: 'readDouble',
6: 'readAmf3String',
7: 'readAmf3Xml',
8: 'readAmf3Date',
9: 'readAmf3Array',
10: 'readAmf3Object',
11: 'readAmf3Xml',
12: 'readByteArray'
}
}
Decodes an AMF btye array and sets the decoded data as the Packet's #version, #headers, and #messages properties
byteArray : Array
A byte array containing the encoded AMF data.
this AMF Packet
Decodes an AMF3 byte array and that has one value and returns it. Note: Destroys previously stored data in this Packet.
byteArray : Array
A byte array containing the encoded AMF data.
the decoded object
Reads a reference from the byte array. Reference types are used to avoid duplicating data if the same instance of a complex object (which is defined in AMF0 as an anonymous object, typed object, array, or ecma-array) is included in the data more than once.
Reads an unsigned integer from the byte array
byteCount : Number
the number of bytes to read, e.g. 2 to read a 16 bit integer, 4 to read a 32 bit integer, etc.
Reads an unsigned 29-bit integer from the byte array. AMF 3 makes use of a special compact format for writing integers to reduce the number of bytes required for encoding. As with a normal 32-bit integer, up to 4 bytes are required to hold the value however the high bit of the first 3 bytes are used as flags to determine whether the next byte is part of the integer. With up to 3 bits of the 32 bits being used as flags, only 29 significant bits remain for encoding an integer. This means the largest unsigned integer value that can be represented is 2^29-1.
(hex) : (binary)
0x00000000 - 0x0000007F : 0xxxxxxx 0x00000080 - 0x00003FFF : 1xxxxxxx 0xxxxxxx 0x00004000 - 0x001FFFFF : 1xxxxxxx 1xxxxxxx 0xxxxxxx 0x00200000 - 0x3FFFFFFF : 1xxxxxxx 1xxxxxxx 1xxxxxxx xxxxxxxx
Reads a UTF-8 string from the byte array
byteLength : Number
The number of bytes to read
Reads an AMF "value-type" from the byte array. Automatically detects the data type by reading the "type marker" from the first byte after the pointer.
ExtWebComponents | Terms of Use