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


top

<ExtCalendar_multiview/> xtype: calendar-multiview premium

Summary

For an overview of calendar views see Ext.calendar.view.Base

This view is used to wrap multiple calendar panels and allows switching between and communicating with them through a single interface. This class does not provide any additional UI functionality. That is provided by <ExtCalendar/> which wraps this component.

Sample Multi view

Ext.create({
    xtype: 'calendar-multiview',
    renderTo: Ext.getBody(),
    height: 400,
    width: 400,
    store: {
        autoLoad: true,
        proxy: {
            type: 'ajax',
            url: 'calendars.php'
        },
        eventStoreDefaults: {
            proxy: {
                type: 'ajax',
                url: 'events.php'
            }
        }
    },
    views: {
        day: {
            xtype: 'calendar-day'
        },
        week: {
            xtype: 'calendar-week'
        },
        month: {
            xtype: 'calendar-month'
        }
    },
    defaultView: 'day'
});

In the previous example we've detailed the calendar panel types we're interested in having contained within the multi view using the cfg-views config option. The key specified for each calendar panel will be used when specifying the initial cfg-defaultView as well as when setting the current view at runtime using the method-setView method.

The following Multi view configs will be applied to any calendar panel in the views config:

Date Range Navigation

The movePrevious and moveNext move the active view backward and forward. The amount moved depends on the current view type.

Alternative Classes

If you require UI controls for navigating views and toggling the visibility of events per source calendar consider <ExtCalendar/>. Ext.calendar.panel.Panel wraps the Multi view and provides navigational controls.

No members found using the current filters

configs

Optional Configs

compact : Boolean
bindable bind

<ExtCalendar_multiview [compact]="true" />
let element = document.body.querySelector('ExtCalendar_multiview');
element.compact = true;
let compact = element.compact;

true to display this view in compact mode, typically used for smaller form factors. Setting to true applies any configured cfg-compactOptions.
The compact config is applied to all configured cfg-views.

Defaults to:

false

getCompact : Boolean

Returns the value of compact

Returns

Boolean

setCompact (compact)

Sets the value of compact

Parameters

compact :  Boolean

compactOptions : Object
bindable bind

<ExtCalendar_multiview compactOptions="{ }" />
let element = document.body.querySelector('ExtCalendar_multiview');
element.compactOptions = { };
let compactOptions = element.compactOptions;

A series of config options for this class to set when this class is in cfg-compact mode.
The compactOptions config is applied to all configured cfg-views.

Defaults to:

null

getCompactOptions : Object

Returns the value of compactOptions

Returns

Object

setCompactOptions (compactOptions)

Sets the value of compactOptions

Parameters

compactOptions :  Object

defaultView : String

<ExtCalendar_multiview defaultView="value" />
let element = document.body.querySelector('ExtCalendar_multiview');
element.defaultView = 'value';
let defaultView = element.defaultView;

The key of the item from views to use as the default.

Defaults to:

null

layout : Object / String
bindable bind

<ExtCalendar_multiview layout="value" />
let element = document.body.querySelector('ExtCalendar_multiview');
element.layout = 'value';
let layout = element.layout;

Configuration for this Container's layout. Example:

Defaults to:

'fit'

getLayout : Object / String

Returns the value of layout

Returns

Object / String

setLayout (layout)

Sets the value of layout

Parameters

layout :  Object / String

store : Object / Ext.calendar.store.Calendars
bindable bind

<ExtCalendar_multiview store="{ }" />
let element = document.body.querySelector('ExtCalendar_multiview');
element.store = { };
let store = element.store;

A Ext.calendar.store.Calendars instance or configuration
The store config is applied to all configured cfg-views.

Defaults to:

null

setStore (store)

Sets the value of store

Parameters

store :  Object / Ext.calendar.store.Calendars

timezoneOffset : Number
bindable bind

<ExtCalendar_multiview [timezoneOffset]="10" />
let element = document.body.querySelector('ExtCalendar_multiview');
element.timezoneOffset = 10;
let timezoneOffset = element.timezoneOffset;

The timezone offset to display this calendar in. The value should be specified in the same way as the native Date offset. That is, the number of minutes between UTC and local time. For example the offset for UTC+10 would be -600 (10 hours * 60 minutes ahead).

Defaults to the current browser offset.
The timezoneOffset config is applied to all configured cfg-views.

Defaults to:

undefined

getTimezoneOffset : Number

Returns the value of timezoneOffset

Returns

Number

setTimezoneOffset (timezoneOffset)

Sets the value of timezoneOffset

Parameters

timezoneOffset :  Number

value : Date
bindable bind

<ExtCalendar_multiview value="value" />
let element = document.body.querySelector('ExtCalendar_multiview');
element.value = 'value';
let value = element.value;

The value for the current view.

value: new Date('10-02-2016') // to set the date to Oct 2nd 2016


The value config is applied to all configured cfg-views.

Defaults to:

undefined

getValue : Date

Returns the value of value

Returns

Date

setValue (value)

Sets the value of value

Parameters

value :  Date

views : Object
bindable bind

<ExtCalendar_multiview views="{ }" />
let element = document.body.querySelector('ExtCalendar_multiview');
element.views = { };
let views = element.views;

The calendar views to have available, each item in this configuration (labelled by a key) is to contain the configuration for the view, a class that extends Ext.calendar.panel.Base.

Example with a day and week view:

views: {
    day: {
        xtype: 'calendar-day'
    },
    week: {
        xtype: 'calendar-week'
    }
}

The "day" and "week" keys would be the eligible values for the cfg-defaultView and the param string to pass to method-setView.

Defaults to:

null

getViews : Object

Returns the value of views

Returns

Object

setViews (views)

Sets the value of views

Parameters

views :  Object

methods

Instance Methods

moveNext

let element = document.body.querySelector('ExtCalendar_multiview');
element.moveNext();

Moves the active view forward. The amount moved depends on the current view.

movePrevious

let element = document.body.querySelector('ExtCalendar_multiview');
element.movePrevious();

Moves the active view backward. The amount moved depends on the current view.

navigate ( amount, [interval] )

let element = document.body.querySelector('ExtCalendar_multiview');
element.navigate(amount, interval);

Move the current view by an amount based of the current value.

Parameters

amount :  Number

The number of intervals to move.

interval :  String (optional)

The interval to navigate by. See Ext.Date for valid intervals.

Defaults to: Ext.Date.DAY

setView ( view )

let element = document.body.querySelector('ExtCalendar_multiview');
element.setView(view);

Set the active view.

Example defaultView / views configuration

defaultView: 'day',
views: {
    day: {
        xtype: 'calendar-day'
    },
    week: {
        xtype: 'calendar-week'
    }
}

To change the view from the default of "day" to "week":

ViewInstance.setView('week');

Parameters

view :  String

The view name from views.

ExtAngular 7.2.0