Docs Help

Terms, Icons, and Labels

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

Access Levels

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

Member Types

Member Syntax

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

lookupComponent ( item ) : Ext.Component
protected

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

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

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

Parameters

item :  Object

The config object being added.

Returns
Ext.Component

The component to be added.

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

Member Flags

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

Class Icons

- Indicates a framework class

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

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

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

Member Icons

- Indicates a class member of type config

- Indicates a class member of type property

- Indicates a class member of type method

- Indicates a class member of type event

- Indicates a class member of type theme variable

- Indicates a class member of type theme mixin

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

Class Member Quick-Nav Menu

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

Getter and Setter Methods

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

History Bar

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

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

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

Search and Filters

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

On API doc pages there is also a filter input field that filters the member rows using the filter string. In addition to filtering by string you can filter the class members by access level and inheritance. This is done using the checkboxes at the top of the page.

The checkbox at the bottom of the API class navigation tree filters the class list to include or exclude private classes.

Clicking on an empty search field will show your last 10 searches for quick navigation.

API Doc Class Metadata

Each API doc page (with the exception of Javascript primitives pages) has a menu view of metadata relating to that class. This metadata view will have one or more of the following:

Expanding and Collapsing Examples and Class Members

Runnable examples (Fiddles) are expanded on a page by default. You can collapse and expand example code blocks individually using the arrow on the top-left of the code block. You can also toggle the collapse state of all examples using the toggle button on the top-right of the page. The toggle-all state will be remembered between page loads.

Class members are collapsed on a page by default. You can expand and collapse members using the arrow icon on the left of the member row or globally using the expand / collapse all toggle button top-right.

Desktop -vs- Mobile View

Viewing the docs on narrower screens or browsers will result in a view optimized for a smaller form factor. The primary differences between the desktop and "mobile" view are:

Viewing the Class Source

The class source can be viewed by clicking on the class name at the top of an API doc page. The source for class members can be viewed by clicking on the "view source" link on the right-hand side of the member row.

Sencha Architect 4.1

Guides
API
top

Setting Up Calendar

The Calendar component (and other premium Ext JS framework packages) may be included in your Architect projects. In this guide, we’ll walk through connecting the premium packages from the ExtJS SDK to your projects. We’ll also step through the additions and configurations required to use Calendar components in an active project.

Note: This guide applies to Architect 4.1+ and Ext JS 6.2+

Premium Package Setup

Architect ships with the Calendar component, which allows you to compose your project with calendar components in the Design view. However, to use them in a saved project, you’ll need to copy the premium packages folders over to your saved project or the Architect frameworks library folder. Below are the two paths you may need to take to add the necessary package folders for use in your Architect projects.

Before Your Architect Project Is Created

The following steps will be the steps you’ll need to include the Calendar component and other premium packages in new Architect projects.

  1. In your computer’s file browser, open the Ext JS SDK addons packages folder.
    I.e. {ext-addons-6.2.1}/packages. You should see the "calendar" folder along with the other included premium add-ons.

  2. Copy all folders in the "packages" folder

  3. Paste the premium package folders into the Architect frameworks folder

    1. Mac: /Users//Documents/Architect/frameworks/ext62/6.2.1.167/commercial/packages/

    2. PC: c:\Users\pf\Documents\Architect\frameworks\ext62\6.2.1.167\commercial\packages\

    3. Linux: ~/Documents/Architect/frameworks/ext62/6.2.1.167/commercial/packages

Note: Architect will use the most recent version of the framework within the "frameworks" subfolder. For example, if you see 6.2.0.x and 6.2.1.x in the “frameworks/ext62” folder, you’ll want to make sure the packages are added to the 6.2.1.x folder from the 6.2.1 addons download.

Existing Architect Project

Once a project has been saved for the first time, the framework assets are copied to the project’s output directory. For previously saved projects, you’ll need to copy the premium package folders to the project itself via these steps:

  1. In your computer’s file browser, open the Ext JS SDK addons packages folder.
    I.e. {ext-addons-6.2.0}/packages. You should see the "calendar" folder along with the other included premium add-ons.

  2. Copy all folders in the "packages" folder

  3. Paste the premium package folders in your saved project folder’s {SavePath}/ext/packages

Note: If you have already added a Calendar component to your project prior to adding the package to your save folder, you’ll need to restart Architect after copying the premium package folders before you can preview your project.

Using the Calendar in a Project

Add the Calendar Panel to the View

With the Calendar component accessible to both Architect and your project builds, you may search for "calendar" in the component toolbox panel and drag the Calendar Panel onto the design view. Any of the calendar views / panels could be selected. We’ll use the Calendar Panel component for the purpose of this walkthrough.

Add a Calendars Store

  1. From the Project Inspector pane, click the "+" button and choose Store > Calendars Store

  2. Drag "Calendar Model" from the Toolbox panel to the “Models” node in the Project Inspector pane. The calendar model will be created with a class name of "MyCalendars".

  3. Select the "MyCalendars" store in the Project Inspector view

  4. Search for "autoLoad" in the config panel and place a checkbox next to the “autoLoad” config

  5. Search for "model" in the config panel and choose “MyCalendar” as the value for the “model” config

  6. Search for "eventStoreDefaults" in the config panel and add the following as the value for “eventStoreDefaults”

     {
         proxy: {
             type: 'ajax',
             url: 'resources/events.json'
         }
     }
    
  7. Here is an example of events.json

    [{
        "id": 1001,
        "calendarId": 1,
        "endDate": "2016-05-30T01:30:00.000Z",
        "startDate": "2016-05-30T00:30:00.000Z",
        "title": "Meet with Development"
    }, {
        "id": 1002,
        "calendarId": 1,
        "endDate": "2016-05-31T03:00:00.000Z",
        "startDate": "2016-05-31T01:00:00.000Z",
        "title": "Review with Marketing"
    }]
    
  8. Search for "proxy" in the config panel, click on the + button for the “Proxy” config, and choose "Ajax Proxy"

  9. Click on the "MyAjaxProxy" node under the "MyCalendars" store in the "Project Inspector" view

  10. Search for "url" in the config panel and set the value of “url” to “resources/calendars.json”

  11. Here is an example of calendars.json

    [{
        "id": 1,
        "title": "Personal"
    }]
    
  12. Save your project

Adding and configuring the calendars store sets up the structure needed for a working calendar to consume both the calendars list and its events from a remote server. In the real world you’ll have to replace the two "url" configs above with your own server urls.

Additional Resources

For additional information on the Calendar component refer to the Calendar Guide. You can also inspect the examples in the Kitchen Sink and the Google calendar example.

Sencha Architect 4.1

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

Sencha Test

2.0.0 1.0.3

Cmd

Cmd

Sencha Themer

1.1.0 EA 1.0.2

GXT

5.x EA 4.x 3.x

IDE Plugins

IDE Plugins

Sencha Inspector

Sencha Inspector

Sencha Fiddle

Sencha Fiddle

Offline Documentation

Offline Documentation