Sencha Documentation

Ext.util.Point

Overview

Super classes

Ext.util.Region
Represents a 2D point with x and y properties, useful for comparison and instantiation from an event: 
var point = Ext.util.Point.fromEvent(e);

Methods

 
adjust( Number top, Number right, Number bottom, Number left ) : Void
Modifies the current region to be adjusted by offsets.
Modifies the current region to be adjusted by offsets.

Parameters

  • top : Number
    top offset
  • right : Number
    right offset
  • bottom : Number
    bottom offset
  • left : Number
    left offset

Returns

  • Void
 
constrainTo( Ext.util.Region targetRegion ) : Void
Modifies the current region to be constrained to the targetRegion.
Modifies the current region to be constrained to the targetRegion.

Parameters

  • targetRegion : Ext.util.Region

Returns

  • Void
 
constructor( Number top, Number right, Number bottom, Number left ) : Void

Parameters

  • top : Number
    Top
  • right : Number
    Right
  • bottom : Number
    Bottom
  • left : Number
    Left

Returns

  • Void
 
contains( Ext.util.Region region ) : Void
Checks if this region completely contains the region that is passed in.
Checks if this region completely contains the region that is passed in.

Parameters

  • region : Ext.util.Region

Returns

  • Void
 
copy : Ext.util.Region
Copy a new instance
Copy a new instance
 
copyFrom( Region The ) : Ext.util.Point
Copy the values of another Region to this Region
Copy the values of another Region to this Region

Parameters

  • The : Region
    region to copy from.

Returns

  • Ext.util.Point   this This point
 
equals( Ext.util.Point/Object The ) : Boolean
Compare this point and another point
Compare this point and another point

Parameters

  • The : Ext.util.Point/Object
    point to compare with, either an instance of Ext.util.Point or an object with left and top properties

Returns

  • Boolean   Returns whether they are equivalent
 
fromEvent( Event e ) : Void
Returns a new instance of Ext.util.Point base on the pageX / pageY values of the given event
Returns a new instance of Ext.util.Point base on the pageX / pageY values of the given event

Parameters

  • e : Event
    The event

Returns

  • Void
 
getOutOfBoundOffset( String axis, Ext.util.Point p ) : Ext.util.Offset
Get the offset amount of a point outside the region
Get the offset amount of a point outside the region

Parameters

  • axis : String
    optional
  • p : Ext.util.Point
    the point

Returns

  • Ext.util.Offset   undefined
 
getOutOfBoundOffsetX( Number p ) : Number
Get the offset amount on the x-axis
Get the offset amount on the x-axis

Parameters

  • p : Number
    the offset

Returns

  • Number   undefined
 
getOutOfBoundOffsetY( Number p ) : Number
Get the offset amount on the y-axis
Get the offset amount on the y-axis

Parameters

  • p : Number
    the offset

Returns

  • Number   undefined
 
intersect( Ext.util.Region region ) : Ext.util.Region/Boolean
Checks if this region intersects the region passed in.
Checks if this region intersects the region passed in.

Parameters

  • region : Ext.util.Region

Returns

  • Ext.util.Region/Boolean   Returns the intersected region or false if there is no intersection.
 
isOutOfBound( String axis, Ext.util.Point/Number p ) : Boolean
Check whether the point / offset is out of bound
Check whether the point / offset is out of bound

Parameters

  • axis : String
    optional
  • p : Ext.util.Point/Number
    the point / offset

Returns

  • Boolean   undefined
 
isOutOfBoundX( Number p ) : Boolean
Check whether the offset is out of bound in the x-axis
Check whether the offset is out of bound in the x-axis

Parameters

  • p : Number
    the offset

Returns

  • Boolean   undefined
 
isOutOfBoundY( Number p ) : Boolean
Check whether the offset is out of bound in the y-axis
Check whether the offset is out of bound in the y-axis

Parameters

  • p : Number
    the offset

Returns

  • Boolean   undefined
 
isWithin( Ext.util.Point/Object The, Object/Number threshold ) : Boolean
Whether the given point is not away from this point within the given threshold amount. TODO: Rename this isNear.
Whether the given point is not away from this point within the given threshold amount. TODO: Rename this isNear.

Parameters

  • The : Ext.util.Point/Object
    point to check with, either an instance of Ext.util.Point or an object with left and top properties
  • threshold : Object/Number
    Can be either an object with x and y properties or a number

Returns

  • Boolean   undefined
 
round : Ext.util.Region
Round all the properties of this region
Round all the properties of this region
 
roundedEquals( Ext.util.Point/Object The ) : Boolean
Compare this point with another point when the x and y values of both points are rounded. E.g: [100.3,199.8] will equ...
Compare this point with another point when the x and y values of both points are rounded. E.g: [100.3,199.8] will equals to [100, 200]

Parameters

  • The : Ext.util.Point/Object
    point to compare with, either an instance of Ext.util.Point or an object with x and y properties

Returns

  • Boolean   undefined
 
toString : String
Returns a human-eye-friendly string that represents this point, useful for debugging
Returns a human-eye-friendly string that represents this point, useful for debugging
 
translate( Ext.util.Offset/Object offset, Number The ) : Ext.util.Region
Translate this region by the given offset amount. TODO: Either use translate or translateBy!
Translate this region by the given offset amount. TODO: Either use translate or translateBy!

Parameters

  • offset : Ext.util.Offset/Object
    Object containing the x and y properties. Or the x value is using the two argument form.
  • The : Number
    y value unless using an Offset object.

Returns

  • Ext.util.Region   this This Region
 
translateBy( Ext.util.Offset/Object offset, Number The ) : Ext.util.Region
Translate this region by the given offset amount
Translate this region by the given offset amount

Parameters

  • offset : Ext.util.Offset/Object
    Object containing the x and y properties. Or the x value is using the two argument form.
  • The : Number
    y value unless using an Offset object.

Returns

  • Ext.util.Region   this This Region
 
union( Ext.util.Region region ) : Void
Returns the smallest region that contains the current AND targetRegion.
Returns the smallest region that contains the current AND targetRegion.

Parameters

  • region : Ext.util.Region

Returns

  • Void
© 2011 Sencha Inc.