addEllipse

addEllipse is a common function name in 2D drawing libraries used to create and insert an ellipse into a drawing surface or scene graph. The function typically encapsulates the creation of an ellipse shape and appends it to a target container, such as a canvas, layer, or group. The exact behavior and terminology vary by library, but the concept is consistent: generate an ellipse with specified size and position and integrate it into the current drawing.

Typical usage and parameters

A typical signature resembles addEllipse(x, y, width, height, options). The x and y parameters specify the position, while width and height define the ellipse’s bounding box. Depending on the library, x and y may refer to the ellipse center or to a corner of the bounding box. The options object (or equivalent parameter) commonly includes styling such as fill color, stroke color, stroke width, opacity, and sometimes rotation or z-order. The function often returns a reference to the created shape, which can be queried or modified later (for example, to change color or remove it from the scene).

Examples and behavior

In practice, a call might look like addEllipse(100, 150, 80, 60, {fill: '#ff0000', stroke: '#000000', strokeWidth: 2}). The function then creates the ellipse with those visual properties and adds it to the active canvas or parent container. Some libraries also allow chaining or provide methods to animate, group, or transform the shape after creation.

Notes and variations

Because implementations differ, developers should consult the specific library’s documentation for coordinate conventions, supported styling options, and how to remove or modify the ellipse after creation. See also ellipse, circle, drawEllipse, and addShape for related concepts.