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 + + + + + + + + + + + + + + + + + + + + + + + + + +
IconPropertyTypeValueComment
label iconNamestringIt must not be the same for two objects.This value represents the object.
label iconLabel contentEnumeration +
    +
  • null: No label
  • +
  • name: Name of the object
  • +
  • name + value: Name of the object and it's value (generally in "name = value")
  • +
+
It's generally used with a positioning property (Label position or Label's X position).
+ + + + +### ![Icon](https://git.ad5001.eu/Ad5001/LogarithmPlotter/raw/branch/master/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/icons/objects/Point.svg) Points + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
IconPropertyTypeValueComment
Position iconXExpressionDefault: 1Position of the point on the x-axis.
Position iconYExpressionDefault: 0Position of the point on the y-axis.
All direction iconLabel positionEnumeration +
    +
  • ↑ Above
  • +
  • ↓ Below
  • +
  • ← Left
  • +
  • → Right
  • +
  • ↖ Above left
  • +
  • ↗ Above right
  • +
  • ↙ Below left
  • +
  • ↘ Below right
  • +
+ Default: ↑ Above +
Position of the label relative to the point.
Appearance iconPoint styleEnumeration +
    +
  • +
  • +
  • +
+ Default: ● +
Visual style of the point representation.
+ + + + +### ![Icon](https://git.ad5001.eu/Ad5001/LogarithmPlotter/raw/branch/master/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/icons/objects/Text.svg) Texts + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
IconPropertyTypeValueComment
Position iconXExpressionDefault: 1Position of the text on the x-axis.
Position iconYExpressionDefault: 0Position of the text on the y-axis.
All direction iconLabel positionEnumeration +
    +
  • >|< Center
  • +
  • ↑ Top
  • +
  • ↓ Bottom
  • +
  • ← Left
  • +
  • → Right
  • +
  • ↖ Top left
  • +
  • ↗ Top right
  • +
  • ↙ Bottom left
  • +
  • ↘ Bottom right
  • +
+ Default: >|< Center +
Position of the label relative to the position.
Label iconContentstringDefault: New textContent of the text item.
+ + + +### ![Icon](https://git.ad5001.eu/Ad5001/LogarithmPlotter/raw/branch/master/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/icons/objects/Function.svg) Functions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
IconPropertyTypeValueComment
Expression iconExpressionExpressionDefault: xExpression of the function (depending on variable x).
Domain iconDomainDomainDefault: ℝ⁺*Domain (definition range) of the function.
Range iconRangeDomainDefault: ℝRange (destination range) of the function.
Arrows iconLabel positionEnumeration +
    +
  • ↑ Above
  • +
  • ↓ Below
  • +
  • ← Left
  • +
  • → Right
  • +
  • ↖ Above left
  • +
  • ↗ Above right
  • +
  • ↙ Below left
  • +
  • ↘ Below right
  • +
+ Default: ↑ Above +
Position of the label relative to the position.
Appearance iconDisplay modeEnumeration +
    +
  • + Application:
    + + + + + + + + + + + + + +
    name:domainrange
    xexpression
    +
  • +
  • + Function:
    + name(x) = expression +
  • +
