Maker.js, a Microsoft Garage project, is a JavaScript library for creating and sharing modular line drawings for CNC and laser cutters.

View project on GitHub Star

Api - Circle Class

Class for circle path.

Hierarchy

  • Circle

Implements

Index

Constructors

Properties

Constructors

constructor

  • Class for circle path, created from radius. Origin will be [0, 0].

    Example:

    var c = new makerjs.paths.Circle(7);

    Parameters

    • radius: number

      The radius of the circle.

    Returns Circle

  • Class for circle path, created from origin point and radius.

    Example:

    var c = new makerjs.paths.Circle([10, 10], 7);

    Parameters

    • origin: IPoint

      The center point of the circle.

    • radius: number

      The radius of the circle.

    Returns Circle

  • Class for circle path, created from 2 points.

    Example:

    var c = new makerjs.paths.Circle([5, 15], [25, 15]);

    Parameters

    • pointA: IPoint

      First point on the circle.

    • pointB: IPoint

      Second point on the circle.

    Returns Circle

  • Class for circle path, created from 3 points.

    Example:

    var c = new makerjs.paths.Circle([0, 0], [0, 10], [20, 0]);

    Parameters

    • pointA: IPoint

      First point on the circle.

    • pointB: IPoint

      Second point on the circle.

    • pointC: IPoint

      Third point on the circle.

    Returns Circle

Properties

origin

origin: IPoint

radius

radius: number

type

type: string

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc