VEGAS JS

Class: EdgeMetrics

graphics.geom. EdgeMetrics

new EdgeMetrics( [left] [, top] [, right] [, bottom])

The EdgeMetrics class specifies the thickness, in pixels, of the four edge regions around a visual component.

The EdgeMetrics class specifies the thickness, in pixels, of the four edge regions around a visual component.

Parameters:
Name Type Argument Default Description
left number <optional>
 0

The width, in pixels, of the left edge region.
top number <optional>
 0

The height, in pixels, of the top edge region.
right number <optional>
 0

The width, in pixels, of the right edge region.
bottom number <optional>
 0

The height, in pixels, of the bottom edge region.

Members

bottom :Number

The height, in pixels, of the bottom edge region.

Type:
  • Number
Default Value:
  • 0

<readonly> horizontal

The horizontal, in pixels, of the sum of left and right region.

left :Number

The width, in pixels, of the left edge region.

Type:
  • Number
Default Value:
  • 0

The width, in pixels, of the right edge region.

Type:
  • Number
Default Value:
  • 0

top :Number

The height, in pixels, of the top edge region.

Type:
  • Number
Default Value:
  • 0

<readonly> vertical

The vertical, in pixels, of the sum of top and vertical region.

Methods

clone()

Returns a shallow copy of the object.

Returns:

a shallow copy of the object.

copyFrom(source)

Copies all of vector data from the source EdgeMetrics object into the calling EdgeMetrics object.

Parameters:
Name Type Description
source graphics.geom.EdgeMetrics

The EdgeMetrics object from which to copy the data.
Returns:

The current graphics.geom.EdgeMetrics reference.

equals(o)

Compares the passed-in object with this object for equality.

Parameters:
Name Type Description
o graphics.geom.EdgeMetrics

The object to evaluate.
Returns:

true if the the specified object is equal with this object.

setTo( [left] [, top] [, right] [, bottom])

Sets the members of EdgeMetrics to the specified values.

Parameters:
Name Type Argument Default Description
left number <optional>
 0

The width, in pixels, of the left edge region.
top number <optional>
 0

The height, in pixels, of the top edge region.
right number <optional>
 0

The width, in pixels, of the right edge region.
bottom number <optional>
 0

The height, in pixels, of the bottom edge region.
Returns:

The current object reference.

Type
Rectangle

toObject()

Returns the Object representation of this object.

Returns:

the Object representation of this object.

toString()

Returns the string representation of this instance.

Returns:

the string representation of this instance.

Type
string