+ Default: Application +
Display style of the function's label.
Position iconLabel's X positionnumberDefault: 1Base position for the label of the function based on the specified x-axis position and it's corresponding y-axis of the function.
Show pointsbooleanTrue 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 linesbooleanTrue 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](https://git.ad5001.eu/Ad5001/LogarithmPlotter/raw/branch/master/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/icons/objects/Gain%20Bode.svg) Bode Magnitude + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
IconPropertyTypeValueComment
Angle iconω0PointBy 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 .
Bode pass iconPassEnumeration +
    +
  • High
  • +
  • Low
  • +
+ Default: High +
Type of bode magnitude pass used for this this object.
Gain iconGainExpression + Default: 20 + Amount of decibels per decade used for the bode gain (should be positive for high pass, and negative for low pass).
Arrows iconLabel positionEnumeration +
    +
  • ↑ Above
  • +
  • ↓ Below
  • +
  • ← Left
  • +
  • → Right
  • +
  • ↖ Above left
  • +
  • ↗ Above right
  • +
  • ↙ Below left
  • +
  • ↘ Below right
  • +
+ Default: ↓ Below +
Position of the label relative to the position.
Position iconLabel's X positionnumberDefault: 1Base 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 ω0booleanTrue of false
+ Default: false
When ticked, will show a vertical dashed line on top of the assigned ω0.
+ + +### ![Icon](https://git.ad5001.eu/Ad5001/LogarithmPlotter/raw/branch/master/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/icons/objects/Somme%20gains%20Bode.svg) Bode Magnitudes Sum + + + + + + + + + + + + + + + + + + + + + + + + + +
IconPropertyTypeValueComment
Arrows iconLabel positionEnumeration +
    +
  • ↑ Above
  • +
  • ↓ Below
  • +
  • ← Left
  • +
  • → Right
  • +
  • ↖ Above left
  • +
  • ↗ Above right
  • +
  • ↙ Below left
  • +
  • ↘ Below right
  • +
+ Default: ↑ Above +
Position of the label relative to the position.
Position iconLabel's X positionnumberDefault: 1Base 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](https://git.ad5001.eu/Ad5001/LogarithmPlotter/raw/branch/master/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/icons/objects/Phase%20Bode.svg) Bode Phases + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
IconPropertyTypeValueComment
Angle iconω0PointBy 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 .
Angle iconPhaseExpression + Default: 90 + Amount of phase (defined in the unit below) used for the bode phase.
Angle iconUnit to useEnumeration +
    +
  • °
  • +
  • deg
  • +
  • rad
  • +
+ Default: ° +
Unit of the phase to be used (used for display).
Arrows iconLabel positionEnumeration +
    +
  • ↑ Above
  • +
  • ↓ Below
  • +
  • ← Left
  • +
  • → Right
  • +
  • ↖ Above left
  • +
  • ↗ Above right
  • +
  • ↙ Below left
  • +
  • ↘ Below right
  • +
+ Default: ↓ Below +
Position of the label relative to the position.
Position iconLabel's X positionnumberDefault: 1Base position for the label of the function based on the specified x-axis position and it's corresponding y-axis on the function.
+ + + +### ![Icon](https://git.ad5001.eu/Ad5001/LogarithmPlotter/raw/branch/master/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/icons/objects/Somme%20phases%20Bode.svg) Bode Phases Sum + + + + + + + + + + + + + + + + + + + + + + + + + +
IconPropertyTypeValueComment
Arrows iconLabel positionEnumeration +
    +
  • ↑ Above
  • +
  • ↓ Below
  • +
  • ← Left
  • +
  • → Right
  • +
  • ↖ Above left
  • +
  • ↗ Above right
  • +
  • ↙ Below left
  • +
  • ↘ Below right
  • +
+ Default: ↑ Above +
Position of the label relative to the position.
Position iconLabel's X positionnumberDefault: 1Base 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](https://git.ad5001.eu/Ad5001/LogarithmPlotter/raw/branch/master/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/icons/objects/X%20Cursor.svg) X Cursors + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
IconPropertyTypeValueComment
Position iconXExpressionDefault: 1Position of the cursor on the x-axis.
Target iconObject to targetExecutable 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. +
Arrows iconLabel positionEnumeration +
    +
  • ↑ Above
  • +
  • ↓ Below
  • +
  • ← Left
  • +
  • → Right
  • +
  • ↖ Above left
  • +
  • ↗ Above right
  • +
  • ↙ Below left
  • +
  • ↘ Below right
  • +
+ Default: ← Left +
Position of the label relative to the position.
Show approximate valuebooleanTrue 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 iconRoundingExpressionDefault: 3Rounding of the approximate value.
Arrows iconDisplay styleEnumeration +
    +
  •               
  • +
  •               
  • +
  • • • •
  • +
+ Default:                +
Style of the vertical bar of the cursor.
Position iconTarget's value positionEnumeration +
    +
  • Next to target
  • +
  • With label
  • +
  • Hidden
  • +
+ Default: Next to target +
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](https://git.ad5001.eu/Ad5001/LogarithmPlotter/raw/branch/master/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/icons/objects/Sequence.svg) Sequences + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
IconPropertyTypeValueComment
Show pointsbooleanTrue 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 linesbooleanTrue 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 expressionDictionary (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 valuesDictionary (key is a number, value an expressionvar[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.
Arrows iconLabel positionEnumeration +
    +
  • ↑ Above
  • +
  • ↓ Below
  • +
  • ← Left
  • +
  • → Right
  • +
  • ↖ Above left
  • +
  • ↗ Above right
  • +
  • ↙ Below left
  • +
  • ↘ Below right
  • +
+ Default: ← Left +
Position of the label relative to the position.
Position iconLabel's X positionnumberDefault: 1Base 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](https://git.ad5001.eu/Ad5001/LogarithmPlotter/raw/branch/master/LogarithmPlotter/qml/eu/ad5001/LogarithmPlotter/icons/objects/Repartition.svg) Distributions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
IconPropertyTypeValueComment
Arrows iconLabel positionEnumeration +
    +
  • ↑ Above
  • +
  • ↓ Below
  • +
  • ← Left
  • +
  • → Right
  • +
  • ↖ Above left
  • +
  • ↗ Above right
  • +
  • ↙ Below left
  • +
  • ↘ Below right
  • +
+ Default: ← Left +
Position of the label relative to the position.
Position iconLabel's X positionnumberDefault: 1Base position for the label of the distribution based on the specified x-axis position and it's corresponding y-axis of the distribution.
Probabilities listDictionary (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.
- [Next chapter →](https://git.ad5001.eu/Ad5001/LogarithmPlotter/wiki/User-Manual:-Chapter-3) \ No newline at end of file