CircleSector | plotboilerplate

classdesc: A simple circle sector: circle, start- and end-angle.
requires: Line
requires: SVGSerializale
requires: UID
requires: UIDGenerator
requires: XYCoords

Hierarchy

CircleSector

Implements

SVGSerializable

Index

Constructors

constructor

Properties

Methods

destroy

Object literals

circleSectorUtils

Constructors

constructor

new CircleSector(circle: Circle, startAngle: number, endAngle: number): CircleSector

- Defined in src/ts/CircleSector.ts:65
Create a new circle sector with given circle, start- and end-angle.

name

CircleSector

Parameters
- circle: Circle
  
  The circle.
- startAngle: number
  
  The start angle of the sector.
- endAngle: number
  
  The end angle of the sector.
Returns CircleSector

Properties

circle

circle: Circle

member: {Circle}
memberof: CircleSector
instance

Readonly className

className: string = "CircleSector"

Required to generate proper CSS classes and other class related IDs.

endAngle

endAngle: number

member: {number}
memberof: CircleSector
instance

isDestroyed

isDestroyed: boolean

member: isDestroyed
memberof: CircleSector
instance

startAngle

startAngle: number

member: {number}
memberof: CircleSector
instance

Readonly uid

uid: UID

The UID of this drawable object.

member: {UID}
memberof: CircleSector
instance
readonly

Methods

destroy

destroy(): void

- Defined in src/ts/CircleSector.ts:88
This function should invalidate any installed listeners and invalidate this object. After calling this function the object might not hold valid data any more and should not be used.

Returns void

Object literals

Static circleSectorUtils

circleSectorUtils: object

describeSVGArc

describeSVGArc(x: number, y: number, radius: number, startAngle: number, endAngle: number, options?: { moveToStart: boolean }): SVGPathParams

- Defined in src/ts/CircleSector.ts:117
Helper function to convert a circle section as SVG arc params (for the d attribute). Found at: https://stackoverflow.com/questions/5736398/how-to-calculate-the-svg-path-for-an-arc-of-a-circle

TODO: generalize for ellipses (two radii).

Parameters
- x: number
- y: number
- radius: number
- startAngle: number
- endAngle: number
- Optional options: { moveToStart: boolean }
  - moveToStart: boolean
Returns SVGPathParams

polarToCartesian

polarToCartesian(centerX: number, centerY: number, radius: number, angle: number): XYCoords

- Defined in src/ts/CircleSector.ts:101
Helper function to convert polar circle coordinates to cartesian coordinates.

TODO: generalize for ellipses (two radii).

Parameters
- centerX: number
- centerY: number
- radius: number
- angle: number
  
  The angle in radians.
Returns XYCoords

Generated using TypeDoc