Ad5001/LogarithmPlotter
Ad5001/LogarithmPlotter
1
0
Fork 0
Code Issues 2 Pull requests Projects 1 Releases Wiki Activity

Initial chapter 2

Ad5001 2022-02-08 13:55:38 +00:00
parent 1d6e7deb4d
commit 3a0d42073a
1 changed files with 92 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

92
User-Manual%3A-Chapter-2.md Normal file

@ -0,0 +1,92 @@
[← Previous chapter](https://git.ad5001.eu/Ad5001/LogarithmPlotter/wiki/User-Manual:-Chapter-1) | Chapter 2: Editing object properties ([≡ Index](User-Manual)) | [Next chapter →](https://git.ad5001.eu/Ad5001/LogarithmPlotter/wiki/User-Manual:-Chapter-3)
# Editing object properties
## Introduction
Each object (as seen in chapter 0) has properties, which are the core of the customisability of objects. There exists many different kind of properties for different things, like naming objects, the position of points, the expression and domains of functions...
When creating an object, or when clicking on it on the object list, you open the Object Property Editor dialog.
<p align="center">
![Image of the Object Property Editor dialog](https://apps.ad5001.eu/img/en/logarithmplotter/object-settings.webp)
*Example dialog for a distribution*
</p>
This dialog contains all of the properties of the object that can be modified. Each property is updated in real time. You can drag the dialog away to see the consequences of your changes on the graph.
That dialog can be closed by eitheir closing the window or clicking the "OK" button. Both these options save all changes done.
## Type of properties
There exists a lot of properties, but each of them are separated in different kinds.
<table>
<thead>
<th>Type</th>
<th>Editor</th>
<th>Example(s)</th>
<th>Comment</th>
</thead>
<tbody>
<tr>
<td>Strings</td>
<td>Inline text input</td>
<td>Object name</td>
<td>At the end of the input, the little "α" button allows to enter symbols (greek letters, and indices or supscripts letters and numbers).</td>
</tr>
<tr>
<td>Numbers (integers and decimals)</td>
<td>Inline text input</td>
<td>Label position</td>
<td>All inputs other than digits, one optional minus at the start and a dot in the middle are forbidden.</td>
</tr>
<tr>
<td>Expressions</td>
<td>Inline text input</td>
<td>Point position, function expression</td>
<td>Like strings, they have the symbol character input dialog. You can use values like e or pi (can also be noted π) in it.</td>
</tr>
<tr>
<td>Domains & ranges (sets)</td>
<td>Inline text input</td>
<td>Function domain and range</td>
<td>Use symbolic expressions (e.g R+* will translate to ℝ⁺*, the strictly positive integer set), ranges (e.g ]0;1[) or even sets (e.g {0;3;4}).</td>
</tr>
<tr>
<td>Booleans (true or false)</td>
<td>Checkbox</td>
<td>Show graduation on ω₀ for Bode Magnitude</td>
<td></td>
</tr>
<tr>
<td>Enumerations (set of predefined values)</td>
<td>Combo box</td>
<td>Label position and content, point style, bode pass</td>
<td></td>
</tr>
<tr>
<td>Other objects</td>
<td>Combo box</td>
<td>Bode's ω₀, X Cursor's target objects.</td>
<td>Contains a list of all objects created in required type, and allows to create a new one if needed. X Cursor target object is an exception as it can target several different types of objects.</td>
</tr>
<tr>
<td>Lists (lists of values)</td>
<td>List of inline text inputs</td>
<td>Unused at the moment</td>
<td>Sometimes allows the creation of values, at other the number of values is constant.</td>
</tr>
<tr>
<td>Dictionaries (list of values associated with another value)</td>
<td>List of lines having two text inputs separated by text</td>
<td>Sequence expression and default values, distribution default values</td>
<td>Sometimes allows the creation of values, at other the number of values is constant.</td>
</tr>
</tbody>
</table>
There can also be comments and notes in between properties to explain the specialities of certain non intuitive properties.
<!-- TODO: Add all properties of objects here -->