diff --git a/User-Manual%3A-Chapter-2.md b/User-Manual%3A-Chapter-2.md index f2be888..ea21370 100644 --- a/User-Manual%3A-Chapter-2.md +++ b/User-Manual%3A-Chapter-2.md @@ -88,7 +88,737 @@ There exists a lot of properties, but each of them are separated in different ki There can also be comments and notes in between properties to explain the specialities of certain non intuitive properties. +## Object properties +The following section is a reference for all object properties. It's currently up to date with LogarithmPlotter v0.1.8. + +Reference: +- [All objects](#for-all-objects) +- [Points](#points) +- [Texts](#texts) +- [Functions](#functions) +- [Bode magnitudes](#bode-magnitudes) +- [Bode magnitudes sum](#bode-magnitudes-sum) +- [Bode phases](#bode-phases) +- [Bode phases sum](#bode-phases-sum) +- [X Cursors](#x-cursors) +- [Sequences](#sequences) +- [Distributions](#distributions) + +### For all objects + +
Icon | +Property | +Type | +Value | +Comment | + + +
---|---|---|---|---|
+ | Name | +string | +It must not be the same for two objects. | +This value represents the object. | +
+ | Label content | +Enumeration | +
+
|
+ It's generally used with a positioning property (Label position or Label's X position). | +
Icon | +Property | +Type | +Value | +Comment | + + +
---|---|---|---|---|
+ | X | +Expression | +Default: 1 | +Position of the point on the x-axis. | +
+ | Y | +Expression | +Default: 0 | +Position of the point on the y-axis. | +
+ | Label position | +Enumeration | +
+
|
+ Position of the label relative to the point. | +
+ | Point style | +Enumeration | +
+
|
+ Visual style of the point representation. | +
Icon | +Property | +Type | +Value | +Comment | + + +
---|---|---|---|---|
+ | X | +Expression | +Default: 1 | +Position of the text on the x-axis. | +
+ | Y | +Expression | +Default: 0 | +Position of the text on the y-axis. | +
+ | Label position | +Enumeration | +
+
|
+ Position of the label relative to the position. | +
+ | Content | +string | +Default: New text | +Content of the text item. | +
Icon | +Property | +Type | +Value | +Comment | + + +||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
+ | Expression | +Expression | +Default: x | +Expression of the function (depending on variable x). | +||||||||
+ | Domain | +Domain | +Default: ℝ⁺* | +Domain (definition range) of the function. | +||||||||
+ | Range | +Domain | +Default: ℝ | +Range (destination range) of the function. | +||||||||
+ | Label position | +Enumeration | +
+
|
+ Position of the label relative to the position. | +||||||||
+ | Display mode | +Enumeration | +
+
|
+ Display style of the function's label. | +||||||||
+ | Label's X position | +number | +Default: 1 | +Base position for the label of the function based on the specified x-axis position and it's corresponding y-axis of the function. | +||||||||
+ | Show points | +boolean | +True of false + Default: true |
+ When using a non continous domain (for example ℕ, ℤ, sets like {0;3}) the function can be displayed using points at the points where the function is defined. Unticking this hides the points. | +||||||||
+ | Show dashed lines | +boolean | +True of false + Default: true |
+ When using a non continous domain (for example ℕ, ℤ, sets like {0;3}) the function can be displayed dashed lines between at the points where the function is defined. Unticking this hides the dashed lines. | +
Icon | +Property | +Type | +Value | +Comment | + + +
---|---|---|---|---|
+ | ω0 | +Point | +By default, a newly created point prefixed by ω in (1,0). | +Used as the base for the beginning/end of the transitional side of the bode magnitude as well . | +
+ | Pass | +Enumeration | +
+
|
+ Type of bode magnitude pass used for this this object. | +
+ | Gain | +Expression | ++ Default: 20 + | +Amount of decibels per decade used for the bode gain (should be positive for high pass, and negative for low pass). | +
+ | Label position | +Enumeration | +
+
|
+ Position of the label relative to the position. | +
+ | Label's X position | +number | +Default: 1 | +Base position for the label of the function based on the specified x-axis position and it's corresponding y-axis on the function. | +
+ | Show graduation on ω0 | +boolean | +True of false + Default: false |
+ When ticked, will show a vertical dashed line on top of the assigned ω0. | +
Icon | +Property | +Type | +Value | +Comment | + + +
---|---|---|---|---|
+ | Label position | +Enumeration | +
+
|
+ Position of the label relative to the position. | +
+ | Label's X position | +number | +Default: 1 | +Base position for the label of the bode magnitude based on the specified x-axis position and it's corresponding y-axis of the bode magnitude. | +
Icon | +Property | +Type | +Value | +Comment | + + +
---|---|---|---|---|
+ | ω0 | +Point | +By default, a newly created point prefixed by ω in (1,0). | +Used as the base for the beginning/end of the transitional side of the bode phase as well . | +
+ | Phase | +Expression | ++ Default: 90 + | +Amount of phase (defined in the unit below) used for the bode phase. | +
+ | Unit to use | +Enumeration | +
+
|
+ Unit of the phase to be used (used for display). | +
+ | Label position | +Enumeration | +
+
|
+ Position of the label relative to the position. | +
+ | Label's X position | +number | +Default: 1 | +Base position for the label of the function based on the specified x-axis position and it's corresponding y-axis on the function. | +
Icon | +Property | +Type | +Value | +Comment | + + +
---|---|---|---|---|
+ | Label position | +Enumeration | +
+
|
+ Position of the label relative to the position. | +
+ | Label's X position | +number | +Default: 1 | +Base position for the label of the bode phase based on the specified x-axis position and it's corresponding y-axis of the bode phase. | +
Icon | +Property | +Type | +Value | +Comment | + + +
---|---|---|---|---|
+ | X | +Expression | +Default: 1 | +Position of the cursor on the x-axis. | +
+ | Object to target | +Executable object* | +Default: no object is selected. | +
+ Target object of which to show the value of through the X Cursor. + *Executable objects are objects which take values all along the x-axis with a corresponding y-axis value. Functions, bode magnitudes and phases, sequences and distributions qualify as such. + |
+
+ | Label position | +Enumeration | +
+
|
+ Position of the label relative to the position. | +
+ | Show approximate value | +boolean | +True of false + Default: true |
+ When ticked, will show an approximate version of the value of the targeted object at a the given x next to the value of the simplified expression. | +
+ | Rounding | +Expression | +Default: 3 | +Rounding of the approximate value. | +
+ | Display style | +Enumeration | +
+
|
+ Style of the vertical bar of the cursor. | +
+ | Target's value position | +Enumeration | +
+
|
+ Position of the target's value on the x cursor. When using "Next to target", it will be at the intersection between the target and the cursor vertical bar, while "With label" puts it just below the name of the cursor and it's position. | +
Icon | +Property | +Type | +Value | +Comment | + + +
---|---|---|---|---|
+ | Show points | +boolean | +True of false + Default: true |
+ Sequences are be displayed using points at each integer the points where the sequence is defined. Unticking this hides the points. | +
+ | Show dashed lines | +boolean | +True of false + Default: true |
+ Sequences are displayed dashed lines between at the points where the sequence is defined. Unticking this hides the dashed lines. | +
+ | Default expression | +Dictionary (fixed length at 1, key is a number, value an expression) | +var[n+k] = expression + Default: var=u, k=1, expression=n u[n+1] = n |
+ Note: The expression is being defined through the n variable. You can use the array-syntax to access previous value. For example, for the variable u, you can define u[n+1] depending on u[n] or u[n+2] depending on u[n] and u[n+1] for recursive definition. | +
+ | Initialisation values | +Dictionary (key is a number, value an expression | +var[k] = expr + Default: var=u, k=0, expr=1 u[0] = 1 |
+ Note: You need as many initialisation values (which can be added through the "Add entry button" and removed with the trash buttons) as k. | +
+ | Label position | +Enumeration | +
+
|
+ Position of the label relative to the position. | +
+ | Label's X position | +number | +Default: 1 | +Base position for the label of the sequence based on the specified x-axis position (integer) and it's corresponding y-axis of the sequence. | +
Icon | +Property | +Type | +Value | +Comment | + + +
---|---|---|---|---|
+ | Label position | +Enumeration | +
+
|
+ Position of the label relative to the position. | +
+ | Label's X position | +number | +Default: 1 | +Base position for the label of the distribution based on the specified x-axis position and it's corresponding y-axis of the distribution. | +
+ | Probabilities list | +Dictionary (key is a number, value an number) | +P(var=k) = value + Default: var=X, k=0, expr=1 P(X=0) = 0 |
+ Note: You need as many probabilities as needed (which can be added through the "Add entry button" and removed with the trash buttons) as k. The displayed graph will be the distribution function. | +