Docs Help

Terms, Icons, and Labels

Many classes have shortcut names used when creating (instantiating) a class with a configuration object. The shortcut name is referred to as an alias (or xtype if the class extends Ext.Component). The alias/xtype is listed next to the class name of applicable classes for quick reference.

Access Levels

Framework classes or their members may be specified as private or protected. Else, the class / member is public. Public, protected, and private are access descriptors used to convey how and when the class or class member should be used.

Member Types

Member Syntax

Below is an example class member that we can disect to show the syntax of a class member (the lookupComponent method as viewed from the Ext.button.Button class in this case).

lookupComponent ( item ) : Ext.Component
protected

Called when a raw config object is added to this container either during initialization of the items config, or when new items are added), or {@link #insert inserted.

This method converts the passed object into an instanced child component.

This may be overridden in subclasses when special processing needs to be applied to child creation.

Parameters

item :  Object

The config object being added.

Returns
Ext.Component

The component to be added.

Let's look at each part of the member row:

Member Flags

The API documentation uses a number of flags to further commnicate the class member's function and intent. The label may be represented by a text label, an abbreviation, or an icon.

Class Icons

- Indicates a framework class

- A singleton framework class. *See the singleton flag for more information

- A component-type framework class (any class within the Ext JS framework that extends Ext.Component)

- Indicates that the class, member, or guide is new in the currently viewed version

Member Icons

- Indicates a class member of type config

- Indicates a class member of type property

- Indicates a class member of type method

- Indicates a class member of type event

- Indicates a class member of type theme variable

- Indicates a class member of type theme mixin

- Indicates that the class, member, or guide is new in the currently viewed version

Class Member Quick-Nav Menu

Just below the class name on an API doc page is a row of buttons corresponding to the types of members owned by the current class. Each button shows a count of members by type (this count is updated as filters are applied). Clicking the button will navigate you to that member section. Hovering over the member-type button will reveal a popup menu of all members of that type for quick navigation.

Getter and Setter Methods

Getting and setter methods that correlate to a class config option will show up in the methods section as well as in the configs section of both the API doc and the member-type menus just beneath the config they work with. The getter and setter method documentation will be found in the config row for easy reference.

History Bar

Your page history is kept in localstorage and displayed (using the available real estate) just below the top title bar. By default, the only search results shown are the pages matching the product / version you're currently viewing. You can expand what is displayed by clicking on the button on the right-hand side of the history bar and choosing the "All" radio option. This will show all recent pages in the history bar for all products / versions.

Within the history config menu you will also see a listing of your recent page visits. The results are filtered by the "Current Product / Version" and "All" radio options. Clicking on the button will clear the history bar as well as the history kept in local storage.

If "All" is selected in the history config menu the checkbox option for "Show product details in the history bar" will be enabled. When checked, the product/version for each historic page will show alongside the page name in the history bar. Hovering the cursor over the page names in the history bar will also show the product/version as a tooltip.

Search and Filters

Both API docs and guides can be searched for using the search field at the top of the page.

On API doc pages there is also a filter input field that filters the member rows using the filter string. In addition to filtering by string you can filter the class members by access level, 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.

Ext JS 6.2.0 - Classic Toolkit


top

Ext.calendar.Event xtype: calendar-event premium

Hierarchy

Ext.calendar.Event

Summary

Represents an event on a calendar view.

No members found using the current filters

configs

Optional Configs

defaultTitle : String

The default title to use when one is not specified.

Defaults to:

'(New Event)'

getDefaultTitle : String

Returns the value of defaultTitle

Returns

String

setDefaultTitle (defaultTitle)

Sets the value of defaultTitle

Parameters

defaultTitle :  String

endDate : Date

The end date for this event (as UTC). Will be set automatically if a model is passed. May be set independently of any attached model.

Defaults to:

null

getEndDate : Date

Returns the value of endDate

Returns

Date

setEndDate (endDate)

Sets the value of endDate

Parameters

endDate :  Date

mode : String

The display mode for this event. Possible options are:

  • weekspan
  • weekinline
  • day

Defaults to:

null

getMode : String

Returns the value of mode

Returns

String

setMode (mode)

Sets the value of mode

Parameters

mode :  String

model : Ext.calendar.model.EventBase

A backing model for this widget.

Defaults to:

null

setModel (model)

Sets the value of model

Parameters

model :  Ext.calendar.model.EventBase

palette : Ext.calendar.theme.Palette

A color palette for this event.

Defaults to:

null

setPalette (palette)

Sets the value of palette

Parameters

palette :  Ext.calendar.theme.Palette

resize : Boolean

true to allow this event to be resized via the UI.

Defaults to:

false

getResize : Boolean

Returns the value of resize

Returns

Boolean

setResize (resize)

Sets the value of resize

Parameters

resize :  Boolean

startDate : Date

The start date for this event (as UTC). Will be set automatically if a model is passed. May be set independently of any attached model.

Defaults to:

null

getStartDate : Date

Returns the value of startDate

Returns

Date

setStartDate (startDate)

Sets the value of startDate

Parameters

startDate :  Date

timeFormat : String

A display format for the time.

Defaults to:

'H:i'

getTimeFormat : String

Returns the value of timeFormat

Returns

String

setTimeFormat (timeFormat)

Sets the value of timeFormat

Parameters

timeFormat :  String

title : String

The title for this event. Will be set automatically if a model is passed.

Defaults to:

''

getTitle : String

Returns the value of title

Returns

String

setTitle (title)

Sets the value of title

Parameters

title :  String

touchAction : Object

Emulates the behavior of the CSS href="https://www.w3.org/TR/pointerevents/#the-touch-action-css-property" class="external-link" target="_blank">https://www.w3.org/TR/pointerevents/#the-touch-action-css-property 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:

Ext.create('Ext.Widget', {
    touchAction: {
        panX: false
    },
    listeners: {
        drag: function(e) {
            // implement drag logic
        }
    }
});

Defaults to:

{
    panX: false,
    panY: false
}

getTouchAction : Object

Returns the value of touchAction

Returns

Object

setTouchAction (touchAction)

Sets the value of touchAction

Parameters

touchAction :  Object

view : Ext.calendar.view.Base

The view for this event.

Defaults to:

null

getView : Ext.calendar.view.Base

Returns the value of view

Returns

Ext.calendar.view.Base

setView (view)

Sets the value of view

Parameters

view :  Ext.calendar.view.Base

theme variables

$calendar-event-day-border-style : Number

The border style for a day event.

Defaults to:

solid

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

The border width for a day event.

Defaults to:

1px

$calendar-event-day-font-size : Number

The font size for a day event.

Defaults to:

$calendar-small-font-size

$calendar-event-day-margin : Number / list

The margin for a day event.

Defaults to:

1px 0

$calendar-event-day-padding : Number / list

The padding for a day event.

Defaults to:

2px 4px

$calendar-event-dragging-opacity : Number

The opacity to be used when dragging an event.

Defaults to:

0.8

$calendar-event-font-family : String

The font family for an event.

Defaults to:

$calendar-font-family

$calendar-event-resizer-content : String

The content for the resizer for an event.

Defaults to:

"="

$calendar-event-resizer-font-family : String

The font family for the resizer for an event.

Defaults to:

monospace

$calendar-event-resizer-font-size : Number

The font size for the resizer for an event.

Defaults to:

$calendar-large-font-size

$calendar-event-resizing-opacity : Number

The opacity when resizing an event.

Defaults to:

$calendar-event-dragging-opacity

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

The padding for the time portion of an event.

Defaults to:

0 4px 0 0

$calendar-event-week-font-size : Number

The font size for a week event.

Defaults to:

$calendar-font-size

$calendar-event-week-inline-padding : Number / list

The padding for a week event that is inline (occurs only one day and is not all day).

Defaults to:

0 0 0 3px

$calendar-event-week-margin : Number / list

The margin for a week event.

Defaults to:

3px

$calendar-event-week-span-padding : Number / list

The padding for a week event that spans (all day, or multiple days).

Defaults to:

1px 1px 1px 3px

Ext JS 6.2.0 - Classic Toolkit