ExtReact Docs Help

Introduction

The documentation for the ExtReact product diverges somewhat from the documentation of other Sencha products. The sections below describe documentation for all products except where indicated as unique to ExtReact.

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.

ExtReact component classes list the configurable name prominently at the top of the API class doc followed by the fully-qualified class name.

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

Or in the case of an ExtReact component class this indicates a member of type prop

- 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.

ExtReact component classes do not hoist the getter / setter methods into the prop. All methods will be described in the Methods section

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.

ExtReact 6.5.3


top

Ext.chart.axis.sprite.Axis alias: sprite.axis private premium

NPM Package

@extjs/ext-react-charts

Hierarchy

Ext.Base
Ext.draw.sprite.Sprite
Ext.chart.axis.sprite.Axis
NOTE: This is a private utility class for internal use by the framework. Don't rely on its existence.

Summary

The axis sprite. Currently all types of the axis will be rendered with this sprite.

No members found using the current filters

configs

Optional Configs

axis : Ext.chart.axis.Axis

The axis represented by this sprite.

Defaults to:

null

getAxis : Ext.chart.axis.Axis

Returns the value of axis

Returns

Ext.chart.axis.Axis

setAxis (axis)

Sets the value of axis

Parameters

axis :  Ext.chart.axis.Axis

axisLine : Boolean

'true' if the main line of the axis is drawn.

baseRotation : Number

The starting rotation of the angular axis.

centerX : Number

The central point of the angular axis on the x-axis.

centerY : Number

The central point of the angular axis on the y-axis.

dataMax : Number

The maximum value of the axis data.

dataMin : Number

The minimum value of the axis data.

enlargeEstStepSizeByText : Boolean

'true' if the estimated step size is adjusted by text size.

fillOpacity : Number

The opacity of the fill. Limited from 0 to 1.

Defaults to:

1

fillStyle : String

The color of the shape (a CSS color value).

Defaults to:

"none"

globalAlpha : Number

The opacity of the sprite. Limited from 0 to 1.

Defaults to:

1

globalCompositeOperation : String

Indicates how source images are drawn onto a destination image. globalCompositeOperation attribute is not supported by the SVG and VML (excanvas) engines.

Defaults to:

source-over

grid : Boolean

'true' if the axis has a grid.

hidden : Boolean

Determines whether or not the sprite is hidden.

Defaults to:

false

label : Object

The label configuration object for the Axis. This object may include style attributes like spacing, padding, font that receives a string or number and returns a new string with the modified values.

Defaults to:

null

getLabel : Object

Returns the value of label

Returns

Object

setLabel (label)

Sets the value of label

Parameters

label :  Object

labelOffset : Number

The distance between the label and the edge of a major tick. Only applicable for 'gauge' and 'angular' axes.

Defaults to:

10

getLabelOffset : Number

Returns the value of labelOffset

Returns

Number

setLabelOffset (labelOffset)

Sets the value of labelOffset

Parameters

labelOffset :  Number

layout : Object / Ext.chart.axis.layout.Layout

The layout configuration used by the axis.

Defaults to:

null

setLayout (layout)

Sets the value of layout

Parameters

layout :  Object / Ext.chart.axis.layout.Layout

layoutContext : Object
private pri

Stores the context after calculating layout.

Defaults to:

null

getLayoutContext : Object

Returns the value of layoutContext

Returns

Object

setLayoutContext (layoutContext)

Sets the value of layoutContext

Parameters

layoutContext :  Object

length : Number

The total length of the axis.

lineCap : String

The style of the line caps.

Defaults to:

"butt"

lineDash : Array

An even number of non-negative numbers specifying a dash/space sequence. Note that while this is supported in IE8 (VML engine), the behavior is different from Canvas and SVG. Please refer to this document for details: http://msdn.microsoft.com/en-us/library/bb264085(v=vs.85).aspx Although IE9 and IE10 have Canvas support, the 'lineDash' attribute is not supported in those browsers.

Defaults to:

[]

lineDashOffset : Number

A number specifying how far into the line dash sequence drawing commences.

Defaults to:

0

lineJoin : String

The style of the line join.

Defaults to:

"miter"

lineWidth : Number

The width of the line stroke.

Defaults to:

1

majorTicks : Boolean

'true' if the axis has major ticks.

majorTickSize : Number

The length of the major ticks.

max : Number

The maximum value of the axis. min and max attributes represent the effective range of the axis after segmentation, layout, and range reconciliation between axes.

min : Number

The minimum value of the axis. min and max attributes represent the effective range of the axis after segmentation, layout, and range reconciliation between axes.

