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

Hierarchy

Ext.draw.engine.Canvas

Summary

Provides specific methods to draw with 2D Canvas element.

No members found using the current filters

configs

Optional Configs

background : Object

Background sprite config of the surface.

Defaults to:

null

getBackground : Object

Returns the value of background

Returns

Object

setBackground (background)

Sets the value of background

Parameters

background :  Object

dirty : Boolean

Indicates whether the surface needs to redraw.

Defaults to:

false

getDirty : Boolean

Returns the value of dirty

Returns

Boolean

setDirty (dirty)

Sets the value of dirty

Parameters

dirty :  Boolean

flipRtlText : Boolean

If the surface is in the RTL mode, text will render with the RTL direction, but the alignment and position of the text won't change by default. Setting this config to 'true' will get text alignment and its position within a surface mirrored.

Defaults to:

false

getFlipRtlText : Boolean

Returns the value of flipRtlText

Returns

Boolean

setFlipRtlText (flipRtlText)

Sets the value of flipRtlText

Parameters

flipRtlText :  Boolean

highPrecision : Boolean

True to have the Canvas use JavaScript Number instead of single precision floating point for transforms.

For example, when using data with big numbers to plot line series, the transformation matrix of the canvas will have big elements. Due to the implementation of the SVGMatrix, the elements are represented by 32-bits floats, which will work incorrectly. To compensate for that, we enable the canvas context to perform all the transformations in JavaScript.

Do not use this if you are not encountering 32-bit floating point errors problem, since this will result in a performance penalty.

Defaults to:

false

getHighPrecision : Boolean

Returns the value of highPrecision

Returns

Boolean

setHighPrecision (highPrecision)

Sets the value of highPrecision

Parameters

highPrecision :  Boolean

items : Array

Array of sprite instances.

Defaults to:

[]

getItems : Array

Returns the value of items

Returns

Array

setItems (items)

Sets the value of items

Parameters

items :  Array

rect : Array

The [x, y, width, height] rect of the surface related to its container.

Defaults to:

null

getRect : Array

Returns the value of rect

Returns

Array

setRect (rect)

Sets the value of rect

Parameters

rect :  Array

properties

Instance Properties

clear

Empty the surface content (without touching the sprites.)

Defaults to:

Ext.emptyFn

clearTransform
private pri

Clears the current transformation state on the surface.

Defaults to:

Ext.emptyFn

devicePixelRatio

The reported device pixel density. devicePixelRatio is only supported from IE11, so we use deviceXDPI and logicalXDPI that are supported from IE6.

Defaults to:

window.devicePixelRatio || window.screen.deviceXDPI / window.screen.logicalXDPI

isPendingRenderFrame
private pri

This flag is used to indicate that predecessors surfaces that should render before this surface renders are dirty, and to call renderFrame when all predecessors have their renderFrame called (i.e. not dirty anymore). This flag indicates that current surface has surfaces that are yet to render before current surface can render. When all the predecessors surfaces have rendered, i.e. when dirtyPredecessorCount reaches zero,

Defaults to:

false

toSave
private pri

Properties to be saved/restored in the save and restore methods.

Defaults to:

[
    'fillGradient',
    'strokeGradient'
]

methods

Instance Methods

add ( sprite ) : Ext.draw.sprite.Sprite/Ext.draw.sprite.Sprite[]

Add a Sprite to the surface. You can put any number of objects as the parameter. See Ext.draw.sprite.Sprite for the configuration object to be passed into this method.

For example:

drawContainer.getSurface().add({
    type: 'circle',
    fill: '#ffc',
    radius: 100,
    x: 100,
    y: 100
});
drawContainer.renderFrame();

Parameters

sprite :  Object/Object[]

Returns

:Ext.draw.sprite.Sprite/Ext.draw.sprite.Sprite[]

appendPath ( path )

Uses the given path commands to begin a new path on the canvas.

Parameters

path :  Object

applyItems ( items )
private pri

Parameters

items :  Object

createCanvas
private pri

Creates the canvas element.

createItem ( config )
private pri

Creates an item and appends it to the surface. Called as an internal method when calling add.

Parameters

config :  Object

destroy

Destroys the surface. This is done by removing all components from it and also removing its reference to a DOM element.

For example:

 drawContainer.surface.destroy();

disablePrecisionCompensation ( ctx )
private pri

Clears canvas of compensation for canvas' use of single precision floating point.

Parameters

ctx :  CanvasRenderingContext2D

The canvas context.

ellipse ( cx, cy, rx, ry, rotation, start, end, anticlockwise )

