manim-web 0.19.0 → 0.20.0

package/dist/mobjects/graphing/PieChart.d.ts

@@ -0,0 +1,180 @@
+import { VGroup } from '../../core/VGroup';
+import { VMobject } from '../../core/VMobject';
+/**
+ * Geometry of one slice, derived from the data.
+ * Non-positive values are skipped, so `index` is the position in the
+ * original `values` array and is not always contiguous.
+ */
+export interface SliceGeometry {
+    /** Index of this value in the original `values` array. */
+    index: number;
+    /** The (positive) data value for this slice. */
+    value: number;
+    /** Fraction of the total this slice occupies, in [0, 1]. */
+    fraction: number;
+    /** Start angle of the slice sweep, in radians. */
+    startAngle: number;
+    /** Sweep angle of the slice, in radians (proportional to the value). */
+    angle: number;
+}
+/**
+ * Compute the sweep angles for a set of values.
+ *
+ * Each positive value gets a sweep angle proportional to `value / total`.
+ * Non-positive values (zero and negative) are skipped and get no slice.
+ * The returned slices sweep counterclockwise from `startAngle`, in the order
+ * of the input array.
+ *
+ * @param values - The raw data values.
+ * @param startAngle - Angle of the first slice edge, in radians.
+ * @returns One SliceGeometry per positive value. Empty array if the total is 0.
+ */
+export declare function computeSliceGeometry(values: number[], startAngle: number): SliceGeometry[];
+/** How slice labels are placed relative to the slice. */
+export type LabelPosition = 'inside' | 'outside';
+/**
+ * Options shared by PieChart and DonutChart.
+ */
+export interface PieChartOptions {
+    /** Data values. One slice per positive value. Default: required. */
+    values: number[];
+    /** Text label for each value (by original index). Default: []. */
+    labels?: string[];
+    /** Slice colors. Single color applies to all, array cycles. Default: Manim palette. */
+    colors?: string | string[];
+    /** Angle of the first slice edge, in radians. Default: Math.PI / 2 (12 o'clock). */
+    startAngle?: number;
+    /** Outer radius of the chart. Default: 2. */
+    radius?: number;
+    /** Fill opacity of the slices. Default: 0.8. */
+    fillOpacity?: number;
+    /** Stroke color drawn between slices. Default: WHITE. */
+    strokeColor?: string;
+    /** Stroke width drawn between slices. Default: 2. */
+    strokeWidth?: number;
+    /** Whether to draw text labels on the slices. Default: true when labels are given. */
+    showLabels?: boolean;
+    /** Whether to append the percentage to each label. Default: false. */
+    showPercentages?: boolean;
+    /** Font size for slice labels. Default: 24. */
+    labelFontSize?: number;
+    /** Place labels 'inside' the slices or 'outside' the rim. Default: 'outside'. */
+    labelPosition?: LabelPosition;
+    /** Whether to draw a legend of label swatches. Default: false. */
+    showLegend?: boolean;
+    /** Font size for legend labels. Default: 18. */
+    legendFontSize?: number;
+}
+/**
+ * PieChart - a data-to-pie visualization mobject.
+ *
+ * Builds a VGroup of {@link Sector}s whose sweep angles are proportional to
+ * each value divided by the total. Non-positive values are skipped, a single
+ * value fills the whole circle, and empty data yields an empty group.
+ *
+ * @example
+ * ```typescript
+ * const pie = new PieChart({
+ *   values: [30, 20, 50],
+ *   labels: ['A', 'B', 'C'],
+ *   showPercentages: true,
+ * });
+ * pie.getSlice(0); // the first Sector
+ * ```
+ */
+export declare class PieChart extends VGroup {
+    /** The slice sectors. */
+    slices: VGroup;
+    /** The slice labels. */
+    labelGroup: VGroup;
+    /** The legend, when enabled. */
+    legend: VGroup | null;
+    protected _values: number[];
+    protected _labelTexts: string[];
+    protected _colors: string[];
+    protected _startAngle: number;
+    protected _radius: number;
+    protected _fillOpacity: number;
+    protected _strokeColor: string;
+    protected _strokeWidth: number;
+    protected _showLabels: boolean;
+    protected _showPercentages: boolean;
+    protected _labelFontSize: number;
+    protected _labelPosition: LabelPosition;
+    protected _showLegend: boolean;
+    protected _legendFontSize: number;
+    protected _geometry: SliceGeometry[];
+    constructor(options: PieChartOptions);
+    /**
+     * Create one slice mobject. Overridden by DonutChart to use AnnularSector.
+     * @param geom - The slice geometry.
+     * @param color - The slice fill color.
+     * @returns A Sector sweeping the slice.
+     */
+    protected _makeSlice(geom: SliceGeometry, color: string): VMobject;
+    /** Color for the slice at the given original value index. */
+    protected _colorForIndex(index: number): string;
+    /** Build all slice sectors into `this.slices`. */
+    protected _buildSlices(): void;
+    /** Radius at which to place a label for the given position mode. */
+    protected _labelRadius(): number;
+    /** Build the slice labels into `this.labelGroup`. */
+    protected _buildLabels(): void;
+    /** Compose the label text for a slice (name and/or percentage). */
+    protected _labelText(geom: SliceGeometry): string;
+    /** Build the legend into a new VGroup. */
+    protected _buildLegend(): VGroup;
+    /** Get all slice sectors. */
+    getSectors(): VMobject[];
+    /**
+     * Get a single slice sector by position.
+     * @param index - Position in the slice list (not the original value index).
+     * @returns The sector, or undefined when out of range.
+     */
+    getSlice(index: number): VMobject | undefined;
+    /** Get the slice geometry (angles and fractions) for all slices. */
+    getSliceGeometry(): SliceGeometry[];
+    /** Get the original data values. */
+    getValues(): number[];
+    /** Get the outer radius. */
+    getRadius(): number;
+    copy(): PieChart;
+    /** Options bundle used to reconstruct this chart in copy(). */
+    protected _optionsForCopy(): PieChartOptions;
+}
+/**
+ * Options for DonutChart. Adds the hole radius to {@link PieChartOptions}.
+ */
+export interface DonutChartOptions extends PieChartOptions {
+    /**
+     * Hole radius as a fraction of the outer radius, in [0, 1).
+     * Default: 0.5. A value of 0 makes a full pie.
+     */
+    innerRadius?: number;
+}
+/**
+ * DonutChart - a PieChart with a hole in the middle.
+ *
+ * Builds a VGroup of {@link AnnularSector}s. The slice-angle logic is shared
+ * with {@link PieChart}; only the slice shape differs. `innerRadius` is a
+ * fraction of the outer radius, in [0, 1).
+ *
+ * @example
+ * ```typescript
+ * const donut = new DonutChart({ values: [1, 2, 3], innerRadius: 0.5 });
+ * ```
+ */
+export declare class DonutChart extends PieChart {
+    protected _innerRadiusFraction: number;
+    constructor(options: DonutChartOptions);
+    private static _clampFraction;
+    /** Absolute inner (hole) radius in scene units. */
+    getInnerRadius(): number;
+    /** Inner radius as a fraction of the outer radius. */
+    getInnerRadiusFraction(): number;
+    /** Replace the pie sectors built by the base constructor with annular sectors. */
+    private _rebuildSlicesAsDonut;
+    protected _makeSlice(geom: SliceGeometry, color: string): VMobject;
+    copy(): DonutChart;
+}
+//# sourceMappingURL=PieChart.d.ts.map

