Skip to content

Commit 7a21c2c

Browse files
brandongregoryscottbrandongregoryscott
committed
0.3.0
1 parent 09a736c commit 7a21c2c

File tree

94 files changed

+12177
-179
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

94 files changed

+12177
-179
lines changed

‎docs/README.md‎

Lines changed: 1658 additions & 7 deletions
Large diffs are not rendered by default.

‎docs/classes/basecanvasdrawtool.md‎

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
[andculturecode-javascript-react-components](../README.md) › [BaseCanvasDrawTool](basecanvasdrawtool.md)
2+
3+
# Class: BaseCanvasDrawTool
4+
5+
## Hierarchy
6+
7+
* **BaseCanvasDrawTool**
8+
9+
↳ [LineCanvasDrawTool](linecanvasdrawtool.md)
10+
11+
↳ [PencilCanvasDrawTool](pencilcanvasdrawtool.md)
12+
13+
## Index
14+
15+
### Constructors
16+
17+
* [constructor](basecanvasdrawtool.md#constructor)
18+
19+
### Properties
20+
21+
* [_canvas](basecanvasdrawtool.md#protected-_canvas)
22+
* [_color](basecanvasdrawtool.md#protected-_color)
23+
* [_config](basecanvasdrawtool.md#protected-_config)
24+
* [_context](basecanvasdrawtool.md#protected-_context)
25+
* [_currentPosition](basecanvasdrawtool.md#protected-_currentposition)
26+
* [_isPointerActive](basecanvasdrawtool.md#protected-_ispointeractive)
27+
* [_previousPosition](basecanvasdrawtool.md#protected-_previousposition)
28+
* [_uiSettings](basecanvasdrawtool.md#protected-_uisettings)
29+
* [_width](basecanvasdrawtool.md#protected-_width)
30+
31+
### Methods
32+
33+
* [_onFinishStroke](basecanvasdrawtool.md#protected-_onfinishstroke)
34+
35+
## Constructors
36+
37+
### constructor
38+
39+
\+ **new BaseCanvasDrawTool**(`config`: [DrawToolConfig](../interfaces/drawtoolconfig.md)): *[BaseCanvasDrawTool](basecanvasdrawtool.md)*
40+
41+
*Defined in [src/atoms/forms/canvas-sketch/tools/base-canvas-draw-tool.ts:43](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React.Components/blob/09a736c/src/atoms/forms/canvas-sketch/tools/base-canvas-draw-tool.ts#L43)*
42+
43+
**Parameters:**
44+
45+
Name | Type |
46+
------ | ------ |
47+
`config` | [DrawToolConfig](../interfaces/drawtoolconfig.md) |
48+
49+
**Returns:** *[BaseCanvasDrawTool](basecanvasdrawtool.md)*
50+
51+
## Properties
52+
53+
### `Protected` _canvas
54+
55+
• **_canvas**: *HTMLCanvasElement*
56+
57+
*Defined in [src/atoms/forms/canvas-sketch/tools/base-canvas-draw-tool.ts:35](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React.Components/blob/09a736c/src/atoms/forms/canvas-sketch/tools/base-canvas-draw-tool.ts#L35)*
58+
59+
___
60+
61+
### `Protected` _color
62+
63+
• **_color**: *string*
64+
65+
*Defined in [src/atoms/forms/canvas-sketch/tools/base-canvas-draw-tool.ts:36](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React.Components/blob/09a736c/src/atoms/forms/canvas-sketch/tools/base-canvas-draw-tool.ts#L36)*
66+
67+
___
68+
69+
### `Protected` _config
70+
71+
• **_config**: *[DrawToolConfig](../interfaces/drawtoolconfig.md)*
72+
73+
*Defined in [src/atoms/forms/canvas-sketch/tools/base-canvas-draw-tool.ts:37](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React.Components/blob/09a736c/src/atoms/forms/canvas-sketch/tools/base-canvas-draw-tool.ts#L37)*
74+
75+
___
76+
77+
### `Protected` _context
78+
79+
• **_context**: *CanvasRenderingContext2D*
80+
81+
*Defined in [src/atoms/forms/canvas-sketch/tools/base-canvas-draw-tool.ts:38](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React.Components/blob/09a736c/src/atoms/forms/canvas-sketch/tools/base-canvas-draw-tool.ts#L38)*
82+
83+
___
84+
85+
### `Protected` _currentPosition
86+
87+
• **_currentPosition**: *[PointerPosition](../interfaces/pointerposition.md)*
88+
89+
*Defined in [src/atoms/forms/canvas-sketch/tools/base-canvas-draw-tool.ts:39](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React.Components/blob/09a736c/src/atoms/forms/canvas-sketch/tools/base-canvas-draw-tool.ts#L39)*
90+
91+
___
92+
93+
### `Protected` _isPointerActive
94+
95+
• **_isPointerActive**: *boolean*
96+
97+
*Defined in [src/atoms/forms/canvas-sketch/tools/base-canvas-draw-tool.ts:40](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React.Components/blob/09a736c/src/atoms/forms/canvas-sketch/tools/base-canvas-draw-tool.ts#L40)*
98+
99+
___
100+
101+
### `Protected` _previousPosition
102+
103+
• **_previousPosition**: *[PointerPosition](../interfaces/pointerposition.md)*
104+
105+
*Defined in [src/atoms/forms/canvas-sketch/tools/base-canvas-draw-tool.ts:41](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React.Components/blob/09a736c/src/atoms/forms/canvas-sketch/tools/base-canvas-draw-tool.ts#L41)*
106+
107+
___
108+
109+
### `Protected` _uiSettings
110+
111+
• **_uiSettings**: *[DrawToolUiSettings](../interfaces/drawtooluisettings.md)*
112+
113+
*Defined in [src/atoms/forms/canvas-sketch/tools/base-canvas-draw-tool.ts:42](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React.Components/blob/09a736c/src/atoms/forms/canvas-sketch/tools/base-canvas-draw-tool.ts#L42)*
114+
115+
___
116+
117+
### `Protected` _width
118+
119+
• **_width**: *number*
120+
121+
*Defined in [src/atoms/forms/canvas-sketch/tools/base-canvas-draw-tool.ts:43](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React.Components/blob/09a736c/src/atoms/forms/canvas-sketch/tools/base-canvas-draw-tool.ts#L43)*
122+
123+
## Methods
124+
125+
### `Protected` _onFinishStroke
126+
127+
▸ **_onFinishStroke**(`strokeSettings`: [CanvasDrawToolSettings](../interfaces/canvasdrawtoolsettings.md)): *void*
128+
129+
*Defined in [src/atoms/forms/canvas-sketch/tools/base-canvas-draw-tool.ts:65](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React.Components/blob/09a736c/src/atoms/forms/canvas-sketch/tools/base-canvas-draw-tool.ts#L65)*
130+
131+
**Parameters:**
132+
133+
Name | Type |
134+
------ | ------ |
135+
`strokeSettings` | [CanvasDrawToolSettings](../interfaces/canvasdrawtoolsettings.md) |
136+
137+
**Returns:** *void*

‎docs/classes/basecanvastool.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
[andculturecode-javascript-react-components](../README.md) › [BaseCanvasTool](basecanvastool.md)
2+
3+
# Class: BaseCanvasTool
4+
5+
## Hierarchy
6+
7+
* **BaseCanvasTool**
8+
9+
## Index
10+
11+
### Constructors
12+
13+
* [constructor](basecanvastool.md#constructor)
14+
15+
### Properties
16+
17+
* [_canvas](basecanvastool.md#protected-_canvas)
18+
* [_config](basecanvastool.md#protected-_config)
19+
* [_context](basecanvastool.md#protected-_context)
20+
21+
## Constructors
22+
23+
### constructor
24+
25+
\+ **new BaseCanvasTool**(`toolConfig`: [ToolConfig](../interfaces/toolconfig.md)): *[BaseCanvasTool](basecanvastool.md)*
26+
27+
*Defined in [src/atoms/forms/canvas-sketch/tools/base-canvas-tool.ts:30](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React.Components/blob/09a736c/src/atoms/forms/canvas-sketch/tools/base-canvas-tool.ts#L30)*
28+
29+
**Parameters:**
30+
31+
Name | Type |
32+
------ | ------ |
33+
`toolConfig` | [ToolConfig](../interfaces/toolconfig.md) |
34+
35+
**Returns:** *[BaseCanvasTool](basecanvastool.md)*
36+
37+
## Properties
38+
39+
### `Protected` _canvas
40+
41+
• **_canvas**: *HTMLCanvasElement*
42+
43+
*Defined in [src/atoms/forms/canvas-sketch/tools/base-canvas-tool.ts:28](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React.Components/blob/09a736c/src/atoms/forms/canvas-sketch/tools/base-canvas-tool.ts#L28)*
44+
45+
___
46+
47+
### `Protected` _config
48+
49+
• **_config**: *[ToolConfig](../interfaces/toolconfig.md)*
50+
51+
*Defined in [src/atoms/forms/canvas-sketch/tools/base-canvas-tool.ts:29](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React.Components/blob/09a736c/src/atoms/forms/canvas-sketch/tools/base-canvas-tool.ts#L29)*
52+
53+
___
54+
55+
### `Protected` _context
56+
57+
• **_context**: *CanvasRenderingContext2D*
58+
59+
*Defined in [src/atoms/forms/canvas-sketch/tools/base-canvas-tool.ts:30](https://github.com/AndcultureCode/AndcultureCode.JavaScript.React.Components/blob/09a736c/src/atoms/forms/canvas-sketch/tools/base-canvas-tool.ts#L30)*

0 commit comments

Comments
 (0)