tsparticles 1.35.2 → 1.37.0

package/browser/Plugins/Absorbers/Absorbers.js

@@ -2,6 +2,9 @@ import { AbsorberInstance } from "./AbsorberInstance";
 import { Absorber } from "./Options/Classes/Absorber";
 import { AbsorberClickMode } from "./Enums";
 import { itemFromArray } from "../../Utils";
+/**
+ * @category Absorbers Plugin
+ */
 export class Absorbers {
     constructor(container) {
         this.container = container;

package/browser/Plugins/Absorbers/Enums/AbsorberClickMode.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @category Absorbers Plugin
+ */
 export declare enum AbsorberClickMode {
     absorber = "absorber"
 }

package/browser/Plugins/Absorbers/Enums/AbsorberClickMode.js

@@ -1,3 +1,6 @@
+/**
+ * @category Absorbers Plugin
+ */
 export var AbsorberClickMode;
 (function (AbsorberClickMode) {
     AbsorberClickMode["absorber"] = "absorber";

package/browser/Plugins/Absorbers/Options/Classes/Absorber.d.ts

@@ -4,6 +4,10 @@ import type { RecursivePartial } from "../../../../Types";
 import { AbsorberSize } from "./AbsorberSize";
 import { OptionsColor } from "../../../../Options/Classes/OptionsColor";
 import type { IOptionLoader } from "../../../../Options/Interfaces/IOptionLoader";
+/**
+ * [[include:Options/Plugins/Absorbers.md]]
+ * @category Absorbers Plugin
+ */
 export declare class Absorber implements IAbsorber, IOptionLoader<IAbsorber> {
     color: OptionsColor;
     draggable: boolean;

package/browser/Plugins/Absorbers/Options/Classes/Absorber.js

@@ -1,5 +1,9 @@
 import { AbsorberSize } from "./AbsorberSize";
 import { OptionsColor } from "../../../../Options/Classes/OptionsColor";
+/**
+ * [[include:Options/Plugins/Absorbers.md]]
+ * @category Absorbers Plugin
+ */
 export class Absorber {
     constructor() {
         this.color = new OptionsColor();

package/browser/Plugins/Absorbers/Options/Interfaces/IAbsorber.d.ts

@@ -2,13 +2,42 @@ import type { ICoordinates } from "../../../../Core/Interfaces/ICoordinates";
 import type { IColor } from "../../../../Core/Interfaces/Colors";
 import type { IAbsorberSize } from "./IAbsorberSize";
 import { RecursivePartial } from "../../../../Types";
+/**
+ * Absorber options
+ * [[include:Options/Plugins/Absorbers.md]]
+ * @category Absorbers Plugin
+ */
 export interface IAbsorber {
+    /**
+     * Absorber color
+     */
     color: IColor | string;
+    /**
+     * Absorber name
+     */
     name?: string;
+    /**
+     * Absorber opacity
+     */
     opacity: number;
+    /**
+     * Absorber position, percent values calculated on canvas size
+     */
     position?: RecursivePartial<ICoordinates>;
+    /**
+     * Absorber size, these values will be used as pixels
+     */
     size: IAbsorberSize;
+    /**
+     * Absorber draggable, this enables dragging on absorbers
+     */
     draggable: boolean;
+    /**
+     * Absorber destroy, this enable particle destruction, if disabled the particle will randomly respawn
+     */
     destroy: boolean;
+    /**
+     * Absorber orbits, this enable particles orbiting while being attracted by the attracter
+     */
     orbits: boolean;
 }

package/browser/Plugins/Absorbers/Options/Interfaces/IAbsorberOptions.d.ts

@@ -2,6 +2,9 @@ import type { SingleOrMultiple } from "../../../../Types";
 import type { IAbsorber } from "./IAbsorber";
 import type { IInteractivity } from "../../../../Options/Interfaces/Interactivity/IInteractivity";
 import type { IModes } from "../../../../Options/Interfaces/Interactivity/Modes/IModes";
+/**
+ * @category Absorbers Plugin
+ */
 export interface IAbsorberOptions {
     absorbers: SingleOrMultiple<IAbsorber>;
     interactivity: IInteractivity & {

package/browser/Plugins/Absorbers/plugin.d.ts

@@ -1,2 +1,2 @@
 import type { Main } from "../../main";
-export declare function loadAbsorbersPlugin(tsParticles: Main): void;
+export declare function loadAbsorbersPlugin(tsParticles: Main): Promise<void>;

package/browser/Plugins/Absorbers/plugin.js

@@ -2,6 +2,9 @@ import { Absorbers } from "./Absorbers";
 import { AbsorberClickMode } from "./Enums";
 import { Absorber } from "./Options/Classes/Absorber";
 import { isInArray } from "../../Utils";
+/**
+ * @category Absorbers Plugin
+ */
 class Plugin {
     constructor() {
         this.id = "absorbers";
@@ -71,7 +74,7 @@ class Plugin {
         }
     }
 }
-export function loadAbsorbersPlugin(tsParticles) {
+export async function loadAbsorbersPlugin(tsParticles) {
     const plugin = new Plugin();
-    tsParticles.addPlugin(plugin);
+    await tsParticles.addPlugin(plugin);
 }

package/browser/Plugins/Emitters/EmitterInstance.d.ts

@@ -3,6 +3,9 @@ import type { IEmitter } from "./Options/Interfaces/IEmitter";
 import type { Emitters } from "./Emitters";
 import type { IEmitterSize } from "./Options/Interfaces/IEmitterSize";
 import type { ICoordinates, IDelta, IHsl } from "../../Core/Interfaces";
+/**
+ * @category Emitters Plugin
+ */
 export declare class EmitterInstance {
     #private;
     private readonly emitters;

package/browser/Plugins/Emitters/EmitterInstance.js

@@ -14,6 +14,9 @@ import { colorToHsl, deepExtend, getRangeValue, isPointInside, randomInRange } f
 import { SizeMode } from "../../Enums";
 import { EmitterSize } from "./Options/Classes/EmitterSize";
 import { ShapeManager } from "./ShapeManager";
+/**
+ * @category Emitters Plugin
+ */
 export class EmitterInstance {
     constructor(emitters, container, emitterOptions, position) {
         var _a, _b, _c, _d, _e, _f;

package/browser/Plugins/Emitters/Emitters.d.ts

@@ -6,6 +6,9 @@ import type { RecursivePartial, SingleOrMultiple } from "../../Types";
 import { Emitter } from "./Options/Classes/Emitter";
 import type { IOptions } from "../../Options/Interfaces/IOptions";
 import type { IEmitterOptions } from "./Options/Interfaces/IEmitterOptions";
+/**
+ * @category Emitters Plugin
+ */
 export declare class Emitters implements IContainerPlugin {
     private readonly container;
     array: EmitterInstance[];

package/browser/Plugins/Emitters/Emitters.js

@@ -2,6 +2,9 @@ import { EmitterInstance } from "./EmitterInstance";
 import { Emitter } from "./Options/Classes/Emitter";
 import { EmitterClickMode } from "./Enums";
 import { deepExtend, itemFromArray } from "../../Utils";
+/**
+ * @category Emitters Plugin
+ */
 export class Emitters {
     constructor(container) {
         this.container = container;

package/browser/Plugins/Emitters/Enums/EmitterClickMode.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @category Emitters Plugin
+ */
 export declare enum EmitterClickMode {
     emitter = "emitter"
 }

package/browser/Plugins/Emitters/Enums/EmitterClickMode.js

@@ -1,3 +1,6 @@
+/**
+ * @category Emitters Plugin
+ */
 export var EmitterClickMode;
 (function (EmitterClickMode) {
     EmitterClickMode["emitter"] = "emitter";

package/browser/Plugins/Emitters/Options/Classes/Emitter.d.ts

@@ -9,6 +9,10 @@ import { EmitterSize } from "./EmitterSize";
 import type { IOptionLoader } from "../../../../Options/Interfaces/IOptionLoader";
 import { AnimatableColor } from "../../../../Options/Classes/AnimatableColor";
 import { EmitterShapeType } from "../../Enums";
+/**
+ * [[include:Options/Plugins/Emitters.md]]
+ * @category Emitters Plugin
+ */
 export declare class Emitter implements IEmitter, IOptionLoader<IEmitter> {
     autoPlay: boolean;
     size?: EmitterSize;

package/browser/Plugins/Emitters/Options/Classes/Emitter.js

@@ -4,6 +4,10 @@ import { deepExtend } from "../../../../Utils";
 import { EmitterSize } from "./EmitterSize";
 import { AnimatableColor } from "../../../../Options/Classes/AnimatableColor";
 import { EmitterShapeType } from "../../Enums";
+/**
+ * [[include:Options/Plugins/Emitters.md]]
+ * @category Emitters Plugin
+ */
 export class Emitter {
     constructor() {
         this.autoPlay = true;

package/browser/Plugins/Emitters/Options/Classes/EmitterLife.d.ts

@@ -1,6 +1,9 @@
 import type { IEmitterLife } from "../Interfaces/IEmitterLife";
 import type { RecursivePartial } from "../../../../Types";
 import type { IOptionLoader } from "../../../../Options/Interfaces/IOptionLoader";
+/**
+ * @category Emitters Plugin
+ */
 export declare class EmitterLife implements IEmitterLife, IOptionLoader<IEmitterLife> {
     count?: number;
     delay?: number;

package/browser/Plugins/Emitters/Options/Classes/EmitterLife.js

@@ -1,3 +1,6 @@
+/**
+ * @category Emitters Plugin
+ */
 export class EmitterLife {
     constructor() {
         this.wait = false;

package/browser/Plugins/Emitters/Options/Classes/EmitterRate.d.ts

@@ -1,6 +1,9 @@
 import type { IEmitterRate } from "../Interfaces/IEmitterRate";
 import type { RangeValue, RecursivePartial } from "../../../../Types";
 import type { IOptionLoader } from "../../../../Options/Interfaces/IOptionLoader";
+/**
+ * @category Emitters Plugin
+ */
 export declare class EmitterRate implements IEmitterRate, IOptionLoader<IEmitterRate> {
     quantity: RangeValue;
     delay: RangeValue;

package/browser/Plugins/Emitters/Options/Classes/EmitterRate.js

@@ -1,4 +1,7 @@
 import { setRangeValue } from "../../../../Utils";
+/**
+ * @category Emitters Plugin
+ */
 export class EmitterRate {
     constructor() {
         this.quantity = 1;

package/browser/Plugins/Emitters/Options/Classes/EmitterSize.d.ts

@@ -2,6 +2,9 @@ import type { IEmitterSize } from "../Interfaces/IEmitterSize";
 import type { RecursivePartial } from "../../../../Types";
 import { SizeMode } from "../../../../Enums";
 import type { IOptionLoader } from "../../../../Options/Interfaces/IOptionLoader";
+/**
+ * @category Emitters Plugin
+ */
 export declare class EmitterSize implements IEmitterSize, IOptionLoader<IEmitterSize> {
     mode: SizeMode | keyof typeof SizeMode;
     height: number;

package/browser/Plugins/Emitters/Options/Classes/EmitterSize.js

@@ -1,4 +1,7 @@
 import { SizeMode } from "../../../../Enums";
+/**
+ * @category Emitters Plugin
+ */
 export class EmitterSize {
     constructor() {
         this.mode = SizeMode.percent;

package/browser/Plugins/Emitters/Options/Interfaces/IEmitter.d.ts

@@ -7,17 +7,61 @@ import type { RecursivePartial } from "../../../../Types";
 import type { IEmitterSize } from "./IEmitterSize";
 import type { IAnimatableColor } from "../../../../Options/Interfaces/IAnimatableColor";
 import type { EmitterShapeType } from "../../Enums/EmitterShapeType";
+/**
+ * Particles emitter object options
+ * [[include:Options/Plugins/Emitters.md]]
+ * @category Emitters Plugin
+ */
 export interface IEmitter {
+    /**
+     * Starts the emitter automatically
+     */
     autoPlay: boolean;
+    /**
+     * The size of the particles emitter area
+     */
     size?: IEmitterSize;
+    /**
+     * The direction of the emitted particles, [[MoveDirection]] is the enum used for values
+     */
     direction?: MoveDirection | keyof typeof MoveDirection | MoveDirectionAlt | number;
+    /**
+     * Sets if the particles will spawn at the emitter perimeter or inside the area
+     */
     fill: boolean;
+    /**
+     * The emitter life options
+     */
     life: IEmitterLife;
+    /**
+     * The emitter name
+     */
     name?: string;
+    /**
+     * Particles emitted customization.
+     * These settings will overrides other particles settings for the particles emitted by this emitter
+     * Particles number options won't override anything, they will be ignored completely
+     */
     particles?: RecursivePartial<IParticles>;
+    /**
+     * The relative position (in percent) of the emitter, where particles spawns.
+     * If size is specified the position will be the center of the size options
+     */
     position?: RecursivePartial<ICoordinates>;
+    /**
+     * The particles emitting rate options
+     */
     rate: IEmitterRate;
+    /**
+     * The emitter shape type (circle or square)
+     */
     shape: EmitterShapeType | keyof typeof EmitterShapeType;
+    /**
+     * The particle spawn color
+     */
     spawnColor?: IAnimatableColor;
+    /**
+     * The number of starting particles of the emitter
+     */
     startCount: number;
 }

package/browser/Plugins/Emitters/Options/Interfaces/IEmitterLife.d.ts

@@ -1,6 +1,25 @@
+/**
+ * The particles emitter life options
+ * @category Emitters Plugin
+ */
 export interface IEmitterLife {
+    /**
+     * The count of lives the particles emitter has.
+     * If <= 0 or not specified infinity will be the value.
+     * If the count is > 0 it will spawn only that number of times then it'll be destroyed and removed
+     */
     count?: number;
+    /**
+     * The duration of any emitter life.
+     * If <= 0 or not specified infinity will be the value.
+     */
     duration?: number;
+    /**
+     * The delay between any spawn, except first.
+     */
     delay?: number;
+    /**
+     * If enabled the first delay will be applied
+     */
     wait: boolean;
 }

package/browser/Plugins/Emitters/Options/Interfaces/IEmitterOptions.d.ts

@@ -2,6 +2,9 @@ import type { SingleOrMultiple } from "../../../../Types";
 import type { IEmitter } from "./IEmitter";
 import type { IInteractivity } from "../../../../Options/Interfaces/Interactivity/IInteractivity";
 import type { IModes } from "../../../../Options/Interfaces/Interactivity/Modes/IModes";
+/**
+ * @category Emitters Plugin
+ */
 export interface IEmitterOptions {
     emitters: SingleOrMultiple<IEmitter>;
     interactivity: IInteractivity & {

package/browser/Plugins/Emitters/Options/Interfaces/IEmitterRate.d.ts

@@ -1,5 +1,16 @@
+/**
+ * The particles emitter rate options
+ * @category Emitters Plugin
+ */
 import type { RangeValue } from "../../../../Types";
 export interface IEmitterRate {
+    /**
+     * The emitting velocity, how many seconds will pass between the next particles creation
+     * Decimal values allowed
+     */
     delay: RangeValue;
+    /**
+     * The emitting quantity, how many particles will be created at every creation event
+     */
     quantity: RangeValue;
 }

package/browser/Plugins/Emitters/Options/Interfaces/IEmitterSize.d.ts

@@ -1,5 +1,8 @@
 import type { SizeMode } from "../../../../Enums";
 import type { IDimension } from "../../../../Core/Interfaces/IDimension";
+/**
+ * @category Emitters Plugin
+ */
 export interface IEmitterSize extends IDimension {
     mode: SizeMode | keyof typeof SizeMode;
 }

package/browser/Plugins/Emitters/Shapes/Square/SquareShape.js

@@ -13,22 +13,26 @@ export class SquareShape {
             const halfW = offset.x / 2, halfH = offset.y / 2, side = Math.floor(Math.random() * 4), v = (Math.random() - 0.5) * 2;
             switch (side) {
                 case 0:
+                    // top-left
                     return {
                         x: position.x + v * halfW,
                         y: position.y - halfH,
                     };
                 case 1:
+                    // top-right
                     return {
                         x: position.x - halfW,
                         y: position.y + v * halfH,
                     };
                 case 2:
+                    // bottom-right
                     return {
                         x: position.x + v * halfW,
                         y: position.y + halfH,
                     };
                 case 3:
                 default:
+                    // bottom-left
                     return {
                         x: position.x + halfW,
                         y: position.y + v * halfH,

package/browser/Plugins/Emitters/plugin.d.ts

@@ -1,3 +1,3 @@
 import { EmittersMain } from "./EmittersMain";
-export declare function loadEmittersPlugin(tsParticles: EmittersMain): void;
+export declare function loadEmittersPlugin(tsParticles: EmittersMain): Promise<void>;
 export * from "./EmittersMain";

package/browser/Plugins/Emitters/plugin.js

@@ -5,6 +5,9 @@ import { Emitter } from "./Options/Classes/Emitter";
 import { ShapeManager } from "./ShapeManager";
 import { CircleShape } from "./Shapes/Circle/CircleShape";
 import { SquareShape } from "./Shapes/Square/SquareShape";
+/**
+ * @category Emitters Plugin
+ */
 class EmittersPlugin {
     constructor() {
         this.id = "emitters";
@@ -64,9 +67,9 @@ class EmittersPlugin {
         }
     }
 }
-export function loadEmittersPlugin(tsParticles) {
+export async function loadEmittersPlugin(tsParticles) {
     const plugin = new EmittersPlugin();
-    tsParticles.addPlugin(plugin);
+    await tsParticles.addPlugin(plugin);
     if (!tsParticles.addEmitterShape) {
         tsParticles.addEmitterShape = (name, shape) => {
             ShapeManager.addShape(name, shape);

package/browser/Plugins/PolygonMask/Options/Classes/Draw.d.ts

@@ -3,10 +3,25 @@ import { DrawStroke } from "./DrawStroke";
 import type { RecursivePartial } from "../../../../Types";
 import { OptionsColor } from "../../../../Options/Classes/OptionsColor";
 import type { IOptionLoader } from "../../../../Options/Interfaces/IOptionLoader";
+/**
+ * @category Polygon Mask Plugin
+ */
 export declare class Draw implements IDraw, IOptionLoader<IDraw> {
+    /**
+     * @deprecated the property lineWidth is deprecated, please use the new stroke.width
+     */
     get lineWidth(): number;
+    /**
+     * @deprecated the property lineWidth is deprecated, please use the new stroke.width
+     */
     set lineWidth(value: number);
+    /**
+     * @deprecated the property lineColor is deprecated, please use the new stroke.color
+     */
     get lineColor(): string | OptionsColor;
+    /**
+     * @deprecated the property lineColor is deprecated, please use the new stroke.color
+     */
     set lineColor(value: string | OptionsColor);
     enable: boolean;
     stroke: DrawStroke;

package/browser/Plugins/PolygonMask/Options/Classes/Draw.js

@@ -1,19 +1,34 @@
 import { DrawStroke } from "./DrawStroke";
 import { OptionsColor } from "../../../../Options/Classes/OptionsColor";
+/**
+ * @category Polygon Mask Plugin
+ */
 export class Draw {
     constructor() {
         this.enable = false;
         this.stroke = new DrawStroke();
     }
+    /**
+     * @deprecated the property lineWidth is deprecated, please use the new stroke.width
+     */
     get lineWidth() {
         return this.stroke.width;
     }
+    /**
+     * @deprecated the property lineWidth is deprecated, please use the new stroke.width
+     */
     set lineWidth(value) {
         this.stroke.width = value;
     }
+    /**
+     * @deprecated the property lineColor is deprecated, please use the new stroke.color
+     */
     get lineColor() {
         return this.stroke.color;
     }
+    /**
+     * @deprecated the property lineColor is deprecated, please use the new stroke.color
+     */
     set lineColor(value) {
         this.stroke.color = OptionsColor.create(this.stroke.color, value);
     }

package/browser/Plugins/PolygonMask/Options/Classes/DrawStroke.d.ts

@@ -2,6 +2,9 @@ import type { IDrawStroke } from "../Interfaces/IDrawStroke";
 import type { RecursivePartial } from "../../../../Types";
 import { OptionsColor } from "../../../../Options/Classes/OptionsColor";
 import type { IOptionLoader } from "../../../../Options/Interfaces/IOptionLoader";
+/**
+ * @category Polygon Mask Plugin
+ */
 export declare class DrawStroke implements IDrawStroke, IOptionLoader<IDrawStroke> {
     color: OptionsColor;
     width: number;

package/browser/Plugins/PolygonMask/Options/Classes/DrawStroke.js

@@ -1,5 +1,8 @@
 import { OptionsColor } from "../../../../Options/Classes/OptionsColor";
 import { stringToAlpha } from "../../../../Utils";
+/**
+ * @category Polygon Mask Plugin
+ */
 export class DrawStroke {
     constructor() {
         this.color = new OptionsColor();

package/browser/Plugins/PolygonMask/Options/Classes/Inline.d.ts

@@ -2,6 +2,9 @@ import type { IInline } from "../Interfaces/IInline";
 import { InlineArrangement, InlineArrangementAlt } from "../../Enums";
 import type { RecursivePartial } from "../../../../Types";
 import type { IOptionLoader } from "../../../../Options/Interfaces/IOptionLoader";
+/**
+ * @category Polygon Mask Plugin
+ */
 export declare class Inline implements IInline, IOptionLoader<IInline> {
     arrangement: InlineArrangement | keyof typeof InlineArrangement | InlineArrangementAlt;
     constructor();

package/browser/Plugins/PolygonMask/Options/Classes/Inline.js

@@ -1,4 +1,7 @@
 import { InlineArrangement } from "../../Enums";
+/**
+ * @category Polygon Mask Plugin
+ */
 export class Inline {
     constructor() {
         this.arrangement = InlineArrangement.onePerPoint;

package/browser/Plugins/PolygonMask/Options/Classes/LocalSvg.d.ts

@@ -3,6 +3,9 @@ import type { SingleOrMultiple } from "../../../../Types";
 import type { IDimension } from "../../../../Core/Interfaces/IDimension";
 import type { RecursivePartial } from "../../../../Types";
 import type { IOptionLoader } from "../../../../Options/Interfaces/IOptionLoader";
+/**
+ * @category Polygon Mask Plugin
+ */
 export declare class LocalSvg implements ILocalSvg, IOptionLoader<ILocalSvg> {
     path: SingleOrMultiple<string>;
     size: IDimension;

package/browser/Plugins/PolygonMask/Options/Classes/LocalSvg.js

@@ -1,3 +1,6 @@
+/**
+ * @category Polygon Mask Plugin
+ */
 export class LocalSvg {
     constructor() {
         this.path = [];

package/browser/Plugins/PolygonMask/Options/Classes/Move.d.ts

@@ -2,6 +2,9 @@ import type { IMove } from "../Interfaces/IMove";
 import type { RecursivePartial } from "../../../../Types";
 import { MoveType } from "../../Enums";
 import type { IOptionLoader } from "../../../../Options/Interfaces/IOptionLoader";
+/**
+ * @category Polygon Mask Plugin
+ */
 export declare class Move implements IMove, IOptionLoader<IMove> {
     radius: number;
     type: MoveType | keyof typeof MoveType;

package/browser/Plugins/PolygonMask/Options/Classes/Move.js

@@ -1,4 +1,7 @@
 import { MoveType } from "../../Enums";
+/**
+ * @category Polygon Mask Plugin
+ */
 export class Move {
     constructor() {
         this.radius = 10;

package/browser/Plugins/PolygonMask/Options/Classes/PolygonMask.d.ts

@@ -7,8 +7,18 @@ import type { RecursivePartial } from "../../../../Types";
 import type { ICoordinates } from "../../../../Core/Interfaces/ICoordinates";
 import { LocalSvg } from "./LocalSvg";
 import type { IOptionLoader } from "../../../../Options/Interfaces/IOptionLoader";
+/**
+ * [[include:Options/Plugins/PolygonMask.md]]
+ * @category Polygon Mask Plugin
+ */
 export declare class PolygonMask implements IPolygonMask, IOptionLoader<IPolygonMask> {
+    /**
+     * @deprecated the property inlineArrangement is deprecated, please use the new inline.arrangement
+     */
     get inlineArrangement(): InlineArrangement | keyof typeof InlineArrangement | InlineArrangementAlt;
+    /**
+     * @deprecated the property inlineArrangement is deprecated, please use the new inline.arrangement
+     */
     set inlineArrangement(value: InlineArrangement | keyof typeof InlineArrangement | InlineArrangementAlt);
     draw: Draw;
     enable: boolean;

package/browser/Plugins/PolygonMask/Options/Classes/PolygonMask.js

@@ -4,6 +4,10 @@ import { Move } from "./Move";
 import { Inline } from "./Inline";
 import { LocalSvg } from "./LocalSvg";
 import { deepExtend } from "../../../../Utils";
+/**
+ * [[include:Options/Plugins/PolygonMask.md]]
+ * @category Polygon Mask Plugin
+ */
 export class PolygonMask {
     constructor() {
         this.draw = new Draw();
@@ -13,9 +17,15 @@ export class PolygonMask {
         this.scale = 1;
         this.type = Type.none;
     }
+    /**
+     * @deprecated the property inlineArrangement is deprecated, please use the new inline.arrangement
+     */
     get inlineArrangement() {
         return this.inline.arrangement;
     }
+    /**
+     * @deprecated the property inlineArrangement is deprecated, please use the new inline.arrangement
+     */
     set inlineArrangement(value) {
         this.inline.arrangement = value;
     }