package/dist/mobjects/graphing/PieChart.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PieChart.d.ts","sourceRoot":"","sources":["../../../src/mobjects/graphing/PieChart.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAuB/C;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,0DAA0D;IAC1D,KAAK,EAAE,MAAM,CAAC;IACd,gDAAgD;IAChD,KAAK,EAAE,MAAM,CAAC;IACd,4DAA4D;IAC5D,QAAQ,EAAE,MAAM,CAAC;IACjB,kDAAkD;IAClD,UAAU,EAAE,MAAM,CAAC;IACnB,wEAAwE;IACxE,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,UAAU,EAAE,MAAM,GAAG,aAAa,EAAE,CAyB1F;AAED,yDAAyD;AACzD,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,SAAS,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,oEAAoE;IACpE,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,kEAAkE;IAClE,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,uFAAuF;IACvF,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC3B,oFAAoF;IACpF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,6CAA6C;IAC7C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gDAAgD;IAChD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,yDAAyD;IACzD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,qDAAqD;IACrD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sFAAsF;IACtF,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,sEAAsE;IACtE,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,+CAA+C;IAC/C,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iFAAiF;IACjF,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,kEAAkE;IAClE,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,gDAAgD;IAChD,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,QAAS,SAAQ,MAAM;IAClC,yBAAyB;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,wBAAwB;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,gCAAgC;IAChC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAQ;IAE7B,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;IAC5B,SAAS,CAAC,WAAW,EAAE,MAAM,EAAE,CAAC;IAChC,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;IAC5B,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC;IAC9B,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC;IAC1B,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC;IAC/B,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC;IAC/B,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC;IAC/B,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC;IAC/B,SAAS,CAAC,gBAAgB,EAAE,OAAO,CAAC;IACpC,SAAS,CAAC,cAAc,EAAE,MAAM,CAAC;IACjC,SAAS,CAAC,cAAc,EAAE,aAAa,CAAC;IACxC,SAAS,CAAC,WAAW,EAAE,OAAO,CAAC;IAC/B,SAAS,CAAC,eAAe,EAAE,MAAM,CAAC;IAClC,SAAS,CAAC,SAAS,EAAE,aAAa,EAAE,CAAC;gBAEzB,OAAO,EAAE,eAAe;IAsDpC;;;;;OAKG;IACH,SAAS,CAAC,UAAU,CAAC,IAAI,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,GAAG,QAAQ;IAalE,6DAA6D;IAC7D,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAI/C,kDAAkD;IAClD,SAAS,CAAC,YAAY,IAAI,IAAI;IAQ9B,oEAAoE;IACpE,SAAS,CAAC,YAAY,IAAI,MAAM;IAIhC,qDAAqD;IACrD,SAAS,CAAC,YAAY,IAAI,IAAI;IAsB9B,mEAAmE;IACnE,SAAS,CAAC,UAAU,CAAC,IAAI,EAAE,aAAa,GAAG,MAAM;IAQjD,0CAA0C;IAC1C,SAAS,CAAC,YAAY,IAAI,MAAM;IAmChC,6BAA6B;IAC7B,UAAU,IAAI,QAAQ,EAAE;IAIxB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS;IAI7C,oEAAoE;IACpE,gBAAgB,IAAI,aAAa,EAAE;IAInC,oCAAoC;IACpC,SAAS,IAAI,MAAM,EAAE;IAIrB,4BAA4B;IAC5B,SAAS,IAAI,MAAM;IAIV,IAAI,IAAI,QAAQ;IAMzB,+DAA+D;IAC/D,SAAS,CAAC,eAAe,IAAI,eAAe;CAkB7C;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,eAAe;IACxD;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;;;GAWG;AACH,qBAAa,UAAW,SAAQ,QAAQ;IACtC,SAAS,CAAC,oBAAoB,EAAE,MAAM,CAAC;gBAE3B,OAAO,EAAE,iBAAiB;IAWtC,OAAO,CAAC,MAAM,CAAC,cAAc;IAO7B,mDAAmD;IACnD,cAAc,IAAI,MAAM;IAIxB,sDAAsD;IACtD,sBAAsB,IAAI,MAAM;IAIhC,kFAAkF;IAClF,OAAO,CAAC,qBAAqB;cAeV,UAAU,CAAC,IAAI,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,GAAG,QAAQ;IAiBlE,IAAI,IAAI,UAAU;CAQ5B"}

