Skip to content

Add element diagrams to the annotation types guide #760

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 8, 2022
Merged

Add element diagrams to the annotation types guide #760

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/guide/types/box.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,3 +138,11 @@ A position can be set in 2 different values types:
If this value is a string (possible options are `'start'`, `'center'`, `'end'` or a string in percentage format), it is applied to vertical and horizontal position in the box.

If this value is an object, the `x` property defines the horizontal alignment in the box. Similarly, the `y` property defines the vertical alignment in the box. Possible options for both properties are `'start'`, `'center'`, `'end'`, a string in percentage format. Omitted property have value of the default, `'center'`.

## Element

The following diagram is showing the element properties about a `'box'` annotation:

![box](../../img/elementBoxProps.png)

The label of a box annotation is described as a [label annotation](./label#element) and accessible by `element.label`.
6 changes: 6 additions & 0 deletions docs/guide/types/ellipse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,3 +91,9 @@ If one of the axes does not match an axis in the chart, the ellipse will take th
| `shadowBlur` | The amount of blur applied to shadow. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowBlur).
| `shadowOffsetX` | The distance that shadow will be offset horizontally. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetX).
| `shadowOffsetY` | The distance that shadow will be offset vertically. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetY).

## Element

The following diagram is showing the element properties about a `'ellipse'` annotation:

![ellipse](../../img/elementEllipseProps.png)
6 changes: 6 additions & 0 deletions docs/guide/types/label.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,3 +217,9 @@ All of these options can be [Scriptable](../options#scriptable-options).
| `position` | `string` | `'auto'` | The position of callout, with respect to the label. Could be `left`, `top`, `right`, `bottom` or `auto`.
| `side` | `number` | `5` | Width of the starter line of callout pointer.
| `start` | `number`\|`string` | `'50%'` | The percentage of the separator dimension to use as starting point for callout pointer. Could be set in pixel by a number, or in percentage of the separator dimension by a string.

## Element

The following diagram is showing the element properties about a `'label'` annotation:

![label](../../img/elementLabelProps.png)
8 changes: 8 additions & 0 deletions docs/guide/types/line.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,3 +184,11 @@ All of these options can be [Scriptable](../options#scriptable-options)
| `shadowOffsetX` | `number` | `lineAnnotation.shadowOffsetX` | The distance that shadow, of the arrow head, will be offset horizontally. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetX).
| `shadowOffsetY` | `number` | `lineAnnotation.shadowOffsetY` | The distance that shadow, of the arrow head, will be offset vertically. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetY).
| `width` | `number` | `6` | The width of the arrow head in pixels.

## Element

The following diagram is showing the element properties about a `'line'` annotation:

![line](../../img/elementLineProps.png)

The label of a box annotation is described as a [label annotation](./label#element) and accessible by `element.label`.
6 changes: 6 additions & 0 deletions docs/guide/types/point.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,3 +103,9 @@ The 4 coordinates, xMin, xMax, yMin, yMax are optional. If not specified, the bo
| `shadowBlur` | The amount of blur applied to shadow. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowBlur).
| `shadowOffsetX` | The distance that shadow will be offset horizontally. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetX).
| `shadowOffsetY` | The distance that shadow will be offset vertically. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetY).

## Element

The following diagram is showing the element properties about a `'point'` annotation:

![point](../../img/elementPointProps.png)
6 changes: 6 additions & 0 deletions docs/guide/types/polygon.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,3 +165,9 @@ module.exports = {
config
};
```

## Element

The following diagram is showing the element properties about a `'polygon'` annotation:

![polygon](../../img/elementPolygonProps.png)