pencil.js / particles / ParticlesOptions
Interface: ParticlesOptions
Defined in: particles.ts:35
Particles options
Extends
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
args | unknown[] | Arguments passed to the generator function | - | particles.ts:41 |
cap? | CanvasLineCap | How lines end | ComponentOptions.cap | component.ts:85 |
clip | | Component<ComponentOptions> | null | Other component used to clip the rendering | ComponentOptions.clip | container.ts:26 |
cursor | string | null | Cursor to use when hover | ComponentOptions.cursor | component.ts:81 |
dashed | boolean | number[] | Should the line be dashed, you can also specify the dash pattern (ex: [4, 4] or Component.dashes.dots) | ComponentOptions.dashed | component.ts:79 |
emit | number | [number, number] | null | Number (or range) of particles emitted | - | particles.ts:39 |
fill | Style | Color used to fill, set to null for transparent | ComponentOptions.fill | component.ts:73 |
frequency | number | Probability of emission at each frame (between 0 and 1) | - | particles.ts:37 |
join | CanvasLineJoin | How lines join between them | ComponentOptions.join | component.ts:83 |
opacity | number | null | Opacity level from 0 to 1 (multiplied with its parents opacity, null means 1) | ComponentOptions.opacity | container.ts:16 |
origin | | string | PositionDefinition | Relative offset (Rectangle based shapes also accept named origins like "center") | ComponentOptions.origin | component.ts:87 |
rotation | number | Rotation ratio from 0 to 1 (clockwise) | ComponentOptions.rotation | container.ts:18 |
rotationCenter | PositionDefinition | Center of rotation relative to this position | ComponentOptions.rotationCenter | container.ts:20 |
scale | | number | PositionDefinition | Scaling ratio or a pair of value for horizontal and vertical scaling | ComponentOptions.scale | container.ts:22 |
shadow | Partial<ShadowOptions> | Set of options to set a shadow | ComponentOptions.shadow | component.ts:89 |
shown | boolean | Is shown | ComponentOptions.shown | container.ts:14 |
stroke | Style | Color used to stroke, set to null for transparent | ComponentOptions.stroke | component.ts:75 |
strokeWidth | number | Stroke line thickness in pixels | ComponentOptions.strokeWidth | component.ts:77 |
zIndex | number | Depth ordering | ComponentOptions.zIndex | container.ts:24 |