Docs Help

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.

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

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

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 and inheritance. 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.

Ext JS 6.2.0

Quick Start
Guides
API
modern
classic
top
premium

Exporter package

The Exporter package enables data export to various file formats. It supports native XSLX, Excel XML as well as HTML and CSV/TSV (comma/tab separated value) formats.

The package is not bundled within the Ext JS framework, but is easy to require into your application. Whether you're working with an application generated by Sencha Cmd or with an application structure of your own design, including the Exporter code only requires a couple of steps.

Note: This guide covers the exporter package bundled in the Premium version of the Ext JS 6.2 SDK.

Requirements

Ext JS

Exporter works with both classic and modern toolkits of Sencha Ext JS 6.2.

Sencha Cmd

Sencha Cmd is not required to utilize the Exporter. However, using Cmd allows you to seamlessly include the Exporter package via your application's app.json file.

Installation

Using Exporter with Sencha Cmd

The Exporter is delivered with full source code that is packaged in a way that makes it easy to deploy to your application's packages folder.

To include the Exporter in an application then simply modify your app.json file in your application root directory to require the Exporter package:

{

    "name": "YourApp",

    "requires": [

        "exporter"

    ],

    "id": "391a5ff6-2fd8-4e10-84d3-9114e1980e2d"

}

The package supports both classic and modern toolkits so there's no need for toolkit dependent configs.

Using the Exporter without Sencha Cmd

The SDK contains a compiled version of the Exporter's code that is available for those not using Sencha Cmd. To include the Exporter in this manner, link the following assets from your index page:

{unzippedFolder}/packages/exporter/build/{toolkit}/exporter.js

Using Exporter

The package provides a grid plugin and classes that generate files which could also be used independently.

Grid plugin

It allows grid data export to various file formats available in the package.

The plugin adds two new methods to the grid component:

  • saveDocumentAs: This function will save the exported file

  • getDocumentData: Returns the export document content

Both functions accept a config object as parameter:

  • type: This is the exporter type (_defaults to excel).

  • title: Set a title to be shown above column headers in the exported document.

  • fileName: Name of the saved file.

{
    xtype: 'grid',

    plugins: 'gridexporter',

    columns: [{
        dataIndex: 'value',
        text: 'Total',
        exportStyle: {
            format: 'Currency',
            alignment: {
                horizontal: 'Right'
            }
        }
    }]
}

// later in an event listeners
grid.saveDocumentAs({
    type: 'xlsx',
    title: 'My export',
    fileName: 'myExport.xlsx'
});

The following configs are available on the grid column:

  • ignoreExport Set to true to ignore data export for that column

  • exportStyle Allows you to format the exported data on that column

The exportStyle can be defined as a single object that will be used by all available exporters:

{
    xtype: 'datecolumn',
    dataIndex: 'date',
    text: 'Date',
    width: 120,

    exportStyle: {
        alignment: {
            horizontal: 'Right'
        },
        font: {
            bold: true
        },
        format: 'Short Date'
    }
}

It could also be defined as an array of objects, each object having a "type" property that specifies the exporter to which it applies:

{
    xtype: 'numbercolumn',
    dataIndex: 'price',
    text: 'Price',

    exportStyle: [{
        type: 'html', // used by the html exporter
        format: 'Currency',
        alignment: {
            horizontal: 'Right'
        },
        font: {
            italic: true
        }
    },{
        type: 'csv', // used by the csv exporter
        format: 'General'
    }]
}

When the array form is used, if the first entry does not have a "type" property it will be used for exporters that don't have a matching entry for its type.

{
    xtype: 'numbercolumn',
    dataIndex: 'price',
    text: 'Price',

    exportStyle: [{
        // no "type" defined means this is the default
        format: 'Currency',
        alignment: {
            horizontal: 'Right'
        },
        font: {
            italic: true
        }
    },{
        type: 'csv', // only the CSV exporter has a special style
        format: 'General'
    }]
}

