Ext.data.JsonP.Ext_draw_engine_ImageExporter({"mixins":[],"code_type":"ext_define","inheritable":false,"component":false,"meta":{},"mixedInto":[],"uses":[],"aliases":{},"parentMixins":[],"superclasses":["Ext.Base"],"members":{"event":[],"property":[{"meta":{"private":true},"owner":"Ext.Base","tagname":"property","name":"$className","id":"property-S-className"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"property","name":"configMap","id":"property-configMap"},{"meta":{},"owner":"Ext.draw.engine.ImageExporter","tagname":"property","name":"defaultUrl","id":"property-defaultUrl"},{"meta":{},"owner":"Ext.draw.engine.ImageExporter","tagname":"property","name":"heightParam","id":"property-heightParam"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"property","name":"initConfigList","id":"property-initConfigList"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"property","name":"initConfigMap","id":"property-initConfigMap"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"property","name":"isInstance","id":"property-isInstance"},{"meta":{"protected":true},"owner":"Ext.Base","tagname":"property","name":"self","id":"property-self"},{"meta":{},"owner":"Ext.draw.engine.ImageExporter","tagname":"property","name":"supportedTypes","id":"property-supportedTypes"},{"meta":{},"owner":"Ext.draw.engine.ImageExporter","tagname":"property","name":"svgParam","id":"property-svgParam"},{"meta":{},"owner":"Ext.draw.engine.ImageExporter","tagname":"property","name":"typeParam","id":"property-typeParam"},{"meta":{},"owner":"Ext.draw.engine.ImageExporter","tagname":"property","name":"widthParam","id":"property-widthParam"}],"css_var":[],"method":[{"meta":{"deprecated":{"text":"as of 4.1. Use {@link #callParent} instead."},"protected":true},"owner":"Ext.Base","tagname":"method","name":"callOverridden","id":"method-callOverridden"},{"meta":{"protected":true},"owner":"Ext.Base","tagname":"method","name":"callParent","id":"method-callParent"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"method","name":"configClass","id":"method-configClass"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"method","name":"destroy","id":"method-destroy"},{"meta":{},"owner":"Ext.draw.engine.ImageExporter","tagname":"method","name":"generate","id":"method-generate"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"method","name":"getConfig","id":"method-getConfig"},{"meta":{},"owner":"Ext.Base","tagname":"method","name":"getInitialConfig","id":"method-getInitialConfig"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"method","name":"hasConfig","id":"method-hasConfig"},{"meta":{"protected":true},"owner":"Ext.Base","tagname":"method","name":"initConfig","id":"method-initConfig"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"method","name":"onConfigUpdate","id":"method-onConfigUpdate"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"method","name":"setConfig","id":"method-setConfig"},{"meta":{"protected":true},"owner":"Ext.Base","tagname":"method","name":"statics","id":"method-statics"}],"css_mixin":[],"cfg":[]},"tagname":"class","extends":"Ext.Base","html":"

Hierarchy

Ext.Base
Ext.draw.engine.ImageExporter

Files

Exports a Surface to an image. To do this,\nthe svg string must be sent to a remote server and processed.

\n\n

Sending the data

\n\n

A post request is made to the URL. The following fields are sent:

\n\n\n\n\n

The response

\n\n

It is expected that the user will be prompted with an image download.\nAs such, the following options should be set on the server:

\n\n\n\n\n

Important: By default, chart data is sent to a server operated\nby Sencha to do data processing. You may change this default by\nsetting the defaultUrl of this class.

\n
Defined By

Properties

...
\n

Defaults to: "Ext.Base"

...
\n

Defaults to: {}

Ext.draw.engine.ImageExporter
view source
: String
The default URL to submit the form request. ...

The default URL to submit the form request.

\n

Defaults to: "http://svg.sencha.io"

Ext.draw.engine.ImageExporter
view source
: String
The name of the height parameter to be sent to the server. ...

The name of the height parameter to be sent to the server.\nThe Sencha IO server expects it to be the default value.

\n

Defaults to: "height"

...
\n

Defaults to: []

...
\n

Defaults to: {}

...
\n

Defaults to: true

Get the reference to the current class from which this object was instantiated. ...

Get the reference to the current class from which this object was instantiated. Unlike statics,\nthis.self is scope-dependent and it's meant to be used for dynamic inheritance. See statics\nfor a detailed comparison

\n\n
Ext.define('My.Cat', {\n    statics: {\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        alert(this.self.speciesName); // dependent on 'this'\n    },\n\n    clone: function() {\n        return new this.self();\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n    statics: {\n        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'\n    }\n});\n\nvar cat = new My.Cat();                     // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'\n
\n
Ext.draw.engine.ImageExporter
view source
: Array
A list of export types supported by the server ...

A list of export types supported by the server

\n

Defaults to: ["image/png", "image/jpeg"]

Ext.draw.engine.ImageExporter
view source
: String
The name of the svg parameter to be sent to the server. ...

The name of the svg parameter to be sent to the server.\nThe Sencha IO server expects it to be the default value.

\n

Defaults to: "svg"

Ext.draw.engine.ImageExporter
view source
: String
The name of the type parameter to be sent to the server. ...

The name of the type parameter to be sent to the server.\nThe Sencha IO server expects it to be the default value.

\n

Defaults to: "type"

Ext.draw.engine.ImageExporter
view source
: String
The name of the width parameter to be sent to the server. ...

The name of the width parameter to be sent to the server.\nThe Sencha IO server expects it to be the default value.

\n

Defaults to: "width"

Defined By

Methods

( Array/Arguments args ) : Objectdeprecatedprotected
Call the original method that was previously overridden with override\n\nExt.define('My.Cat', {\n constructor: functi...

Call the original method that was previously overridden with override

\n\n
Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n
\n
\n

This method has been deprecated

\n

as of 4.1. Use callParent instead.

\n\n
\n

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object\nfrom the current method, for example: this.callOverridden(arguments)

    \n

Returns

  • Object

    Returns the result of calling the overridden method

    \n
( Array/Arguments args ) : Objectprotected
Call the \"parent\" method of the current method. ...

Call the \"parent\" method of the current method. That is the method previously\noverridden by derivation or by an override (see Ext.define).

\n\n
 Ext.define('My.Base', {\n     constructor: function (x) {\n         this.x = x;\n     },\n\n     statics: {\n         method: function (x) {\n             return x;\n         }\n     }\n });\n\n Ext.define('My.Derived', {\n     extend: 'My.Base',\n\n     constructor: function () {\n         this.callParent([21]);\n     }\n });\n\n var obj = new My.Derived();\n\n alert(obj.x);  // alerts 21\n
\n\n

This can be used with an override as follows:

\n\n
 Ext.define('My.DerivedOverride', {\n     override: 'My.Derived',\n\n     constructor: function (x) {\n         this.callParent([x*2]); // calls original My.Derived constructor\n     }\n });\n\n var obj = new My.Derived();\n\n alert(obj.x);  // now alerts 42\n
\n\n

This also works with static methods.

\n\n
 Ext.define('My.Derived2', {\n     extend: 'My.Base',\n\n     statics: {\n         method: function (x) {\n             return this.callParent([x*2]); // calls My.Base.method\n         }\n     }\n });\n\n alert(My.Base.method(10);     // alerts 10\n alert(My.Derived2.method(10); // alerts 20\n
\n\n

Lastly, it also works with overridden static methods.

\n\n
 Ext.define('My.Derived2Override', {\n     override: 'My.Derived2',\n\n     statics: {\n         method: function (x) {\n             return this.callParent([x*2]); // calls My.Derived2.method\n         }\n     }\n });\n\n alert(My.Derived2.method(10); // now alerts 40\n
\n

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object\nfrom the current method, for example: this.callParent(arguments)

    \n

Returns

  • Object

    Returns the result of calling the parent method

    \n
Ext.draw.engine.ImageExporter
view source
( Ext.draw.Surface surface, [Object config] ) : Boolean
Exports the surface to an image ...

Exports the surface to an image

\n

Parameters

  • surface : Ext.draw.Surface

    The surface to export

    \n
  • config : Object (optional)

    The following config options are supported:

    \n
    • width : Number

      A width to send to the server to for\nconfiguring the image height

      \n
    • height : Number

      A height to send to the server for\nconfiguring the image height

      \n
    • url : String

      The url to post the data to. Defaults to\nthe defaultUrl configuration on the class.

      \n
    • type : String

      The type of image to export. See the\nsupportedTypes

      \n
    • widthParam : String

      The name of the width parameter to send\nto the server. Defaults to widthParam

      \n
    • heightParam : String

      The name of the height parameter to send\nto the server. Defaults to heightParam

      \n
    • typeParam : String

      The name of the type parameter to send\nto the server. Defaults to typeParam

      \n
    • svgParam : String

      The name of the svg parameter to send\nto the server. Defaults to svgParam

      \n

Returns

  • Boolean

    True if the surface was successfully sent to the server.

    \n
...
\n

Parameters

Returns the initial configuration passed to constructor when instantiating\nthis class. ...

Returns the initial configuration passed to constructor when instantiating\nthis class.

\n

Parameters

  • name : String (optional)

    Name of the config option to return.

    \n

Returns

  • Object/Mixed

    The full config object or a single config value\nwhen name parameter specified.

    \n
...
\n

Parameters

Initialize configuration for this class. ...

Initialize configuration for this class. a typical example:

\n\n
Ext.define('My.awesome.Class', {\n    // The default config\n    config: {\n        name: 'Awesome',\n        isAwesome: true\n    },\n\n    constructor: function(config) {\n        this.initConfig(config);\n    }\n});\n\nvar awesome = new My.awesome.Class({\n    name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n
\n

Parameters

Returns

( Object names, Object callback, Object scope )private
...
\n

Parameters

( Object config, Object applyIfNotSet )private
...
\n

Parameters

Get the reference to the class from which this object was instantiated. ...

Get the reference to the class from which this object was instantiated. Note that unlike self,\nthis.statics() is scope-independent and it always returns the class from which it was called, regardless of what\nthis points to during run-time

\n\n
Ext.define('My.Cat', {\n    statics: {\n        totalCreated: 0,\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        var statics = this.statics();\n\n        alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to\n                                        // equivalent to: My.Cat.speciesName\n\n        alert(this.self.speciesName);   // dependent on 'this'\n\n        statics.totalCreated++;\n    },\n\n    clone: function() {\n        var cloned = new this.self;                      // dependent on 'this'\n\n        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName\n\n        return cloned;\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n\n    statics: {\n        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'\n    },\n\n    constructor: function() {\n        this.callParent();\n    }\n});\n\nvar cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'\nalert(clone.groupName);                 // alerts 'Cat'\n\nalert(My.Cat.totalCreated);             // alerts 3\n
\n

Returns

","subclasses":[],"name":"Ext.draw.engine.ImageExporter","alternateClassNames":[],"inheritdoc":null,"files":[{"href":"ImageExporter.html#Ext-draw-engine-ImageExporter","filename":"ImageExporter.js"}],"html_meta":{},"singleton":true,"id":"class-Ext.draw.engine.ImageExporter","statics":{"property":[],"event":[],"css_var":[],"method":[],"css_mixin":[],"cfg":[]},"requires":[]});