minorTicks : Boolean

'true' if the axis has sub ticks.

minorTickSize : Number

The length of the minor ticks.

minStepSize : Number

The minimum step size between ticks.

miterLimit : Number

Sets the distance between the inner corner and the outer corner where two lines meet.

Defaults to:

10

position : String

The position of the axis on the chart.

renderer : Function

Allows direct customisation of rendered axis sprites.

Defaults to:

null

getRenderer : Function

Returns the value of renderer

Returns

Function

setRenderer (renderer)

Sets the value of renderer

Parameters

renderer :  Function

rotation : Number / Object

Applies an initial angle of rotation to the sprite. May be a number specifying the rotation in degrees. Or may be a config object using the below config options.

Note: Rotation config options will be overridden by values set on the rotationRads, rotationCenterX, and rotationCenterY configs.

Ext.create({
    xtype: 'draw',
    renderTo: Ext.getBody(),
    width: 600,
    height: 400,
    sprites: [{
        type: 'rect',
        x: 50,
        y: 50,
        width: 100,
        height: 100,
        fillStyle: '#1F6D91',
        //rotation: 45
        rotation: {
            degrees: 45,
            //rads: Math.PI / 4,
            //centerX: 50,
            //centerY: 50
        }
    }]
});

Note: Transform configs are always performed in the following order:

  1. Scaling
  2. Rotation
  3. Translation

Properties

rads : Number

The angle in radians to rotate the sprite

degrees : Number

