| Documentation

Kalendar

This JavaScript file contains the Kalendar class

new Kalendar(div: any)

Version: 1.o

Author: Don Dugger

Parameters

div (any)

Static Members

▸ events

Holidays and Events

Event structure "mm/dd/T:text"
   mm              month 1-12
   dd or position  day of month ( 1-31 or day position )
   T               Event type "H" = Holiday, "I" = Information, "P" = Personal
   text            Displayed texmt

The day position:
First 3 characters are the day of the week. Followed by the position first, second, third, fourth or last. The day position ignores case.

events

▸ init(div)

Initialize

init(div: string)

Parameters

div (string) This is the

where the calendar will be displayed.

▸ setLocation(latitude, longitude)

set the location's latitude and longitude for sunrise and sunset. (If not set the sunrise & sunset will not be in the tool tip.)

setLocation(latitude: number, longitude: number)

Parameters

latitude (number) The latitude for the sun rise/set times

longitude (number) The longitude for the sun rise/set times

▸ navLocation(pos)

The navigator.geolocation read-only property returns a Geolocation object that gives Web content access to the location of the device. This allows a website or app to offer customized results based on the user's location.

navLocation(pos: position)

Parameters

pos (position) The location returned by the browser

▸ setDate(year, month)

Set the date, year and mouth to be displayed.

setDate(year: number, month: number)

Parameters

year (number) The year to be set

month (number) The to be set

▸ getOffset()

Get the offset of the first row to the 1st date. In order to determine the first cell to be populated.

getOffset(): number

Returns

number: The offset

▸ getDaysInMonth(year, month)

Get total number of days in the current month.

getDaysInMonth(year: number, month: number)

Parameters

year

(number
            = this.year)

The year to be used

month

(number
            = this.month)

The month to get the number

▸ getPrevNextMonth()

Get the month before and after the current month and the number of days in the previous month in oder to fill in the cells at the beginning of the calendar.

getPrevNextMonth()

▸ prevYear()

Go to the previous Year.

prevYear()

▸ nextYear()

Go to the next Year.

nextYear()

▸ prevMonth()

Go to the previous month.

prevMonth()

▸ nextMonth()

Go to the next month.

nextMonth()

▸ dayNames

Add the the days of the week to heading of calendar table.

dayNames

▸ NEW_MOON

Add the rows of calendar table.

NEW_MOON

▸ NEW_MOON

NEW_MOON

▸ display()

Display the calendar.

display()

▸ allowNotes(allow)

Allow Notes

allowNotes(allow: boolean)

Parameters

allow (boolean) Turn on or off adding notes

▸ setNotesList(list)

Input the note list.

setNotesList(list: Array<string>)

Parameters

list (Array<string>) The list of notes

▸ addNote()

A note is a line of text that will be displayed in a given date cell.

addNote()

▸ readNotes()

The list of notes are stored in a JSON formatted file.

readNotes()

▸ zeroPad

Add the content of the note dialog box.

zeroPad

▸ delNote(note)

Delete a note from the current list of notes. Note this does not delete the note from the file. The "SAVE" button in the note dialog box will rewrite the file.

delNote(note: number)

Parameters

note (number) The index of the note to be deleted

▸ displayYear(year)

Display the entire year in a pop-up box.

displayYear(year: number)

Parameters

year (number) The year to be displayed

▸ displayMonth(year)

Display one month in the year pop-up box.

displayMonth(year: number)

Parameters

year (number) The year to be displayed

▸ addEvent(ev)

Add an event.

Event structure "mm/dd/T:text"

mm month 1-12
dd or position day of month ( 1-31 or day position )
T Event type "H" = Holiday, "I" = Information, "P" = Personal
text Displayed text

The day position: First 3 characters are the day of the week. Followed by the position first, second, third, fourth or last. The day position ignores case.

addEvent(ev: string)

Parameters

ev (string) The event

▸ dayShortNames

Events ( Holidays, Information and Personal events )

dayShortNames

Parameters

str (string) The day of month of position

day_of_week (number) The day of the week (0-6)

▸ isEvent(year, month, day, day_of_week, type)

Check if a data is a holiday.

isEvent(year: number, month: number, day: number, day_of_week: number, type: string)

Parameters

year (number) The year

month (number) The month

day (number) The day of the month

day_of_week (number) The day of week

type (string) Type of event

▸ easter(year)

Calculate Easter

easter(year: number)

Parameters

year (number) The year

Kalendar

new Kalendar(div: string)

Parameters

div (string) -This is the

