Class Switch

Cambia

Elemento dell'interfaccia utente che supporta l'attivazione o la disattivazione. Può essere utilizzato solo all'interno di un widget DecoratedText.

var switchDecoratedText  = CardService.newDecoratedText()
  .setTopLabel("Switch decorated text widget label")
  .setText("This is a decorated text widget with a switch on the right")
  .setWrapText(true)
  .setSwitchControl(CardService.newSwitch()
      .setFieldName("form_input_switch_key")
      .setValue("form_input_switch_value")
      .setOnChangeAction(CardService.newAction()
          .setFunctionName("handleSwitchChange")));

Metodi

MetodoTipo restituitoBreve descrizione
setControlType(controlType)SwitchConsente di impostare il tipo di controllo dell'interruttore.
setFieldName(fieldName)SwitchImposta la chiave che identifica questo sensore nell'oggetto evento generato quando si verifica un'interazione con l'interfaccia utente.
setOnChangeAction(action)SwitchConsente di impostare l'azione da eseguire quando l'interruttore è attivato.
setSelected(selected)SwitchConsente di stabilire se il selettore deve iniziare come selezionato o deselezionato.
setValue(value)SwitchImposta il valore che viene inviato come input di modulo quando questa opzione è attivata.

Documentazione dettagliata

setControlType(controlType)

Consente di impostare il tipo di controllo dell'interruttore. Il valore predefinito è SWITCH.

Parametri

NomeTipoDescrizione
controlTypeSwitchControlTypeIl tipo di controllo del sensore.

Andata e ritorno

Switch: questo oggetto, per il concatenamento.


setFieldName(fieldName)

Imposta la chiave che identifica questo sensore nell'oggetto evento generato quando si verifica un'interazione con l'interfaccia utente. Non sarà visibile all'utente. Obbligatorio.

A differenza degli altri campi del modulo, il nome non deve essere univoco. I valori di input del modulo per i sensori che utilizzano lo stesso nome di campo vengono restituiti come array. L'array è costituito dai valori per tutti i sensori abilitati che hanno quel nome di campo.

Parametri

NomeTipoDescrizione
fieldNameStringLa chiave utilizzata per identificare il sensore.

Andata e ritorno

Switch: questo oggetto, per il concatenamento.


setOnChangeAction(action)

Consente di impostare l'azione da eseguire quando l'interruttore è attivato.

Parametri

NomeTipoDescrizione
actionActionL'azione da eseguire quando il selettore è attivato.

Andata e ritorno

Switch: questo oggetto, per il concatenamento.


setSelected(selected)

Consente di stabilire se il selettore deve iniziare come selezionato o deselezionato.

Parametri

NomeTipoDescrizione
selectedBooleanAvvio dell'impostazione dello stato del sensore.

Andata e ritorno

Switch: questo oggetto, per il concatenamento.


setValue(value)

Imposta il valore che viene inviato come input di modulo quando questa opzione è attivata.

Parametri

NomeTipoDescrizione
valueStringIl valore associato al nome quando l'opzione è attiva. Quando viene inviato al callback del modulo, è sempre rappresentato come una stringa.

Andata e ritorno

Switch: questo oggetto, per il concatenamento.