Last updated

API / geotoolkit / util / Area / Area

Class: Area

util.Area.Area

Represents an abstract class that specify model area.

Hierarchy

Table of contents

Constructors
Methods

Contents

Constructors

new Area()

new Area()

Methods

contains

Abstract contains(x, y): boolean

Check if the area contains point

Throws

if illegal argument count

Parameters

Name Type Description
xnumberx position of the point
ynumbery position of the point

Returns

boolean

Abstract contains(point): boolean

Check if the area contains point

Throws

if illegal argument count

Parameters

Name Type Description
pointPointpoint

Returns

boolean

Abstract contains(x, y?): boolean

Parameters

Name Type
xnumber | Point
Optional ynumber

Returns

boolean


getBounds

Abstract getBounds(): Rect

Return bounds and locks the bounds rect from further editing.

Returns

Rect

bounds


getClassName

getClassName(): string

Returns

string


getProperties

getProperties(): Record<string, any>

Gets all the properties pertaining to this object

Returns

Record<string, any>


setProperties

setProperties(properties?): Area

Sets all the properties pertaining to this object

Parameters

Name Type Description
Optional propertiesRecord<string, any>object containing the properties to set

Returns

Area

this


getClassName

Static getClassName(): string

Returns

string