Interface IScatter

Hierarchy

Index

Properties

Methods

Properties

optional public alias?: Array<string>

[Config Option] (String[])

optional public alternateClassName?: any

[Config Option] (String/String[])

optional public animate?: any

[Config Option] (Object)

optional public background?: any

[Config Option] (Object)

optional public bubbleEvents?: any

[Config Option] (String/String[])

optional public colors?: Array<any>

[Config Option] (Array)

optional public config?: any

[Config Option] (Object)

optional public extend?: string

[Config Option] (String)

optional public hidden?: any

[Config Option] (Boolean|Array)

optional public highlightCfg?: any

[Config Option] (Object)

optional public highlightItem?: any

[Config Option] (Object)

optional public inheritableStatics?: any

[Config Option] (Object)

optional public itemInstancing?: any

[Config Option] (Object)

optional public label?: any

[Config Option] (Object)

optional public labelField?: string

[Config Option] (String)

optional public labelOverflowPadding?: number

[Config Option] (Number)

optional public listeners?: any

[Config Option] (Object)

optional public marker?: any

[Config Option] (Object)

optional public markerSubStyle?: any

[Config Option] (Object)

optional public mixins?: any

[Config Option] (Object)

optional public overlaySurface?: any

[Config Option] (Object)

optional public platformConfig?: any

[Config Option] (Object)

optional public renderer?: any

[Config Option] (Function)

optional public self?: IClass

[Property] (Ext.Class)

optional public seriesType?: string

[Property] (String)

optional public showInLegend?: boolean

[Config Option] (Boolean)

optional public singleton?: boolean

[Config Option] (Boolean)

optional public statics?: any

[Config Option] (Object)

optional public store?: any

[Config Option] (Object)

optional public style?: any

[Config Option] (Object)

optional public subStyle?: any

[Config Option] (Object)

optional public surface?: any

[Config Option] (Object)

optional public title?: string

[Config Option] (String)

optional public type?: string

[Property] (String)

optional public uses?: Array<string>

[Config Option] (String[])

optional public xAxis?: IAxis

[Config Option] (Ext.chart.axis.Axis)

optional public xField?: string

[Config Option] (String)

optional public yAxis?: IAxis

[Config Option] (Ext.chart.axis.Axis)

optional public yField?: string

[Config Option] (String)

Methods

optional public addAfterListener(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Appends an after event handler

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event to listen for.

  • fn?: any optional

    Function/String The method the event invokes.

  • scope?: any optional

    Object The scope for fn.

  • options?: any optional

    Object An object containing handler configuration.

optional public addBeforeListener(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Appends a before event handler

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event to listen for.

  • fn?: any optional

    Function/String The method the event invokes.

  • scope?: any optional

    Object The scope for fn.

  • options?: any optional

    Object An object containing handler configuration.

optional public addEvents(eventNames?: any)

[Method] Adds the specified events to the list of events which this Observable may fire

Parameters

  • eventNames?: any optional

    Object/String... Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters.

optional public addListener(eventName?: any, fn?: any, scope?: any, options?: any, order?: string)

[Method] Appends an event handler to this object

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names.

  • fn?: any optional

    Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below.

  • scope?: any optional

    Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

  • options?: any optional

    Object An object containing handler configuration. This object may contain any of the following properties:

  • order?: string optional

    String The order of when the listener should be added into the listener queue. Possible values are before, current and after.

optional public addManagedListener(object?: any, eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed

Parameters

  • object?: any optional

    Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners.

  • eventName?: any optional

    Object/String The event name, or an object containing event name properties.

  • fn?: any optional

    Function If the eventName parameter was an event name, this is the handler function.

  • scope?: any optional

    Object If the eventName parameter was an event name, this is the scope in which the handler function is executed.

  • options?: any optional

    Object If the eventName parameter was an event name, this is the addListener options.

optional public callOverridden(args?: any): any

[Method] Call the original method that was previously overridden with override This method is deprecated as callParent does

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments)

Returns

any

Object Returns the result of calling the overridden method

optional public callOverridden(args?: any): any

[Method] Call the original method that was previously overridden with override This method is deprecated as callParent does

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments)

Returns

any

Object Returns the result of calling the overridden method

optional public callOverridden(args?: any): any

[Method] Call the original method that was previously overridden with override This method is deprecated as callParent does

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments)

