| Package | com.yworks.io |
| Class | public class ExportOptions |
| Inheritance | ExportOptions  Object |
See also
| Property | Defined By | ||
|---|---|---|---|
| backgroundColor : uint
The custom background color to be used for the export. | ExportOptions | ||
| defaultOptions : ExportOptions [static] [read-only]
Returns an immutable default ExportOptions instance. | ExportOptions | ||
| hasBackground : Boolean
Whether a custom background should be drawn
| ExportOptions | ||
| insets : IRectangle
A rectangle that describes the insets. | ExportOptions | ||
| maxHeight : uint
The maximum height of the exported document. | ExportOptions | ||
| maxWidth : uint
The maximum width of the exported document. | ExportOptions | ||
| scaleMode : uint
Determines how to scale the contents of the exported document. | ExportOptions | ||
| Method | Defined By | ||
|---|---|---|---|
ExportOptions(scaleMode:uint, insets:IRectangle = null, hasBackground:Boolean = false, backgroundColor:uint = 0xFFFFFF)
Creates an custom export options instance. | ExportOptions | ||
| Constant | Defined By | ||
|---|---|---|---|
| SCALE_MODE_FIT : uint = 4 [static]
Fit the exported content to the bounds determined by the
maxWidth and maxHeight properties. | ExportOptions | ||
| SCALE_MODE_NONE : uint = 1 [static]
Do not use a custom scaling for the exported document. | ExportOptions | ||
| SCALE_MODE_VIEWPORT : uint = 2 [static]
Use the visible area and zoom factor determined by the current
view port. | ExportOptions | ||
| backgroundColor | property |
backgroundColor:uintThe custom background color to be used for the export.
public function get backgroundColor():uint public function set backgroundColor(value:uint):voidSee also
| defaultOptions | property |
defaultOptions:ExportOptions [read-only]
Returns an immutable default ExportOptions instance.
public static function get defaultOptions():ExportOptions| hasBackground | property |
hasBackground:BooleanWhether a custom background should be drawn
public function get hasBackground():Boolean public function set hasBackground(value:Boolean):voidSee also
| insets | property |
insets:IRectangle
A rectangle that describes the insets. x is the left inset, y is the top inset,
width is the right inset, and height is the bottom inset.
public function get insets():IRectangle public function set insets(value:IRectangle):void| maxHeight | property |
maxHeight:uintThe maximum height of the exported document.
The exact interpretation of this property depends
on the value of the scaleMode property.
public function get maxHeight():uint public function set maxHeight(value:uint):voidSee also
| maxWidth | property |
maxWidth:uintThe maximum width of the exported document.
The exact interpretation of this property depends
on the value of the scaleMode property.
public function get maxWidth():uint public function set maxWidth(value:uint):voidSee also
| scaleMode | property |
scaleMode:uintDetermines how to scale the contents of the exported document.
One of
public function get scaleMode():uint public function set scaleMode(value:uint):void| ExportOptions | () | Constructor |
public function ExportOptions(scaleMode:uint, insets:IRectangle = null, hasBackground:Boolean = false, backgroundColor:uint = 0xFFFFFF)Creates an custom export options instance.
ParametersscaleMode:uint (default = NaN)One of
| |
insets:IRectangle (default = null)x is the left inset, y is the top inset,
width is the right inset, and height is the bottom inset.
| |
hasBackground:Boolean (default = false) | |
backgroundColor:uint (default = 0xFFFFFF) |
| SCALE_MODE_FIT | Constant |
public static const SCALE_MODE_FIT:uint = 4
Fit the exported content to the bounds determined by the
maxWidth and maxHeight properties.
If only one of both properties is set to a value > 0,
the other dimension will be chosen as apropriate.
| SCALE_MODE_NONE | Constant |
public static const SCALE_MODE_NONE:uint = 1Do not use a custom scaling for the exported document. The natural size of the exported content will be used.
| SCALE_MODE_VIEWPORT | Constant |
public static const SCALE_MODE_VIEWPORT:uint = 2Use the visible area and zoom factor determined by the current view port.