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 7.0.0


top

<ExtCalendar_daysview/> calendar-daysview premium

Summary

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

The Days view displays events for multiple days with the time of day along the y axis. The view will display the current date as the first day displayed unless configured with a different date cfg-value. The number of days displayed can be set using the cfg-visibleDays config option. By default, the calendar hours are displayed as a 24 hour clock and are constrained to 8 (8:00am) and 20 (8:00pm). The beginning and end hour can be set using the cfg-startTime and cfg-endTime configs. The time displayed on the timeline may be customized using either the cfg-timeFormat or cfg-timeRenderer config options.

Below are some of the distinctions to the Days view (and generally its subclasses).

Current Local Time

The current local time (when the current date is displayed) will be shown on the view as a thin marker on the day's timeline. The current time marker can be set using the cfg-showNowMarker option.

Calendar Events

Events show on the timeline with their start and end times correlating to the time labels. The events will display on the timeline according to your local timezone offset from GMT. The timezone offset can be applied explicitly using the cfg-timezoneOffset config option. The exception being all day or multi-day events. All day / multi-day events will show up at the top of the view in a dedicated space preceding the view's start time.

Adding All Day Events

In addition to being able to drag / swipe across a day's timeline to show the event add form, an all day type event can be quickly added by tapping / clicking on the dedicated all day row displayed above the start hour. This is the same dedicated space used to display existing all day events.

Date Range Navigation

The movePrevious and moveNext methods modify the displayed date range by moving the range forward or backward the number of days set on the cfg-visibleDays config.

Alternative Classes

If your view requires a header showing the dates displayed consider using <ExtCalendar_days/> instead. To display a single day consider using the <ExtCalendar_dayview/> view or <ExtCalendar_weekview/> to view a week at a time.

Children

The following Components (and their sub-components) may be included as children of Calendar_DaysView:
<ExtTooltip/>
No members found using the current filters

properties

Optional Properties

addForm : Object

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

The configuration for the <ExtCalendar_form-add/> to be used when an event is to be created. Use null to disable creation.

allowSelection : Boolean

<ExtCalendar_daysview allowSelection="true" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.allowSelection = true;
let allowSelection = element.allowSelection;

