Skip to content

Rectangle

Rectangle is the rectangle geometry class of maptalks, inheriting from Polygon. It is defined by a northwest corner, a width, and a height, and is commonly used for bounding boxes or rectangular areas.

js
import { Rectangle } from "maptalks";
// Usage example
const rect = new Rectangle([0, 0], 1000, 600);

Constructor

js
new Rectangle(nw, width, height, options?)

Parameters:

  • nw — The northwest corner coordinates of the rectangle, e.g. [x, y].
  • width — The width of the rectangle.
  • height — The height of the rectangle.
  • options — (Optional) Configuration options.

options

Rectangle has no specific options; options are inherited from Polygon / Path, with styling controlled via symbol.

Methods

  • getCoordinates() — Gets the coordinates of the rectangle (returns the northwest corner).
  • setCoordinates(nw) — Sets the northwest corner coordinates of the rectangle.
  • getWidth() — Gets the width of the rectangle.
  • setWidth(width) — Sets the width of the rectangle.
  • getHeight() — Gets the height of the rectangle.
  • setHeight(height) — Sets the height of the rectangle.
  • getShell() — Gets the outer ring of the rectangle.
  • getHoles() — Gets the inner rings of the rectangle.
  • animateShow() — Shows the rectangle with an animation.

Static Methods

  • fromJSON(json) — Creates a Rectangle from a JSON object.

Events

  • positionchange — Fired when the position of the rectangle changes.
  • shapechange — Fired when the shape of the rectangle changes.