Class Shape

Hierarchy

Shape

Implements

Index

Constructors

constructor

new Shape(): Shape
Returns Shape
- Defined in Options/Classes/Particles/Shape/Shape.ts:29

Properties

close

close: boolean

Set this property to false for creating an open shape

fill

fill: boolean

Set this property to false for creating an empty shape

`Private` `Readonly` loadShape

loadShape: (<T>(item, mainKey, altKey, altOverride) => void) = ...

Type declaration

- <T>(item, mainKey, altKey, altOverride): void
- Type Parameters
  - T extends IShapeValues
  Parameters
  - item: undefined | RecursivePartial<SingleOrMultiple<T>>
  - mainKey: string
  - altKey: string
  - altOverride: boolean
  Returns void

options

options: ShapeData

type

type: SingleOrMultiple<string>

Accessors

character

get character(): SingleOrMultiple<ICharacterShape>
Returns SingleOrMultiple<ICharacterShape>
the character options

Deprecated
this property was integrated in custom shape management
Implementation of IShape.character
- Defined in Options/Classes/Particles/Shape/Shape.ts:40
set character(value): void
Parameters
- value: SingleOrMultiple<ICharacterShape>
Returns void

Deprecated
this property was integrated in custom shape management
Implementation of IShape.character
- Defined in Options/Classes/Particles/Shape/Shape.ts:47

custom

get custom(): ShapeData
Returns ShapeData
the custom options

Deprecated
This options has been renamed options
Implementation of IShape.custom
- Defined in Options/Classes/Particles/Shape/Shape.ts:55
set custom(value): void
Parameters
- value: ShapeData
Returns void

Deprecated
This options has been renamed options
Implementation of IShape.custom
- Defined in Options/Classes/Particles/Shape/Shape.ts:63

image

get image(): SingleOrMultiple<IImageShape>
Returns SingleOrMultiple<IImageShape>
the image options

Deprecated
this property was integrated in custom shape management
Implementation of IShape.image
- Defined in Options/Classes/Particles/Shape/Shape.ts:71
set image(value): void
Parameters
- value: SingleOrMultiple<IImageShape>
Returns void

Deprecated
this property was integrated in custom shape management
Implementation of IShape.image
- Defined in Options/Classes/Particles/Shape/Shape.ts:79

images

get images(): SingleOrMultiple<IImageShape>
Returns SingleOrMultiple<IImageShape>
the image options

Deprecated
the property images is deprecated, please use the image property, it works with one and many
Implementation of IShape.images
- Defined in Options/Classes/Particles/Shape/Shape.ts:87
set images(value): void
Parameters
- value: SingleOrMultiple<IImageShape>
Returns void

Deprecated
the property images is deprecated, please use the image property, it works with one and many
Implementation of IShape.images
- Defined in Options/Classes/Particles/Shape/Shape.ts:95

polygon

get polygon(): SingleOrMultiple<IPolygonShape>
Returns SingleOrMultiple<IPolygonShape>
the polygon options

Deprecated
this property was integrated in custom shape management
Implementation of IShape.polygon
- Defined in Options/Classes/Particles/Shape/Shape.ts:103
set polygon(value): void
Parameters
- value: SingleOrMultiple<IPolygonShape>
Returns void

Deprecated
this property was integrated in custom shape management
Implementation of IShape.polygon
- Defined in Options/Classes/Particles/Shape/Shape.ts:111

stroke

get stroke(): SingleOrMultiple<Stroke>
Returns SingleOrMultiple<Stroke>
the stroke options

Deprecated
this property was moved to particles section
Implementation of IShape.stroke
- Defined in Options/Classes/Particles/Shape/Shape.ts:119
set stroke(_value): void
Parameters
- _value: SingleOrMultiple<Stroke>
Returns void

Deprecated
this property was moved to particles section
Implementation of IShape.stroke
- Defined in Options/Classes/Particles/Shape/Shape.ts:126

Methods

load

load(data?): void
This load method is used to load data in the classes used as generic
Parameters
- Optional data: RecursivePartial<IShape>
  
  the input options
Returns void
Implementation of IOptionLoader.load
- Defined in Options/Classes/Particles/Shape/Shape.ts:130

Class Shape

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Shape

Properties

close

fill

Private Readonly loadShape

Type declaration

Type Parameters

T extends IShapeValues

Parameters

item: undefined | RecursivePartial<SingleOrMultiple<T>>

mainKey: string

altKey: string

altOverride: boolean

Returns void

options

type

Accessors

character

Returns SingleOrMultiple<ICharacterShape>

Deprecated

Parameters

value: SingleOrMultiple<ICharacterShape>

Returns void

Deprecated

custom

Returns ShapeData

Deprecated

Parameters

value: ShapeData

Returns void

Deprecated

image

Returns SingleOrMultiple<IImageShape>

Deprecated

Parameters

value: SingleOrMultiple<IImageShape>

Returns void

Deprecated

images

Returns SingleOrMultiple<IImageShape>

Deprecated

Parameters

value: SingleOrMultiple<IImageShape>

Returns void

Deprecated

polygon

Returns SingleOrMultiple<IPolygonShape>

Deprecated

Parameters

value: SingleOrMultiple<IPolygonShape>

Returns void

Deprecated

stroke

Returns SingleOrMultiple<Stroke>

Deprecated

Parameters

_value: SingleOrMultiple<Stroke>

Returns void

Deprecated

Methods

load

Parameters

Optional data: RecursivePartial<IShape>

Returns void

Settings

Member Visibility

Theme

On This Page

`Private` `Readonly` loadShape

`Optional` data: RecursivePartial<IShape>