where the calendar will be displayed.

Static Members

▸ events

Holidays and Events

Event structure "mm/dd/T:text"
   mm              month 1-12
   dd or position  day of month ( 1-31 or day position )
   T               Event type "H" = Holiday, "I" = Information, "P" = Personal
   text            Displayed texmt

The day position:
First 3 characters are the day of the week. Followed by the position first, second, third, fourth or last. The day position ignores case.

events

▸ init(div)

Initialize

init(div: string)

Parameters

div (string) This is the

where the calendar will be displayed.

▸ setLocation(latitude, longitude)

set the location's latitude and longitude for sunrise and sunset. (If not set the sunrise & sunset will not be in the tool tip.)

setLocation(latitude: number, longitude: number)

Parameters

latitude (number) The latitude for the sun rise/set times

longitude (number) The longitude for the sun rise/set times

▸ navLocation(pos)

navLocation(pos: position)

Parameters

pos (position) The location returned by the browser

▸ setDate(year, month)

Set the date, year and mouth to be displayed.

setDate(year: number, month: number)

Parameters

year (number) The year to be set

month (number) The to be set

▸ getOffset()

Get the offset of the first row to the 1st date. In order to determine the first cell to be populated.

getOffset(): number

Returns

number: The offset

▸ getDaysInMonth(year, month)

Get total number of days in the current month.

getDaysInMonth(year: number, month: number)

Parameters

year

(number
            = this.year)

The year to be used

month

(number
            = this.month)

The month to get the number

▸ getPrevNextMonth()

Get the month before and after the current month and the number of days in the previous month in oder to fill in the cells at the beginning of the calendar.

getPrevNextMonth()

▸ prevYear()

Go to the previous Year.

prevYear()

▸ nextYear()

Go to the next Year.

nextYear()

▸ prevMonth()

Go to the previous month.

prevMonth()

▸ nextMonth()

Go to the next month.

nextMonth()

▸ dayNames

Add the the days of the week to heading of calendar table.

dayNames

▸ NEW_MOON

Add the rows of calendar table.

NEW_MOON

▸ NEW_MOON

NEW_MOON

▸ display()

Display the calendar.

display()

▸ allowNotes(allow)

Allow Notes

allowNotes(allow: boolean)

Parameters

allow (boolean) Turn on or off adding notes

▸ setNotesList(list)

Input the note list.

setNotesList(list: Array<string>)

Parameters

list (Array<string>) The list of notes

▸ addNote()

A note is a line of text that will be displayed in a given date cell.

addNote()

▸ readNotes()

The list of notes are stored in a JSON formatted file.

readNotes()

▸ zeroPad

Add the content of the note dialog box.

zeroPad

▸ delNote(note)

Delete a note from the current list of notes. Note this does not delete the note from the file. The "SAVE" button in the note dialog box will rewrite the file.

delNote(note: number)

Parameters

note (number) The index of the note to be deleted

▸ displayYear(year)

Display the entire year in a pop-up box.

displayYear(year: number)

Parameters

year (number) The year to be displayed

▸ displayMonth(year)

Display one month in the year pop-up box.

displayMonth(year: number)

Parameters

year (number) The year to be displayed

▸ addEvent(ev)

Add an event.

Event structure "mm/dd/T:text"

mm month 1-12
dd or position day of month ( 1-31 or day position )
T Event type "H" = Holiday, "I" = Information, "P" = Personal
text Displayed text

The day position: First 3 characters are the day of the week. Followed by the position first, second, third, fourth or last. The day position ignores case.

addEvent(ev: string)

Parameters

ev (string) The event

▸ dayShortNames

Events ( Holidays, Information and Personal events )

dayShortNames

Parameters

str (string) The day of month of position

day_of_week (number) The day of the week (0-6)

▸ isEvent(year, month, day, day_of_week, type)

Check if a data is a holiday.

isEvent(year: number, month: number, day: number, day_of_week: number, type: string)

Parameters

year (number) The year

month (number) The month

day (number) The day of the month

day_of_week (number) The day of week

type (string) Type of event

▸ easter(year)

Calculate Easter

easter(year: number)

Parameters

year (number) The year

display

If the browser is given permission to obtain the location it will be set automatically. Other wise it can be set with the setLocation() function. Note the call to display() is in navLocation()

display

append

Put in the rows of the calendar.

append

ct

The Seven days

now

Set the cell type

now

str

Display the day of the month.

str

Display Content.

str

Tool Tips - includes full data.

str

day_of_month

Display phase of the Moon

day_of_month