Controles do Usuário

Os Controles do Usuário em um plugin assumem a forma de uma variável global que pode ser modificada pelo usuário final. Todos são exportados do plugin via ControllableParameters(), que retorna um array de objetos de configuração conforme mostrado abaixo.

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"}
    ];
}

Esses objetos de configuração sempre têm alguns parâmetros base. Estes são válidos para todos os Controles de Usuário de plugins.

Parâmetro	Valor	Tipo
property	O nome da variável que você deseja atribuir ao controle.	String
label	O rótulo a exibir para o usuário.	String
type	O tipo de controle. Atualmente, as seguintes opções são válidas: boolean, number, hue, color, combobox, e textfield	String
default	O valor padrão para o controle.	Varia

Slider Numérico

O controle numérico permite ao usuário selecionar o valor de um número usando um slider.

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

Este controle suporta os seguintes atributos:

Parâmetro	Valor	Tipo
property	O nome da variável que você deseja atribuir ao controle.	String
label	O rótulo a exibir para o usuário.	String
type	”number”	String
default	O valor padrão para o controle.	String, Int
min	O valor mínimo selecionável para o slider. Este atributo suporta valores negativos.	String, Int
max	O valor máximo selecionável para o slider.	String, Int
step	O valor de incremento e decremento do slider	String, Int

Botão de Alternância Boolean

O controle boolean permite ao usuário selecionar o valor de uma variável boolean usando um controle de alternância.

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

Este controle suporta os seguintes atributos:

Parâmetro	Valor	Tipo
property	O nome da variável que você deseja atribuir ao controle.	String
label	O rótulo a exibir para o usuário.	String
type	”boolean”	String
default	O valor padrão para a alternância. Defina como 1 para que “ligado” seja o estado padrão.	String, Int

Slider de Matiz

O controle de seleção de matiz permite ao usuário selecionar o componente de matiz de uma cor com um controle deslizante.

Este controle suporta os seguintes atributos:

Parâmetro	Valor	Tipo
property	O nome da variável que você deseja atribuir ao controle.	String
label	O rótulo a exibir para o usuário.	String
type	”hue”	String, Int
default	O valor padrão para o slider de matiz.	String
min	O valor mínimo de matiz selecionável. Este valor deve estar entre 0 e 359.	String, Int
max	O valor máximo de matiz selecionável. Este valor deve estar entre 1 e 360.	String, Int

Seletor de Cor

O controle de cor permite ao usuário selecionar uma cor usando uma roda de matiz, slider de saturação e slider de luminância. O ícone de chave inglesa abrirá uma paleta de cores mais avançada para seleção.

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

Este controle suporta os seguintes atributos:

Parâmetro	Valor	Tipo
property	O nome da variável que você deseja atribuir ao controle.	String
label	O rótulo a exibir para o usuário.	String
type	”color”	String
default	O valor padrão para o seletor de cor. Deve ser especificado como um valor hex no formato #RRGGBB	String
min	O valor mínimo de matiz selecionável. Este valor deve estar entre 0 e 359.	Int
max	O valor máximo de matiz selecionável. Este valor deve estar entre 1 e 360.	Int

Caixa de Combinação

O controle de caixa de combinação permite ao usuário selecionar a partir de um menu suspenso de valores predefinidos.

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

Este controle suporta os seguintes atributos:

Parâmetro	Valor	Tipo
property	O nome da variável que você deseja atribuir ao controle.	String
label	O rótulo a exibir para o usuário.	String
type	”combobox”	String
default	O valor padrão para a caixa de combinação. Este valor deve estar no array de valores	String, Int
values	Um array de valores para o menu suspenso. Os tipos válidos são strings e inteiros.	[String, Int]

Campo de Texto

O controle de campo de texto permite ao usuário inserir texto livremente com um filtro RegEx opcional.

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

Este controle suporta os seguintes atributos:

Parâmetro	Valor	Tipo
property	O nome da variável que você deseja atribuir ao controle.	String
label	O rótulo a exibir para o usuário.	String
type	”textfield”	String
default	O valor padrão para o campo de texto.	String, Int
filter	um filtro RegEx opcional para limitar a entrada do usuário	String RegEx