| Package | com.yworks.yfiles.layout.organic |
| Class | public class OutputRestriction |
| Inheritance | OutputRestriction  YObject Object |
setOutputRestriction(OutputRestriction) method, e.g.
com.yworks.yfiles.layout.organic.SmartOrganicLayouter.outputRestriction in SmartOrganicLayouter to restrict the output area and shape of the layout. Instances of this class can only be retrieved from the factory methods or from the static field.
See also
| Property | Defined By | ||
|---|---|---|---|
| NONE : OutputRestriction [static] [read-only] | OutputRestriction | ||
| Method | Defined By | ||
|---|---|---|---|
OutputRestriction(init:Boolean = true) | OutputRestriction | ||
createAspectRatioRestriction(ratio:Number):OutputRestriction [static]
This factory method creates a restriction object that can be used to restrict the result of a layout run of com.yworks.yfiles.layout.organic.SmartOrganicLayouter so that the bounding box roughly has the given aspect ratio. | OutputRestriction | ||
createCircularCageRestriction(x:Number, y:Number, radius:Number):OutputRestriction [static]
This factory method creates a restriction object that can be used to restrict the result of a layout run of com.yworks.yfiles.layout.organic.SmartOrganicLayouter so that the nodes lie within a circle. | OutputRestriction | ||
createEllipticalCageRestriction(x:Number, y:Number, w:Number, h:Number):OutputRestriction [static]
This factory method creates a restriction object that can be used to restrict the result of a layout run of com.yworks.yfiles.layout.organic.SmartOrganicLayouter so that the nodes lie within an ellipse whose main axes are parallel to the coordinate axes. | OutputRestriction | ||
createRectangularCageRestriction(x:Number, y:Number, w:Number, h:Number):OutputRestriction [static]
This factory method creates a restriction object that can be used to restrict the result of a layout run of com.yworks.yfiles.layout.organic.SmartOrganicLayouter so that the nodes lie within the given rectangle. | OutputRestriction | ||
 | equals(o:Object):Boolean | YObject | |
getClass():Class [override] | OutputRestriction | ||
| hashCode():int | YObject | |
| NONE | property |
Hide Inherited Public Methods
Show Inherited Public MethodsNONE:OutputRestriction [read-only] public static function get NONE():OutputRestriction| OutputRestriction | () | Constructor |
public function OutputRestriction(init:Boolean = true)init:Boolean (default = true) |
| createAspectRatioRestriction | () | method |
public static function createAspectRatioRestriction(ratio:Number):OutputRestrictionThis factory method creates a restriction object that can be used to restrict the result of a layout run of com.yworks.yfiles.layout.organic.SmartOrganicLayouter so that the bounding box roughly has the given aspect ratio.
Parameters
ratio:Number — the preferred aspect ratio (width/height) of the output
|
OutputRestriction — an instance for use in com.yworks.yfiles.layout.organic.SmartOrganicLayouter.outputRestriction
|
See also
| createCircularCageRestriction | () | method |
public static function createCircularCageRestriction(x:Number, y:Number, radius:Number):OutputRestrictionThis factory method creates a restriction object that can be used to restrict the result of a layout run of com.yworks.yfiles.layout.organic.SmartOrganicLayouter so that the nodes lie within a circle.
Parameters
x:Number — x coordinate of the center of the restriction circle
| |
y:Number — y coordinate of the center of the restriction circle
| |
radius:Number — the radius of the restriction circle
|
OutputRestriction — an instance for use in com.yworks.yfiles.layout.organic.SmartOrganicLayouter.outputRestriction
|
See also
| createEllipticalCageRestriction | () | method |
public static function createEllipticalCageRestriction(x:Number, y:Number, w:Number, h:Number):OutputRestrictionThis factory method creates a restriction object that can be used to restrict the result of a layout run of com.yworks.yfiles.layout.organic.SmartOrganicLayouter so that the nodes lie within an ellipse whose main axes are parallel to the coordinate axes.
Parameters
x:Number — x coordinate of the upper left corner
| |
y:Number — y coordinate of the upper left corner
| |
w:Number — width of the bounding box of the ellipse
| |
h:Number — the height of the bounding box of the ellipse
|
OutputRestriction — an instance for use in com.yworks.yfiles.layout.organic.SmartOrganicLayouter.outputRestriction
|
See also
| createRectangularCageRestriction | () | method |
public static function createRectangularCageRestriction(x:Number, y:Number, w:Number, h:Number):OutputRestrictionThis factory method creates a restriction object that can be used to restrict the result of a layout run of com.yworks.yfiles.layout.organic.SmartOrganicLayouter so that the nodes lie within the given rectangle.
Parameters
x:Number — x coordinate of the upper-left corner of the restriction rectangle
| |
y:Number — y coordinate of the upper-left corner of the restriction rectangle
| |
w:Number — width of the restriction rectangle
| |
h:Number — height of the restriction rectangle
|
OutputRestriction — an instance for use in com.yworks.yfiles.layout.organic.SmartOrganicLayouter.outputRestriction
|
See also
| getClass | () | method |
override public function getClass():ClassReturnsClass |