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

Guides
API
top
Guide applies to: classic

Pivot Grid Upgrade Guide

Package Structure

The mzPivotGrid and mzPivotMatrix packages have been merged into a single package called pivot. The resulting structure looks like this:

PivotGrid File Structure

Package Inclusion

If you used the mzPivotGrid package in your MVC app, you will need to change your requires block in the Sencha Cmd generated app.json file. Previously, it was named mzPivotGrid. It should be updated to pivot and the exporter package should also be copied to the app packages folder since it is required by pivot.

Build Files

If you used the built version of mzPivotGrid, be sure to change all paths to point towards the compiled file in the package's build directory.

For instance:

 pivot/build/pivot{-debug}.js

You will also need to utilize the appropriate CSS file that can also be found in the build directory's theme folders.

 pivot/build/{theme}/resources/pivot-{flavor}.js

Updated Namespace

Several classes have been changed:

  • Mz namespace has been moved to the Ext namespace.
  • Mz.aggregate. have been moved to Ext.pivot..
  • All Abstract classes have been renamed to Base.
  • Mz.pivot.plugin.ExcelExport is now Ext.pivot.plugin.Exporter and its ptype is exporter.
  • Mz.pivot.dataexport.* have been dropped and the Excel classes are now part of the exporter package.
  • Mz.pivot.plugin.drilldown.* have been dropped.
  • All Sass variables for the pivot package have been reworked and are now prefixed with pivot-grid.
  • Ext.pivot.MixedCollection and all Ext.pivot.plugin.configurator.* classes are now private.
  • All plugins have new ptypes prefixed with pivot: pivotconfigurator, pivotdrilldown, pivotrangeeditor and pivotexporter

Updated Configs

The pivot grid component used to have mzpivotgrid as xtype which is now pivotgrid. mzpivotgrid is still available but will be dropped in future versions.

All Abstract (Base) classes have been changed to use factoriable configs. Ext.Factory is used now internally to instantiate objects instead of Ext.createByAlias. Previously the mztype config was used to identify the class that needed to be instantiated. Since version 6 you should use type instead of mztype.

For instance:

 {
      xtype: 'mzpivotgrid',
      matrixConfig: {
           mztype: 'local',
           store: 'storeId'
      },
      //...
 }

Should be replaced with:

 {
      xtype: 'pivotgrid',
      matrixConfig: {
           type: 'local',
           store: 'storeId'
      },
      //...
 }

Since mztype is now type, the old type config in Ext.pivot.filter.Base became operator. All constants defined in the Base filter class were dropped and literals should be used to set the operator.

For instance:

 topAxis: [{
      dataIndex:     'year',
      header:        'Year',
      filter: {
           mztype:   'label',
           type:     Mz.aggregate.filter.Abstract.TypeBetween
           from:     2010,
           to:       2012
      }
 }]

Should be replaced with:

 topAxis: [{
      dataIndex:     'year',
      header:        'Year',
      filter: {
           type:     'label',
           operator: 'between',
           value:    [2010, 2012]
      }
 }]

Please take a look at the Ext.pivot.filter.* classes to see what other operators are available.

Remote calculations

Matrix configs keysSeparator and grandTotalKey are sent to the server together will all configured dimensions and should be used on the server when the JSON response is generated.

Localization

image alt text

All pivot grid locales have been moved to the pivot-locale package.

Export to Excel plugin

This plugin has been refactored. The Mz.pivot.plugin.ExcelExport class has been renamed to Ext.pivot.plugin.Exporter which has now the ptype: "pivotexporter".

For instance:

 {
      xtype: 'mzpivotgrid',
      plugins: [{
           ptype: 'mzexcelexport',
           pluginId: 'excel',
           title: 'Excel export'
      }]
 }

 //somewhere on a button you might have something like this
 var xml = grid.getPlugin('excel').getExcelData(true, true);
 // and the xml content was either sent to the server or saved in the browser somehow

Should be replaced with:

 {
      xtype: 'pivotgrid',
      plugins: [{
           ptype: 'pivotexporter'
      }]
 }

 // somewhere on a button you may have something like this
 grid.saveDocumentAs({
      type: 'excel',
      title: 'Excel export',
      onlyExpandedNodes: true, // that's the equivalent of the first param in the old getExcelData function
      showSummary: false, // that's the equivalent of the 2nd param in the old getExcelData function
      fileName: 'export.xml'
 });

 // saveDocumentAs will try to save the file in the browser. If your browser is not supported then do this
 var xml = grid.getDocumentData({
       type: 'excel',
       title: 'Excel export',
       onlyExpandedNodes: true, // that's the equivalent of the first param in the old getExcelData function
       showSummary: false // that's the equivalent of the 2nd param in the old getExcelData function
  });
 // and probably send the xml content to the server

As you can see above the pivotexporter plugin adds two new methods to the pivot grid component. These methods accept a config object as parameter.

A bunch of configs were available on the old plugin which allowed you to style the Excel output. These configs do not exist anymore on the plugin level, instead a new set of configs can be passed to the saveDocumentAs or getDocumentData methods. Reason is that you could implement your own Exporter class that extends Ext.exporter.Base which can have its own set of configs.

Here is an example of how to map the old configs to the new Excel Exporter class.

 grid.saveDocumentAs({
      type: 'excel',
      title: 'Excel export', // previously set on the plugin itself
      defaultStyle: {
           font: {
                FontName: 'Calibri',     // previously known as `cellFontName`
                Size: 11,                // previously known as `cellFontSize`
                Family: 'Swiss',
                Color: '#000000'
           },
           interior: {
                Color: '#ffffff'         // previously known as `cellFillColor`
           },
           borders: [{
                Position: 'Top',
                Color: 'red'             // previously known as `cellBorderColor`
           }]
      },

      titleStyle: {
           name: 'Title',
           font: {
                Size: 11                 // previously known as `titleFontSize`
           },
           interior: {
                Color: '#ffffff'         // previously known as `titleFillColor`
           }
      },

      tableHeaderStyle: {
           name: 'Heading 1',
           font: {
                Size: 11                 // previously known as `headerFontSize`
           },
           interior: {
                Color: '#ffffff'         // previously known as `headerFillColor`
           }
      },

      groupHeaderStyle: {
           name: 'Group header',
           font: {
                Size: 11                 // previously known as `groupHeaderFontSize`
           },
           interior: {
                Color: '#ffffff'         // previously known as `groupHeaderFillColor`
           }
      },

      groupFooterStyle: {
           name: 'Group header',
           font: {
                Size: 11                 // previously known as `groupFooterFontSize`
           },
           interior: {
                Color: '#ffffff'         // previously known as `groupFooterFillColor`
           }
      }
 });

In this new approach various other styling can be applied to the exported document. Check out the Ext.exporter.file.excel.Style class for more styling options.

Ext JS 6.0.2

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

Sencha Test

2.0.0 1.0.3

Cmd

Cmd

Sencha Themer

1.1.0 EA 1.0.2

GXT

5.x EA 4.x 3.x

IDE Plugins

IDE Plugins

Sencha Inspector

Sencha Inspector

Sencha Fiddle

Sencha Fiddle

Offline Documentation

Offline Documentation