package/dist/mobjects/graphing/index.d.ts

@@ -21,5 +21,6 @@ export { VectorFieldVector, type VectorFieldVectorOptions } from './Vector';
 export { ComplexPlane, type ComplexPlaneOptions, type Complex } from './ComplexPlane';
 export { PolarPlane, type PolarPlaneOptions } from './ComplexPlane';
 export { BarChart, type BarChartOptions } from './BarChart';
+export { PieChart, type PieChartOptions, DonutChart, type DonutChartOptions, computeSliceGeometry, type SliceGeometry, type LabelPosition, } from './PieChart';
 export { VectorField, ArrowVectorField, StreamLines, stepVectorField, type Integrator, type VectorFunction, type ColorFunction, type VectorFieldBaseOptions, type ArrowVectorFieldOptions, type StreamLinesOptions, type ContinuousMotionOptions, } from './VectorField';
 //# sourceMappingURL=index.d.ts.map

package/dist/mobjects/graphing/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/mobjects/graphing/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EACL,UAAU,EACV,KAAK,iBAAiB,EACtB,YAAY,EACZ,KAAK,mBAAmB,GACzB,MAAM,cAAc,CAAC;AAGtB,OAAO,EAAE,IAAI,EAAE,KAAK,WAAW,EAAE,MAAM,QAAQ,CAAC;AAGhD,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAG3D,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,KAAK,sBAAsB,EAAE,MAAM,SAAS,CAAC;AAGtF,OAAO,EAAE,KAAK,2BAA2B,EAAE,KAAK,uBAAuB,EAAE,MAAM,iBAAiB,CAAC;AAGjG,OAAO,EAAE,WAAW,EAAE,KAAK,kBAAkB,EAAE,KAAK,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAG/F,OAAO,EAAE,aAAa,EAAE,KAAK,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAG3E,OAAO,EAAE,gBAAgB,EAAE,KAAK,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAGpF,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGtF,OAAO,EAAE,eAAe,EAAE,KAAK,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAGzE,OAAO,EAAE,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,aAAa,EAAE,MAAM,WAAW,CAAC;AAG7E,OAAO,EAAE,WAAW,EAAE,KAAK,kBAAkB,EAAE,KAAK,YAAY,EAAE,MAAM,eAAe,CAAC;AAGxF,OAAO,EAAE,kBAAkB,EAAE,KAAK,yBAAyB,EAAE,MAAM,sBAAsB,CAAC;AAG1F,OAAO,EAAE,iBAAiB,EAAE,KAAK,wBAAwB,EAAE,MAAM,UAAU,CAAC;AAG5E,OAAO,EAAE,YAAY,EAAE,KAAK,mBAAmB,EAAE,KAAK,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAGtF,OAAO,EAAE,UAAU,EAAE,KAAK,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAGpE,OAAO,EAAE,QAAQ,EAAE,KAAK,eAAe,EAAE,MAAM,YAAY,CAAC;AAG5D,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,WAAW,EACX,eAAe,EACf,KAAK,UAAU,EACf,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC5B,KAAK,kBAAkB,EACvB,KAAK,uBAAuB,GAC7B,MAAM,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/mobjects/graphing/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EACL,UAAU,EACV,KAAK,iBAAiB,EACtB,YAAY,EACZ,KAAK,mBAAmB,GACzB,MAAM,cAAc,CAAC;AAGtB,OAAO,EAAE,IAAI,EAAE,KAAK,WAAW,EAAE,MAAM,QAAQ,CAAC;AAGhD,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAG3D,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,KAAK,sBAAsB,EAAE,MAAM,SAAS,CAAC;AAGtF,OAAO,EAAE,KAAK,2BAA2B,EAAE,KAAK,uBAAuB,EAAE,MAAM,iBAAiB,CAAC;AAGjG,OAAO,EAAE,WAAW,EAAE,KAAK,kBAAkB,EAAE,KAAK,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAG/F,OAAO,EAAE,aAAa,EAAE,KAAK,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAG3E,OAAO,EAAE,gBAAgB,EAAE,KAAK,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAGpF,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGtF,OAAO,EAAE,eAAe,EAAE,KAAK,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAGzE,OAAO,EAAE,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,aAAa,EAAE,MAAM,WAAW,CAAC;AAG7E,OAAO,EAAE,WAAW,EAAE,KAAK,kBAAkB,EAAE,KAAK,YAAY,EAAE,MAAM,eAAe,CAAC;AAGxF,OAAO,EAAE,kBAAkB,EAAE,KAAK,yBAAyB,EAAE,MAAM,sBAAsB,CAAC;AAG1F,OAAO,EAAE,iBAAiB,EAAE,KAAK,wBAAwB,EAAE,MAAM,UAAU,CAAC;AAG5E,OAAO,EAAE,YAAY,EAAE,KAAK,mBAAmB,EAAE,KAAK,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAGtF,OAAO,EAAE,UAAU,EAAE,KAAK,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAGpE,OAAO,EAAE,QAAQ,EAAE,KAAK,eAAe,EAAE,MAAM,YAAY,CAAC;AAG5D,OAAO,EACL,QAAQ,EACR,KAAK,eAAe,EACpB,UAAU,EACV,KAAK,iBAAiB,EACtB,oBAAoB,EACpB,KAAK,aAAa,EAClB,KAAK,aAAa,GACnB,MAAM,YAAY,CAAC;AAGpB,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,WAAW,EACX,eAAe,EACf,KAAK,UAAU,EACf,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC5B,KAAK,kBAAkB,EACvB,KAAK,uBAAuB,GAC7B,MAAM,eAAe,CAAC"}