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.

ExtAngular 7.3.0


top

NPM Package

@sencha/ext-amf

Hierarchy

Ext.data.amf.Packet

Summary

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.

No members found using the current filters

properties

Instance Properties

converters
private pri

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 || [];
    }
}

headers : Array
readonly ro

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 value

messages : Array
readonly ro

The 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 name
  • byteLength: Number Optional byte-length of the message body
  • body: Mixed The message body

readTrue
private pri

Returns true. Used for reading the true type

Defaults to:

Ext.returnTrue

typeMap
private pri

Mapping 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'
    }
}

version : Number
readonly ro

The AMF version number (0 or 3)

methods

Instance Methods

decode ( byteArray ) : Ext.data.amf.Packet
chainable ch

Decodes an AMF btye array and sets the decoded data as the Packet's #version, #headers, and #messages properties

Parameters

byteArray :  Array

A byte array containing the encoded AMF data.

Returns

:Ext.data.amf.Packet

this AMF Packet

decodeValue ( byteArray ) : Object

Decodes an AMF3 byte array and that has one value and returns it. Note: Destroys previously stored data in this Packet.

Parameters

byteArray :  Array

A byte array containing the encoded AMF data.

Returns

:Object

the decoded object

parseXml ( xml )
private pri

Parses an xml string and returns an xml document

Parameters

xml :  String

readAmf0Date
private pri

Reads an AMF0 date from the byte array

readAmf0Object ( obj )
private pri

Reads an AMF0 Object from the byte array

Parameters

obj :  Object

readAmf0String
private pri

Reads an AMF0 string from the byte array

readAmf3Date
private pri

Reads an AMF3 date from the byte array

readAmf3Object
private pri

Reads an AMF3 object from the byte array

readAmf3String
private pri

Reads an AMF3 string from the byte array

readAmf3Xml
private pri

Reads an AMF3 XMLDocument type or XML type from the byte array

readBoolean
private pri

Reads an AMF0 boolean from the byte array

readByteArray
private pri

Reads an AMF3 ByteArray type from the byte array

readDouble Number
private pri

Reads a IEEE 754 double-precision binary floating-point number

Returns

:Number

readEcmaArray
private pri

Reads an AMF0 ECMA Array from the byte array

readFalse Boolean
private pri

Returns false. Used for reading the false type

Returns

:Boolean

readLongString
private pri

Reads a long string (longer than 65535 bytes) from the byte array

readNull
private pri

Returns null. Used for reading the null type

readReference
private pri

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.

readStrictArray
private pri

Reads an AMF0 strict array (an array with ordinal indices)

readTypedObject
private pri

Reads an AMF0 typed object from the byte array

readUInt ( byteCount ) : Number
private pri

Reads an unsigned integer from the byte array

Parameters

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.

Returns

:Number

readUInt29 Number
private pri

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

Returns

:Number

readUndefined
private pri

Returns undefined. Used for reading the undefined type

readUnsupported
private pri

Returns undefined. Used for reading the unsupported type

readUtf8 ( byteLength ) : String
private pri

Reads a UTF-8 string from the byte array

Parameters

byteLength :  Number

The number of bytes to read

Returns

:String

readValue
chainable ch private pri

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.

ExtAngular 7.3.0