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.0.1 - Modern Toolkit


top

Ext.draw.Container xtype: draw

Summary

The container that holds and manages instances of the Ext.draw.Surface in which Ext.draw.sprite.Sprite are rendered. Draw containers are used as the foundation for all of the chart classes but may also be created directly in order to create custom drawings.

In the previous example we created a draw container and configured it with a single sprite. The type of the sprite is Ext.draw.sprite.Circle, so if you run this code you'll see a green circle.

You can attach sprite event listeners to the draw container with the help of the Ext.draw.plugin.SpriteEvents plugin.

For more information on sprites, the core elements added to a draw container's surface, refer to the Ext.draw.sprite.Sprite documentation.

For more information on surfaces, the interface owned by the draw container used to manage all sprites, see the Ext.draw.Surface documentation.

No members found using the current filters

configs

Optional Configs

engine : String

Defines the engine (type of surface) used to render draw container contents.

The render engine is selected automatically depending on the platform used. Priority is given to the Ext.draw.engine.Canvas engine due to its performance advantage.

You may also set the engine config to be Ext.draw.engine.Svg if so desired.

Defaults to:

"Ext.draw.engine.Canvas"

gradients : Object[]

Defines a set of gradients that can be used as color properties (fillStyle and strokeStyle, but not shadowColor) in sprites. The gradients array is an array of objects with the following properties:

  • id - string - The unique name of the gradient.
  • type - string, optional - The type of the gradient. Available types are: 'linear', 'radial'. Defaults to 'linear'.
  • angle - number, optional - The angle of the gradient in degrees.
  • stops - array - An array of objects with 'color' and 'offset' properties, where 'offset' is a real number from 0 to 1.

For example:

gradients: [{
    id: 'gradientId1',
    type: 'linear',
    angle: 45,
    stops: [{
        offset: 0,
        color: 'red'
    }, {
       offset: 1,
       color: 'yellow'
    }]
}, {
   id: 'gradientId2',
   type: 'radial',
   stops: [{
       offset: 0,
       color: '#555',
   }, {
       offset: 1,
       color: '#ddd',
   }]
}]

Then the sprites can use 'gradientId1' and 'gradientId2' by setting the color attributes to those ids, for example:

sprite.setAttributes({
    fillStyle: 'url(#gradientId1)',
    strokeStyle: 'url(#gradientId2)'
});

Defaults to:

[]

getGradients : Object[]

Returns the value of gradients

Returns

Object[]

setGradients (gradients)

Sets the value of gradients

Parameters

gradients :  Object[]

resizeHandler : Function

The resize function that can be configured to have a behavior, e.g. resize draw surfaces based on new draw container dimensions.

Note: since resize events trigger renderFrame calls automatically, return false from the resize function, if it also calls renderFrame, to prevent double rendering.

Defaults to:

null

getResizeHandler : Function

Returns the value of resizeHandler

Returns

Function

setResizeHandler (resizeHandler)

Sets the value of resizeHandler

Parameters

resizeHandler :  Function

sprites : Object[]

Defines a set of sprites to be added to the drawContainer surface.

For example:

 sprites: [{
      type: 'circle',
      fillStyle: '#79BB3F',
      r: 100,
      x: 100,
      y: 100
 }]

Defaults to:

null

getSprites : Object[]

Returns the value of sprites

Returns

Object[]

setSprites (sprites)

Sets the value of sprites

Parameters

sprites :  Object[]

properties

Instance Properties

defaultDownloadServerUrl : String

The default URL used by download.

Defaults to:

"http://svg.sencha.io"

supportedFormats : Array
private pri

A list of export types supported by the server.

Defaults to:

["png", "pdf", "jpeg", "gif"]

methods

Instance Methods

download ( [config] ) : Boolean

Downloads an image or PDF of the chart / drawing or opens it in a separate browser tab/window if the download can't be triggered. The exact behavior is platform and browser specific. For more consistent results on mobile devices use the preview method instead.

Parameters

config :  Object (optional)

The following config options are supported:

url :  String

The url to post the data to. Defaults to the defaultDownloadServerUrl configuration on the class.

format :  String

The format of image to export. See the supportedFormats. Defaults to 'png' on the Sencha IO server. Note that you can't export to 'svg' format if the Ext.draw.engine.Canvas engine is used.

width :  Number

A width to send to the server for configuring the image width. Defaults to natural image width on the Sencha IO server.

