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


top

NPM Package

@extjs/ext-react-exporter

Summary

This class defines a single style in the current workbook. This element is optional, but is required to perform any custom formatting.

A style can be either standalone or based on one other style (this is called the parent style), in which case, all base properties are first inherited from the parent, then the properties in the style are treated as overrides. Parent styles must be specified before they are first referenced.

No members found using the current filters

configs

Optional Configs

alignment : Object

Following keys are allowed on this object and are all optional:

Properties

horizontal : String

Specifies the left-to-right alignment of text within a cell. The Spreadsheet component does not support CenterAcrossSelection, Fill, Justify, Distributed, and JustifyDistributed. Possible values: Automatic, Left, Center, Right, Fill, Justify, CenterAcrossSelection, Distributed, and JustifyDistributed. Default is Automatic.

indent : Number

Specifies the number of indents. This attribute is not supported by the Spreadsheet component. Defaults to 0.

readingOrder : String

Specifies the default right-to-left text entry mode for a cell. The Spreadsheet component does not support Context. Possible values: RightToLeft, LeftToRight, and Context. Defaults to Context.

rotate : Number

Specifies the rotation of the text within the cell. 90 is straight up, 0 is horizontal, and -90 is straight down. The Spreadsheet component does not support this attribute. Defaults to 0.

shrinkToFit : Boolean

true means that the text size should be shrunk so that all of the text fits within the cell. false means that the font within the cell should behave normally. The Spreadsheet component does not support this attribute. Defaults to false.

vertical : String

Specifies the top-to-bottom alignment of text within a cell. Distributed and JustifyDistributed are only legitimate values when VerticalText is 1. The Spreadsheet component does not support Justify, Distributed, or JustifyDistributed. Possible values: Automatic, Top, Bottom, Center, Justify, Distributed, and JustifyDistributed. Defaults to Automatic.

verticalText : Boolean

true specifies whether the text is drawn "downwards", whereby each letter is drawn horizontally, one above the other. The Spreadsheet component does not support this attribute. Defaults to false.

wrapText : Boolean

Specifies whether the text in this cell should wrap at the cell boundary. false means that text either spills or gets truncated at the cell boundary (depending on whether the adjacent cell(s) have content). The Spreadsheet component does not support this attribute. Defaults to false.

getAlignment : Object

Returns the value of alignment

Returns

Object

setAlignment (alignment)

Sets the value of alignment

Parameters

alignment :  Object

autoGenerateId : Boolean

Set to true to auto generate an id if none is defined.

Defaults to:

true

getAutoGenerateId : Boolean

Returns the value of autoGenerateId

Returns

Boolean

setAutoGenerateId (autoGenerateId)

Sets the value of autoGenerateId

Parameters

autoGenerateId :  Boolean

borders : Object[]

Array of border objects. Following keys are allowed for border objects:

Properties

position : String

Specifies which of the six possible borders this element represents. Duplicate borders are not permitted and are considered invalid. The Spreadsheet component does not support DiagonalLeft or DiagonalRight. Possible values: Left, Top, Right, Bottom, DiagonalLeft, and DiagonalRight

color : String

Specifies the color of this border. This value can be either a 6-hexadecimal digit number in "#rrggbb" format or it can be any of the Microsoft® Internet Explorer named colors (including the named Microsoft Windows® colors). This string can also be the special value of Automatic. This string is case insensitive.

lineStyle : String

Specifies the appearance of this border. The Spreadsheet component does not support SlantDashDot and Double. Possible values: None, Continuous, Dash, Dot, DashDot, DashDotDot, SlantDashDot, and Double.

weight : Number

Specifies the weight (or thickness) of this border. This measurement is specified in points, and the following values map to Excel: 0—Hairline, 1—Thin, 2—Medium, 3—Thick.

getBorders : Object[]

Returns the value of borders

Returns

Object[]

setBorders (borders)

Sets the value of borders

Parameters

borders :  Object[]

font : Object

Defines the font attributes to use in this style. Each attribute that is specified is considered an override from the default.

Following keys are allowed on this object:

Properties

bold : Boolean

Specifies the bold state of the font. If the parent style has Bold: true and the child style wants to override the setting, it must explicitly set the value to Bold: false. If this attribute is not specified within an element, the default is assumed. Defaults to false.

color : String

Specifies the color of the font. This value can be either a 6-hexadecimal digit number in "#rrggbb" format or it can be any of the Internet Explorer named colors (including the named Windows colors). This string can also be special value of Automatic. This string is case insensitive. If this attribute is not specified within an element, the default is assumed. Defaults to Automatic.

fontName : String

Specifies the name of the font. This string is case insensitive. If this attribute is not specified within an element, the default is assumed. Defaults to Arial.

italic : Boolean

Similar to font.bold in behavior, this attribute specifies the italic state of the font. If this attribute is not specified within an element, the default is assumed. Defaults to false.

outline : Boolean

Similar to font.bold in behavior, this attribute specifies whether the font is rendered as an outline. This property originates in Macintosh Office, and is not used on Windows. If this attribute is not specified within an element, the default is assumed. The Spreadsheet component does not support this attribute. Defaults to false.

shadow : Boolean

Similar to font.bold in behavior, this attribute specifies whether the font is shadowed. This property originates in Macintosh Office, and is not used on Windows. If this attribute is not specified within an element, the default is assumed. The Spreadsheet component does not support this attribute. Defaults to false.