Returns

any

Object Returns the result of calling the overridden method

optional public callParent(args?: any): any

[Method] Call the parent method of the current method

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments)

Returns

any

Object Returns the result of calling the parent method

optional public callParent(args?: any): any

[Method] Call the parent method of the current method

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments)

Returns

any

Object Returns the result of calling the parent method

optional public callParent(args?: any): any

[Method] Call the parent method of the current method

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments)

Returns

any

Object Returns the result of calling the parent method

optional public callSuper(args?: any): any

[Method] This method is used by an override to call the superclass method but bypass any overridden method

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments)

Returns

any

Object Returns the result of calling the superclass method

optional public callSuper(args?: any): any

[Method] This method is used by an override to call the superclass method but bypass any overridden method

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments)

Returns

any

Object Returns the result of calling the superclass method

optional public callSuper(args?: any): any

[Method] This method is used by an override to call the superclass method but bypass any overridden method

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments)

Returns

any

Object Returns the result of calling the superclass method

optional public clearListeners()

[Method] Removes all listeners for this object

optional public destroy()

[Method]

optional public enableBubble(events?: any)

[Method] Enables events fired by this Observable to bubble up an owner hierarchy by calling this getBubbleTarget if present

Parameters

  • events?: any optional

    String/String[] The event name to bubble, or an Array of event names.

optional public fireAction(eventName?: string, args?: Array<any>, fn?: any, scope?: any): any

[Method] Fires the specified event with the passed parameters and execute a function action at the end if there are no liste

Parameters

  • eventName?: string optional

    String The name of the event to fire.

  • args?: Array<any> optional

    Array Arguments to pass to handers.

  • fn?: any optional

    Function Action.

  • scope?: any optional

    Object Scope of fn.

Returns

any

Object

optional public fireEvent(eventName: string, args?: Array<any>): boolean

[Method] Fires the specified event with the passed parameters minus the event name plus the options object passed to addList

Parameters

  • eventName: string

    String The name of the event to fire.

  • args?: Array<any> optional

    Object... Variable number of parameters are passed to handlers.

Returns

boolean

Boolean Returns false if any of the handlers return false.

optional public getAnimate(): any

[Method] Returns the value of animate

Returns

any

Object

optional public getBackground(): any

[Method] Returns the value of background

Returns

any

Object

optional public getBubbleEvents(): any

[Method] Returns the value of bubbleEvents

Returns

any

String/String[]

optional public getColors(): Array<any>

[Method] Returns the value of colors

Returns

Array<any>

Array

optional public getHidden(): any

[Method] Returns the value of hidden

Returns

any

Boolean|Array

optional public getHighlightCfg(): any

[Method] Returns the value of highlightCfg

Returns

any

Object

optional public getHighlightItem(): any

[Method] Returns the value of highlightItem

Returns

any

Object

optional public getId(): any

[Method] Retrieves the id of this component

Returns

any

any id

optional public getInitialConfig(name?: string): any

[Method] Returns the initial configuration passed to constructor

Parameters

  • name?: string optional

    String When supplied, value for particular configuration option is returned, otherwise the full config object is returned.

Returns

any

Object/Mixed

optional public getInitialConfig(name?: string): any

[Method] Returns the initial configuration passed to constructor

Parameters

  • name?: string optional

    String When supplied, value for particular configuration option is returned, otherwise the full config object is returned.

Returns

any

Object/Mixed

optional public getInitialConfig(name?: string): any

[Method] Returns the initial configuration passed to constructor

Parameters

  • name?: string optional

    String When supplied, value for particular configuration option is returned, otherwise the full config object is returned.

Returns

any

Object/Mixed

optional public getItemForPoint(x?: any, y?: any): any

[Method] For a given x y point relative to the main region find a corresponding item from this series if any

Parameters

  • x?: any optional

    Object

  • y?: any optional

    Object

