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


top

Ext.data.writer.Writer alias: writer.base

NPM Package

@sencha/ext-react

Hierarchy

Ext.Base
Ext.data.writer.Writer

Summary

Base Writer class used by most subclasses of Ext.data.proxy.Server. This class is responsible for taking a set of Ext.data.operation.Operation objects and a Ext.data.Request object and modifying that request based on the Operations.

For example a Ext.data.writer.Json would format the Operations and their Ext.data.Model instances based on the config options passed to the JsonWriter's constructor.

Writers are not needed for any kind of local storage - whether via a Ext.data.proxy.WebStorage (see Ext.data.proxy.LocalStorage and Ext.data.proxy.SessionStorage) or just in memory via a Ext.data.proxy.Memory.

Dates

Before sending dates to the server, they can be formatted using an Ext.Date format. These formats can be specified both on the field and the writer itself. In terms of precedence, from highest to lowest:

No members found using the current filters

configs

Optional Configs

allDataOptions : Object

This object contains the options passed to Ext.data.Model#getData when writing Ext.data.Model#phantom records or when writeAllFields is set to true.

NOTE: The serialize option cannot be used here.

getAllDataOptions : Object

Returns the value of allDataOptions

Returns

Object

setAllDataOptions (allDataOptions)

Sets the value of allDataOptions

Parameters

allDataOptions :  Object

clientIdProperty : String

When specified this property causes the Ext.data.Model#idProperty of newly created records to be sent to the server as this name instead of the value of the idProperty.

For example, by default, the following code:

 Ext.define('Person', {
     idProperty: 'id',  // this is the default value (for clarity)

     fields: [ 'name' ]
 });

 var person = new Person({
     // no id provided, so one is generated
     name: 'Clark Kent'
 });

Will send this to the server:

 {
     id: 'Person-1',
     name: 'Clark Kent'
 }

This can be an issue if the server expects an integer for the "id" property. You can use Ext.data.Model#identifier to produce identifiers that the server would recognize or use this config to send the client's id in a different property.

 Ext.define('Person', {
     idProperty: 'id',  // this is the default value (for clarity)

     proxy: {
         writer: {
             clientIdProperty: 'clientId'
         }
     },

     fields: [ 'name' ]
 });

Given the above, the server is sent this data now:

 {
     clientId: 'Person-1',
     name: 'Clark Kent'
 }

While this config provides the behavior of Ext.data.Model#clientIdProperty from previous releases, this property is not as useful as a suitable Ext.data.Model#identifier due to id's appearing in foreign-key fields and in Ext.data.Model#manyToMany associations.

See Ext.data.Model#identifier for more on id generation.

getClientIdProperty : String

Returns the value of clientIdProperty

Returns

String

setClientIdProperty (clientIdProperty)

Sets the value of clientIdProperty

Parameters

clientIdProperty :  String

dateFormat : String

This is used for each field of type date in the model to format the value before it is sent to the server.

getDateFormat : String

Returns the value of dateFormat

Returns

String

setDateFormat (dateFormat)

Sets the value of dateFormat

Parameters

dateFormat :  String

nameProperty : String

This property is used to read the key for each value that will be sent to the server.

For example:

Ext.define('Person', {
    extend: 'Ext.data.Model',
    fields: [{
        name: 'first',
        mapping: 'firstName'
    }, {
        name: 'last',
        mapping: 'lastName'
    }, {
        name: 'age'
    }]
});

new Ext.data.writer.Writer({
    nameProperty: 'mapping'
});

// This will be sent to the server
{
    firstName: 'first name value',
    lastName: 'last name value',
    age: 1
}

If the value is not present, the field name will always be used.

Defaults to:

"name"

getNameProperty : String

Returns the value of nameProperty

Returns

String

setNameProperty (nameProperty)

Sets the value of nameProperty

Parameters

nameProperty :  String

partialDataOptions : Object

This object contains the options passed to Ext.data.Model#getData when writing non Ext.data.Model#phantom records or when writeAllFields is set to false.

NOTE: The serialize option cannot be used here.

getPartialDataOptions : Object

Returns the value of partialDataOptions

Returns

Object

setPartialDataOptions (partialDataOptions)

Sets the value of partialDataOptions

Parameters

partialDataOptions :  Object

transform : Function / Object

If a transform function is set, it will be invoked just before writeRecords executes. It is passed the unserialized data object and the Ext.data.Request object. The transform function returns a data object, which can be a modified version of the original data object, or a completely new data object. The transform can be a function, or an object with a 'fn' key and an optional 'scope' key. Example usage:

new Ext.data.Store({
    model: 'User',
    proxy: {
        type: 'ajax',
        url : 'users.json',
        writer: {
            type: 'json',
            transform: {
                fn: function(data, request) {
                    // do some manipulation of the unserialized data object
                    return data;
                },
                scope: this
            }
        }
    },
});

getTransform : Function / Object

Returns the value of transform

Returns

Function / Object

setTransform (transform)

Sets the value of transform

Parameters

transform :  Function / Object

writeAllFields : Boolean

true to write all fields from the record to the server. If set to false it will only send the fields that were modified. Note that any fields that have Ext.data.field.Field#persist set to false will still be ignored while those with Ext.data.field.Field#critical set to true will be included.

The exact set of fields written is determined by allDataOptions (when true) or partialDataOptions (when false). This option is ignored and treated as true when writing Ext.data.Model#phantom records.

It is seldom a good idea to use this config. Rather use allDataOptions or partialDataOptions to control what fields are sent for records based on their Ext.data.Model#phantom state.

In the previous release, this was default true.

getWriteAllFields : Boolean

Returns the value of writeAllFields

Returns

Boolean

setWriteAllFields (writeAllFields)

Sets the value of writeAllFields

Parameters

writeAllFields :  Boolean

writeRecordId : Boolean

By default, each record's id is always included in the output for non-phantom records since in most cases the id will be required on the server to process the record action. This is helpful since the id will normally not be modified, and so would not be sent to the server unless writeAllFields was explicitly enabled.

However, there are cases where it is not desirable for the record id to be passed in the data directly. For example, when using a RESTful API the record id would typically be appended to the url instead.

getWriteRecordId : Boolean

Returns the value of writeRecordId

Returns

Boolean

setWriteRecordId (writeRecordId)

Sets the value of writeRecordId

Parameters

writeRecordId :  Boolean

properties

Instance Properties

factoryConfig : Object

If this property is specified by the target class of this mixin its properties are used to configure the created Ext.Factory.

isWriter : Boolean

true in this class to identify an object as an instantiated Writer, or subclass thereof.

Defaults to:

true

methods

Instance Methods

constructor ( [config] )

Creates new Writer.

Parameters

config :  Object (optional)

Config object.

getRecordData ( record, [operation] ) : Object

Formats the data for each record before sending it to the server. This method should be overridden to format the data in a way that differs from the default.

Parameters

record :  Ext.data.Model

The record that we are writing to the server.

operation :  Ext.data.operation.Operation (optional)

An operation object.

Returns

:Object

An object literal of name/value keys to be written to the server. By default this method returns the data property on the record.

write ( request ) : Ext.data.Request

Prepares a Proxy's Ext.data.Request object.

Parameters

request :  Ext.data.Request

The request object.

Returns

:Ext.data.Request

The modified request object.

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