Documentation update.

This commit is contained in:
Leon Styhre 2023-01-28 14:19:01 +01:00
parent 66b416d718
commit 2874a3c9b7

View file

@ -1256,7 +1256,7 @@ Properties:
- Valid values are `nearest` or `linear` - Valid values are `nearest` or `linear`
- Default is `linear` - Default is `linear`
* `imageColor` - type: COLOR * `imageColor` - type: COLOR
- Applies a color shift to the images defined by `staticImage`, `imageType` and `defaultImage` by multiplying each pixel's color by this color value. For example, an all-white image with `FF0000` applied would become completely red. You can also control the transparency of the images by setting the value to for example `FFFFFFAA`. This keeps all pixels at their normal color and only affects the alpha channel. This property is applied after `imageSaturation` so by setting that property to `0` it's possible to colorize rather than color shift. - Applies a color shift to the images defined by `staticImage`, `imageType` or `defaultImage` by multiplying each pixel's color by this color value. For example, an all-white image with `FF0000` applied would become completely red. You can also control the transparency of the images by setting the value to for example `FFFFFFAA`. This keeps all pixels at their normal color and only affects the alpha channel. This property is applied after `imageSaturation` so by setting that property to `0` it's possible to colorize rather than color shift.
- Default is `FFFFFFFF` (no color shift applied) - Default is `FFFFFFFF` (no color shift applied)
* `imageColorEnd` - type: COLOR * `imageColorEnd` - type: COLOR
- Works in the exact same way as `imageColor` but can be set as the end color to apply a color shift gradient. - Works in the exact same way as `imageColor` but can be set as the end color to apply a color shift gradient.
@ -1455,7 +1455,8 @@ Properties:
- Minimum value is `0.2` and maximum value is `1` - Minimum value is `0.2` and maximum value is `1`
- Default is `1` - Default is `1`
* `imageColor` - type: COLOR * `imageColor` - type: COLOR
- Applies a color shift to the images defined by `staticImage`, `imageType` and `defaultImage` by multiplying each pixel's color by this color value. For example, an all-white image with `FF0000` applied would become completely red. You can also control the transparency of the images by setting the value to for example `FFFFFFAA`. This keeps all pixels at their normal color and only affects the alpha channel. This property is applied after `imageSaturation` so by setting that property to `0` it's possible to colorize rather than color shift. - Applies a color shift to the images defined by `staticImage`, `imageType` or `defaultImage` by multiplying each pixel's color by this color value. For example, an all-white image with `FF0000` applied would become completely red. You can also control the transparency of the images by setting the value to for example `FFFFFFAA`. This keeps all pixels at their normal color and only affects the alpha channel. This property is applied after `imageSaturation` so by setting that property to `0` it's possible to colorize rather than color shift.
- Default is `FFFFFFFF` (no color shift applied)
* `imageColorEnd` - type: COLOR * `imageColorEnd` - type: COLOR
- Works in the exact same way as `imageColor` but can be set as the end color to apply a color shift gradient. - Works in the exact same way as `imageColor` but can be set as the end color to apply a color shift gradient.
- Default is the same value as `imageColor` - Default is the same value as `imageColor`
@ -1463,6 +1464,16 @@ Properties:
- The direction to apply the color gradient if both `imageColor` and `imageColorEnd` have been defined. - The direction to apply the color gradient if both `imageColor` and `imageColorEnd` have been defined.
- Valid values are `horizontal` or `vertical` - Valid values are `horizontal` or `vertical`
- Default is `horizontal` - Default is `horizontal`
* `imageSelectedColor` - type: COLOR
- Applies a color shift to the currently selected item's image as defined by `staticImage`, `imageType` or `defaultImage` by multiplying each pixel's color by this color value. For example, an all-white image with `FF0000` applied would become completely red. You can also control the transparency of the images by setting the value to for example `FFFFFFAA`. This keeps all pixels at their normal color and only affects the alpha channel. This property is applied after `imageSaturation` so by setting that property to `0` it's possible to colorize rather than color shift.
- Default is the same value as `imageColor`
* `imageSelectedColorEnd` - type: COLOR
- Works in the exact same way as `imageSelectedColor` but can be set as the end color to apply a color shift gradient.
- Default is the same value as `imageSelectedColor`
* `imageSelectedGradientType` - type: STRING
- The direction to apply the color gradient if both `imageSelectedColor` and `imageSelectedColorEnd` have been defined.
- Valid values are `horizontal` or `vertical`
- Default is `horizontal`
* `imageBrightness` - type: FLOAT * `imageBrightness` - type: FLOAT
- Controls the relative level of brightness. This is intended primarily for fine adjustments, for example if a color shift has been applied which may have lowered the overall brightness of the image. - Controls the relative level of brightness. This is intended primarily for fine adjustments, for example if a color shift has been applied which may have lowered the overall brightness of the image.
- Minimum value is `-2` and maximum value is `2` - Minimum value is `-2` and maximum value is `2`
@ -1516,6 +1527,12 @@ Properties:
- Default is `000000FF` - Default is `000000FF`
* `textBackgroundColor` - type: COLOR * `textBackgroundColor` - type: COLOR
- Default is `FFFFFF00` - Default is `FFFFFF00`
* `textSelectedColor` - type: COLOR
- Sets the text color for the currently selected item.
- Default is the same value as `textColor`
* `textSelectedBackgroundColor` - type: COLOR
- Sets the text background color for the currently selected item.
- Default is the same value as `textBackgroundColor`
* `fontPath` - type: PATH * `fontPath` - type: PATH
- Path to a TrueType font (.ttf) used as fallback if there is no `staticImage` / `imageType` image defined or found, and if `defaultImage` has not been defined. - Path to a TrueType font (.ttf) used as fallback if there is no `staticImage` / `imageType` image defined or found, and if `defaultImage` has not been defined.
* `fontSize` - type: FLOAT * `fontSize` - type: FLOAT