Fix linking in documentation
This commit is contained in:
parent
e4e7cdfdb2
commit
fcfa0c81c9
2 changed files with 28 additions and 28 deletions
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
## Manager
|
||||
|
||||
A Manager allows to manipulate multiple [Canvas](#Canvas) inside a DOM
|
||||
A Manager allows to manipulate multiple [Canvas](#canvas) inside a DOM
|
||||
element
|
||||
|
||||
### Manager.parent_element
|
||||
|
|
@ -15,7 +15,7 @@ DOM element containing every canvas Element
|
|||
|
||||
*property*: **list<Canvas>**
|
||||
|
||||
List of [Canvas](#Canvas) managed
|
||||
List of [Canvas](#canvas) managed
|
||||
|
||||
### Manager.add_canvas
|
||||
|
||||
|
|
@ -34,16 +34,16 @@ Height in pixel of the canvas Element. Default to 100
|
|||
- *position*(optional): **int**
|
||||
|
||||
Position of the added Canvas in the
|
||||
[parent_element](#Manager.parent_element) and in
|
||||
[list_canvas](#Manager.list_canvas). Default to 0
|
||||
[parent_element](#manager-parent_element) and in
|
||||
[list_canvas](#manager-list_canvas). Default to 0
|
||||
|
||||
Return:
|
||||
|
||||
**Canvas**: the created [Canvas](#Canvas)
|
||||
**Canvas**: the created [Canvas](#canvas)
|
||||
|
||||
### Manager.draw
|
||||
|
||||
Draw every managed [Canvas](#Canvas)
|
||||
Draw every managed [Canvas](#canvas)
|
||||
|
||||
### Manager.remove_canvas
|
||||
|
||||
|
|
@ -94,56 +94,56 @@ Height of the figure (related to each axes)
|
|||
|
||||
*property*: **list<Axes>**
|
||||
|
||||
List of [Axes](#Axes).
|
||||
List of [Axes](#axes).
|
||||
|
||||
### Figure.add_axes
|
||||
|
||||
Add an [Axes](#Axes) to this figure
|
||||
Add an [Axes](#axes) to this figure
|
||||
|
||||
Parameters:
|
||||
|
||||
- *width*(optional): **int**
|
||||
|
||||
Relative width of the new [Axes](#Axes). Default to 50
|
||||
Relative width of the new [Axes](#axes). Default to 50
|
||||
|
||||
- *height*(optional): **int**
|
||||
|
||||
Relative height of the new [Axes](#Axes). Default to 50
|
||||
Relative height of the new [Axes](#axes). Default to 50
|
||||
|
||||
- *position*(optional): **int**
|
||||
|
||||
Position of the new [Axes](#Axes) in the [list_axes](#Figure.list_axes).
|
||||
Position of the new [Axes](#axes) in the [list_axes](#figure-list_axes).
|
||||
Default to 0
|
||||
|
||||
Return:
|
||||
|
||||
**Axes**: Added [Axes](#Axes)
|
||||
**Axes**: Added [Axes](#axes)
|
||||
|
||||
### Figure.remove_axes
|
||||
|
||||
Remove an [Axes](#Axes) in a given position
|
||||
Remove an [Axes](#axes) in a given position
|
||||
|
||||
Parameters:
|
||||
|
||||
- *position*: **int**
|
||||
|
||||
Position of the [Axes](#Axes) to delete
|
||||
Position of the [Axes](#axes) to delete
|
||||
|
||||
## Axes
|
||||
|
||||
An Axes represents one plot in a [Figure](#Figure)
|
||||
An Axes represents one plot in a [Figure](#figure)
|
||||
|
||||
### Axes.width
|
||||
|
||||
*property*: **int**
|
||||
|
||||
Width of the axes (relative to the [Figure](#Figure))
|
||||
Width of the axes (relative to the [Figure](#figure))
|
||||
|
||||
### Axes.height
|
||||
|
||||
*property*: **int**
|
||||
|
||||
Height of the axes (relative to the [Figure](#Figure))
|
||||
Height of the axes (relative to the [Figure](#figure))
|
||||
|
||||
### Axes.title
|
||||
|
||||
|
|
|
|||
|
|
@ -25,23 +25,23 @@ manager.add_canvas(500, 500).figure.add_axes().plot(
|
|||
manager.draw();
|
||||
```
|
||||
|
||||
The first instruction create a [Manager](references.md#Manager) which
|
||||
can be used to manage one or more [Canvas](references.md#Canvas). This
|
||||
The first instruction create a [Manager](references.md#manager) which
|
||||
can be used to manage one or more [Canvas](references.md#canvas). This
|
||||
manager is defined from the html `<body>` tag, so each
|
||||
[Canvas](references.md#Canvas) managed by this one will be at the end
|
||||
[Canvas](references.md#canvas) managed by this one will be at the end
|
||||
of this elements.
|
||||
|
||||
The second instruction do a lot of things at once. First, the method
|
||||
[`add_canvas`](references.md#Manager-add_canvas) add, like this name
|
||||
indicate, a [Canvas](references.md#Canvas) with a specific width and
|
||||
height associated to the [Manager](references.md#Manager) we created
|
||||
before. Next, the method [`add_axes`](references.md#Figure-add_axes) of
|
||||
the [figure](references.md#Canvas-figure) property of the canvas we
|
||||
created add an [Axes](references.md#Axes) to this figure. Then, the
|
||||
[`plot`](references.md#Axes-plot) method take the first list of number
|
||||
[`add_canvas`](references.md#manager-add_canvas) add, like this name
|
||||
indicate, a [Canvas](references.md#canvas) with a specific width and
|
||||
height associated to the [Manager](references.md#manager) we created
|
||||
before. Next, the method [`add_axes`](references.md#figure-add_axes) of
|
||||
the [figure](references.md#canvas-figure) property of the canvas we
|
||||
created add an [Axes](references.md#axes) to this figure. Then, the
|
||||
[`plot`](references.md#axes-plot) method take the first list of number
|
||||
as the x coordinate of points, the second as y ones and finally, an
|
||||
optional dictionary which define the style of the plot composed of each
|
||||
point.
|
||||
|
||||
Finally the [`draw`](references.md#Manager-draw) method render the plot
|
||||
Finally the [`draw`](references.md#manager-draw) method render the plot
|
||||
we created to display it on the created canvas in the web page.
|
||||
|
|
|
|||
Loading…
Reference in a new issue