kalmusgo-api-doc.md

Dokumentasi API Kalender Musim Gorontalo

 

Konstruktor

Sintaks

new Kalmusgo([modeHijriah[, tahun[, indeksBulan[, mulaiHari[, warnaTema[, timeout]]]]]]);

Parameter-Parameter

• modeHijriah (optional)
  Bilangan boolean yang menunjukkan mode kalender:
  true: kalender Hijriah
  false: kalender Masehi
  Default: false

• tahun (optional)
  Bilangan bulat yang menunjukkan angka tahun kalender. Bisa diisi dengan angka dibawah 1 (0 atau bilangan negatif) yang menunjukkan penanggalan sebelum Hijriah/Masehi. Angka 0 berarti 1 SH/SM, -1 berarti 2 SH/SM, dan seterusnya.
  Default: tahun sekarang

• indeksBulan (optional)
  Bilangan bulat yang menunjukkan angka indeks bulan kalender, mulai dari 0 untuk bulan Muharam/Januari hingga 11 untuk bulan Zulhijjah/Desember.
  Default: indeks dari bulan sekarang

• mulaiHari (optional)
  Bilangan bulat yang menunjukkan hari pertama dalam mingguan (0-6), angka 0 untuk hari Senin hingga 6 untuk hari Sabtu.
  Default: 1 (hari Senin)

• warnaTema (optional)
  Bilangan bulat yang menunjukkan indeks warna tema (0-22) atau nilai string berupa warna yang digunakan.
   0 atau "amber"
 1 atau "aqua"
 2 atau "black"
 3 atau "blue"
 4 atau "blue-grey""
   5 atau "brown"
 6 atau "cyan"
 7 atau "dark-grey"
 8 atau "deep-orange"
 9 atau "deep-purple"
10 atau "green"
11 atau "grey"
12 atau "indigo"
13 atau "khaki"
14 atau "light-blue"
15 atau "light-green"
16 atau "lime"
17 atau "orange"
18 atau "pink"
19 atau "purple"
20 atau "red"
21 atau "teal"
22 atau "yellow"
  Default: akan dipilih salah satu warna di atas secara acak

• timeout (optional)
  Bilangan bulat yang menunjukkan angka timeout dalam detik untuk kembali ke tampilan tanggal sekarang.
  Default: 120 detik

Metode-Metode Instans Kalmusgo

• .attachTo(elemenParent)
  Mengisikan elemen kalender ke dalam elemen HTML pada variabel elemenParent.

• .fireResize()
  Memberitahu kalender untuk menyesuaikan tampilan dengan layar agar tetap responsif, terutama bila konteinernya (elemen HTML parent) statis atau bukan document.body.

• .getElement()
  Mengembalikan elemen kalender.

• .resetDate(tahun, indeksBulan)
  Mengatur tampilan kalender pada angka tahun dan indeks bulan tertentu sekaligus, sesuai dengan bilangan bulat tahun dan bilangan bulat indeksBulan.

• .setFirstDayOfWeek(mulaiHari)
  Mengatur tampilan kalender dimulai dengan hari tertentu yang ditunjukkan oleh mulaiHari berupa bilangan bulat (0-6).

• .setFullYear(tahun)
  Mengatur tampilan kalender pada angka tahun tertentu yang ditunjukkan oleh tahun yang berupa bilangan bulat.

• .setHijriMode(modeHijriah)
  Mengatur mode kalender dengan bilangan boolean modeHijriah.
  true: kalender Hijriah
  false: kalender Masehi

• .setMonth(indeksBulan)
  Mengatur tampilan kalender pada bulan tertentu yang ditunjukkan oleh indeksBulan yang berupa bilangan bulat.

• .setTheme([warnaTema])
  Mengatur warna tema kalender dengan bilangan bulat (0-22) sebagai indeks warna atau nama warna dalam string yang ditunjukkan oleh warnaTema. Bila warnaTema dihilangkan maka salah satu warna yang dipilih secara acak yang akan diterapkan.
   0 atau "amber"
 1 atau "aqua"
 2 atau "black"
 3 atau "blue"
 4 atau "blue-grey""
   5 atau "brown"
 6 atau "cyan"
 7 atau "dark-grey"
 8 atau "deep-orange"
 9 atau "deep-purple"
10 atau "green"
11 atau "grey"
12 atau "indigo"
13 atau "khaki"
14 atau "light-blue"
15 atau "light-green"
16 atau "lime"
17 atau "orange"
18 atau "pink"
19 atau "purple"
20 atau "red"
21 atau "teal"
22 atau "yellow"

• .setTime(waktu)
  Mengatur tampilan kalender pada satu waktu tertentu yang ditunjukkan oleh bilangan bulat waktu sebagai angka dalam milidetik.

• .setTodayTimeout(timeout)
  Mengatur waktu timeout dalam bilangan bulat timeout sebagai angka dalam detik untuk mengembalikan tampilan kalender ke waktu sekarang.

• .today()
  Mengembalikan tampilan kalender ke waktu tahun dan bulan sekarang.

Metode-Metode Tambahan untuk Date.prototype dan HijriDate.prototype

Dengan menggunakan librari ini, metode-metode berikut akan ditambahkan pada instans Date.prototype dan HijriDate.prototype.

• .getMonthName([indeksBulan])
  Mengembalikan nama bulan sesuai angka indeks bulan (0-11) yang diinginkan dalam indeksBulan sebagai nilai string ("Januari"-"Desember" atau "Muharam"-"Zulhijjah"). If indeksBulan dihilangkan maka nama bulan sekarang yang akan dikembalikan.

• .getMonthShortName([indeksBulan])
  Mengembalikan nama dari indeks bulan (0-11) yang diinginkanthat dalam indkesBulan sebagai string yang bisa dibaca ("Januari"-"Desember" atau "Muharam"-"Zulhijjah"). Jika indeksBulan dihilangkan maka nama bulan sekarang yang akan dikembalikan.

• .getWeekdayName([hari])
  Mengembalikan nama hari (0-6) dalam hari sebagai string yang bisa dibaca ("Minggu"-"Sabtu"). Jika hari dihilangkan maka nama hari sekarang yang akan dikembalikan.

• .getWeekdayShortName([hari])
  Mengembalikan singkatan nama hari (0-6) dalam hari sebagai string yang bisa dibaca ("Min"-"Sab"). Jika hari dihilangkan maka singkatan nama hari sekarang yang akan dikembalikan.

• .getYearString([tahun])
  Mengembalikan bilangan bulat tahun yang diinginkan dalam tahun diikuti dengan singkatan era ("M"/"SM" atau "H"/"SH") sebagai string. Jika tahun dihilangkan maka tahun sekarang yang akan dikembalikan.

• .todayShortString()
  Mengembalikan singkatan tanggal sekarang sebagai string yang bisa dibaca tergantung mode kalender (Masehi atau Hijriah). Sebagai contoh "Jum, 4 Jan 2019" untuk mode kalender Masehi atau "Jum, 27 Rak 1440" untuk mode kalender Hijriah.

• .todayString()
  Mengembalikan tanggal sekarang sebagai string yang bisa dibaca tergantung mode kalender (Masehi atau Hijriah). Sebagai contoh "Jum'at, 4 Januari 2019" untuk mode kalender Masehi atau "Jum'at, 27 Rabi'ul-Akhir 1440" untuk mode kalender Hijriah.

 

 

 

---

Didesain oleh ZulNs

@Gorontalo, 29 April 2019

---