Adds points to the subpath such that the arc described by the circumference of the ellipse described by the arguments, starting at the given start angle and ending at the given end angle, going in the given direction (defaulting to clockwise), is added to the path, connected to the previous point by a straight line.

Parameters

cx :  Object

cy :  Object

rx :  Object

ry :  Object

rotation :  Object

start :  Object

end :  Object

anticlockwise :  Object

enablePrecisionCompensation ( ctx )
private pri

Compensate for canvas' use of single precision floating point.

Parameters

ctx :  CanvasRenderingContext2D

The canvas context.

fill

Fills the subpaths of the current default path or the given path with the current fill style.

fillStroke ( attr, transformFillStroke )

Parameters

attr :  Object

transformFillStroke :  Object

flatten ( size, surfaces ) : Object

Flattens the given drawing surfaces into a single image and returns an object containing the data (in the DataURL format) and the type (e.g. 'png' or 'svg') of that image.

Parameters

size :  Object

The size of the final image.

width :  Number

height :  Number

surfaces :  Ext.draw.Surface[]

The surfaces to flatten.

Returns

:Object

data :  String

The DataURL of the flattened image.

type :  String

The type of the image.

get ( id ) : Ext.draw.sprite.Sprite

Get the sprite by id or index. It will first try to find a sprite with the given id, otherwise will try to use the id as an index.

Parameters

id :  String/Number

Returns

:Ext.draw.sprite.Sprite

getBBox ( sprites, [isWithoutTransform] ) :

Return the minimal bounding box that contains all the sprites bounding boxes in the given list of sprites.

Parameters

sprites :  Ext.draw.sprite.Sprite[]/Ext.draw.sprite.Sprite

isWithoutTransform :  Boolean (optional)

Defaults to: false

Returns

:

{{x: Number, y: Number, width: number, height: number}}

hitTest ( point, options ) : Object

Performs a hit test on all sprites in the surface, returning the first matching one.

Parameters

point :  Array

A two-item array containing x and y coordinates of the point.

options :  Object

Hit testing options.

Returns

:Object

A hit result object that contains more information about what exactly was hit or null if nothing was hit.

hitTestEvent ( point, options ) : Object

Performs a hit test on all sprites in the surface, returning the first matching one. Since hit testing is typically performed on mouse events, this convenience method converts event's page coordinates to surface coordinates before calling hitTest.

Parameters

point :  Array

An event object.

options :  Object

Hit testing options.

Returns

:Object

A hit result object that contains more information about what exactly was hit or null if nothing was hit.

onAdd ( sprite )
protected pro

Invoked when a sprite is added to the surface.

Parameters

sprite :  Ext.draw.sprite.Sprite

The sprite to be added.

orderByZIndex
private pri

Order the items by their z-index if any of that has been changed since last sort.

remove ( sprite, [isDestroy] ) : Ext.draw.sprite.Sprite

Remove a given sprite from the surface, optionally destroying the sprite in the process. You can also call the sprite's own remove method.

For example:

 drawContainer.surface.remove(sprite);
 // or...
 sprite.remove();

Parameters

sprite :  Ext.draw.sprite.Sprite/String

A sprite instance or its ID.

isDestroy :  Boolean (optional)

If true, the sprite will be destroyed.

Defaults to: false

Returns

:Ext.draw.sprite.Sprite

Returns the removed/destroyed sprite or null otherwise.

removeAll ( [isDestroy] )

Remove all sprites from the surface, optionally destroying the sprites in the process.

For example:

drawContainer.getSurface('main').removeAll();

Parameters

isDestroy :  Boolean (optional)

Defaults to: false

renderFrame

Triggers the re-rendering of the canvas.

renderSprite ( sprite ) : Boolean
private pri

Renders a single sprite into the surface. Do not call it from outside renderFrame method.

Parameters

sprite :  Ext.draw.sprite.Sprite

The Sprite to be rendered.

Returns

:Boolean

returns false to stop the rendering to continue.

repaint

Force the element to redraw.

resetTransform

Reset the matrix of the surface.

roundPixel ( num ) : Number

Round the number to align to the pixels on device.

Parameters

num :  Number

The number to align.

Returns

:Number

The resultant alignment.

setGradientBBox ( bbox )

Parameters

bbox :  Object

setLineDash ( dashList )

2D Canvas context in IE (up to IE10, inclusive) doesn't support the setLineDash method and the lineDashOffset property.

Parameters

dashList :  Object

An even number of non-negative numbers specifying a dash list.

stroke

Strokes the subpaths of the current default path or the given path with the current stroke style.

waitFor ( surface )

Mark the surface to render after another surface is updated.

Parameters

surface :  Ext.draw.Surface

The surface to wait for.

Ext JS 6.0.1 - Modern Toolkit