The angle in degrees to rotate the sprite (is ignored if rads or rotationRads is set

centerX : Number

The central coordinate of the sprite's rotation on the x-axis. Unless explicitly set, will default to the calculated center of the sprite along the x-axis.

centerY : Number

The central coordinate of the sprite's rotation on the y-axis. Unless explicitly set, will default to the calculated center of the sprite along the y-axis.

rotationCenterX : Number

The central coordinate of the sprite's scale operation on the x-axis. Unless explicitly set, will default to the calculated center of the sprite along the x-axis.

Note: Transform configs are always performed in the following order:

  1. Scaling
  2. Rotation
  3. Translation

See also: rotation, rotationRads, and rotationCenterY

Defaults to:

null

rotationCenterY : Number

The central coordinate of the sprite's rotate operation on the y-axis. Unless explicitly set, will default to the calculated center of the sprite along the y-axis.

Note: Transform configs are always performed in the following order:

  1. Scaling
  2. Rotation
  3. Translation

See also: rotation, rotationRads, and rotationCenterX

Defaults to:

null

rotationRads : Number

The angle of rotation of the sprite in radians.

Note: Transform configs are always performed in the following order:

  1. Scaling
  2. Rotation
  3. Translation

See also: rotation, rotationCenterX, and rotationCenterY

Defaults to:

0

scaling : Number / Object

Applies initial scaling to the sprite. May be a number specifying the amount to scale both the x and y-axis. The number value represents a percentage by which to scale the sprite. 1 is equal to 100%, 2 would be 200%, etc. Or may be a config object using the below config options.

Note: Scaling config options will be overridden by values set on the scalingX, scalingY, scalingCenterX, and scalingCenterY configs.

Ext.create({
    xtype: 'draw',
    renderTo: Ext.getBody(),
    width: 600,
    height: 400,
    sprites: [{
        type: 'rect',
        x: 50,
        y: 50,
        width: 100,
        height: 100,
        fillStyle: '#1F6D91',
        //scaling: 2,
        scaling: {
            x: 2,
            y: 2
            //centerX: 100,
            //centerY: 100
        }
    }]
});

Note: Transform configs are always performed in the following order:

  1. Scaling
  2. Rotation
  3. Translation

Properties

x : Number

The amount by which to scale the sprite along the x-axis. The number value represents a percentage by which to scale the sprite. 1 is equal to 100%, 2 would be 200%, etc.

y : Number

The amount by which to scale the sprite along the y-axis. The number value represents a percentage by which to scale the sprite. 1 is equal to 100%, 2 would be 200%, etc.

centerX :

The central coordinate of the sprite's scaling on the x-axis. Unless explicitly set, will default to the calculated center of the sprite along the x-axis.

centerY : Number

The central coordinate of the sprite's scaling on the y-axis. Unless explicitly set, will default to the calculated center of the sprite along the y-axis.

scalingCenterX : Number

The central coordinate of the sprite's scale operation on the x-axis.

Note: Transform configs are always performed in the following order:

  1. Scaling
  2. Rotation
  3. Translation

See also: scaling, scalingX, scalingY, and scalingCenterY

Defaults to:

null

scalingCenterY : Number

The central coordinate of the sprite's scale operation on the y-axis.

Note: Transform configs are always performed in the following order:

  1. Scaling
  2. Rotation
  3. Translation

See also: scaling, scalingX, scalingY, and scalingCenterX

Defaults to:

null

scalingX : Number

The scaling of the sprite on the x-axis. The number value represents a percentage by which to scale the sprite. 1 is equal to 100%, 2 would be 200%, etc.

Note: Transform configs are always performed in the following order:

  1. Scaling
  2. Rotation
  3. Translation

See also: scaling, scalingY, scalingCenterX, and scalingCenterY

Defaults to:

1

scalingY : Number

The scaling of the sprite on the y-axis. The number value represents a percentage by which to scale the sprite. 1 is equal to 100%, 2 would be 200%, etc.

Note: Transform configs are always performed in the following order:

  1. Scaling
  2. Rotation
  3. Translation

See also: scaling, scalingX, scalingCenterX, and scalingCenterY

Defaults to:

1

segmenter : Object / Ext.chart.axis.segmenter.Segmenter

The method of segmenter used by the axis.

Defaults to:

null

setSegmenter (segmenter)

Sets the value of segmenter

Parameters

segmenter :  Object / Ext.chart.axis.segmenter.Segmenter

shadowBlur : Number

The amount blur used on the shadow.

Defaults to:

0

shadowColor : String

The color of the shadow (a CSS color value).

Defaults to:

"none"

shadowOffsetX : Number

The offset of the sprite's shadow on the x-axis.

Defaults to:

0

shadowOffsetY : Number

The offset of the sprite's shadow on the y-axis.

Defaults to:

0

strokeOpacity : Number

The opacity of the stroke. Limited from 0 to 1.

Defaults to:

1

strokeStyle : String

The color of the stroke (a CSS color value).

Defaults to:

"none"

textPadding : Number

The padding around axis labels to determine collision. The default is 0 for all axes except horizontal axes of cartesian charts, where the default is 5 to prevent axis labels from blending one into another. This default is defined in the axis config of the Ext.chart.theme.Base theme. You may want to change this default to a smaller number or 0, if you have horizontal axis labels rotated, which allows for more text to fit in.

Defaults to:

0

transformFillStroke : Boolean

Determines whether the fill and stroke are affected by sprite transformations.

Defaults to:

false

translation : Object

Applies an initial translation, adjustment in x/y positioning, to the sprite.

Note: Translation config options will be overridden by values set on the translationX and translationY configs.

Ext.create({
    xtype: 'draw',
    renderTo: Ext.getBody(),
    width: 600,
    height: 400,
        sprites: [{
        type: 'rect',
        x: 50,
        y: 50,
        width: 100,
        height: 100,
        fillStyle: '#1F6D91',
        translation: {
            x: 50,
            y: 50
        }
    }]
});

Note: Transform configs are always performed in the following order:

  1. Scaling
  2. Rotation
  3. Translation

Properties

x : Number

The amount to translate the sprite along the x-axis.

y : Number

The amount to translate the sprite along the y-axis.

translationX : Number

The translation, position offset, of the sprite on the x-axis.

Note: Transform configs are always performed in the following order:

  1. Scaling
  2. Rotation
  3. Translation

See also: translation and translationY

Defaults to:

0

translationY : Number

The translation, position offset, of the sprite on the y-axis.

Note: Transform configs are always performed in the following order:

  1. Scaling
  2. Rotation
  3. Translation

See also: translation and translationX

Defaults to:

0

visibleMax : Number

The maximum value that is displayed.

visibleMin : Number

The minimum value that is displayed.

zIndex : Number

The stacking order of the sprite.

Defaults to:

0

properties

Instance Properties

attr : Object

The visual attributes of the sprite, e.g. strokeStyle, fillStyle, lineWidth...

methods

Static Methods

override ( members ) : Ext.Base
static sta

Override members of this class. Overridden methods can be invoked via Ext.Base#callParent.

Ext.define('My.Cat', {
    constructor: function() {
        alert("I'm a cat!");
    }
});

My.Cat.override({
    constructor: function() {
        alert("I'm going to be a cat!");

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                          // alerts "I'm a cat!"
                          // alerts "Meeeeoooowwww"

Direct use of this method should be rare. Use Ext.define instead:

Ext.define('My.CatOverride', {
    override: 'My.Cat',
    constructor: function() {
        alert("I'm going to be a cat!");

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).

Parameters

members :  Object

The properties to add to this class. This should be specified as an object literal containing one or more properties.

Returns

:Ext.Base

this class

ExtReact 6.5.3