Benutzersteuerungen

Benutzersteuerungen in einem Plugin haben die Form einer globalen Variable, die vom Endbenutzer geändert werden kann. Sie werden alle über ControllableParameters() aus dem Plugin exportiert, das ein Array von Einstellungsobjekten zurückgibt, wie unten gezeigt.

export function ControllableParameters(){
    return [
        {"property":"LightingMode", "label":"Lighting Mode", "type":"combobox", "values":["Canvas","Forced"], "default":"Canvas"},
        {"property":"forcedColor", "label":"Forced Color","min":"0","max":"360","type":"color","default":"#009bde"},
        {"property":"SettingControl", "label":"Enable Setting Control","type":"boolean","default":"false"},
        {"property":"dpi1", "label":"DPI","step":"50", "type":"number","min":"200", "max":"18000","default":"800"}
    ];
}

Diese Einstellungsobjekte haben immer einige Basisparameter. Diese gelten für alle Plugin-Benutzersteuerungen.

Parameter	Wert	Typ
property	Der Name der Variable, die Sie der Steuerung zuweisen möchten.	String
label	Das dem Benutzer angezeigte Label.	String
type	Der Typ der Steuerung. Derzeit sind folgende Optionen gültig: boolean, number, hue, color, combobox und textfield	String
default	Der Standardwert für die Steuerung.	Variiert

Zahlen-Regler

Die number-Steuerung ermöglicht es dem Benutzer, den Wert einer Zahl über einen Schieberegler auszuwählen.

{"property":"dpi1", "label":"DPI","step":"50", "type":"number","min":"200", "max":"18000","default":"800"},

Diese Steuerung unterstützt die folgenden Attribute:

Parameter	Wert	Typ
property	Der Name der Variable, die Sie der Steuerung zuweisen möchten.	String
label	Das dem Benutzer angezeigte Label.	String
type	”number”	String
default	Der Standardwert für die Steuerung.	String, Int
min	Der minimal auswählbare Wert für den Schieberegler. Dieses Attribut unterstützt negative Werte.	String, Int
max	Der maximal auswählbare Wert für den Schieberegler.	String, Int
step	Der Schrittweite, um die der Schieberegler erhöht und verringert wird.	String, Int

Boolescher Schalter

Die boolean-Steuerung ermöglicht es dem Benutzer, den Wert einer booleschen Variable über eine Umschaltsteuerung auszuwählen.

{"property":"AngleSnap", "label":"Angle Snapping", "type":"boolean", "default":"0"},

Diese Steuerung unterstützt die folgenden Attribute:

Parameter	Wert	Typ
property	Der Name der Variable, die Sie der Steuerung zuweisen möchten.	String
label	Das dem Benutzer angezeigte Label.	String
type	”boolean”	String
default	Der Standardwert für den Schalter. Setzen Sie diesen auf 1, um “Ein” als Standardzustand festzulegen.	String, Int

Farbton-Regler

Die hue-Steuerung ermöglicht es dem Benutzer, den Farbtonanteil einer Farbe über einen Schieberegler auszuwählen.

Diese Steuerung unterstützt die folgenden Attribute:

Parameter	Wert	Typ
property	Der Name der Variable, die Sie der Steuerung zuweisen möchten.	String
label	Das dem Benutzer angezeigte Label.	String
type	”hue”	String, Int
default	Der Standardwert für den Farbton-Regler.	String
min	Der minimal auswählbare Farbtonwert. Dieser Wert muss zwischen 0 und 359 liegen.	String, Int
max	Der maximal auswählbare Farbtonwert. Dieser Wert muss zwischen 1 und 360 liegen.	String, Int

Farbauswahl

Die color-Steuerung ermöglicht es dem Benutzer, eine Farbe über ein Farbtonrad, einen Sättigungsregler und einen Helligkeitsregler auszuwählen. Das Schraubenschlüssel-Symbol öffnet eine erweiterte Farbpalette zur Auswahl.

{"property":"forcedColor", "label":"Forced Color","min":"0","max":"360","type":"color","default":"#009bde"},

Diese Steuerung unterstützt die folgenden Attribute:

Parameter	Wert	Typ
property	Der Name der Variable, die Sie der Steuerung zuweisen möchten.	String
label	Das dem Benutzer angezeigte Label.	String
type	”color”	String
default	Der Standardwert für die Farbauswahl. Dieser muss als Hex-Wert in der Form #RRGGBB angegeben werden.	String
min	Der minimal auswählbare Farbtonwert. Dieser Wert muss zwischen 0 und 359 liegen.	Int
max	Der maximal auswählbare Farbtonwert. Dieser Wert muss zwischen 1 und 360 liegen.	Int

Kombinationsfeld

Die combobox-Steuerung ermöglicht es dem Benutzer, aus einem Dropdown-Menü mit vordefinierten Werten auszuwählen.

{"property":"SleepModeTime", "label":"Sleep After x Minutes", "type":"combobox", "values":[5,10,15,30,60], "default":10},

Diese Steuerung unterstützt die folgenden Attribute:

Parameter	Wert	Typ
property	Der Name der Variable, die Sie der Steuerung zuweisen möchten.	String
label	Das dem Benutzer angezeigte Label.	String
type	”combobox”	String
default	Der Standardwert für das Kombinationsfeld. Dieser Wert muss im values-Array vorhanden sein.	String, Int
values	Ein Array von Werten für das Dropdown-Menü. Gültige Typen sind Strings und Integer.	[String, Int]

Textfeld

Die textfield-Steuerung ermöglicht es dem Benutzer, Text frei einzugeben, optional mit einem RegEx-Filter.

{"property":"textBox", "label":"Text Field", "type":"textfield", "default":"3"},

Diese Steuerung unterstützt die folgenden Attribute:

Parameter	Wert	Typ
property	Der Name der Variable, die Sie der Steuerung zuweisen möchten.	String
label	Das dem Benutzer angezeigte Label.	String
type	”textfield”	String
default	Der Standardwert für das Textfeld.	String, Int
filter	Ein optionaler RegEx-Filter zur Einschränkung der Benutzereingabe.	RegEx-String