Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

CircleDiagram

Classes

Class: CircleDiagram

Extends Widget

CircleDiagram

A CircleDiagram widget displays circular diagrams.

Method: AddPoint

(method) CircleDiagram:AddPoint(offX: number, offY: number)

Adds a point at the specified offset coordinates for the CircleDiagram.

@param offX — The x-coordinate offset.

@param offY — The y-coordinate offset.

Method: SetDiagramColor

(method) CircleDiagram:SetDiagramColor(r: number, g: number, b: number, a: number)

Sets the color for the CircleDiagram.

@param r — The red color component (min: 0, max: 1).

@param g — The green color component (min: 0, max: 1).

@param b — The blue color component (min: 0, max: 1).

@param a — The alpha (opacity) component (min: 0, max: 1).

Method: SetLineThickness

(method) CircleDiagram:SetLineThickness(thickness: number)

Sets the line thickness for the CircleDiagram.

@param thickness — The thickness of the diagram’s lines.

Method: SetMaxValue

(method) CircleDiagram:SetMaxValue(maxValue: number)

Sets the maximum value for the CircleDiagram.

@param maxValue — The maximum value for the diagram.

Method: GetPointOffset

(method) CircleDiagram:GetPointOffset(index: number)
  -> offX: number
  2. offY: number

Retrieves the offset coordinates for the specified point index of the CircleDiagram.

@param index — The index of the point.

@return offX — The x-coordinate offset of the point.

@return offY — The y-coordinate offset of the point.

Method: ClearPoints

(method) CircleDiagram:ClearPoints()

Clears all points from the CircleDiagram.

Method: GetCenterOffset

(method) CircleDiagram:GetCenterOffset()
  -> offX: number
  2. offY: number

Retrieves the offset coordinates of the CircleDiagram’s center.

@return offX — The x-coordinate offset of the center.

@return offY — The y-coordinate offset of the center.

Method: AddPointsByAngle

(method) CircleDiagram:AddPointsByAngle(pointNum: number)

Adds a point by angle for the CircleDiagram.

@param pointNum — The angle value (in radians) for the point.

Method: SetPointValue

(method) CircleDiagram:SetPointValue(index: number, value: number)

Sets the value for a specific point index of the CircleDiagram.

@param index — The index of the point.

@param value — The value to set for the point.