Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kmkzt committed Jun 14, 2022
1 parent 0c17b9c commit 0c89356
Show file tree
Hide file tree
Showing 23 changed files with 223 additions and 227 deletions.
54 changes: 27 additions & 27 deletions docs/packages/classes/svg_drawing_animation.SvgAnimation.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

#### Defined in

[animation/src/animation.ts:30](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/animation/src/animation.ts#L30)
[animation/src/animation.ts:30](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/animation/src/animation.ts#L30)

## Properties

Expand All @@ -29,7 +29,7 @@

#### Defined in

[animation/src/animation.ts:21](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/animation/src/animation.ts#L21)
[animation/src/animation.ts:21](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/animation/src/animation.ts#L21)

___

Expand All @@ -39,19 +39,19 @@ ___

#### Defined in

[animation/src/animation.ts:23](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/animation/src/animation.ts#L23)
[animation/src/animation.ts:23](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/animation/src/animation.ts#L23)

___

### \_repeatCount

`Private` **\_repeatCount**: `string`

Relation animate element TODO: add easing option
Relation animate element

#### Defined in

[animation/src/animation.ts:29](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/animation/src/animation.ts#L29)
[animation/src/animation.ts:29](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/animation/src/animation.ts#L29)

___

Expand All @@ -61,7 +61,7 @@ ___

#### Defined in

[animation/src/animation.ts:22](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/animation/src/animation.ts#L22)
[animation/src/animation.ts:22](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/animation/src/animation.ts#L22)

___

Expand All @@ -71,7 +71,7 @@ ___

#### Defined in

[animation/src/animation.ts:20](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/animation/src/animation.ts#L20)
[animation/src/animation.ts:20](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/animation/src/animation.ts#L20)

___

Expand All @@ -83,7 +83,7 @@ Private prorperty

#### Defined in

[animation/src/animation.ts:19](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/animation/src/animation.ts#L19)
[animation/src/animation.ts:19](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/animation/src/animation.ts#L19)

___

Expand All @@ -95,7 +95,7 @@ Options

#### Defined in

[animation/src/animation.ts:17](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/animation/src/animation.ts#L17)
[animation/src/animation.ts:17](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/animation/src/animation.ts#L17)

___

Expand All @@ -105,7 +105,7 @@ ___

#### Defined in

[animation/src/animation.ts:26](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/animation/src/animation.ts#L26)
[animation/src/animation.ts:26](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/animation/src/animation.ts#L26)

___

Expand All @@ -115,7 +115,7 @@ ___

#### Defined in

[animation/src/animation.ts:27](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/animation/src/animation.ts#L27)
[animation/src/animation.ts:27](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/animation/src/animation.ts#L27)

___

Expand All @@ -127,7 +127,7 @@ Modules

#### Defined in

[animation/src/animation.ts:25](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/animation/src/animation.ts#L25)
[animation/src/animation.ts:25](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/animation/src/animation.ts#L25)

## Methods

Expand All @@ -143,7 +143,7 @@ Default value is total of commands length.

#### Defined in

[animation/src/animation.ts:241](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/animation/src/animation.ts#L241)
[animation/src/animation.ts:241](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/animation/src/animation.ts#L241)

___

Expand All @@ -157,7 +157,7 @@ ___

#### Defined in

[animation/src/animation.ts:247](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/animation/src/animation.ts#L247)
[animation/src/animation.ts:247](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/animation/src/animation.ts#L247)

___

Expand All @@ -177,7 +177,7 @@ ___

#### Defined in

[animation/src/animation.ts:254](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/animation/src/animation.ts#L254)
[animation/src/animation.ts:254](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/animation/src/animation.ts#L254)

___

Expand All @@ -191,7 +191,7 @@ ___

#### Defined in

[animation/src/animation.ts:102](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/animation/src/animation.ts#L102)
[animation/src/animation.ts:102](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/animation/src/animation.ts#L102)

___

Expand All @@ -201,17 +201,17 @@ ___

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `filename?` | `string` | TODO: Support gif and apng |
| Name | Type |
| :------ | :------ |
| `filename?` | `string` |

#### Returns

`void`

#### Defined in

[animation/src/animation.ts:232](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/animation/src/animation.ts#L232)
[animation/src/animation.ts:232](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/animation/src/animation.ts#L232)

___

Expand All @@ -231,7 +231,7 @@ ___

#### Defined in

[animation/src/animation.ts:87](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/animation/src/animation.ts#L87)
[animation/src/animation.ts:87](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/animation/src/animation.ts#L87)

___

Expand All @@ -245,7 +245,7 @@ ___

#### Defined in

[animation/src/animation.ts:82](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/animation/src/animation.ts#L82)
[animation/src/animation.ts:82](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/animation/src/animation.ts#L82)

___

Expand All @@ -269,7 +269,7 @@ ___

#### Defined in

[animation/src/animation.ts:59](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/animation/src/animation.ts#L59)
[animation/src/animation.ts:59](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/animation/src/animation.ts#L59)

___

Expand All @@ -283,7 +283,7 @@ ___

#### Defined in

[animation/src/animation.ts:95](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/animation/src/animation.ts#L95)
[animation/src/animation.ts:95](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/animation/src/animation.ts#L95)

___

Expand All @@ -297,7 +297,7 @@ ___

#### Defined in

[animation/src/animation.ts:73](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/animation/src/animation.ts#L73)
[animation/src/animation.ts:73](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/animation/src/animation.ts#L73)

___

Expand All @@ -311,7 +311,7 @@ ___

#### Defined in

[animation/src/animation.ts:132](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/animation/src/animation.ts#L132)
[animation/src/animation.ts:132](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/animation/src/animation.ts#L132)

___

Expand All @@ -325,4 +325,4 @@ ___

#### Defined in

[animation/src/animation.ts:128](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/animation/src/animation.ts#L128)
[animation/src/animation.ts:128](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/animation/src/animation.ts#L128)
24 changes: 12 additions & 12 deletions docs/packages/classes/svg_drawing_core.Command.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

#### Defined in

[core/src/svg.ts:62](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/core/src/svg.ts#L62)
[core/src/svg.ts:62](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/core/src/svg.ts#L62)

## Properties

Expand All @@ -29,7 +29,7 @@

#### Defined in

[core/src/svg.ts:59](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/core/src/svg.ts#L59)
[core/src/svg.ts:59](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/core/src/svg.ts#L59)

___

Expand All @@ -39,7 +39,7 @@ ___

#### Defined in

[core/src/svg.ts:60](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/core/src/svg.ts#L60)
[core/src/svg.ts:60](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/core/src/svg.ts#L60)

## Accessors

Expand All @@ -53,7 +53,7 @@ ___

#### Defined in

[core/src/svg.ts:90](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/core/src/svg.ts#L90)
[core/src/svg.ts:90](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/core/src/svg.ts#L90)

`set` **cl**(`po`): `void`

Expand All @@ -69,7 +69,7 @@ ___

#### Defined in

[core/src/svg.ts:82](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/core/src/svg.ts#L82)
[core/src/svg.ts:82](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/core/src/svg.ts#L82)

___

Expand All @@ -83,7 +83,7 @@ ___

#### Defined in

[core/src/svg.ts:75](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/core/src/svg.ts#L75)
[core/src/svg.ts:75](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/core/src/svg.ts#L75)

`set` **cr**(`po`): `void`

Expand All @@ -99,7 +99,7 @@ ___

#### Defined in

[core/src/svg.ts:67](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/core/src/svg.ts#L67)
[core/src/svg.ts:67](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/core/src/svg.ts#L67)

___

Expand All @@ -113,7 +113,7 @@ ___

#### Defined in

[core/src/svg.ts:103](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/core/src/svg.ts#L103)
[core/src/svg.ts:103](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/core/src/svg.ts#L103)

`set` **point**(`po`): `void`

Expand All @@ -129,7 +129,7 @@ ___

#### Defined in

[core/src/svg.ts:98](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/core/src/svg.ts#L98)
[core/src/svg.ts:98](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/core/src/svg.ts#L98)

## Methods

Expand All @@ -143,7 +143,7 @@ ___

#### Defined in

[core/src/svg.ts:121](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/core/src/svg.ts#L121)
[core/src/svg.ts:121](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/core/src/svg.ts#L121)

___

Expand All @@ -163,7 +163,7 @@ ___

#### Defined in

[core/src/svg.ts:113](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/core/src/svg.ts#L113)
[core/src/svg.ts:113](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/core/src/svg.ts#L113)

___

Expand All @@ -177,4 +177,4 @@ ___

#### Defined in

[core/src/svg.ts:108](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/core/src/svg.ts#L108)
[core/src/svg.ts:108](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/core/src/svg.ts#L108)
12 changes: 6 additions & 6 deletions docs/packages/classes/svg_drawing_core.Convert.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

#### Defined in

[core/src/convert.ts:6](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/core/src/convert.ts#L6)
[core/src/convert.ts:6](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/core/src/convert.ts#L6)

## Properties

Expand All @@ -28,7 +28,7 @@

#### Defined in

[core/src/convert.ts:5](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/core/src/convert.ts#L5)
[core/src/convert.ts:5](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/core/src/convert.ts#L5)

## Methods

Expand All @@ -50,7 +50,7 @@

#### Defined in

[core/src/convert.ts:9](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/core/src/convert.ts#L9)
[core/src/convert.ts:9](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/core/src/convert.ts#L9)

___

Expand All @@ -73,7 +73,7 @@ ___

#### Defined in

[core/src/convert.ts:22](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/core/src/convert.ts#L22)
[core/src/convert.ts:22](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/core/src/convert.ts#L22)

___

Expand All @@ -93,7 +93,7 @@ ___

#### Defined in

[core/src/convert.ts:44](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/core/src/convert.ts#L44)
[core/src/convert.ts:44](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/core/src/convert.ts#L44)

___

Expand All @@ -113,4 +113,4 @@ ___

#### Defined in

[core/src/convert.ts:37](https://github.com/kmkzt/svg-drawing/blob/6dacb53/packages/core/src/convert.ts#L37)
[core/src/convert.ts:37](https://github.com/kmkzt/svg-drawing/blob/0c17b9c/packages/core/src/convert.ts#L37)
Loading

0 comments on commit 0c89356

Please sign in to comment.