Pivot Grid plugin

This plugin is part of the pivot package but uses exporters to export the data. The exportStyle config used by the grid column and described in the previous section is available on the aggregate and left axis dimensions of the pivot grid.

{
    xtype: 'pivotgrid',

    plugins: 'exporter',

    matrix: {

        leftAxis: [{
            dataIndex: 'employee',
            header: 'Employee',
            exportStyle: {
                font: {
                    bold: true
                }
            }
        }],

        aggregate: [{
            dataIndex: 'price',
            header: 'Total',
            aggregator: 'sum',
            exportStyle: {
                format: 'Currency',
                alignment: {
                    horizontal: 'Right'
                },
                font: {
                    italic: true
                }
            }
        }]

        // ... more configs
    }
}

Exporters

The base class for an exporter is Ext.exporter.Base. If a new exporter is needed then a new class could be defined that extends the Base class.

Ext.define('App.exporter.Pdf', {
    extend: 'Ext.exporter.Base',
    alias: 'exporter.pdf',

    fileName: 'export.pdf',
    binary: true,

    getContent: function(){
        // generate pdf content and return it back
    }

});

The new exporter will be available for Grid and Pivot Grid Exporter plugins.

// in an event listeners
grid.saveDocumentAs({
    type: 'pdf',
    title: 'My export',
    fileName: 'myExport.pdf'

    // ... other pdf specific configs
});

There are cases when tabular data that doesn't come from a grid panel or a pivot grid needs to be exported to a file. This could be achieved using the available exporters independently.

var exporter = Ext.Factory.exporter({
    type: 'excel',
    data: {
        columns: [{
            text: 'Vacation',
            columns: [
                { text: 'Month', width: 200, style: { alignment: { horizontal: 'Right' } } },
                { text: 'Days', style: { format: 'General Number' } }
            ]
        }],
        groups: [{
            text: 'Employees',
            groups: [{
                text: 'Adrian',
                rows: [{
                    cells: [
                        { value: 'January' },
                        { value: 2 }
                    ]
                },{
                    cells: [
                        { value: 'July' },
                        { value: 10 }
                    ]
                }],
                summaries: [{
                    cells: [
                        { value: 'Total' },
                        { value: 12 }
                    ]
                }]
            },{
                text: 'John',
                rows: [{
                    cells: [
                        { value: 'March' },
                        { value: 4 }
                    ]
                },{
                    cells: [
                        { value: 'May' },
                        { value: 4 }
                    ]
                },{
                    cells: [
                        { value: 'July' },
                        { value: 2 }
                    ]
                }],
                summaries: [{
                    cells: [
                        { value: 'Total' },
                        { value: 10 }
                    ]
                }]
            }],
            summaries: [{
                cells: [
                    { value: 'Grand total' },
                    { value: 22 }
                ]
            }]
        }]
    }
});
// save the file
exporter.saveAs().then( function() { exporter.destroy(); } );

File saving

The singleton Ext.exporter.File contains functions for file manipulation. It is used by exporters to save generated files on the end-user machine. Some modern browsers allow local file saving via Blobs but others do not support this. To solve this problem the generated file content is sent to the server and returned back with proper headers that will trigger a file download. The default server that does that is defined in Ext.exporter.File#property-url which goes to https://exporter.sencha.com but an internal server could be used instead.

Check out the server folder in the exporter package for Node and PHP implementations of a server script.

Ext JS 6.2.0

Ext JS
Sencha Test
Cmd
Sencha Themer
GXT
IDE Plugins
Sencha Inspector
Architect
Sencha Fiddle
Touch
Offline Documentation

Sencha Test

2.0.1 2.0.0 1.0.3

Cmd

Cmd

Sencha Themer

1.1.0 1.0.2

GXT

4.x 3.x

IDE Plugins

IDE Plugins

Sencha Inspector

Sencha Inspector

Sencha Fiddle

Sencha Fiddle

Offline Documentation

Offline Documentation