height :  Number

A height to send to the server for configuring the image height. Defaults to natural image height on the Sencha IO server.

filename :  String

The filename of the downloaded image. Defaults to 'chart' on the Sencha IO server. The config.format is used as a filename extension.

scale :  Number

The scaling of the downloaded image. Defaults to 1 on the Sencha IO server. The server will try to determine the natural size of the image unless the width/height configs have been set. If the Ext.draw.engine.Canvas engine is used the natural image size will depend on the value of the window.devicePixelRatio. For example, for devices with devicePixelRatio of 2 the produced image will be two times larger than for devices with devicePixelRatio of 1 for the same drawing. This is done so that the users with devices with HiDPI screens get a downloaded image that looks as crisp on their device as the original drawing. If you want image size to be consistent across devices with different device pixel ratios, you can set the value of this config to 1/devicePixelRatio. This parameter is ignored by the Sencha IO server if config.format is set to 'svg'.

pdf :  Object

PDF specific options. This config is only used if config.format is set to 'pdf'. The given object should be in either this format:

{
  width: '200px',
  height: '300px',
  border: '0px'
}

or this format:

{
  format: 'A4',
  orientation: 'portrait',
  border: '1cm'
}

Supported dimension units are: 'mm', 'cm', 'in', 'px'. No unit means 'px'. Supported formats are: 'A3', 'A4', 'A5', 'Legal', 'Letter', 'Tabloid'. Orientation ('portrait', 'landscape') is optional and defaults to 'portrait'.

jpeg :  Object

JPEG specific options. This config is only used if config.format is set to 'jpeg'. The given object should be in this format:

{
  quality: 80
}

Where quality is an integer between 0 and 100.

Returns

:Boolean

True if request was successfully sent to the server.

getImage ( [format] ) : Object

Produces an image of the chart / drawing.

Parameters

format :  String (optional)

Possible options are 'image' (the method will return an Image object) and 'stream' (the method will return the image as a byte stream). If missing, the DataURL of the drawing's (or chart's) image will be returned.

Returns

:Object

data :  String

Image element, byte stream or DataURL.

type :  String

The type of the data (e.g. 'png' or 'svg').

getSurface ( [id] ) : Ext.draw.Surface

Get a surface by the given id or create one if it doesn't exist.

Parameters

id :  String (optional)

Defaults to: "main"

Returns

:Ext.draw.Surface

preview

Displays an image of a Ext.draw.Container on screen. On mobile devices this lets users tap-and-hold to bring up the menu with image saving options. Note: some browsers won't save the preview image if it's SVG based (i.e. generated from a draw container that uses 'Ext.draw.engine.Svg' engine). And some platforms may not have the means of viewing successfully saved SVG images.

renderFrame

Render all the surfaces in the container.

events

bodyresize ( size, eOpts )

Fires when the size of the draw container body changes.

Parameters

size :  Object

The object containing 'width' and 'height' of the draw container's body.

eOpts : Object

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

spriteclick ( sprite, event, eOpts )

Fires when a click event occurs on a sprite.

Parameters

sprite :  Object

event :  Event

eOpts : Object

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

spritedblclick ( sprite, event, eOpts )

Fires when a double click event occurs on a sprite.

Parameters

sprite :  Object

event :  Event

eOpts : Object

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

spritemousedown ( sprite, event, eOpts )

Fires when a mousedown event occurs on a sprite.

Parameters

sprite :  Object

event :  Event

eOpts : Object

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

spritemousemove ( sprite, event, eOpts )

Fires when the mouse is moved on a sprite.

Parameters

sprite :  Object

event :  Event

eOpts : Object

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

spritemouseout ( sprite, event, eOpts )

Fires when the mouse exits a sprite.

Parameters

sprite :  Object

event :  Event

eOpts : Object

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

spritemouseover ( sprite, event, eOpts )

Fires when the mouse enters a sprite.

Parameters

sprite :  Object

event :  Event

eOpts : Object

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

spritemouseup ( sprite, event, eOpts )

Fires when a mouseup event occurs on a sprite.

Parameters

sprite :  Object

event :  Event

eOpts : Object

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

spritetap ( sprite, event, eOpts )

Fires when a tap event occurs on a sprite.

Parameters

sprite :  Object

event :  Event

eOpts : Object

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

Ext JS 6.0.1 - Modern Toolkit