Skip to content

Commit

Permalink
version 1.1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
stagas committed Jan 22, 2022
1 parent a640be5 commit 7f83ab5
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 9 deletions.
34 changes: 26 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,8 @@ plots[3].data = [1, 0, -1, 0, 1, 0, -1]
#### Table of Contents

* [HTMLPlotElement](#htmlplotelement)
* [width](#width)
* [height](#height)
* [pixelRatio](#pixelratio)
* [data](#data)
* [zoom](#zoom)
Expand All @@ -81,7 +83,7 @@ plots[3].data = [1, 0, -1, 0, 1, 0, -1]

### HTMLPlotElement

[src/index.ts:16-31](https://github.com/stagas/x-plot/blob/ee44628f82ef104d66d92f586d1fe092c56c922c/src/index.ts#L16-L31 "Source code on GitHub")
[src/index.ts:16-35](https://github.com/stagas/x-plot/blob/a640be5f18b0fcb72a1f4c74d00d651b0f2950d2/src/index.ts#L16-L35 "Source code on GitHub")

Plot settings.

Expand All @@ -93,57 +95,73 @@ i.e lineWidth => line-width
The `data` can only be set directly at the element instance
for example acquiring it through a `querySelector()`.

#### width

[src/index.ts:18-18](https://github.com/stagas/x-plot/blob/a640be5f18b0fcb72a1f4c74d00d651b0f2950d2/src/index.ts#L18-L18 "Source code on GitHub")

Width of plot

Type: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)

#### height

[src/index.ts:20-20](https://github.com/stagas/x-plot/blob/a640be5f18b0fcb72a1f4c74d00d651b0f2950d2/src/index.ts#L20-L20 "Source code on GitHub")

Height of plot

Type: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)

#### pixelRatio

[src/index.ts:18-18](https://github.com/stagas/x-plot/blob/ee44628f82ef104d66d92f586d1fe092c56c922c/src/index.ts#L18-L18 "Source code on GitHub")
[src/index.ts:22-22](https://github.com/stagas/x-plot/blob/a640be5f18b0fcb72a1f4c74d00d651b0f2950d2/src/index.ts#L22-L22 "Source code on GitHub")

The pixel ratio. Defaults to `window.devicePixelRatio`

Type: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)

#### data

[src/index.ts:20-20](https://github.com/stagas/x-plot/blob/ee44628f82ef104d66d92f586d1fe092c56c922c/src/index.ts#L20-L20 "Source code on GitHub")
[src/index.ts:24-24](https://github.com/stagas/x-plot/blob/a640be5f18b0fcb72a1f4c74d00d651b0f2950d2/src/index.ts#L24-L24 "Source code on GitHub")

Array-like number data to plot

Type: [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)>

#### zoom

[src/index.ts:22-22](https://github.com/stagas/x-plot/blob/ee44628f82ef104d66d92f586d1fe092c56c922c/src/index.ts#L22-L22 "Source code on GitHub")
[src/index.ts:26-26](https://github.com/stagas/x-plot/blob/a640be5f18b0fcb72a1f4c74d00d651b0f2950d2/src/index.ts#L26-L26 "Source code on GitHub")

Zoom amount

Type: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)

#### autoresize

[src/index.ts:24-24](https://github.com/stagas/x-plot/blob/ee44628f82ef104d66d92f586d1fe092c56c922c/src/index.ts#L24-L24 "Source code on GitHub")
[src/index.ts:28-28](https://github.com/stagas/x-plot/blob/a640be5f18b0fcb72a1f4c74d00d651b0f2950d2/src/index.ts#L28-L28 "Source code on GitHub")

Autoresize

Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)

#### lineWidth

[src/index.ts:26-26](https://github.com/stagas/x-plot/blob/ee44628f82ef104d66d92f586d1fe092c56c922c/src/index.ts#L26-L26 "Source code on GitHub")
[src/index.ts:30-30](https://github.com/stagas/x-plot/blob/a640be5f18b0fcb72a1f4c74d00d651b0f2950d2/src/index.ts#L30-L30 "Source code on GitHub")

Line width

Type: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)

#### background

[src/index.ts:28-28](https://github.com/stagas/x-plot/blob/ee44628f82ef104d66d92f586d1fe092c56c922c/src/index.ts#L28-L28 "Source code on GitHub")
[src/index.ts:32-32](https://github.com/stagas/x-plot/blob/a640be5f18b0fcb72a1f4c74d00d651b0f2950d2/src/index.ts#L32-L32 "Source code on GitHub")

Background color

Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)

#### color

[src/index.ts:30-30](https://github.com/stagas/x-plot/blob/ee44628f82ef104d66d92f586d1fe092c56c922c/src/index.ts#L30-L30 "Source code on GitHub")
[src/index.ts:34-34](https://github.com/stagas/x-plot/blob/a640be5f18b0fcb72a1f4c74d00d651b0f2950d2/src/index.ts#L34-L34 "Source code on GitHub")

Stroke color

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"author": "stagas",
"short": "stagas/x-plot",
"description": "a web component that plots zoomable waveforms",
"version": "1.1.1",
"version": "1.1.2",
"license": "MIT",
"repository": {
"type": "git",
Expand Down

0 comments on commit 7f83ab5

Please sign in to comment.