size : Number

Specifies the size of the font in points. This value must be strictly greater than 0. If this attribute is not specified within an element, the default is assumed. Defaults to 10.

strikeThrough : Boolean

Similar to font.bold in behavior, this attribute specifies the strike-through state of the font. If this attribute is not specified within an element, the default is assumed. The Spreadsheet component does not support this attribute. Defaults to false.

underline : String

Specifies the underline state of the font. If the parent style is something other than None and a child style wants to override the value, it must explicitly reset the value. If this attribute is not specified within an element, the default is assumed. Possible values: None, Single, Double, SingleAccounting, and DoubleAccounting. Defaults to None.

verticalAlign : String

This attribute specifies the subscript or superscript state of the font. If this attribute is not specified within an element, the default is assumed. The Spreadsheet component does not support this attribute. Possible values: None, Subscript, and Superscript. Defaults to None.

charSet : Number

Win32-dependent character set value. Defaults to 0.

family : String

Win32-dependent font family. Possible values: Automatic, Decorative, Modern, Roman, Script, and Swiss. Defaults to Automatic.

getFont : Object

Returns the value of font

Returns

Object

setFont (font)

Sets the value of font

Parameters

font :  Object

format : String

A number format code in the Excel number format syntax. This can also be one of the following values: General, General Number, General Date, Long Date, Medium Date, Short Date, Long Time, Medium Time, Short Time, Currency, Euro Currency, Fixed, Standard, Percent, Scientific, Yes/No, True/False, or On/Off. All special values are the same as the HTML number formats, with the exception of Currency and Euro Currency.

Currency is the currency format with two decimal places and red text with parenthesis for negative values.

Euro Currency is the same as Currency using the Euro currency symbol instead.

getFormat : String

Returns the value of format

Returns

String

setFormat (format)

Sets the value of format

Parameters

format :  String

id : String

A unique name within this XML document that identifies this style. This string can be any valid identifier and there is no notion of order. The special value of "Default" indicates that this style represents the default formatting for this workbook.

getId : String

Returns the value of id

Returns

String

setId (id)

Sets the value of id

Parameters

id :  String

interior : Object

Defines the fill properties to use in this style. Each attribute that is specified is considered an override from the default.

Following keys are allowed on this object:

Properties

color : String

Specifies the fill color of the cell. This value can be either a 6-hexadecimal digit number in "#rrggbb" format or it can be any of the Internet Explorer named colors (including the named Windows colors). This string can also be special value of Automatic. This string is case insensitive. If interior.pattern: "Solid", this value is the fill color of the cell. Otherwise, the cell is filled with a blend of interior.color and interior.patternColor, with the interior.pattern attribute choosing the appearance.

pattern : String

Specifies the fill pattern in the cell. The fill pattern determines how to blend the interior.color and interior.patternColor attributes to produce the cell's appearance. The Spreadsheet component does not support this attribute. Possible values: None, Solid, Gray75, Gray50, Gray25, Gray125, Gray0625, HorzStripe, VertStripe, ReverseDiagStripe, DiagStripe, DiagCross, ThickDiagCross, ThinHorzStripe, ThinVertStripe, ThinReverseDiagStripe, ThinDiagStripe, ThinHorzCross, and ThinDiagCross. Defaults to None.

patternColor : String

Specifies the secondary fill color of the cell when interior.pattern does not equal Solid. The Spreadsheet component does not support this attribute. Defaults to Automatic.

getInterior : Object

Returns the value of interior

Returns

Object

setInterior (interior)

Sets the value of interior

Parameters

interior :  Object

name : String

This property identifies this style as a named style that was created in Excel using the Style command (Format menu). Duplicate names are illegal.

getName : String

Returns the value of name

Returns

String

setName (name)

Sets the value of name

Parameters

name :  String

parentId : String

Presence of this element indicates that this style should first inherit it's default formatting settings from the specified parent style. Then, after the parent settings are inherited, we apply the settings in this style as overrides. This attribute refers to a predefined style ID.

Defaults to:

null

getParentId : String

Returns the value of parentId

Returns

String

setParentId (parentId)

Sets the value of parentId

Parameters

parentId :  String

protection : Object

Defines the protection properties that should be used in cells referencing this style. This element exists as a short-hand way to apply protection to an entire table, row, or column, by simply adding it to a style.

Following keys are allowed on this object and are all optional:

Defaults to:

null

Properties

protected : Boolean

This attribute indicates whether or not this cell is protected. When the worksheet is unprotected, cell-level protection has no effect. When a cell is protected, it will not allow the user to enter information into it. Defaults to true.

hideFormula : Boolean

This attribute indicates whether or not this cell's formula should be hidden when worksheet protection is enabled. Defaults to false.

getProtection : Object

Returns the value of protection

Returns

Object

setProtection (protection)

Sets the value of protection

Parameters

protection :  Object

properties

methods

Instance Methods

checkCollection ( data, dataCollection, className ) : Ext.util.Collection

This method could be used in config appliers that need to initialize a Collection that has items of type className.

Parameters

data :  Object

dataCollection :  Object

className :  Object

Returns

:Ext.util.Collection

getFormattedValue ( v )

Returns the specified value formatted according to the format of this style.

Parameters

v :  Object

getRenderData Object

Return the data used when rendering the template

Returns

:Object

render String

Renders the content according to the template provided to the class

Returns

:String
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.5.1