CSOListToStylePalette¶
- MLModule¶
author
package
dll
definition
see also
StylePalette,DynamicStylePalette,ApplyStylePaletteToCSOListkeywords
Purpose¶
Maps CSO properties, such as line or marker color to a StylePalette.
Usage¶
A typical use-case is to match CSO colors to the corresponding curve colors (see example network).
Details¶
Input Fields¶
inCSOList¶
- name: inCSOList, type: MLBase¶
Connect the input CSO list here.
Output Fields¶
outStylePalette¶
- name: outStylePalette, type: MLBase¶
Provides the generated StylePalette. Note that a StylePalette base object can differ from the fixed number of 12 styles of a StylePalette module (use DynamicStylePalette to handle that).
Parameter Fields¶
Field Index¶
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Visible Fields¶
Create style for each:¶
- name: styleSource, type: Enum, default: CSO Id¶
Select if a style is generated per CSO id or group ID.
Values:
Title |
Name |
Description |
|---|---|---|
CSO Id |
CSO Id |
StylePalette size will be set to maximum CSO id. Every CSO id will match one StylePalette index. Note that StylePalette indices are continuous so for CSO ids [2, 5, 6] there will be [1,2,3,4,5,6] styles. |
Group Id |
Group Id |
StylePalette size will be set to maximum CSO group id. Every group id will match one StylePalette index. Note that StylePalette indices are continuous so for group ids [2, 5, 6] there will be [1,2,3,4,5,6] styles. |
Group Label |
Group Label |
The number of styles will match the number of distinct group labels. In this case CSO group ids and style indices do not correspond. |
Take color from:¶
- name: styleColor, type: Enum, default: Path color¶
Select which CSO attribute maps to style color.
Values:
Title |
Name |
Description |
|---|---|---|
None |
None |
Defaults to white. |
Path point color |
Path color |
CSO path point color |
Seed point color |
Marker color |
CSO seed point color |
Set Anti Alias¶
- name: setAntiAlias, type: Bool, default: TRUE¶
Select if output styles should be anti-aliased.
Number of styles¶
- name: numStyles, type: Integer, persistent: no¶
Indicates how many styles have been generated (read-only).
Auto update¶
- name: autoUpdate, type: Bool, default: TRUE¶
There is no separation between auto apply and update since that is usually a minor processing.
Is Up To Date¶
- name: isUpToDate, type: Bool, persistent: no¶
Status flag (read-only).
Update¶
- name: update, type: Trigger¶
Manual trigger for update and apply.