Class SvgAnimation

Hierarchy

SvgAnimation

Index

Constructors

constructor

new SvgAnimation(el: HTMLElement, __namedParameters?: AnimationOption): SvgAnimation

- Defined in animation/src/animation.ts:30
Parameters
- el: HTMLElement
- __namedParameters: AnimationOption = ...
Returns SvgAnimation

Properties

Private _anim

_anim: null | FrameAnimation

Private _framesNumber

_framesNumber: undefined | number

Private _repeatCount

_repeatCount: string

Relation animate element TODO: add easing option

Private _restorePaths

_restorePaths: Path[]

Private _stopAnimation

_stopAnimation: null | (() => void)

Private _stopId

_stopId: number

Private prorperty

ms

ms: number

Options

renderer

renderer: Renderer

resizeHandler

resizeHandler: ResizeHandler

svg

svg: Svg

Modules

Methods

Private _getFramesNumber

_getFramesNumber(): number

- Defined in animation/src/animation.ts:241
Returns number
Default value is total of commands length.

Private _registerRestorePaths

_registerRestorePaths(): void

- Defined in animation/src/animation.ts:247
Returns void

Private _resize

_resize(__namedParameters: DOMRect | { height: number; left: number; top: number; width: number }): void

- Defined in animation/src/animation.ts:254
Parameters
- __namedParameters: DOMRect | { height: number; left: number; top: number; width: number }
Returns void

Private _startAnimation

_startAnimation(): void

- Defined in animation/src/animation.ts:102
Returns void

download

download(filename?: string): void

- Defined in animation/src/animation.ts:232
Parameters
- Optional filename: string
  
  TODO: Support gif and apng
Returns void

generateFrame

generateFrame(index?: number): Path[]

- Defined in animation/src/animation.ts:87
Parameters
- Optional index: number
Returns Path[]

restore

restore(): void

- Defined in animation/src/animation.ts:82
Returns void

setAnimation

setAnimation(fn: FrameAnimation, opts?: { frames?: number; ms?: number; repeatCount?: string | number }): void

- Defined in animation/src/animation.ts:59
Parameters
- fn: FrameAnimation
- opts: { frames?: number; ms?: number; repeatCount?: string | number } = {}
  
  frame is the number of frames to animate repeat is related for repeatCount of animate element attribute.
  - Optional frames?: number
  - Optional ms?: number
  - Optional repeatCount?: string | number
Returns void

start

start(): void

- Defined in animation/src/animation.ts:95
Returns void

stop

stop(): boolean

- Defined in animation/src/animation.ts:73
Returns boolean

toElement

toElement(): SVGSVGElement

- Defined in animation/src/animation.ts:132
Returns SVGSVGElement

update

update(): void

- Defined in animation/src/animation.ts:128
Returns void

Generated using TypeDoc