true to allow selection in the UI to create events. This includes being able to drag-select a range in the all day area, as well as click/tap in the day area (the dedicated space just above the start time's row) to create an event.

See method-showAddForm for adding an event when selection is disabled.

Defaults to:

true

alwaysOnTop : Boolean / Number

<ExtCalendar_daysview alwaysOnTop="true" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.alwaysOnTop = true;
let alwaysOnTop = element.alwaysOnTop;

A flag indicating that this component should be above its floated siblings.

This may be a positive number to prioritize the ordering of multiple visible always on top components.

This may be set to a negative number to prioritize a component to the bottom of the z-index stack.

Defaults to:

null

Available since: 6.2.0

ariaAttributes : Object

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

An object containing ARIA attributes to be set on this Component's ARIA element. Use this to set the attributes that cannot be determined by the Component's state, such as aria-live, aria-flowto, etc.

Note that this config is only meaningful at the Component rendering time, and setting it after that will do nothing.

ariaDescribedBy : String
immutable imm

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

DOM selector for a child element that is to be used as description for this Component, set in aria-describedby attribute. The selector works the same way as ariaLabelledBy.

ariaLabel : String
immutable imm

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

ARIA label for this Component. It is best to use ariaLabelledBy option instead, because screen readers prefer aria-labelledby attribute to aria-label. ariaLabel and ariaLabelledBy config options are mutually exclusive.

ariaLabelledBy : String
immutable imm

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

DOM selector for a child element that is to be used as label for this Component, set in aria-labelledby attribute. If the selector is by id, the label element can be any existing element, not necessarily a child of the main Component element.

ariaLabelledBy and ariaLabel config options are mutually exclusive, and ariaLabelledBy has the higher precedence.

axisLock : Boolean
immutable imm

<ExtCalendar_daysview axisLock="true" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.axisLock = true;
let axisLock = element.axisLock;

If true, then, when showBy or alignTo fallback on constraint violation only takes place along the major align axis.

That is, if alignment "l-r" is being used, and axisLock: true is used, then if constraints fail, only fallback to "r-l" is considered.

Defaults to:

null

border : Boolean

<ExtCalendar_daysview border="true" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.border = true;
let border = element.border;

Enables or disables bordering on this component. The following values are accepted:

  • null or `true (default): Do nothing and allow the border to be specified by the theme.
  • false: suppress the default border provided by the theme.

Please note that enabling bordering via this config will not add a border-color or border-style CSS property to the component; you provide the border-color and border-style via CSS rule or style configuration (if not already provide by the theme).

Defaults to:

null

bottom : Number / String

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

The absolute bottom position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Explicitly setting this value will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

centered : Boolean

<ExtCalendar_daysview centered="true" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.centered = true;
let centered = element.centered;

Configure this as true to have this Component centered within its Container. Setting this value to true will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

compact : Boolean

<ExtCalendar_daysview compact="true" />
let element = document.body.querySelector('ExtCalendar_daysview');
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.

Defaults to:

false

compactOptions : Object

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

A series of config options for this class to set when this class is in cfg-compact mode.

Defaults to:

null

constrainTo : Ext.dom.Element / Ext.util.Region

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

The element into which floated or positioned items constrain their position.

Defaults to the parent container for positioned components, and to the viewport for floated components.

Defaults to:

null

contentEl : Ext.dom.Element / HTMLElement / String

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

The configured element will automatically be added as the content of this component. When you pass a string, we expect it to be an element id. If the content element is hidden, we will automatically show it.

Defaults to:

null

data : Object

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

The initial set of data to apply to the tpl to update the content area of the Component.

Defaults to:

null

disabled : Boolean

<ExtCalendar_daysview disabled="true" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.disabled = true;
let disabled = element.disabled;

Whether or not this component is disabled

Defaults to:

null

displayOverlap : Boolean

<ExtCalendar_daysview displayOverlap="true" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.displayOverlap = true;
let displayOverlap = element.displayOverlap;

When displaying events, allow events that intersect to horizontally overlap to save on horizontal space.

Defaults to:

true

docked : String

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

The dock position of this component in its container. Can be left, top, right or bottom.

Notes

You must use a HTML5 doctype for docked bottom to work. To do this, simply add the following code to the HTML file:

<!doctype html>

So your index.html file should look a little like this:

<!doctype html>
<html>
    <head>
        <title>MY application title</title>
        ...

Defaults to:

null

draggable : Boolean

<ExtCalendar_daysview draggable="true" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.draggable = true;
let draggable = element.draggable;

true to allows events to be dragged from this view.

Defaults to:

true

droppable : Boolean

<ExtCalendar_daysview droppable="true" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.droppable = true;
let droppable = element.droppable;

true to allows events to be dropped on this view.

Defaults to:

true

editForm : Object

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

The configuration for the <ExtCalendar_form-edit/> to be used when an event is to be modified. Use null to disable editing.

endTime : Number

<ExtCalendar_daysview endTime="10" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.endTime = 10;
let endTime = element.endTime;

The hour number to end this view. Should be a value between 1 and 24.

Defaults to:

20

eventDefaults : Object

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

The default configuration for <ExtCalendar_event/> widgets

factoryConfig : Object
readonly ro

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

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

flex : Number / String / Object

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

The flex of this item if this item item is inside a Ext.layout.HBox or Ext.layout.VBox layout.

You can also update the flex of a component dynamically using the Ext.layout.FlexBox#setItemFlex method.

When supplied as a string or number this option supports the same syntax as CSS href="https://developer.mozilla.org/en-US/docs/Web/CSS/flex" class="external-link" target="_blank">https://developer.mozilla.org/en-US/docs/Web/CSS/flex flex. For example:

flex: '1 2 auto'

sets flex-grow property to 0, flex-shrink to 2 and flex-basis to 'auto'.

The default flex-shrink value for box layout items is set to 0 in the stylesheet, which is different from the browser's default flex-shrink value of 1. This accommodates the majority use case for applications since where non-flexed components are typically not expected to shrink smaller than their default size.

For convenience when only a single number is supplied it is used as the value for both flex-grow and flex-shrink, for example flex: 3 is the same as flex: '3 3'

An object form with camel-cased names is also accepted:

flex: {
    grow: 1,
    shrink: 2,
    basis: 'auto'
}

When the object form is supplied shrink always defaults to 0 regardless of the value of grow.

Although 'auto' is the default value for flex-basis, flex-basis defaults to 0% when flex is supplied as a single numeric or string value (e.g. flex: 1). If this behavior is not desired either explicitly set flex-basis to 'auto' or use the object form to set only grow and/or shrink:

flex: {
    grow: 2
}

floated : Boolean

<ExtCalendar_daysview floated="true" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.floated = true;
let floated = element.floated;

A Component may be floated above all other components in the application. This means that the component is absolutely positioned, and will move to the front and occlude other sibling floated component if clicked.

A Floated component may have floated descendants. It will bring these decendants to the front with it when brought to the front of its sibling floated components.

By default, descendant floated components are all positioned using the viewport coordinate system. To make a floating component a positioning parent for descendants, and have the ancestors positioned relatively, configure the parent floated component with cfg-relative: true.

Defaults to:

null

Available since: 6.2.0

focusCls : String
immutable imm

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

CSS class that will be added to focused component's focusClsEl, and removed when component blurs.

Defaults to:

'x-focused'

focusClsEl : Ext.dom.Element
readonly ro

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

The element that will have the focusCls applied when component's focusEl is focused.

focusEl : Ext.dom.Element
readonly ro

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

The element that will be focused when focus method is called on this component. Usually this is the same element that receives focus via mouse clicks, taps, and pressing Tab key.

Defaults to:

'el'

fullscreen : Boolean
immutable imm

<ExtCalendar_daysview fullscreen="true" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.fullscreen = true;
let fullscreen = element.fullscreen;

Force the component to take up 100% width and height available, by adding it to Ext.Viewport.

gestureNavigation : Boolean

<ExtCalendar_daysview gestureNavigation="true" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.gestureNavigation = true;
let gestureNavigation = element.gestureNavigation;

Allow the view to have the value (displayed date range) changed via swipe navigation on devices that support it

Defaults to:

true

height : Number / String

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

The height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. By default, if this is not explicitly set, this Component's element will simply have its own natural size. If set to auto, it will set the width to null meaning it will have its own natural size.

Defaults to:

null

hidden : Boolean

<ExtCalendar_daysview hidden="true" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.hidden = true;
let hidden = element.hidden;

Whether or not this Component is hidden (its CSS display property is set to none).

Defaults to true for floated Components.

Defaults to:

null

hideAnimation : String / Mixed

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

Animation effect to apply when the Component is being hidden. Typically you want to use an outbound animation type such as 'fadeOut' or 'slideOut'. For more animations, check the Ext.fx.Animation#type config.

Defaults to:

null

hideOnMaskTap : Boolean

<ExtCalendar_daysview hideOnMaskTap="true" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.hideOnMaskTap = true;
let hideOnMaskTap = element.hideOnMaskTap;

When using a modal Component, setting this to true will hide the modal mask and the Container when the mask is tapped on.

Defaults to:

null

html : String / Ext.dom.Element / HTMLElement

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

Optional HTML content to render inside this Component, or a reference to an existing element on the page.

Defaults to:

null

id : String

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

The unique id of this component instance.

It should not be necessary to use this configuration except for singleton objects in your application. Components created with an id may be accessed globally using Ext.getCmp.

Instead of using assigned ids, use the itemId config, and Ext.ComponentQuery which provides selector-based searching for Sencha Components analogous to DOM querying. The <ExtContainer/> class contains shortcut methods to query its descendant Components by selector.

Note that this id will also be used as the element id for the containing HTML element that is rendered to the page for this component. This allows you to write id-based CSS rules to style the specific instance of this component uniquely, and also to select sub-elements using this component's id as the parent.

Note: to avoid complications imposed by a unique id also see itemId.

Defaults to an auto-assigned id.

isObservable : Boolean
readonly ro

<ExtCalendar_daysview isObservable="true" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.isObservable = true;
let isObservable = element.isObservable;

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

Defaults to:

true

itemId : String

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

An itemId can be used as an alternative way to get a reference to a component when no object reference is available. Instead of using an id with Ext#getCmp, use itemId with Ext.Container#getComponent which will retrieve itemId's or id's. Since itemId's are an index to the container's internal MixedCollection, the itemId is scoped locally to the container - avoiding potential conflicts with Ext.ComponentManager which requires a unique id.

Also see id, Ext.Container#query, Ext.Container#down and Ext.Container#child.

keyMap : Object

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

An object containing handlers for keyboard events. The property names of this object are the key name and any modifiers. The values of the properties are the descriptors of how to handle each event.

The handler descriptor can be simply the handler function (either the literal function or the method name), or it can be an object with these properties:

  • handler: The function or its name to call to handle the event.
  • scope: The this pointer context (can be "this" or "controller").
  • event: An optional override of the key event to which to listen.

Important: Calls to setKeyMap do not replace the entire keyMap but instead update the provided mappings. That is, unless null is passed as the value of the keyMap which will clear the keyMap of all entries.

Properties

scope : String

The default scope to apply to key handlers which do not specify a scope. This is processed the same way as the scope of cfg-listeners. It defaults to the "controller", but using 'this' means that an instance method will be used.

keyMapEnabled : Boolean

<ExtCalendar_daysview keyMapEnabled="true" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.keyMapEnabled = true;
let keyMapEnabled = element.keyMapEnabled;

Enables or disables processing keys in the keyMap. This value starts as null and if it is null when initKeyMap is called, it will automatically be set to true. Since initKeyMap is called by Ext.Component at the proper time, this is not something application code normally handles.

Defaults to:

null

left : Number / String

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

The absolute left position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Explicitly setting this value will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

listeners : Object

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

A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once.

DOM events from Ext JS Ext.Component

While some Ext JS Component classes export selected DOM events (e.g. "click", "mouseover" etc), this is usually only done when extra value can be added. For example the DataView's itemclick event passing the node clicked on. To access DOM events directly from a child element of a Component, we need to specify the element option to identify the Component property to add a DOM listener to:

new Ext.panel.Panel({
    width: 400,
    height: 200,
    dockedItems: [{
        xtype: 'toolbar'
    }],
    listeners: {
        click: {
            element: 'el', //bind to the underlying el property on the panel
            fn: function(){ console.log('click el'); }
        },
        dblclick: {
            element: 'body', //bind to the underlying body property on the panel
            fn: function(){ console.log('dblclick body'); }
        }
    }
});

margin : Number / String
immutable imm

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

The margin to use on this Component. Can be specified as a number (in which case all edges get the same margin) or a CSS string like '5 10 10 10'

maxHeight : Number / String

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

The maximum height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. If set to auto, it will set the width to null meaning it will have its own natural size. Note that this config will not apply if the Component is 'positioned' (absolutely positioned or centered)

Defaults to:

null

maxWidth : Number / String

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

The maximum width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. If set to auto, it will set the width to null meaning it will have its own natural size. Note that this config will not apply if the Component is 'positioned' (absolutely positioned or centered)

Defaults to:

null

minHeight : Number / String

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

The minimum height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. If set to auto, it will set the width to null meaning it will have its own natural size.

Defaults to:

null

minWidth : Number / String

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

The minimum width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. If set to auto, it will set the width to null meaning it will have its own natural size.

Defaults to:

null

modal : Boolean

<ExtCalendar_daysview modal="true" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.modal = true;
let modal = element.modal;

true to make this Component modal. This will create a mask underneath the Component that covers its parent and does not allow the user to interact with any other Components until this Component is dismissed.

Defaults to:

null

name : String
immutable imm

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

Name for the widget to be used with Ext.Container#lookupName et al.

Defaults to:

null

padding : Number / String

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

The padding to use on this Component. Can be specified as a number (in which case all edges get the same padding) or a CSS string like '5 10 10 10'

Defaults to:

null

plugins : Object / String / Object[] / String[]

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

An object or array of objects that will provide custom functionality for this component. If a string is provided or a string is one of the elements of the array, that string is treated as the type alias. For example, "listpaging" is the type alias for Ext.plugin.ListPaging. The full alias includes the "plugin." prefix (i.e., 'plugin.listpaging').

Plugins should derive from Ext.plugin.Abstract but this is not required. The only requirement for a valid plugin is that it contain an init() method that accepts a reference to the owning component.

When a component is created, if any plugins are available, the component will call the init method on each plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the component as needed to provide its functionality.

Example code

A plugin by alias:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: 'listpaging'
 });

Multiple plugins by alias:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: ['listpaging', 'pullrefresh']
 });

Single plugin by class name with config options:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: {
         type: 'listpaging',
         autoPaging: true
     }
 });

Multiple plugins by type and class name with config options:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: [{
         xclass: 'Ext.plugin.PullRefresh',
         pullRefreshText: 'Pull to refresh...'
     }, {
         type: 'listpaging',
         autoPaging: true
     }]
 });

record : Ext.data.Model

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

A model instance which updates the Component's html based on it's tpl. Similar to the data configuration, but tied to to a record to make allow dynamic updates. This must be a model instance and not a configuration of one.

Defaults to:

null

relative : Boolean

<ExtCalendar_daysview relative="true" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.relative = true;
let relative = element.relative;

Only valid when a component is cfg-floated

Configure this as true if you require descendant floated components to be positioned relative to this component's coordinate space, not the viewport's coordinate space.

Note: The coordinate space is this Component's encapsulating element's area. Not that of the inner element in which static child items are rendered by the layout.

Defaults to:

null

Available since: 6.2.0

resizeEvents : Boolean

<ExtCalendar_daysview resizeEvents="true" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.resizeEvents = true;
let resizeEvents = element.resizeEvents;

true to allow events in the day area to be resized.

Defaults to:

true

right : Number / String

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

The absolute right position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Explicitly setting this value will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

scrollable : Boolean / String / Object

<ExtCalendar_daysview scrollable="true" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.scrollable = true;
let scrollable = element.scrollable;

Configuration options to make this Component scrollable. Acceptable values are:

  • true to enable auto scrolling.
  • false (or null) to disable scrolling - this is the default.
  • x or horizontal to enable horizontal scrolling only
  • y or vertical to enable vertical scrolling only

Also accepts a configuration object for a Ext.scroll.Scroller if if advanced configuration is needed.

The getter for this config returns the Ext.scroll.Scroller instance. You can use the Scroller API to read or manipulate the scroll position:

// scrolls the component to 5 on the x axis and 10 on the y axis
component.getScrollable().scrollTo(5, 10);

Defaults to:

null

shadow : Boolean

<ExtCalendar_daysview shadow="true" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.shadow = true;
let shadow = element.shadow;

Configure as true for the component to have a drop shadow. 'false' will suppress any default shadow. By default the theme will determine the presence of a shadow.

Defaults to:

null

Available since: 6.2.0

shim : Boolean

<ExtCalendar_daysview shim="true" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.shim = true;
let shim = element.shim;

Only valid when a component is cfg-floated

Configure as true for the component to use an <iframe> as an underlay to ensure certain non-standard browser plugins are occluded by this component.

Defaults to:

null

Available since: 6.2.0

showAnimation : String / Mixed

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

Animation effect to apply when the Component is being shown. Typically you want to use an inbound animation type such as 'fadeIn' or 'slideIn'. For more animations, check the Ext.fx.Animation#type config.

Defaults to:

null

showNowMarker : Boolean

<ExtCalendar_daysview showNowMarker="true" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.showNowMarker = true;
let showNowMarker = element.showNowMarker;

true to show a marker on the view that equates to the current local time.

Defaults to:

true

startTime : Number

<ExtCalendar_daysview startTime="10" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.startTime = 10;
let startTime = element.startTime;

The hour number to start this view. Should be a value between 0 and 23.

Defaults to:

8

store : Object / Ext.calendar.store.Calendars

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

A Ext.calendar.store.Calendars instance or configuration

Defaults to:

null

style : String / Object

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

Additional CSS styles that will be rendered into an inline style attribute when the widget is rendered.

You can pass either a string syntax:

style: 'background:red'

Or by using an object:

style: {
    background: 'red'
}

When using the object syntax, you can define CSS Properties by using a string:

style: {
    'border-left': '1px solid red'
}

Although the object syntax is much easier to read, we suggest you to use the string syntax for better performance.

Defaults to:

null

tabIndex : Number

<ExtCalendar_daysview tabIndex="10" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.tabIndex = 10;
let tabIndex = element.tabIndex;

DOM tabIndex attribute for this component's focusEl.

Defaults to:

null

timeFormat : String

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

The format to display the time values in the time gutter.

Refer to the class description of Ext.Date for formatting options.

Example format for displaying a 12-hour time with an am/pm suffix:

timeFormat: 'h:ia' // displays 14:00 hours as 2:00pm

Defaults to:

'H:i'

timeRenderer : Function

<ExtCalendar_daysview timeRenderer="function() { }" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.timeRenderer(hour, formatted, firstInGroup);

A formatting function for more complex displays of time values in the time gutter.

Defaults to:

null

Parameters

hour :  Number

The hour being shown.

formatted :  String

The formatted value as specified by the timeFormat.

firstInGroup :  Boolean

true if this hour is the first hour in the specified time range to be in the morning (< 12) or in the afternoon > 12.

timezoneOffset : Number

<ExtCalendar_daysview timezoneOffset="10" />
let element = document.body.querySelector('ExtCalendar_daysview');
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.

Defaults to:

undefined

toFrontOnShow : Boolean

<ExtCalendar_daysview toFrontOnShow="true" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.toFrontOnShow = true;
let toFrontOnShow = element.toFrontOnShow;

True to automatically call toFront when a cfg-floated Component is shown.

Defaults to:

true

top : Number / String

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

The absolute top position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Explicitly setting this value will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

touchAction : Object
immutable imm

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

Emulates the behavior of the CSS touch-action property in a cross-browser compatible manner.

Keys in this object are touch action names, and values are false to disable a touch action or true to enable it. Accepted keys are:

  • panX
  • panY
  • pinchZoom
  • doubleTapZoom

All touch actions are enabled (true) by default, so it is usually only necessary to specify which touch actions to disable. For example, the following disables only horizontal scrolling and pinch-to-zoom on the component's main element:

touchAction: {
    panX: false,
    pinchZoom: false
}

Touch actions can be specified on reference elements using the reference element name, for example:

// disables horizontal scrolling on the main element, and double-tap-zoom
// on the child element named "body"
touchAction: {
    panY: false
    body: {
        doubleTapZoom: false
    }
}

The primary motivation for setting the touch-action of an element is to prevent the browser's default handling of a gesture such as pinch-to-zoom, or drag-to-scroll, so that the application can implement its own handling of that gesture on the element. Suppose, for example, a component has a custom drag handler on its element and wishes to prevent horizontal scrolling of its container while it is being dragged:

Defaults to:

null

tpl : Function / String / String[]

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

A string, array of strings, or a function that returns JSX.

tpl = data =>

{data.first_name} {data.last_name}

Note The data configuration must be set for any content to be shown in the component when using this configuration.

Defaults to:

null

tplWriteMode : String

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

The Ext.(X)Template method to use when updating the content area of the Component.

Valid modes are:

  • append
  • insertAfter
  • insertBefore
  • insertFirst
  • overwrite

Defaults to:

'overwrite'

ui : String / String[]
immutable imm

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

The ui or uis to be used on this Component

When a ui is configured, CSS class names are added to the element, created by appending the ui name(s) to each classCls and/or baseCls.

Defaults to:

null

userCls : String / String[]
immutable imm

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

One or more CSS classes to add to the component's primary element. This config is intended solely for use by the component instantiator (the "user"), not by derived classes.

Defaults to:

null

value : Date

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

The value to start the view from. The events displayed on this view are configured by the value and the visibleDays.

Defaults to:

new Date()

visibleDays : Number

<ExtCalendar_daysview visibleDays="10" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.visibleDays = 10;
let visibleDays = element.visibleDays;

The number of days to show starting from the cfg-value.

Defaults to:

4

weight : Number
immutable imm

<ExtCalendar_daysview weight="10" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.weight = 10;
let weight = element.weight;

This value controls this item's order in a weighted <ExtContainer/> (see parent).

Lower values gravitate towards the start of the container - the top in vertical layouts, the locale start side in horizontal layouts.

Defaults to:

null

width : Number / String

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

The width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. By default, if this is not explicitly set, this Component's element will simply have its own natural size. If set to auto, it will set the width to null meaning it will have its own natural size.

Defaults to:

null

x : Number

<ExtCalendar_daysview x="10" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.x = 10;
let x = element.x;

Only valid when a component is cfg-floated

The x position at which to position this component. This is usually viewport-relative. But if there is a relative: true ancestor, it will be relative to that.

Defaults to:

0

xtype : String
immutable imm

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

The xtype configuration option can be used to optimize Component creation and rendering. It serves as a shortcut to the full component name. For example, the component Ext.button.Button has an xtype of button.

You can define your own xtype on a custom Ext.Component by specifying the alias config option with a prefix of widget. For example:

Ext.define('PressMeButton', {
    extend: 'Ext.button.Button',
    alias: 'widget.pressmebutton',
    text: 'Press Me'
});

Any Component can be created implicitly as an object config with an xtype specified, allowing it to be declared and passed into the rendering pipeline without actually being instantiated as an object. Not only is rendering deferred, but the actual creation of the object itself is also deferred, saving memory and resources until they are actually needed. In complex, nested layouts containing many Components, this can make a noticeable improvement in performance.

Defaults to:

"component"

y : Number

<ExtCalendar_daysview y="10" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.y = 10;
let y = element.y;

Only valid when a component is cfg-floated

The x position at which to position this component. This is usually viewport-relative. But if there is a relative: true ancestor, it will be relative to that.

Defaults to:

0

zIndex : Number

<ExtCalendar_daysview zIndex="10" />
let element = document.body.querySelector('ExtCalendar_daysview');
element.zIndex = 10;
let zIndex = element.zIndex;

The z-index to give this Component when it is rendered.

Not valid for cfg-floated Components. The Z ordering of cfg-floated Components is managed by ordering of the DOM elements.

Defaults to:

null

children

tooltip : <ExtTooltip/>
immutable imm

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

The <ExtTooltip/> for this component.

<Button text="Basic Tip">
    <ToolTip>A simple tooltip</ToolTip>
</Button>

Defaults to:

null

methods

Instance Methods

addAfterListener

let element = document.body.querySelector('ExtCalendar_daysview');
element.addAfterListener();

Alias for onAfter.

addBeforeListener

let element = document.body.querySelector('ExtCalendar_daysview');
element.addBeforeListener();

Alias for onBefore.

addListener ( eventName, [fn], [scope], [options], [order] ) : Object

let element = document.body.querySelector('ExtCalendar_daysview');
let addListener = element.addListener(eventName, fn, scope, options, order);

The on method is shorthand for addListener.

Appends an event handler to this object. For example:

myGridPanel.on("itemclick", this.onItemClick, this);

The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:

myGridPanel.on({
    cellclick: this.onCellClick,
    select: this.onSelect,
    viewready: this.onViewReady,
    scope: this // Important. Ensure "this" is correct during handler execution
});

One can also specify options for each event handler separately:

myGridPanel.on({
    cellclick: {fn: this.onCellClick, scope: this, single: true},
    viewready: {fn: panel.onViewReady, scope: panel}
});

Names of methods in a specified scope may also be used:

myGridPanel.on({
    cellclick: {fn: 'onCellClick', scope: this, single: true},
    viewready: {fn: 'onViewReady', scope: panel}
});

Parameters

eventName :  String/Object

The name of the event to listen for. May also be an object who's property names are event names.

fn :  Function/String (optional)

The method the event invokes or the name of the method within the specified scope. Will be called with arguments given to Ext.util.Observable#fireEvent plus the options parameter described below.

scope :  Object (optional)

The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

options :  Object (optional)

An object containing handler configuration.

Note: The options object will also be passed as the last argument to every event handler.

This object may contain any of the following properties:

scope :  Object

The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

delay :  Number

The number of milliseconds to delay the invocation of the handler after the event fires.

single :  Boolean

True to add a handler to handle just the next firing of the event, and then remove itself.

buffer :  Number

Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.

onFrame :  Number

Causes the handler to be scheduled to run at the next animation frame event. If the event fires again before that time, the handler is not rescheduled - the handler will only be called once when the next animation frame is fired, with the last set of arguments passed.

target :  Ext.util.Observable

Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.

element :  String

This option is only valid for listeners bound to Ext.Component. The name of a Component property which references an Ext.dom.Element to add a listener to.

This option is useful during Component construction to add DOM event listeners to elements of Ext.Component which will exist only after the Component is rendered.

For example, to add a click listener to a Panel's body:

  var panel = new Ext.panel.Panel({
      title: 'The title',
      listeners: {
          click: this.handlePanelClick,
          element: 'body'
      }
  });

In order to remove listeners attached using the element, you'll need to reference the element itself as seen below.

 panel.body.un(...)

delegate :  String (optional)

A simple selector to filter the event target or look for a descendant of the target.

The "delegate" option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

See the delegate example below.

capture :  Boolean (optional)

When set to true, the listener is fired in the capture phase of the event propagation sequence, instead of the default bubble phase.

The capture option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

stopPropagation :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call stopPropagation on the event object before firing the handler.

preventDefault :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call preventDefault on the event object before firing the handler.

stopEvent :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call stopEvent on the event object before firing the handler.

args :  Array (optional)

Optional arguments to pass to the handler function. Any additional arguments passed to fireEvent will be appended to these arguments.

destroyable :  Boolean (optional)

When specified as true, the function returns a destroyable object. An object which implements the destroy method which removes all listeners added in this call. This syntax can be a helpful shortcut to using un; particularly when removing multiple listeners. NOTE - not compatible when using the element option. See un for the proper syntax for removing listeners added using the element config.

Defaults to:

false

priority :  Number (optional)

An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handlers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code. A priority must be an integer to be valid. Fractional values are reserved for internal framework use.

order :  String (optional)

A legacy option that is provided for backward compatibility. It is recommended to use the priority option instead. Available options are:

  • 'before': equal to a priority of 100
  • 'current': equal to a priority of 0 or default priority
  • 'after': equal to a priority of -100

Defaults to:

'current'

order :  String (optional)

A shortcut for the order event option. Provided for backward compatibility. Please use the priority event option instead.

Combining Options

Using the options argument, it is possible to combine different types of listeners:

A delayed, one-time listener.

myPanel.on('hide', this.handleClick, this, {
    single: true,
    delay: 100
});

Attaching multiple handlers in 1 call

The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers and handler configs.

grid.on({
    itemclick: 'onItemClick',
    itemcontextmenu: grid.onItemContextmenu,
    destroy: {
        fn: function () {
            // function called within the 'altCmp' scope instead of grid
        },
        scope: altCmp // unique scope for the destroy handler
    },
    scope: grid       // default scope - provided for example clarity
});

Delegate

This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example:

var panel = Ext.create({
    xtype: 'panel',
    renderTo: document.body,
    title: 'Delegate Handler Example',
    frame: true,
    height: 220,
    width: 220,
    html: '<h1 class="myTitle">BODY TITLE</h1>Body content'
});

// The click handler will only be called when the click occurs on the
// delegate: h1.myTitle ("h1" tag with class "myTitle")
panel.on({
    click: function (e) {
        console.log(e.getTarget().innerHTML);
    },
    element: 'body',
    delegate: 'h1.myTitle'
 });

Defaults to: 'current'

Returns

:Object

Only when the destroyable option is specified.

A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

this.btnListeners =  = myButton.on({
    destroyable: true
    mouseover:   function() { console.log('mouseover'); },
    mouseout:    function() { console.log('mouseout'); },
    click:       function() { console.log('click'); }
});

And when those listeners need to be removed:

Ext.destroy(this.btnListeners);

or

this.btnListeners.destroy();

addManagedListener ( item, ename, [fn], [scope], [options] ) : Object

let element = document.body.querySelector('ExtCalendar_daysview');
let addManagedListener = element.addManagedListener(item, ename, fn, scope, options);

The addManagedListener method is used when some object (call it "A") is listening to an event on another observable object ("B") and you want to remove that listener from "B" when "A" is destroyed. This is not an issue when "B" is destroyed because all of its listeners will be removed at that time.

Example:

Ext.define('Foo', {
    extend: 'Ext.Component',

    initComponent: function () {
        this.addManagedListener(MyApp.SomeGlobalSharedMenu, 'show', this.doSomething);
        this.callParent();
    }
});

As you can see, when an instance of Foo is destroyed, it ensures that the 'show' listener on the menu (MyApp.SomeGlobalSharedMenu) is also removed.

As of version 5.1 it is no longer necessary to use this method in most cases because listeners are automatically managed if the scope object provided to addListener is an Observable instance. However, if the observable instance and scope are not the same object you still need to use mon or addManagedListener if you want the listener to be managed.

Parameters

item :  Ext.util.Observable/Ext.dom.Element

The item to which to add a listener/listeners.

ename :  Object/String

The event name, or an object containing event name properties.

fn :  Function/String (optional)

If the ename parameter was an event name, this is the handler function or the name of a method on the specified scope.

scope :  Object (optional)

If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

options :  Object (optional)

If the ename parameter was an event name, this is the addListener options.

Returns

:Object

Only when the destroyable option is specified.

A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

this.btnListeners = myButton.mon({
    destroyable: true
     mouseover:   function() { console.log('mouseover'); },
    mouseout:    function() { console.log('mouseout'); },
    click:       function() { console.log('click'); }
});

And when those listeners need to be removed:

Ext.destroy(this.btnListeners);

or

this.btnListeners.destroy();

addPlugin ( plugin )

let element = document.body.querySelector('ExtCalendar_daysview');
element.addPlugin(plugin);

Adds a plugin. For example:

 list.addPlugin('pullrefresh');

Or:

 list.addPlugin({
     type: 'pullrefresh',
     pullRefreshText: 'Pull to refresh...'
 });

Available since: 6.2.0

Parameters

plugin :  Object/String/Ext.plugin.Abstract

The plugin or config object or alias to add.

clearListeners

let element = document.body.querySelector('ExtCalendar_daysview');
element.clearListeners();

Removes all listeners for this object including the managed listeners

clearManagedListeners

let element = document.body.querySelector('ExtCalendar_daysview');
element.clearManagedListeners();

Removes all managed listeners for this object.

destroyPlugin ( plugin ) : Ext.plugin.Abstract

let element = document.body.querySelector('ExtCalendar_daysview');
let destroyPlugin = element.destroyPlugin(plugin);

Removes and destroys a plugin.

Note: Not all plugins are designed to be removable. Consult the documentation for the specific plugin in question to be sure.

Available since: 6.2.0

Parameters

plugin :  String/Ext.plugin.Abstract

The plugin or its id to remove.

Returns

:Ext.plugin.Abstract

plugin instance or null if not found.

enableBubble ( eventNames )

let element = document.body.querySelector('ExtCalendar_daysview');
element.enableBubble(eventNames);

Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present. There is no implementation in the Observable base class.

This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component#getBubbleTarget. The default implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly.

Example:

Ext.define('Ext.overrides.form.field.Base', {
    override: 'Ext.form.field.Base',

    //  Add functionality to Field's initComponent to enable the change event to bubble
    initComponent: function () {
        this.callParent();
        this.enableBubble('change');
    }
});

var myForm = Ext.create('Ext.form.Panel', {
    title: 'User Details',
    items: [{
        ...
    }],
    listeners: {
        change: function() {
            // Title goes red if form has been modified.
            myForm.header.setStyle('color', 'red');
        }
    }
});

Parameters

eventNames :  String/String[]

The event name to bubble, or an Array of event names.

findPlugin ( type ) : Ext.plugin.Abstract

let element = document.body.querySelector('ExtCalendar_daysview');
let findPlugin = element.findPlugin(type);

Retrieves plugin by its type alias. For example:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: ['listpaging', 'pullrefresh']
 });

 list.findPlugin('pullrefresh').setPullRefreshText('Pull to refresh...');

Note: See also getPlugin.

Available since: 6.2.0

Parameters

type :  String

The Plugin's type as specified by the class's alias configuration.

Returns

:Ext.plugin.Abstract

plugin instance or null if not found.

fireEvent ( eventName, args ) : Boolean

let element = document.body.querySelector('ExtCalendar_daysview');
let fireEvent = element.fireEvent(eventName, args);

Fires the specified event with the passed parameters (minus the event name, plus the options object passed to addListener).

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component#getBubbleTarget) by calling enableBubble.

Parameters

eventName :  String

The name of the event to fire.

args :  Object...

Variable number of parameters are passed to handlers.

Returns

:Boolean

returns false if any of the handlers return false otherwise it returns true.

fireEventArgs ( eventName, args ) : Boolean

let element = document.body.querySelector('ExtCalendar_daysview');
let fireEventArgs = element.fireEventArgs(eventName, args);

Fires the specified event with the passed parameter list.

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component#getBubbleTarget) by calling enableBubble.

Parameters

eventName :  String

The name of the event to fire.

args :  Object[]

An array of parameters which are passed to handlers.

Returns

:Boolean

returns false if any of the handlers return false otherwise it returns true.

fireEventedAction ( eventName, args, fn, [scope], [fnArgs] )

let element = document.body.querySelector('ExtCalendar_daysview');
element.fireEventedAction(eventName, args, fn, scope, fnArgs);

Fires the specified event with the passed parameters and executes a function (action). Evented Actions will automatically dispatch a 'before' event passing. This event will be given a special controller that allows for pausing/resuming of the event flow.

By pausing the controller the updater and events will not run until resumed. Pausing, however, will not stop the processing of any other before events.

Parameters

eventName :  String

The name of the event to fire.

args :  Array

Arguments to pass to handlers and to the action function.

fn :  Function/String

The action function.

scope :  Object (optional)

The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

fnArgs :  Array/Boolean (optional)

Optional arguments for the action fn. If not given, the normal args will be used to call fn. If false is passed, the args are used but if the first argument is this instance it will be removed from the args passed to the action function.

focus ( [selectText] ) : Boolean

let element = document.body.querySelector('ExtCalendar_daysview');
let focus = element.focus(selectText);

Try to focus this component.

If this component is disabled or otherwise not focusable, a close relation will be targeted for focus instead to keep focus localized for keyboard users.

Parameters

selectText :  Boolean/Number[] (optional)

If applicable, true to also select all the text in this component, or an array consisting of start and end (defaults to start) position of selection.

Returns

:Boolean

true if focus target was found and focusing was attempted, false if no focusing attempt was made.

getDisplayRange Ext.calendar.date.Range

let element = document.body.querySelector('ExtCalendar_daysview');
let getDisplayRange = element.getDisplayRange();

Get the display range for this view.

Returns

:Ext.calendar.date.Range

The display range.

getEventSource Ext.calendar.store.EventSource

let element = document.body.querySelector('ExtCalendar_daysview');
let getEventSource = element.getEventSource();

Get the Ext.calendar.store.EventSource for this view.

Returns

:Ext.calendar.store.EventSource

The event source.

getForm Ext.calendar.form.Base

let element = document.body.querySelector('ExtCalendar_daysview');
let getForm = element.getForm();

Get the active cfg-editForm or cfg-addForm if it exists.

Returns

:Ext.calendar.form.Base

The active form. null if not active.

getInherited ( [inner] ) : Object

let element = document.body.querySelector('ExtCalendar_daysview');
let getInherited = element.getInherited(inner);

This method returns an object containing the inherited properties for this instance.

Available since: 5.0.0

Parameters

inner :  Boolean (optional)

Pass true to return inheritedStateInner instead of the normal inheritedState object. This is only needed internally and should not be passed by user code.

Defaults to: false

Returns

:Object

The inheritedState object containing inherited properties.

getInheritedConfig ( property, [skipThis] ) : Mixed

let element = document.body.querySelector('ExtCalendar_daysview');
let getInheritedConfig = element.getInheritedConfig(property, skipThis);

This method returns the value of a config property that may be inherited from some ancestor.

In some cases, a config may be explicitly set on a component with the intent of only being presented to its children while that component should act upon the inherited value (see referenceHolder for example). In these cases the skipThis parameter should be specified as true.

Available since: 5.0.0

Parameters

property :  String

The name of the config property to return.

skipThis :  Boolean (optional)

Pass true if the property should be ignored if found on this instance. In other words, true means the property must be inherited and not explicitly set on this instance.

Defaults to: false

Returns

:Mixed

The value of the requested property.

getParent Ext.Component

let element = document.body.querySelector('ExtCalendar_daysview');
let getParent = element.getParent();

Returns the parent of this component, if it has one.

Returns

:Ext.Component

The parent of this component.

getPlugin ( id ) : Ext.plugin.Abstract

let element = document.body.querySelector('ExtCalendar_daysview');
let getPlugin = element.getPlugin(id);

Retrieves a plugin by its id.

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: {
         xclass: 'Ext.plugin.PullRefresh',
         id: 'foo'
     }
 });

 list.getPlugin('foo').setPullRefreshText('Pull to refresh...');

Note: See also findPlugin.

Available since: 6.2.0

Parameters

id :  String

The id of the plugin.

Returns

:Ext.plugin.Abstract

plugin instance or null if not found.

getTabIndex Number

let element = document.body.querySelector('ExtCalendar_daysview');
let getTabIndex = element.getTabIndex();

Return the actual tabIndex for this Focusable.

Returns

:Number

tabIndex attribute value

getVisibleRange Ext.calendar.date.Range

let element = document.body.querySelector('ExtCalendar_daysview');
let getVisibleRange = element.getVisibleRange();

Get the visible range for this view.

Returns

:Ext.calendar.date.Range

The visible range.

hasListener ( eventName ) : Boolean

let element = document.body.querySelector('ExtCalendar_daysview');
let hasListener = element.hasListener(eventName);

Checks to see if this object has any listeners for a specified event, or whether the event bubbles. The answer indicates whether the event needs firing or not.

Parameters

eventName :  String

The name of the event to check for

Returns

:Boolean

true if the event is being listened for or bubbles, else false

hasParent Boolean

let element = document.body.querySelector('ExtCalendar_daysview');
let hasParent = element.hasParent();

Returns true if this component has a parent.

Returns

:Boolean

true if this component has a parent.

is Boolean
template tpl

let element = document.body.querySelector('ExtCalendar_daysview');
let is = element.is();

Selector processing function for use by nextSibling,previousibling, nextNode,and previousNode, to filter candidate nodes.

The base implementation returns true. Classes which mix in Traversable may implement their own implementations. @link{Ext.Widget} does this to implement Ext.ComponentQuery based filterability.

Returns

:Boolean

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

isAncestor ( possibleDescendant )

let element = document.body.querySelector('ExtCalendar_daysview');
element.isAncestor(possibleDescendant);

Determines whether this Component is an ancestor of the passed Component. This will return true if the passed Component is anywhere within the subtree beneath this Component.

Parameters

possibleDescendant :  Ext.Component

The Component to test for presence within this Component's subtree.

isDescendantOf ( ancestor ) : Boolean

let element = document.body.querySelector('ExtCalendar_daysview');
let isDescendantOf = element.isDescendantOf(ancestor);

Determines whether this component is the descendant of a passed component.

Parameters

ancestor :  Ext.Component

A Component which may contain this Component.

Returns

:Boolean

true if the component is the descendant of the passed component, otherwise false.

isFocusable ( [deep] ) : Boolean

let element = document.body.querySelector('ExtCalendar_daysview');
let isFocusable = element.isFocusable(deep);

Determine if this Focusable can receive focus at this time.

Note that Containers can be non-focusable themselves while delegating focus treatment to a child Component; see <ExtContainer/> for more information.

Parameters

deep :  Boolean (optional)

Optionally determine if the container itself is focusable, or if container's focus is delegated to a child component and that child is focusable.

Defaults to: false

Returns

:Boolean

True if component is focusable, false if not.

isSuspended ( [event] ) : Boolean

let element = document.body.querySelector('ExtCalendar_daysview');
let isSuspended = element.isSuspended(event);

Checks if all events, or a specific event, is suspended.

Parameters

event :  String (optional)

The name of the specific event to check

Returns

:Boolean

true if events are suspended

mon ( item, ename, [fn], [scope], [options] ) : Object

let element = document.body.querySelector('ExtCalendar_daysview');
let mon = element.mon(item, ename, fn, scope, options);

Shorthand for addManagedListener. The addManagedListener method is used when some object (call it "A") is listening to an event on another observable object ("B") and you want to remove that listener from "B" when "A" is destroyed. This is not an issue when "B" is destroyed because all of its listeners will be removed at that time.

Example:

Ext.define('Foo', {
    extend: 'Ext.Component',

    initComponent: function () {
        this.addManagedListener(MyApp.SomeGlobalSharedMenu, 'show', this.doSomething);
        this.callParent();
    }
});

As you can see, when an instance of Foo is destroyed, it ensures that the 'show' listener on the menu (MyApp.SomeGlobalSharedMenu) is also removed.

As of version 5.1 it is no longer necessary to use this method in most cases because listeners are automatically managed if the scope object provided to addListener is an Observable instance. However, if the observable instance and scope are not the same object you still need to use mon or addManagedListener if you want the listener to be managed.

Parameters

item :  Ext.util.Observable/Ext.dom.Element

The item to which to add a listener/listeners.

ename :  Object/String

The event name, or an object containing event name properties.

fn :  Function/String (optional)

If the ename parameter was an event name, this is the handler function or the name of a method on the specified scope.

scope :  Object (optional)

If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

options :  Object (optional)

If the ename parameter was an event name, this is the addListener options.

Returns

:Object

Only when the destroyable option is specified.

A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

this.btnListeners = myButton.mon({
    destroyable: true
     mouseover:   function() { console.log('mouseover'); },
    mouseout:    function() { console.log('mouseout'); },
    click:       function() { console.log('click'); }
});

And when those listeners need to be removed:

Ext.destroy(this.btnListeners);

or

this.btnListeners.destroy();

moveNext

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

Move the view forward to view the "next" portion of the view based on the current cfg-value. This amount depends on the current view.

movePrevious

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

Move the view forward to view the "next" portion of the view based on the current cfg-value. This amount depends on the current view.

mun ( item, ename, [fn], [scope] )

let element = document.body.querySelector('ExtCalendar_daysview');
element.mun(item, ename, fn, scope);

Shorthand for removeManagedListener. Removes listeners that were added by the mon method.

Parameters

item :  Ext.util.Observable/Ext.dom.Element

The item from which to remove a listener/listeners.

ename :  Object/String

The event name, or an object containing event name properties.

fn :  Function (optional)

If the ename parameter was an event name, this is the handler function.

scope :  Object (optional)

If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

navigate ( amount, [interval] )

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

Move the current view by an amount based off of the current cfg-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

nextNode ( [selector] ) : Ext.Component

let element = document.body.querySelector('ExtCalendar_daysview');
let nextNode = element.nextNode(selector);

Returns the next node in the Component tree in tree traversal order.

Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will walk the tree to attempt to find a match. Contrast with nextSibling.

Parameters

selector :  String (optional)

A Ext.ComponentQuery selector to filter the following nodes.

Returns

:Ext.Component

The next node (or the next node which matches the selector). Returns null if there is no matching node.

nextSibling ( [selector] ) : Ext.Component

let element = document.body.querySelector('ExtCalendar_daysview');
let nextSibling = element.nextSibling(selector);

Returns the next sibling of this Component.

Optionally selects the next sibling which matches the passed Ext.ComponentQuery selector.

May also be referred to as next()

Note that this is limited to siblings, and if no siblings of the item match, null is returned. Contrast with nextNode

Parameters

selector :  String (optional)

A Ext.ComponentQuery selector to filter the following items.

Returns

:Ext.Component

The next sibling (or the next sibling which matches the selector). Returns null if there is no matching sibling.

on ( eventName, [fn], [scope], [options], [order] ) : Object

let element = document.body.querySelector('ExtCalendar_daysview');
let on = element.on(eventName, fn, scope, options, order);

The on method is shorthand for addListener.

Appends an event handler to this object. For example:

myGridPanel.on("itemclick", this.onItemClick, this);

The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:

myGridPanel.on({
    cellclick: this.onCellClick,
    select: this.onSelect,
    viewready: this.onViewReady,
    scope: this // Important. Ensure "this" is correct during handler execution
});

One can also specify options for each event handler separately:

myGridPanel.on({
    cellclick: {fn: this.onCellClick, scope: this, single: true},
    viewready: {fn: panel.onViewReady, scope: panel}
});

Names of methods in a specified scope may also be used:

myGridPanel.on({
    cellclick: {fn: 'onCellClick', scope: this, single: true},
    viewready: {fn: 'onViewReady', scope: panel}
});

Parameters

eventName :  String/Object

The name of the event to listen for. May also be an object who's property names are event names.

fn :  Function/String (optional)

The method the event invokes or the name of the method within the specified scope. Will be called with arguments given to Ext.util.Observable#fireEvent plus the options parameter described below.

scope :  Object (optional)

The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

options :  Object (optional)

An object containing handler configuration.

Note: The options object will also be passed as the last argument to every event handler.

This object may contain any of the following properties:

scope :  Object

The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

delay :  Number

The number of milliseconds to delay the invocation of the handler after the event fires.

single :  Boolean

True to add a handler to handle just the next firing of the event, and then remove itself.

buffer :  Number

Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.

onFrame :  Number

Causes the handler to be scheduled to run at the next animation frame event. If the event fires again before that time, the handler is not rescheduled - the handler will only be called once when the next animation frame is fired, with the last set of arguments passed.

target :  Ext.util.Observable

Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.

element :  String

This option is only valid for listeners bound to Ext.Component. The name of a Component property which references an Ext.dom.Element to add a listener to.

This option is useful during Component construction to add DOM event listeners to elements of Ext.Component which will exist only after the Component is rendered.

For example, to add a click listener to a Panel's body:

  var panel = new Ext.panel.Panel({
      title: 'The title',
      listeners: {
          click: this.handlePanelClick,
          element: 'body'
      }
  });

In order to remove listeners attached using the element, you'll need to reference the element itself as seen below.

 panel.body.un(...)

delegate :  String (optional)

A simple selector to filter the event target or look for a descendant of the target.

The "delegate" option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

See the delegate example below.

capture :  Boolean (optional)

When set to true, the listener is fired in the capture phase of the event propagation sequence, instead of the default bubble phase.

The capture option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

stopPropagation :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call stopPropagation on the event object before firing the handler.

preventDefault :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call preventDefault on the event object before firing the handler.

stopEvent :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call stopEvent on the event object before firing the handler.

args :  Array (optional)

Optional arguments to pass to the handler function. Any additional arguments passed to fireEvent will be appended to these arguments.

destroyable :  Boolean (optional)

When specified as true, the function returns a destroyable object. An object which implements the destroy method which removes all listeners added in this call. This syntax can be a helpful shortcut to using un; particularly when removing multiple listeners. NOTE - not compatible when using the element option. See un for the proper syntax for removing listeners added using the element config.

Defaults to:

false

priority :  Number (optional)

An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handlers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code. A priority must be an integer to be valid. Fractional values are reserved for internal framework use.

order :  String (optional)

A legacy option that is provided for backward compatibility. It is recommended to use the priority option instead. Available options are:

  • 'before': equal to a priority of 100
  • 'current': equal to a priority of 0 or default priority
  • 'after': equal to a priority of -100

Defaults to:

'current'

order :  String (optional)

A shortcut for the order event option. Provided for backward compatibility. Please use the priority event option instead.

Combining Options

Using the options argument, it is possible to combine different types of listeners:

A delayed, one-time listener.

myPanel.on('hide', this.handleClick, this, {
    single: true,
    delay: 100
});

Attaching multiple handlers in 1 call

The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers and handler configs.

grid.on({
    itemclick: 'onItemClick',
    itemcontextmenu: grid.onItemContextmenu,
    destroy: {
        fn: function () {
            // function called within the 'altCmp' scope instead of grid
        },
        scope: altCmp // unique scope for the destroy handler
    },
    scope: grid       // default scope - provided for example clarity
});

Delegate

This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example:

var panel = Ext.create({
    xtype: 'panel',
    renderTo: document.body,
    title: 'Delegate Handler Example',
    frame: true,
    height: 220,
    width: 220,
    html: '<h1 class="myTitle">BODY TITLE</h1>Body content'
});

// The click handler will only be called when the click occurs on the
// delegate: h1.myTitle ("h1" tag with class "myTitle")
panel.on({
    click: function (e) {
        console.log(e.getTarget().innerHTML);
    },
    element: 'body',
    delegate: 'h1.myTitle'
 });

Defaults to: 'current'

Returns

:Object

Only when the destroyable option is specified.

A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

this.btnListeners =  = myButton.on({
    destroyable: true
    mouseover:   function() { console.log('mouseover'); },
    mouseout:    function() { console.log('mouseout'); },
    click:       function() { console.log('click'); }
});

And when those listeners need to be removed:

Ext.destroy(this.btnListeners);

or

this.btnListeners.destroy();

onAfter ( eventName, fn, [scope], [options] )

let element = document.body.querySelector('ExtCalendar_daysview');
element.onAfter(eventName, fn, scope, options);

Appends an after-event handler.

Same as addListener with order set to 'after'.

Parameters

eventName :  String/String[]/Object

The name of the event to listen for.

fn :  Function/String

The method the event invokes.

scope :  Object (optional)

The scope for fn.

options :  Object (optional)

An object containing handler configuration.

onBefore ( eventName, fn, [scope], [options] )

let element = document.body.querySelector('ExtCalendar_daysview');
element.onBefore(eventName, fn, scope, options);

Appends a before-event handler. Returning false from the handler will stop the event.

Same as addListener with order set to 'before'.

Parameters

eventName :  String/String[]/Object

The name of the event to listen for.

fn :  Function/String

The method the event invokes.

scope :  Object (optional)

The scope for fn.

options :  Object (optional)

An object containing handler configuration.

previousNode ( [selector] ) : Ext.Component

let element = document.body.querySelector('ExtCalendar_daysview');
let previousNode = element.previousNode(selector);

Returns the previous node in the Component tree in tree traversal order.

Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will walk the tree in reverse order to attempt to find a match. Contrast with previousSibling.

Parameters

selector :  String (optional)

A Ext.ComponentQuery selector to filter the preceding nodes.

Returns

:Ext.Component

The previous node (or the previous node which matches the selector). Returns null if there is no matching node.

previousSibling ( [selector] ) : Ext.Component

let element = document.body.querySelector('ExtCalendar_daysview');
let previousSibling = element.previousSibling(selector);

Returns the previous sibling of this Component.

Optionally selects the previous sibling which matches the passed Ext.ComponentQuery selector.

May also be referred to as prev()

Note that this is limited to siblings, and if no siblings of the item match, null is returned. Contrast with previousNode

Parameters

selector :  String (optional)

A Ext.ComponentQuery selector to filter the preceding items.

Returns

:Ext.Component

The previous sibling (or the previous sibling which matches the selector). Returns null if there is no matching sibling.

relayEvents ( origin, events, [prefix] ) : Object

let element = document.body.querySelector('ExtCalendar_daysview');
let relayEvents = element.relayEvents(origin, events, prefix);

Relays selected events from the specified Observable as if the events were fired by this.

For example if you are extending Grid, you might decide to forward some events from store. So you can do this inside your initComponent:

this.relayEvents(this.getStore(), ['load']);

The grid instance will then have an observable 'load' event which will be passed the parameters of the store's load event and any function fired with the grid's load event would have access to the grid using the this keyword (unless the event is handled by a controller's control/listen event listener in which case 'this' will be the controller rather than the grid).

Parameters

origin :  Object

The Observable whose events this object is to relay.

events :  String[]/Object

Array of event names to relay or an Object with key/value pairs translating to ActualEventName/NewEventName respectively. For example: this.relayEvents(this, {add:'push', remove:'pop'});

Would now redispatch the add event of this as a push event and the remove event as a pop event.

prefix :  String (optional)

A common prefix to prepend to the event names. For example:

this.relayEvents(this.getStore(), ['load', 'clear'], 'store');

Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'.

Returns

:Object

A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example:

this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store');

Can be undone by calling

Ext.destroy(this.storeRelayers);

or this.store.relayers.destroy();

removeAfterListener

let element = document.body.querySelector('ExtCalendar_daysview');
element.removeAfterListener();

Alias for unAfter.

removeBeforeListener

let element = document.body.querySelector('ExtCalendar_daysview');
element.removeBeforeListener();

Alias for unBefore.

removeListener ( eventName, fn, [scope] )

let element = document.body.querySelector('ExtCalendar_daysview');
element.removeListener(eventName, fn, scope);

Removes an event handler.

Parameters

eventName :  String

The type of event the handler was associated with.

fn :  Function

The handler to remove. This must be a reference to the function passed into the addListener call.

scope :  Object (optional)

The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to Ext.util.Observable#addListener or the listener will not be removed.

Convenience Syntax

You can use the addListener destroyable: true config option in place of calling un(). For example:

var listeners = cmp.on({
    scope: cmp,
    afterrender: cmp.onAfterrender,
    beforehide: cmp.onBeforeHide,
    destroyable: true
});

// Remove listeners
listeners.destroy();
// or
cmp.un(
    scope: cmp,
    afterrender: cmp.onAfterrender,
    beforehide: cmp.onBeforeHide
);

Exception - DOM event handlers using the element config option

You must go directly through the element to detach an event handler attached using the addListener element option.

panel.on({
    element: 'body',
    click: 'onBodyCLick'
});

panel.body.un({
    click: 'onBodyCLick'
});

removeManagedListener ( item, ename, [fn], [scope] )

let element = document.body.querySelector('ExtCalendar_daysview');
element.removeManagedListener(item, ename, fn, scope);

Removes listeners that were added by the mon method.

Parameters

item :  Ext.util.Observable/Ext.dom.Element

The item from which to remove a listener/listeners.

ename :  Object/String

The event name, or an object containing event name properties.

fn :  Function (optional)

If the ename parameter was an event name, this is the handler function.

scope :  Object (optional)

If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

removePlugin ( plugin, [destroy] ) : Ext.plugin.Abstract

let element = document.body.querySelector('ExtCalendar_daysview');
let removePlugin = element.removePlugin(plugin, destroy);

Removes and (optionally) destroys a plugin.

Note: Not all plugins are designed to be removable. Consult the documentation for the specific plugin in question to be sure.

Available since: 6.2.0

Parameters

plugin :  String/Ext.plugin.Abstract

The plugin or its id to remove.

destroy :  Boolean (optional)

Pass true to not call destroy() on the plugin.

Returns

:Ext.plugin.Abstract

plugin instance or null if not found.

resumeEvent ( eventName )

let element = document.body.querySelector('ExtCalendar_daysview');
element.resumeEvent(eventName);

Resumes firing of the named event(s).

After calling this method to resume events, the events will fire when requested to fire.

Note that if the suspendEvent method is called multiple times for a certain event, this converse method will have to be called the same number of times for it to resume firing.

Parameters

eventName :  String...

Multiple event names to resume.

resumeEvents ( [discardQueue] )

let element = document.body.querySelector('ExtCalendar_daysview');
element.resumeEvents(discardQueue);

Resumes firing events (see suspendEvents).

If events were suspended using the queueSuspended parameter, then all events fired during event suspension will be sent to any listeners now.

Parameters

discardQueue :  Boolean (optional)

true to prevent any previously queued events from firing while we were suspended. See suspendEvents.

setAddForm ( addForm )

Returns the value of addForm

setAllowSelection ( allowSelection )

Returns the value of allowSelection

setAlwaysOnTop ( alwaysOnTop )

Returns the value of alwaysOnTop

setAriaAttributes ( ariaAttributes )

Returns the value of ariaAttributes

setBorder ( border )

Returns the value of border

setBottom ( bottom )

Returns the value of bottom

setCentered ( centered )

Returns the value of centered

setCompact ( compact )

Returns the value of compact

setCompactOptions ( compactOptions )

Returns the value of compactOptions

setConstrainTo ( constrainTo )

Returns the value of constrainTo

setContentEl ( contentEl )

Returns the value of contentEl

setData ( data )

Returns the value of data

setDisabled ( disabled )

Returns the value of disabled

setDisplayOverlap ( displayOverlap )

Returns the value of displayOverlap

setDocked ( docked )

Returns the value of docked

setDraggable ( draggable )

Returns the value of draggable

setDroppable ( droppable )

Returns the value of droppable

setEditForm ( editForm )

Returns the value of editForm

setEndTime ( endTime )

Returns the value of endTime

setEventDefaults ( eventDefaults )

Returns the value of eventDefaults

setFlex ( flex )

Returns the value of flex

setFloated ( floated )

Returns the value of floated

setGestureNavigation ( gestureNavigation )

Returns the value of gestureNavigation

setHeight ( height )

Returns the value of height

setHidden ( hidden )

Returns the value of hidden

setHideAnimation ( hideAnimation )

Returns the value of hideAnimation

setHideOnMaskTap ( hideOnMaskTap )

Returns the value of hideOnMaskTap

setHtml ( html )

Returns the value of html

setId ( id )

Returns the value of id

setItemId ( itemId )

Returns the value of itemId

setKeyMap ( keyMap )

Returns the value of keyMap

setKeyMapEnabled ( keyMapEnabled )

Returns the value of keyMapEnabled

setLeft ( left )

Returns the value of left

setListeners ( listeners )

let element = document.body.querySelector('ExtCalendar_daysview');
element.setListeners(listeners);

An alias for addListener. In versions prior to 5.1, listeners had a generated setter which could be called to add listeners. In 5.1 the listeners config is not processed using the config system and has no generated setter, so this method is provided for backward compatibility. The preferred way of adding listeners is to use the on method.

Parameters

listeners :  Object

The listeners

setMaxHeight ( maxHeight )

Returns the value of maxHeight

setMaxWidth ( maxWidth )

Returns the value of maxWidth

setMinHeight ( minHeight )

Returns the value of minHeight

setMinWidth ( minWidth )

Returns the value of minWidth

setModal ( modal )

Returns the value of modal

setPadding ( padding )

Returns the value of padding

setPlugins ( plugins )

Returns the value of plugins

setRecord ( record )

Returns the value of record

setRelative ( relative )

Returns the value of relative

setResizeEvents ( resizeEvents )

Returns the value of resizeEvents

setRight ( right )

Returns the value of right

setScrollable ( scrollable )

Returns the value of scrollable

setShadow ( shadow )

Returns the value of shadow

setShim ( shim )

Returns the value of shim

setShowAnimation ( showAnimation )

Returns the value of showAnimation

setShowNowMarker ( showNowMarker )

Returns the value of showNowMarker

setStartTime ( startTime )

Returns the value of startTime

setStore ( store )

Returns the value of store

setStyle ( style )

Returns the value of style

setTabIndex ( newTabIndex )

let element = document.body.querySelector('ExtCalendar_daysview');
element.setTabIndex(newTabIndex);

Set the tabIndex property for this Focusable. If the focusEl is available, set tabIndex attribute on it, too.

Parameters

newTabIndex :  Number

new tabIndex to set

setTimeFormat ( timeFormat )

Returns the value of timeFormat

setTimeRange ( start, end )

let element = document.body.querySelector('ExtCalendar_daysview');
element.setTimeRange(start, end);

Sets the startTime and endTime simultaneously.

Parameters

start :  Number

The start hour between 0 and 23.

end :  Number

The end hour between 1 and 24.

setTimeRenderer ( timeRenderer )

Returns the value of timeRenderer

setTimezoneOffset ( timezoneOffset )

Returns the value of timezoneOffset

setToFrontOnShow ( toFrontOnShow )

Returns the value of toFrontOnShow

setTop ( top )

Returns the value of top

setTpl ( tpl )

Returns the value of tpl

setTplWriteMode ( tplWriteMode )

Returns the value of tplWriteMode

setValue ( value )

Returns the value of value

setVisibleDays ( visibleDays )

Returns the value of visibleDays

setWidth ( width )

Returns the value of width

setX ( x )

Returns the value of x

setY ( y )

Returns the value of y

setZIndex ( zIndex )

Returns the value of zIndex

showAddForm ( [event], [options] )

let element = document.body.querySelector('ExtCalendar_daysview');
element.showAddForm(event, options);

Show the cfg-addForm for this calendar. Has no behavior if cfg-addForm is null.

Parameters

event :  Ext.calendar.model.EventBase (optional)

A new event record containing any data to be passed to the form. If not specified, default dates from this view will be chosen.

options :  Object (optional)

Callback options for form creation.

onSave :  Function (optional)

A save callback function.

onCancel :  Function (optional)

A cancel callback function.

scope :  Object (optional)

A scope for the callback functions.

showEditForm ( event, [options] )

let element = document.body.querySelector('ExtCalendar_daysview');
element.showEditForm(event, options);

Show the cfg-editForm for this calendar. Has no behavior if cfg-editForm is null.

Parameters

event :  Ext.calendar.model.EventBase

The event to be passed to the form.

options :  Object (optional)

Callback options for form creation.

onSave :  Function (optional)

A save callback function.

onCancel :  Function (optional)

A cancel callback function.

scope :  Object (optional)

A scope for the callback functions.

suspendEvent ( eventName )

let element = document.body.querySelector('ExtCalendar_daysview');
element.suspendEvent(eventName);

Suspends firing of the named event(s).

After calling this method to suspend events, the events will no longer fire when requested to fire.

Note that if this is called multiple times for a certain event, the converse method resumeEvent will have to be called the same number of times for it to resume firing.

Parameters

eventName :  String...

Multiple event names to suspend.

suspendEvents ( queueSuspended )

let element = document.body.querySelector('ExtCalendar_daysview');
element.suspendEvents(queueSuspended);

Suspends the firing of all events. (see resumeEvents)

Parameters

queueSuspended :  Boolean

true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events.

un ( eventName, fn, [scope] )

let element = document.body.querySelector('ExtCalendar_daysview');
element.un(eventName, fn, scope);

Shorthand for removeListener. Removes an event handler.

Parameters

eventName :  String

The type of event the handler was associated with.

fn :  Function

The handler to remove. This must be a reference to the function passed into the addListener call.

scope :  Object (optional)

The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to Ext.util.Observable#addListener or the listener will not be removed.

Convenience Syntax

You can use the addListener destroyable: true config option in place of calling un(). For example:

var listeners = cmp.on({
    scope: cmp,
    afterrender: cmp.onAfterrender,
    beforehide: cmp.onBeforeHide,
    destroyable: true
});

// Remove listeners
listeners.destroy();
// or
cmp.un(
    scope: cmp,
    afterrender: cmp.onAfterrender,
    beforehide: cmp.onBeforeHide
);

Exception - DOM event handlers using the element config option

You must go directly through the element to detach an event handler attached using the addListener element option.

panel.on({
    element: 'body',
    click: 'onBodyCLick'
});

panel.body.un({
    click: 'onBodyCLick'
});

unAfter ( eventName, fn, [scope], [options] )

let element = document.body.querySelector('ExtCalendar_daysview');
element.unAfter(eventName, fn, scope, options);

Removes a before-event handler.

Same as removeListener with order set to 'after'.

Parameters

eventName :  String/String[]/Object

The name of the event the handler was associated with.

fn :  Function/String

The handler to remove.

scope :  Object (optional)

The scope originally specified for fn.

options :  Object (optional)

Extra options object.

unBefore ( eventName, fn, [scope], [options] )

let element = document.body.querySelector('ExtCalendar_daysview');
element.unBefore(eventName, fn, scope, options);

Removes a before-event handler.

Same as removeListener with order set to 'before'.

Parameters

eventName :  String/String[]/Object

The name of the event the handler was associated with.

fn :  Function/String

The handler to remove.

scope :  Object (optional)

The scope originally specified for fn.

options :  Object (optional)

Extra options object.

up ( [selector], [limit] ) : Ext.Container

let element = document.body.querySelector('ExtCalendar_daysview');
let up = element.up(selector, limit);

Walks up the ownership hierarchy looking for an ancestor Component which matches the passed simple selector.

Example:

var owningTabPanel = grid.up('tabpanel');

Parameters

selector :  String (optional)

The simple selector to test.

limit :  String/Number/Ext.Component (optional)

This may be a selector upon which to stop the upward scan, or a limit of the number of steps, or Component reference to stop on.

Returns

:Ext.Container

The matching ancestor Container (or undefined if no match was found).

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

events

onAdded : function ( this, container, index, eOpts )

// Delcare in template tag
onAdded={this._onAdded}
// Declare in class
_onAdded = ({ sender, container, index }) => { //... };

Fires after a Component had been added to a Container.

Parameters

this :  Ext.Component

container :  Ext.Container

Parent Container

index :  Number

The index of the item within the Container.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onBeforeBottomChange : function ( sender, value, oldValue, eOpts ) => Boolean

// Delcare in template tag
onBeforebottomchange={this._onBeforebottomchange}
// Declare in class
_onBeforebottomchange = ({ sender, value, oldValue }) => { //... };

This event fires when bottom changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of bottom.

oldValue :  Number/String

The previous value of bottom.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeCenteredChange : function ( sender, value, oldValue, eOpts ) => Boolean

// Delcare in template tag
onBeforecenteredchange={this._onBeforecenteredchange}
// Declare in class
_onBeforecenteredchange = ({ sender, value, oldValue }) => { //... };

This event fires when centered changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Boolean

The current value of centered.

oldValue :  Boolean

The previous value of centered.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeDisabledChange : function ( sender, value, oldValue, eOpts ) => Boolean

// Delcare in template tag
onBeforedisabledchange={this._onBeforedisabledchange}
// Declare in class
_onBeforedisabledchange = ({ sender, value, oldValue }) => { //... };

This event fires when disabled changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Boolean

The current value of disabled.

oldValue :  Boolean

The previous value of disabled.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeDockedChange : function ( sender, value, oldValue, eOpts ) => Boolean

// Delcare in template tag
onBeforedockedchange={this._onBeforedockedchange}
// Declare in class
_onBeforedockedchange = ({ sender, value, oldValue }) => { //... };

This event fires when docked changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  String

The current value of docked.

oldValue :  String

The previous value of docked.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeEventAdd : function ( this, context, eOpts )

// Delcare in template tag
onBeforeeventadd={this._onBeforeeventadd}
// Declare in class
_onBeforeeventadd = ({ sender, context }) => { //... };

Fired before an event addForm is shown.

Parameters

this :  Ext.calendar.view.Base

This view.

context :  Object

The context.

event :  Ext.calendar.model.EventBase

The new event to be added.

Return false to cancel the form being shown.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onBeforeEventDragStart : function ( this, context, eOpts )

// Delcare in template tag
onBeforeeventdragstart={this._onBeforeeventdragstart}
// Declare in class
_onBeforeeventdragstart = ({ sender, context }) => { //... };

Fired before an event drag begins. Depends on the cfg-draggable config.

Parameters

this :  Ext.calendar.view.Days

This view.

context :  Object

The context.

event :  Ext.calendar.model.EventBase

The event model.

Return false to cancel the drag.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onBeforeEventEdit : function ( this, context, eOpts )

// Delcare in template tag
onBeforeeventedit={this._onBeforeeventedit}
// Declare in class
_onBeforeeventedit = ({ sender, context }) => { //... };

Fired before an event editForm is shown.

Parameters

this :  Ext.calendar.view.Base

This view.

context :  Object

The context.

event :  Ext.calendar.model.EventBase

The event to be edited.

Return false to cancel the form being shown.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onBeforeEventResizeStart : function ( this, context, eOpts )

// Delcare in template tag
onBeforeeventresizestart={this._onBeforeeventresizestart}
// Declare in class
_onBeforeeventresizestart = ({ sender, context }) => { //... };

Fired before an event resize begins. Depends on the cfg-resizeEvents config.

Parameters

this :  Ext.calendar.view.Days

This view.

context :  Object

The context.

event :  Ext.calendar.model.EventBase

The event model.

Return false to cancel the resize.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onBeforeHeightChange : function ( sender, value, oldValue, eOpts ) => Boolean

// Delcare in template tag
onBeforeheightchange={this._onBeforeheightchange}
// Declare in class
_onBeforeheightchange = ({ sender, value, oldValue }) => { //... };

This event fires when height changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Number/String

The current value of height.

oldValue :  Number/String

The previous value of height.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeHiddenChange : function ( sender, value, oldValue, eOpts ) => Boolean

// Delcare in template tag
onBeforehiddenchange={this._onBeforehiddenchange}
// Declare in class
_onBeforehiddenchange = ({ sender, value, oldValue }) => { //... };

This event fires when hidden changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Boolean

The current value of hidden.

oldValue :  Boolean

The previous value of hidden.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeHide : function ( this, eOpts )

// Delcare in template tag
onBeforehide={this._onBeforehide}
// Declare in class
_onBeforehide = ({ sender }) => { //... };

Fires before the Component is hidden. Hide may be vetoed by returning false from a handler.

Parameters

this :  Ext.Component

The component instance

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onBeforeLeftChange : function ( sender, value, oldValue, eOpts ) => Boolean

// Delcare in template tag
onBeforeleftchange={this._onBeforeleftchange}
// Declare in class
_onBeforeleftchange = ({ sender, value, oldValue }) => { //... };

This event fires when left changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of left.

oldValue :  Number/String

The previous value of left.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeMaxHeightChange : function ( sender, value, oldValue, eOpts ) => Boolean

// Delcare in template tag
onBeforemaxHeightchange={this._onBeforemaxHeightchange}
// Declare in class
_onBeforemaxHeightchange = ({ sender, value, oldValue }) => { //... };

This event fires when maxHeight changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of maxHeight.

oldValue :  Number/String

The previous value of maxHeight.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeMaxWidthChange : function ( sender, value, oldValue, eOpts ) => Boolean

// Delcare in template tag
onBeforemaxWidthchange={this._onBeforemaxWidthchange}
// Declare in class
_onBeforemaxWidthchange = ({ sender, value, oldValue }) => { //... };

This event fires when maxWidth changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of maxWidth.

oldValue :  Number/String

The previous value of maxWidth.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeMinHeightChange : function ( sender, value, oldValue, eOpts ) => Boolean

// Delcare in template tag
onBeforeminHeightchange={this._onBeforeminHeightchange}
// Declare in class
_onBeforeminHeightchange = ({ sender, value, oldValue }) => { //... };

This event fires when minHeight changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of minHeight.

oldValue :  Number/String

The previous value of minHeight.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeMinWidthChange : function ( sender, value, oldValue, eOpts ) => Boolean

// Delcare in template tag
onBeforeminWidthchange={this._onBeforeminWidthchange}
// Declare in class
_onBeforeminWidthchange = ({ sender, value, oldValue }) => { //... };

This event fires when minWidth changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of minWidth.

oldValue :  Number/String

The previous value of minWidth.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeRightChange : function ( sender, value, oldValue, eOpts ) => Boolean

// Delcare in template tag
onBeforerightchange={this._onBeforerightchange}
// Declare in class
_onBeforerightchange = ({ sender, value, oldValue }) => { //... };

This event fires when right changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of right.

oldValue :  Number/String

The previous value of right.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeScrollableChange : function ( sender, value, oldValue, eOpts ) => Boolean

// Delcare in template tag
onBeforescrollablechange={this._onBeforescrollablechange}
// Declare in class
_onBeforescrollablechange = ({ sender, value, oldValue }) => { //... };

This event fires when scrollable changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Boolean/String/Object

The current value of scrollable.

oldValue :  Boolean/String/Object

The previous value of scrollable.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeShow : function ( this, eOpts )

// Delcare in template tag
onBeforeshow={this._onBeforeshow}
// Declare in class
_onBeforeshow = ({ sender }) => { //... };

Fires before the Component is shown. Show may be vetoed by returning false from a handler.

Parameters

this :  Ext.Component

The component instance

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onBeforeToFront : function ( this, eOpts )

// Delcare in template tag
onBeforetofront={this._onBeforetofront}
// Declare in class
_onBeforetofront = ({ sender }) => { //... };

Fires before a cfg-floated component is brought to the front of the visual stack.

Parameters

this :  Ext.Component

The component instance

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onBeforeTopChange : function ( sender, value, oldValue, eOpts ) => Boolean

// Delcare in template tag
onBeforetopchange={this._onBeforetopchange}
// Declare in class
_onBeforetopchange = ({ sender, value, oldValue }) => { //... };

This event fires when top changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of top.

oldValue :  Number/String

The previous value of top.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeWidthChange : function ( sender, value, oldValue, eOpts ) => Boolean

// Delcare in template tag
onBeforewidthchange={this._onBeforewidthchange}
// Declare in class
_onBeforewidthchange = ({ sender, value, oldValue }) => { //... };

This event fires when width changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Number/String

The current value of width.

oldValue :  Number/String

The previous value of width.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBlur : function ( this, event, eOpts )

// Delcare in template tag
onBlur={this._onBlur}
// Declare in class
_onBlur = ({ sender, event }) => { //... };

Fires when this Component's focusEl loses focus.

Parameters

this :  Ext.Component

event :  Ext.event.Event

The blur event.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onBottomChange : function ( sender, value, oldValue, eOpts )

// Delcare in template tag
onBottomchange={this._onBottomchange}
// Declare in class
_onBottomchange = ({ sender, value, oldValue }) => { //... };

This event fires when bottom changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of bottom.

oldValue :  Number/String

The previous value of bottom.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onCenteredChange : function ( sender, value, oldValue, eOpts )

// Delcare in template tag
onCenteredchange={this._onCenteredchange}
// Declare in class
_onCenteredchange = ({ sender, value, oldValue }) => { //... };

This event fires when centered changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Boolean

The current value of centered.

oldValue :  Boolean

The previous value of centered.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onDestroy

// Delcare in template tag
onDestroy={this._onDestroy}
// Declare in class
_onDestroy = ({  }) => { //... };

Fires when the component is destroyed

onDisabledChange : function ( sender, value, oldValue, eOpts )

// Delcare in template tag
onDisabledchange={this._onDisabledchange}
// Declare in class
_onDisabledchange = ({ sender, value, oldValue }) => { //... };

This event fires when disabled changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Boolean

The current value of disabled.

oldValue :  Boolean

The previous value of disabled.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onDockedChange : function ( sender, value, oldValue, eOpts )

// Delcare in template tag
onDockedchange={this._onDockedchange}
// Declare in class
_onDockedchange = ({ sender, value, oldValue }) => { //... };

This event fires when docked changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  String

The current value of docked.

oldValue :  String

The previous value of docked.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onErased : function ( this, eOpts )

// Delcare in template tag
onErased={this._onErased}
// Declare in class
_onErased = ({ sender }) => { //... };

Fires when the component is no longer displayed in the DOM. Listening to this event will degrade performance not recommend for general use.

Parameters

this :  Ext.Component

The component instance

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onEventAdd : function ( this, context, eOpts )

// Delcare in template tag
onEventadd={this._onEventadd}
// Declare in class
_onEventadd = ({ sender, context }) => { //... };

Fired when an event has been added via the addForm.

Parameters

this :  Ext.calendar.view.Base

This view.

context :  Object

The context.

event :  Ext.calendar.model.EventBase

The newly added event with data.

data :  Object

The data provided by the form.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onEventDrop : function ( this, context, eOpts )

// Delcare in template tag
onEventdrop={this._onEventdrop}
// Declare in class
_onEventdrop = ({ sender, context }) => { //... };

Fired when an event drop is complete. Depends on the cfg-droppable config.

Parameters

this :  Ext.calendar.view.Days

The view.

context :  Object

The context.

event :  Ext.calendar.model.EventBase

The event model.

newRange :  Ext.calendar.date.Range

The new date range.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onEventEdit : function ( this, context, eOpts )

// Delcare in template tag
onEventedit={this._onEventedit}
// Declare in class
_onEventedit = ({ sender, context }) => { //... };

Fired when an event has been edited via the editForm.

Parameters

this :  Ext.calendar.view.Base

This view.

context :  Object

The context.

event :  Ext.calendar.model.EventBase

The edited event with data.

data :  Object

The data provided by the form.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onEventResize : function ( this, context, eOpts )

// Delcare in template tag
onEventresize={this._onEventresize}
// Declare in class
_onEventresize = ({ sender, context }) => { //... };

Fired when an event resize is complete. Depends on the cfg-resizeEvents config.

Parameters

this :  Ext.calendar.view.Days

The view.

context :  Object

The context.

event :  Ext.calendar.model.EventBase

The event model.

newRange :  Ext.calendar.date.Range

The new date range.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onEventTap : function ( this, context, eOpts )

// Delcare in template tag
onEventtap={this._onEventtap}
// Declare in class
_onEventtap = ({ sender, context }) => { //... };

Fired when an event is tapped.

Parameters

this :  Ext.calendar.view.Base

This view.

context :  Object

The context.

event :  Ext.calendar.model.EventBase

The event model.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onFocus : function ( this, event, eOpts )

// Delcare in template tag
onFocus={this._onFocus}
// Declare in class
_onFocus = ({ sender, event }) => { //... };

Fires when this Component's focusEl receives focus.

Parameters

this :  Ext.Component/Ext.Widget

event :  Ext.event.Event

The focus event.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onFocusEnter : function ( this, event, eOpts )

// Delcare in template tag
onFocusenter={this._onFocusenter}
// Declare in class
_onFocusenter = ({ sender, event }) => { //... };

Fires when focus enters this Component's hierarchy.

Parameters

this :  Ext.Component

event :  Ext.event.Event

The focusenter event.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onFocusLeave : function ( this, event, eOpts )

// Delcare in template tag
onFocusleave={this._onFocusleave}
// Declare in class
_onFocusleave = ({ sender, event }) => { //... };

Fires when focus leaves this Component's hierarchy.

Parameters

this :  Ext.Component

event :  Ext.event.Event

The focusleave event.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onFullscreen : function ( this, eOpts )

// Delcare in template tag
onFullscreen={this._onFullscreen}
// Declare in class
_onFullscreen = ({ sender }) => { //... };

Fires whenever a Component with the fullscreen config is instantiated

Parameters

this :  Ext.Component

The component instance

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onHeightChange : function ( sender, value, oldValue, eOpts )

// Delcare in template tag
onHeightchange={this._onHeightchange}
// Declare in class
_onHeightchange = ({ sender, value, oldValue }) => { //... };

This event fires when height changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Number/String

The current value of height.

oldValue :  Number/String

The previous value of height.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onHiddenChange : function ( sender, value, oldValue, eOpts )

// Delcare in template tag
onHiddenchange={this._onHiddenchange}
// Declare in class
_onHiddenchange = ({ sender, value, oldValue }) => { //... };

This event fires when hidden changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Boolean

The current value of hidden.

oldValue :  Boolean

The previous value of hidden.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onHide : function ( this, eOpts )

// Delcare in template tag
onHide={this._onHide}
// Declare in class
_onHide = ({ sender }) => { //... };

Fires whenever the Component is hidden

Parameters

this :  Ext.Component

The component instance

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onInitialize : function ( this, eOpts )

// Delcare in template tag
onInitialize={this._onInitialize}
// Declare in class
_onInitialize = ({ sender }) => { //... };

Fires when the component has been initialized

Parameters

this :  Ext.Component

The component instance

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onLeftChange : function ( sender, value, oldValue, eOpts )

// Delcare in template tag
onLeftchange={this._onLeftchange}
// Declare in class
_onLeftchange = ({ sender, value, oldValue }) => { //... };

This event fires when left changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of left.

oldValue :  Number/String

The previous value of left.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onMaxHeightChange : function ( sender, value, oldValue, eOpts )

// Delcare in template tag
onMaxHeightchange={this._onMaxHeightchange}
// Declare in class
_onMaxHeightchange = ({ sender, value, oldValue }) => { //... };

This event fires when maxHeight changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of maxHeight.

oldValue :  Number/String

The previous value of maxHeight.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onMaxWidthChange : function ( sender, value, oldValue, eOpts )

// Delcare in template tag
onMaxWidthchange={this._onMaxWidthchange}
// Declare in class
_onMaxWidthchange = ({ sender, value, oldValue }) => { //... };

This event fires when maxWidth changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of maxWidth.

oldValue :  Number/String

The previous value of maxWidth.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onMinHeightChange : function ( sender, value, oldValue, eOpts )

// Delcare in template tag
onMinHeightchange={this._onMinHeightchange}
// Declare in class
_onMinHeightchange = ({ sender, value, oldValue }) => { //... };

This event fires when minHeight changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of minHeight.

oldValue :  Number/String

The previous value of minHeight.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onMinWidthChange : function ( sender, value, oldValue, eOpts )

// Delcare in template tag
onMinWidthchange={this._onMinWidthchange}
// Declare in class
_onMinWidthchange = ({ sender, value, oldValue }) => { //... };

This event fires when minWidth changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of minWidth.

oldValue :  Number/String

The previous value of minWidth.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onMoved : function ( this, container, toIndex, fromIndex, eOpts )

// Delcare in template tag
onMoved={this._onMoved}
// Declare in class
_onMoved = ({ sender, container, toIndex, fromIndex }) => { //... };

Fires when a component si moved within its Container.

Parameters

this :  Ext.Component

container :  Ext.Container

Container which holds the component

toIndex :  Number

The new index of the item.

fromIndex :  Number

The old index of the item.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onPainted : function ( element, eOpts )

// Delcare in template tag
onPainted={this._onPainted}
// Declare in class
_onPainted = ({ element }) => { //... };

Fires whenever this Element actually becomes visible (painted) on the screen. This is useful when you need to perform 'read' operations on the DOM element, i.e: calculating natural sizes and positioning.

Note: This event is not available to be used with event delegation. Instead painted only fires if you explicitly add at least one listener to it, for performance reasons.

Parameters

element :  Ext.dom.Element

The component's outer element (this.element)

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onPositionedChange : function ( this, positioned, eOpts )

// Delcare in template tag
onPositionedchange={this._onPositionedchange}
// Declare in class
_onPositionedchange = ({ sender, positioned }) => { //... };

Fires whenever there is a change in the positioned status of a component

Parameters

this :  Ext.Component

The component instance

positioned :  Boolean

The component's new positioned state. This becomes true is a component is positioned using the cfg-top, cfg-right, cfg-bottom or cfg-left configs.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onRemoved : function ( this, container, index, eOpts )

// Delcare in template tag
onRemoved={this._onRemoved}
// Declare in class
_onRemoved = ({ sender, container, index }) => { //... };

Fires when a component is removed from a Container

Parameters

this :  Ext.Component

container :  Ext.Container

Container which holds the component

index :  Number

The index of the item that was removed.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onResize : function ( component, width, height, oldWidth, oldHeight, eOpts )

// Delcare in template tag
onResize={this._onResize}
// Declare in class
_onResize = ({ component, width, height, oldWidth, oldHeight }) => { //... };

Fires asynchronously after a browser layout caused by a component resize. This may be triggered for any or several of the following reasons:

Parameters

component :  Ext.Component

This Component.

width :  String/Number

The new width.

height :  String/Number

The new height.

oldWidth :  String/Number

The previous width.

oldHeight :  String/Number

The previous height.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onRightChange : function ( sender, value, oldValue, eOpts )

// Delcare in template tag
onRightchange={this._onRightchange}
// Declare in class
_onRightchange = ({ sender, value, oldValue }) => { //... };

This event fires when right changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of right.

oldValue :  Number/String

The previous value of right.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onScrollableChange : function ( sender, value, oldValue, eOpts )

// Delcare in template tag
onScrollablechange={this._onScrollablechange}
// Declare in class
_onScrollablechange = ({ sender, value, oldValue }) => { //... };

This event fires when scrollable changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Boolean/String/Object

The current value of scrollable.

oldValue :  Boolean/String/Object

The previous value of scrollable.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onShow : function ( this, eOpts )

// Delcare in template tag
onShow={this._onShow}
// Declare in class
_onShow = ({ sender }) => { //... };

Fires whenever the Component is shown

Parameters

this :  Ext.Component

The component instance

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onToFront : function ( this, eOpts )

// Delcare in template tag
onTofront={this._onTofront}
// Declare in class
_onTofront = ({ sender }) => { //... };

Fires when a cfg-floated component has been brought to the front of the visual stack.

Parameters

this :  Ext.Component

The component instance

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onTopChange : function ( sender, value, oldValue, eOpts )

// Delcare in template tag
onTopchange={this._onTopchange}
// Declare in class
_onTopchange = ({ sender, value, oldValue }) => { //... };

This event fires when top changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of top.

oldValue :  Number/String

The previous value of top.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onValidateEventAdd : function ( this, context, eOpts )

// Delcare in template tag
onValidateeventadd={this._onValidateeventadd}
// Declare in class
_onValidateeventadd = ({ sender, context }) => { //... };

Fired after the addForm has been completed, but before the event is added. Allows the add to be validated.

Parameters

this :  Ext.calendar.view.Base

This view.

context :  Object

The context.

event :  Ext.calendar.model.EventBase

The new event to be added, the data is not yet set on the event.

data :  Object

The data provided by the form. This will be used to set the event data using Ext.calendar.model.EventBase#setData.

validate :  Ext.Promise

A promise that allows validation to occur. The default behavior is for no validation to take place. To achieve asynchronous validation, the promise on the context object must be replaced:

{
    listeners: {
        validateeventadd: function(view, context) {
            context.validate = context.then(function() {
                return Ext.Ajax.request({
                    url: '/checkAdd'
                }).then(function(response) {
                    return Promise.resolve(response.responseText === 'ok');
                });
            });
        }
    }
}

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onValidateEventDrop : function ( this, context, eOpts )

// Delcare in template tag
onValidateeventdrop={this._onValidateeventdrop}
// Declare in class
_onValidateeventdrop = ({ sender, context }) => { //... };

Fired when an event is dropped on this view, allows the drop to be validated. Depends on the cfg-droppable config.

Parameters

this :  Ext.calendar.view.Days

The view.

context :  Object

The context.

event :  Ext.calendar.model.EventBase

The event model.

newRange :  Ext.calendar.date.Range

The new date range.

validate :  Ext.Promise

A promise that allows validation to occur. The default behavior is for no validation to take place. To achieve asynchronous validation, the promise on the context object must be replaced:

{
    listeners: {
        validateeventdrop: function(view, context) {
            context.validate = context.then(function() {
                return Ext.Ajax.request({
                    url: '/checkDrop'
                }).then(function(response) {
                    return Promise.resolve(response.responseText === 'ok');
                });
            });
        }
    }
}

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onValidateEventEdit : function ( this, context, eOpts )

// Delcare in template tag
onValidateeventedit={this._onValidateeventedit}
// Declare in class
_onValidateeventedit = ({ sender, context }) => { //... };

Fired after the editForm has been completed, but before the event is saved. Allows the edit to be validated.

Parameters

this :  Ext.calendar.view.Base

This view.

context :  Object

The context.

event :  Ext.calendar.model.EventBase

The event to be edited, the data is not yet set on the event.

data :  Object

The data provided by the form. This will be used to set the event data using Ext.calendar.model.EventBase#setData.

validate :  Ext.Promise

A promise that allows validation to occur. The default behavior is for no validation to take place. To achieve asynchronous validation, the promise on the context object must be replaced:

{
    listeners: {
        validateeventedit: function(view, context) {
            context.validate = context.then(function() {
                return Ext.Ajax.request({
                    url: '/checkEdit'
                }).then(function(response) {
                    return Promise.resolve(response.responseText === 'ok');
                });
            });
        }
    }
}

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onValidateEventResize : function ( this, context, eOpts )

// Delcare in template tag
onValidateeventresize={this._onValidateeventresize}
// Declare in class
_onValidateeventresize = ({ sender, context }) => { //... };

Fired when an event is resized on this view, allows the resize to be validated. Depends on the cfg-resizeEvents config.

Parameters

this :  Ext.calendar.view.Days

The view.

context :  Object

The context.

event :  Ext.calendar.model.EventBase

The event model.

newRange :  Ext.calendar.date.Range

The new date range.

validate :  Ext.Promise

A promise that allows validation to occur. The default behavior is for no validation to take place. To achieve asynchronous validation, the promise on the context object must be replaced:

{
    listeners: {
        validateeventresize: function(view, context) {
            context.validate = context.then(function() {
                return Ext.Ajax.request({
                    url: '/checkResize'
                }).then(function(response) {
                    return Promise.resolve(response.responseText === 'ok');
                });
            });
        }
    }
}

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onValueChange : function ( this, context, eOpts )

// Delcare in template tag
onValuechange={this._onValuechange}
// Declare in class
_onValuechange = ({ sender, context }) => { //... };

Fired when the cfg-value changes.

Parameters

this :  Ext.calendar.view.Base

This view.

context :  Object

The context.

value :  Date

The new value.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onWidthChange : function ( sender, value, oldValue, eOpts )

// Delcare in template tag
onWidthchange={this._onWidthchange}
// Declare in class
_onWidthchange = ({ sender, value, oldValue }) => { //... };

This event fires when width changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Number/String

The current value of width.

oldValue :  Number/String

The previous value of width.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

theme variables

$calendar-days-allday-empty-height : Number

The height for the empty all day row to allow creation.

Defaults to:

10px

$calendar-days-background-color : color

The background color.

Defaults to:

$calendar-background-color

$calendar-days-compact-day-gutter-width : Number

The width for the day gutter when in compact mode.

Defaults to:

0

$calendar-days-compact-day-start-margin : Number

The start margin for the day container when in compact mode.

Defaults to:

0

$calendar-days-compact-time-font-size : Number

The font size for the time display when in compact mode.

Defaults to:

$calendar-small-font-size

$calendar-days-compact-time-padding : Number / list

The padding for the time display when in compact mode.

Defaults to:

2px 2px 0 0

$calendar-days-compact-time-width : Number

The width for the time display when in compact mode.

Defaults to:

24px

$calendar-days-day-border-color : color

The border color for days.

Defaults to:

$calendar-days-marker-border-color

$calendar-days-day-border-style : String

The border style for days.

Defaults to:

$calendar-days-marker-border-style

$calendar-days-day-border-width : Number

The border width for days.

Defaults to:

$calendar-days-marker-border-width

$calendar-days-day-gutter-width : Number

The width for the day gutter.

Defaults to:

15px

$calendar-days-day-start-margin : Number

The start margin for the day container.

Defaults to:

5px

$calendar-days-hour-height : Number

The height for a single hour in the view.

Defaults to:

42px

$calendar-days-marker-alt-border-color : color

The border color for half hour markers.

Defaults to:

$calendar-border-color

$calendar-days-marker-alt-border-style : String

The border style for half hour markers.

Defaults to:

dotted

$calendar-days-marker-alt-border-width : Number

The border width for half hour markers.

Defaults to:

1px

$calendar-days-marker-border-color : color

The border color for hour markers.

Defaults to:

$calendar-border-color

$calendar-days-marker-border-style : String

The border style for hour markers.

Defaults to:

solid

$calendar-days-marker-border-width : Number

The border width for hour markers.

Defaults to:

1px

$calendar-days-now-marker-border-color : color

The color for the current time marker.

Defaults to:

#a94442

$calendar-days-now-marker-border-style : String

The style for the current time marker.

Defaults to:

solid

$calendar-days-now-marker-border-width : Number

The height for the current time marker.

Defaults to:

2px 0 0 0

$calendar-days-now-marker-margin : Number / list

The margin for the current time marker.

Defaults to:

0 5px

$calendar-days-now-marker-opacity : Number

The opacity for the current time marker.

Defaults to:

0.7

$calendar-days-selection-background-color : color

The background color for a selection.

Defaults to:

$calendar-selection-color

$calendar-days-selection-opacity : Number

The opacity for a selection.

Defaults to:

0.3

$calendar-days-time-ampm-line-height : Number

The line height for the am/pm text when used in the time gutter.

Defaults to:

12px

$calendar-days-time-background-color : String

The background color for the time display.

Defaults to:

#F7F9FD

$calendar-days-time-color : String

The color for the time display.

Defaults to:

#666

$calendar-days-time-font-family : String

The font family for the time display.

Defaults to:

$calendar-font-family

$calendar-days-time-font-size : Number

The font size for the time display.

Defaults to:

$calendar-font-size

$calendar-days-time-padding : Number / list

The padding for the time display.

Defaults to:

2px 2px 0 0

$calendar-days-time-text-align : String

The text align for the time display.

Defaults to:

right

$calendar-days-time-width : Number

The width for the time display.

Defaults to:

48px

$calendar-today-highlight-background-color : color

The background color for a today.

Defaults to:

$calendar-today-background-color

theme mixins

calendar-days-ui ( ...list... )

Creates a visual theme for the calendar days view.

Parameters

$ui :  String

The name of the UI being created. Can not included spaces or special punctuation (used in CSS class names).

$background-color :  color (optional)

The background color.

$hour-height :  Number (optional)

The height for a single hour in the view.

$day-gutter-width :  Number (optional)

The width for the day gutter.

$day-start-margin :  Number (optional)

The start margin for the day container.

$marker-border-width :  Number (optional)

The border width for hour markers.

$marker-border-style :  String (optional)

The border style for hour markers.

$marker-border-color :  color (optional)

The border color for hour markers.

$marker-alt-border-width :  Number (optional)

The border width for half hour markers.

$marker-alt-border-style :  String (optional)

The border style for half hour markers.

$marker-alt-border-color :  color (optional)

The border color for half hour markers.

$day-border-width :  Number (optional)

The border width for days.

$day-border-style :  String (optional)

The border style for days.

$day-border-color :  color (optional)

The border color for days.

$now-marker-opacity :  Number (optional)

The opacity for the current time marker.

$now-marker-margin :  Number/list (optional)

The margin for the current time marker.

$now-marker-border-width :  Number/list (optional)

The border width for the current time marker.

$now-marker-border-style :  String (optional)

The border style for the current time marker.

$now-marker-border-color :  color (optional)

The border color for the current time marker.

$time-width :  Number (optional)

The width of the current time

$time-background-color :  color (optional)

The background color for the current time

$time-color :  color (optional)

The color for the current time

$time-font-family :  String (optional)

The font family for the current time

$time-font-size :  Number (optional)

The font size for the current time

$time-text-align :  String (optional)

The font alignment for the current time

$time-padding :  Number (optional)

The padding for the current time

$time-ampm-line-height :  String (optional)

The line height for the current time

$allday-empty-height :  Number (optional)

The height for the empty all day row to allow creation.

$selection-background-color :  color (optional)

The background color for a selection.

$selection-opacity :  Number (optional)

The background color for a selection.

ExtReact 7.0.0