Ext JS

https://docs.sencha.com/extjs/5.1.3/index.html
Admin
Ext JS is a comprehensive JavaScript framework for building rich, interactive web applications with...
Tokens:2,878
Snippets:70
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Class Member Syntax Example

Source: https://docs.sencha.com/extjs/5.1.3/index.html

An example illustrating the syntax of a class member, specifically the `lookupComponent` method from `Ext.button.Button` as viewed from `Ext.container.Container`.

```APIDOC
## Ext.container.Container

### Description

This section details the syntax of a class member, using `lookupComponent` as an example.

### Method

`lookupComponent`

### Endpoint

N/A (Class Member Documentation)

### Parameters

#### Path Parameters

None

#### Query Parameters

None

#### Request Body

None

### Request Example

None

### Response

#### Success Response (200)

- **item** (Object) - Required/Optional - The config object being added.

#### Response Example

```json
{
  "example": "Ext.Component"
}
```

### Member Details

- **Member Name**: `lookupComponent`
- **Method Param**: `( item )`
- **Return type**: `Ext.Component`
- **Flags**: `protected`
- **Member Origin**: `Ext.container.Container`
- **Member Source**: `view source`
- **Params List**: `item : Object - The config object being added.`
- **Returns**: `Ext.Component - The component to be added.`
```

--------------------------------

### API Member Flags

Source: https://docs.sencha.com/extjs/5.1.3/index.html

Explanation of the various flags used in the API documentation to describe class members.

```APIDOC
## API Member Flags

### Description

This section explains the meaning of different flags used in the API documentation.

### Flags

- **Required**: Required config when instantiating a class.
- **Bindable**: The config has a setter which allows this config to be set via ViewModel binding.
- **Read Only**: The property may be read, but cannot be used to configure / re-configure a class instance at runtime.
- **Singleton**: Singleton classes are instantiated immediately once defined and may not be instantiated manually.
- **Static**: A static method or property is a method or property belonging to the class itself, not an instance of the class.
- **Chainable**: Refers to methods that return the class instance back when called, enabling chained method calls.
- **Deprecated**: A class or member scheduled for removal in a future framework version, provided for backwards compatibility.
- **Removed**: A removed class or member existing only as a reference for upgrading users.
- **Template**: A method defined within a base class designed to be overridden by subclasses.
- **Abstract**: A class or member defined as abstract, establishing structure with limited code, to be overridden by subclasses.
- **Preventable**: Events marked preventable will not fire if `false` is returned from an event handler.
```
Tokens:
Raw