Returns

any

Object An object describing the item, or null if there is no matching item. The exact contents of this object will vary by series type, but should always contain at least the following:

optional public getItemInstancing(): any

[Method] Returns the value of itemInstancing

Returns

any

Object

optional public getLabel(): any

[Method] Returns the value of label

Returns

any

Object

optional public getLabelField(): string

[Method] Returns the value of labelField

Returns

string

String

optional public getLabelOverflowPadding(): number

[Method] Returns the value of labelOverflowPadding

Returns

number

Number

optional public getListeners(): any

[Method] Returns the value of listeners

Returns

any

Object

optional public getMarker(): any

[Method] Returns the value of marker

Returns

any

Object

optional public getMarkerSubStyle(): any

[Method] Returns the value of markerSubStyle

Returns

any

Object

optional public getOverlaySurface(): any

[Method] Returns the value of overlaySurface

Returns

any

Object

optional public getRenderer(): any

[Method] Returns the value of renderer

Returns

any

Function

optional public getShowInLegend(): boolean

[Method] Returns the value of showInLegend

Returns

boolean

Boolean

optional public getSprites()

[Method] Performs drawing of this series

optional public getStyle(): any

[Method] Returns the value of style

Returns

any

Object

optional public getSubStyle(): any

[Method] Returns the value of subStyle

Returns

any

Object

optional public getSurface(): any

[Method] Returns the value of surface

Returns

any

Object

optional public getTitle(): string

[Method] Returns the value of title

Returns

string

String

optional public getXAxis(): IAxis

[Method] Returns the value of xAxis

Returns

IAxis

Ext.chart.axis.Axis

optional public getXField(): string

[Method] Returns the value of xField

Returns

string

String

optional public getYAxis(): IAxis

[Method] Returns the value of yAxis

Returns

IAxis

Ext.chart.axis.Axis

optional public getYField(): string

[Method] Returns the value of yField

Returns

string

String

optional public hasListener(eventName?: string): boolean

[Method] Checks to see if this object has any listeners for a specified event

Parameters

  • eventName?: string optional

    String The name of the event to check for

Returns

boolean

Boolean True if the event is being listened for, else false

optional public initConfig(instanceConfig?: any): any

[Method] Initialize configuration for this class

Parameters

  • instanceConfig?: any optional

    Object

Returns

any

Object mixins The mixin prototypes as key - value pairs

optional public initConfig(instanceConfig?: any): any

[Method] Initialize configuration for this class

Parameters

  • instanceConfig?: any optional

    Object

Returns

any

Object mixins The mixin prototypes as key - value pairs

optional public initConfig(instanceConfig?: any): any

[Method] Initialize configuration for this class

Parameters

  • instanceConfig?: any optional

    Object

Returns

any

Object mixins The mixin prototypes as key - value pairs

