geometry.pixel.Rectangle

Extends IPixelRectangleGeometry.

The "Rectangle" pixel geometry.

Constructor | Fields | Methods

Constructor

geometry.pixel.Rectangle([coordinates[, metaData]])

Parameters:

Parameter

Default value

Description

coordinates

null

Type: Number[][]|null

Coordinates of two opposite corners of the rectangle.

metaData

Type: Object

Metadata.

Fields

Name

Type

Description

events

IEventManager

Event manager.

Inherited from IEventEmitter.

Methods

Name

Returns

Description

equals(geometry)

Boolean

Returns true if the passed geometry is equivalent to the given one.

Inherited from IPixelGeometry.

getBounds()

Number[][]|null

Returns coordinates of the two opposite corners of the area that surrounds the geometry. The first item in the array is the corner with the smallest coordinate values relative to the rest of the points in the area; the second item is the corner with the largest coordinate values.

Inherited from IBaseGeometry.

getClosest(anchorPosition)

Object

Searches for the point nearest to "anchorPosition" on the rectangle.

Inherited from IPixelRectangleGeometry.

getCoordinates()

Number[][]

Returns coordinates of two opposite corners of the rectangle.

Inherited from IPixelRectangleGeometry.

getMetaData()

Object

Returns metadata of the pixel geometry.

Inherited from IPixelGeometry.

getType()

String

Returns ID of the geometry type.

Inherited from IBaseGeometry.

scale(factor)

IPixelGeometry

Creates a scaled copy of the geometry.

Inherited from IPixelGeometry.

shift(offset)

IPixelGeometry

Creates a copy of the geometry that is shifted by the specified amount.

Inherited from IPixelGeometry.

In this article: