Class Switch

Alihkan

Elemen UI yang mendukung untuk diaktifkan atau dinonaktifkan. Ini hanya dapat digunakan dalam 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")));

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setControlType(controlType)SwitchMenetapkan jenis kontrol tombol.
setFieldName(fieldName)SwitchMenetapkan kunci yang mengidentifikasi tombol ini di objek peristiwa yang dihasilkan saat ada interaksi UI.
setOnChangeAction(action)SwitchMenetapkan tindakan yang akan diambil saat tombol dialihkan.
setSelected(selected)SwitchMenetapkan apakah tombol ini harus dimulai sebagai dipilih atau batal dipilih.
setValue(value)SwitchMenetapkan nilai yang dikirim sebagai input formulir saat tombol ini diaktifkan.

Dokumentasi mendetail

setControlType(controlType)

Menetapkan jenis kontrol tombol. Default-nya adalah SWITCH.

Parameter

NameJenisDeskripsi
controlTypeSwitchControlTypeJenis kontrol tombol.

Return

Switch — Objek ini, untuk rantai.


setFieldName(fieldName)

Menetapkan kunci yang mengidentifikasi tombol ini di objek peristiwa yang dihasilkan saat ada interaksi UI. Tidak terlihat oleh pengguna. Wajib diisi.

Tidak seperti kolom formulir lainnya, nama kolom ini tidak harus unik. Nilai input formulir untuk tombol yang menggunakan nama kolom yang sama akan ditampilkan sebagai array. Array terdiri dari nilai untuk semua tombol yang diaktifkan dengan nama kolom tersebut.

Parameter

NameJenisDeskripsi
fieldNameStringKunci yang digunakan untuk mengidentifikasi tombol ini.

Return

Switch — Objek ini, untuk rantai.


setOnChangeAction(action)

Menetapkan tindakan yang akan diambil saat tombol dialihkan.

Parameter

NameJenisDeskripsi
actionActionTindakan yang harus diambil saat tombol dialihkan.

Return

Switch — Objek ini, untuk rantai.


setSelected(selected)

Menetapkan apakah tombol ini harus dimulai sebagai dipilih atau batal dipilih.

Parameter

NameJenisDeskripsi
selectedBooleanSetelan status tombol akses awal.

Return

Switch — Objek ini, untuk rantai.


setValue(value)

Menetapkan nilai yang dikirim sebagai input formulir saat tombol ini diaktifkan.

Parameter

NameJenisDeskripsi
valueStringNilai yang terkait dengan nama saat tombol aktif. Ketika dikirim ke callback formulir, callback ini selalu direpresentasikan sebagai string.

Return

Switch — Objek ini, untuk rantai.