Skip to main content

Interface: PolarPlaneOptions

Defined in: mobjects/graphing/ComplexPlane.ts:484

Options for creating a PolarPlane

Properties​

angleLabels?​

optional angleLabels: (string | Mobject)[]

Defined in: mobjects/graphing/ComplexPlane.ts:518

Custom angle labels. Length must equal angularDivisions.

  • string entries render via Text with labelFontSize / labelColor.
  • Mobject entries are used as-is (caller owns styling); they are positioned by the plane and reparented into the angle-labels group.

Entries are placed in division order starting at azimuthOffset and rotating counter-clockwise — index 0 is the first division, not a fixed compass point.

angularDivisions?​

optional angularDivisions: number

Defined in: mobjects/graphing/ComplexPlane.ts:492

Number of angular divisions (radial lines). Default: 12

azimuthOffset?​

optional azimuthOffset: number

Defined in: mobjects/graphing/ComplexPlane.ts:508

Azimuth offset angle in radians (0 = right). Default: 0

gridColor?​

optional gridColor: string

Defined in: mobjects/graphing/ComplexPlane.ts:494

Stroke color for grid lines. Default: '#555555'

gridOpacity?​

optional gridOpacity: number

Defined in: mobjects/graphing/ComplexPlane.ts:498

Grid line opacity. Default: 0.5

gridStrokeWidth?​

optional gridStrokeWidth: number

Defined in: mobjects/graphing/ComplexPlane.ts:496

Stroke width for grid lines. Default: 1

includeAngleLabels?​

optional includeAngleLabels: boolean

Defined in: mobjects/graphing/ComplexPlane.ts:500

Whether to include angle labels. Default: true

includeRadiusLabels?​

optional includeRadiusLabels: boolean

Defined in: mobjects/graphing/ComplexPlane.ts:502

Whether to include radius labels. Default: true

labelColor?​

optional labelColor: string

Defined in: mobjects/graphing/ComplexPlane.ts:506

Color for axis labels. Default: '#ffffff'

labelFontSize?​

optional labelFontSize: number

Defined in: mobjects/graphing/ComplexPlane.ts:504

Font size for labels. Default: 20

radialDivisions?​

optional radialDivisions: number

Defined in: mobjects/graphing/ComplexPlane.ts:490

Number of radial divisions (concentric circles). Default: 3

radius?​

optional radius: number

Defined in: mobjects/graphing/ComplexPlane.ts:486

Maximum radius in coordinate units. Default: 3

radiusLabels?​

optional radiusLabels: (string | Mobject)[]

Defined in: mobjects/graphing/ComplexPlane.ts:528

Custom radius labels. Length must equal radialDivisions.

  • string entries render via Text at labelFontSize * 0.8 (matches default radius-label sizing).
  • Mobject entries are used as-is; they are positioned along the positive x-axis and reparented into the radius-labels group.

Index i corresponds to radius ((i + 1) / radialDivisions) * radius.

size?​

optional size: number

Defined in: mobjects/graphing/ComplexPlane.ts:488

Visual size (diameter) of the plane. Default: 6