optional public mon(object?: any, eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Alias for addManagedListener

Parameters

  • object?: any optional

    Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners.

  • eventName?: any optional

    Object/String The event name, or an object containing event name properties.

  • fn?: any optional

    Function If the eventName parameter was an event name, this is the handler function.

  • scope?: any optional

    Object If the eventName parameter was an event name, this is the scope in which the handler function is executed.

  • options?: any optional

    Object If the eventName parameter was an event name, this is the addListener options.

optional public mun(object?: any, eventName?: any, fn?: any, scope?: any)

[Method] Alias for removeManagedListener

Parameters

  • object?: any optional

    Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners.

  • eventName?: any optional

    Object/String The event name, or an object containing event name properties.

  • fn?: any optional

    Function If the eventName parameter was an event name, this is the handler function.

  • scope?: any optional

    Object If the eventName parameter was an event name, this is the scope in which the handler function is executed.

optional public on(eventName?: any, fn?: any, scope?: any, options?: any, order?: string)

[Method] Alias for addListener

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event to listen for. May also be an object who's property names are event names.

  • fn?: any optional

    Function/String The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below.

  • scope?: any optional

    Object The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

  • options?: any optional

    Object An object containing handler configuration. This object may contain any of the following properties:

  • order?: string optional

    String The order of when the listener should be added into the listener queue. Possible values are before, current and after.

optional public onAfter(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Alias for addAfterListener

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event to listen for.

  • fn?: any optional

    Function/String The method the event invokes.

  • scope?: any optional

    Object The scope for fn.

  • options?: any optional

    Object An object containing handler configuration.

optional public onBefore(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Alias for addBeforeListener

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event to listen for.

  • fn?: any optional

    Function/String The method the event invokes.

  • scope?: any optional

    Object The scope for fn.

  • options?: any optional

    Object An object containing handler configuration.

optional public provideLegendInfo(target?: any)

[Method] Provide legend information to target array

Parameters

  • target?: any optional

    Object

optional public relayEvents(object?: any, events?: any): IObservable

[Method] Relays selected events from the specified Observable as if the events were fired by this

Parameters

  • object?: any optional

    Object The Observable whose events this object is to relay.

  • events?: any optional

    String/Array/Object Array of event names to relay.

Returns

IObservable

Ext.mixin.Observable this

optional public removeAfterListener(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Removes a before event handler

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event the handler was associated with.

  • fn?: any optional

    Function/String The handler to remove.

  • scope?: any optional

    Object The scope originally specified for fn.

  • options?: any optional

    Object Extra options object.

optional public removeBeforeListener(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Removes a before event handler

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event the handler was associated with.

  • fn?: any optional

    Function/String The handler to remove.

  • scope?: any optional

    Object The scope originally specified for fn.

  • options?: any optional

    Object Extra options object.

optional public removeListener(eventName?: any, fn?: any, scope?: any, options?: any, order?: string)

[Method] Removes an event handler

Parameters

  • eventName?: any optional

    String/String[]/Object The type of event the handler was associated with.

  • fn?: any optional

    Function/String The handler to remove. This must be a reference to the function passed into the addListener call.

  • scope?: any optional

    Object The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.

  • options?: any optional

    Object Extra options object. See addListener for details.

  • order?: string optional

    String The order of the listener to remove. Possible values are before, current and after.

optional public removeManagedListener(object?: any, eventName?: any, fn?: any, scope?: any)

[Method] Adds listeners to any Observable object or Element which are automatically removed when this Component is destroyed

Parameters

  • object?: any optional

    Ext.mixin.Observable/HTMLElement The item to which to add a listener/listeners.

  • eventName?: any optional

    Object/String The event name, or an object containing event name properties.

  • fn?: any optional

    Function If the eventName parameter was an event name, this is the handler function.

  • scope?: any optional

    Object If the eventName parameter was an event name, this is the scope in which the handler function is executed.

optional public resumeEvents(discardQueuedEvents?: boolean)

[Method] Resumes firing events see suspendEvents

Parameters

  • discardQueuedEvents?: boolean optional

    Boolean Pass as true to discard any queued events.

optional public setAnimate(animate?: any)

[Method] Sets the value of animate

Parameters

  • animate?: any optional

    Object

optional public setBackground(background?: any)

[Method] Sets the value of background

Parameters

  • background?: any optional

    Object

optional public setBubbleEvents(bubbleEvents?: any)

[Method] Sets the value of bubbleEvents

Parameters

  • bubbleEvents?: any optional

    String/String[]

optional public setColors(colors?: Array<any>)

[Method] Sets the value of colors

Parameters

  • colors?: Array<any> optional

    Array

optional public setHidden(hidden?: any)

[Method] Sets the value of hidden

Parameters

  • hidden?: any optional

    Boolean|Array

optional public setHiddenByIndex(index?: number, value?: boolean)

[Method]

Parameters

  • index?: number optional

    Number

  • value?: boolean optional

    Boolean

optional public setHighlightCfg(highlightCfg?: any)

[Method] Sets the value of highlightCfg

Parameters

  • highlightCfg?: any optional

    Object

optional public setHighlightItem(highlightItem?: any)

[Method] Sets the value of highlightItem

Parameters

  • highlightItem?: any optional

    Object

optional public setItemInstancing(itemInstancing?: any)

[Method] Sets the value of itemInstancing

Parameters

  • itemInstancing?: any optional

    Object

optional public setLabel(label?: any)

[Method] Sets the value of label

Parameters

  • label?: any optional

    Object

optional public setLabelField(labelField?: string)

[Method] Sets the value of labelField

Parameters

  • labelField?: string optional

    String

optional public setLabelOverflowPadding(labelOverflowPadding?: number)

[Method] Sets the value of labelOverflowPadding

Parameters

  • labelOverflowPadding?: number optional

    Number

optional public setListeners(listeners?: any)

[Method] Sets the value of listeners

Parameters

  • listeners?: any optional

    Object

optional public setMarker(marker?: any)

[Method] Sets the value of marker

Parameters

  • marker?: any optional

    Object

optional public setMarkerSubStyle(markerSubStyle?: any)

[Method] Sets the value of markerSubStyle

Parameters

  • markerSubStyle?: any optional

    Object

optional public setOverlaySurface(overlaySurface?: any)

[Method] Sets the value of overlaySurface

Parameters

  • overlaySurface?: any optional

    Object

optional public setRenderer(renderer?: any): any

[Method] Sets the value of renderer

Parameters

  • renderer?: any optional

    Function

Returns

any

Object The attributes that have been changed or added. Note: it is usually possible to add or modify the attributes directly into the config parameter and not return anything, but returning an object with only those attributes that have been changed may allow for optimizations in the rendering of some series. Example to draw every other item in red: renderer: function (sprite, config, rendererData, index) { if (index % 2 == 0) { return { strokeStyle: 'red' }; } }

optional public setShowInLegend(showInLegend?: boolean)

[Method] Sets the value of showInLegend

Parameters

  • showInLegend?: boolean optional

    Boolean

optional public setStore(store?: any)

[Method] Sets the value of store

Parameters

  • store?: any optional

    Object

optional public setStyle(style?: any)

[Method] Sets the value of style

Parameters

  • style?: any optional

    Object

optional public setSubStyle(subStyle?: any)

[Method] Sets the value of subStyle

Parameters

  • subStyle?: any optional

    Object

optional public setSurface(surface?: any)

[Method] Sets the value of surface

Parameters

  • surface?: any optional

    Object

optional public setTitle(title?: string)

[Method] Sets the value of title

Parameters

  • title?: string optional

    String

optional public setXAxis(xAxis?: IAxis)

[Method] Sets the value of xAxis

Parameters

  • xAxis?: IAxis optional

    Ext.chart.axis.Axis

optional public setXField(xField?: string)

[Method] Sets the value of xField

Parameters

  • xField?: string optional

    String

optional public setYAxis(yAxis?: IAxis)

[Method] Sets the value of yAxis

Parameters

  • yAxis?: IAxis optional

    Ext.chart.axis.Axis

optional public setYField(yField?: string)

[Method] Sets the value of yField

Parameters

  • yField?: string optional

    String

optional public suspendEvents()

[Method] Suspends the firing of all events

optional public un(eventName?: any, fn?: any, scope?: any, options?: any, order?: string)

[Method] Alias for removeListener

Parameters

  • eventName?: any optional

    String/String[]/Object The type of event the handler was associated with.

  • fn?: any optional

    Function/String The handler to remove. This must be a reference to the function passed into the addListener call.

  • scope?: any optional

    Object The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.

  • options?: any optional

    Object Extra options object. See addListener for details.

  • order?: string optional

    String The order of the listener to remove. Possible values are before, current and after.

optional public unAfter(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Alias for removeAfterListener

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event the handler was associated with.

  • fn?: any optional

    Function/String The handler to remove.

  • scope?: any optional

    Object The scope originally specified for fn.

  • options?: any optional

    Object Extra options object.

optional public unBefore(eventName?: any, fn?: any, scope?: any, options?: any)

[Method] Alias for removeBeforeListener

Parameters

  • eventName?: any optional

    String/String[]/Object The name of the event the handler was associated with.

  • fn?: any optional

    Function/String The handler to remove.

  • scope?: any optional

    Object The scope originally specified for fn.

  • options?: any optional

    Object Extra options object.