TimelineKit API
Docs
Gantt Chart
Resource Scheduler
Event Calendar
Preparing search index...
CalendarTask
Class CalendarTask
Hierarchy (
View Summary
)
CalendarItem
CalendarTask
Index
Constructors
constructor
Properties
data
end
Time
Changed$
changed$
start
Time
Changed$
type
Accessors
calendar
Id
color
completed
At
description
end
Time
external
Source
has
Reminders
id
is
All
Day
is
Completed
is
Recurring
location
priority
recurrence
Exceptions
recurrence
Rule
start
Time
tags
time
Zone
title
visibility
Methods
add
Property
cancel
Occurrence
clear
Exceptions
clone
get
Exception
get
Property
By
Name
get
Property
Value
remove
Exception
remove
Property
set
Exception
set
Property
Value
to
Any
from
Any
Constructors
constructor
new
CalendarTask
(
id
:
string
|
null
)
:
CalendarTask
Parameters
id
:
string
|
null
Returns
CalendarTask
Properties
data
data
:
any
= undefined
end
Time
Changed$
endTimeChanged$
:
Subject
<
CalendarItemEventArgs
>
= ...
changed$
changed$
:
Subject
<
CalendarItemEventArgs
>
= ...
start
Time
Changed$
startTimeChanged$
:
Subject
<
CalendarItemEventArgs
>
= ...
Readonly
type
type
:
"task"
= ...
Accessors
calendar
Id
get
calendarId
()
:
string
|
null
Returns
string
|
null
set
calendarId
(
value
:
string
|
null
)
:
void
Parameters
value
:
string
|
null
Returns
void
color
get
color
()
:
ColorValue
Color index into the theme's taskColors array, or a custom color definition.
Returns
ColorValue
set
color
(
value
:
ColorValue
)
:
void
Parameters
value
:
ColorValue
Returns
void
completed
At
get
completedAt
()
:
Date
|
null
Returns
Date
|
null
set
completedAt
(
value
:
Date
|
null
)
:
void
Parameters
value
:
Date
|
null
Returns
void
description
get
description
()
:
string
|
null
Returns
string
|
null
set
description
(
value
:
string
|
null
)
:
void
Parameters
value
:
string
|
null
Returns
void
end
Time
get
endTime
()
:
Date
|
null
Returns
Date
|
null
set
endTime
(
value
:
Date
|
null
)
:
void
Parameters
value
:
Date
|
null
Returns
void
external
Source
get
externalSource
()
:
string
|
null
Returns
string
|
null
set
externalSource
(
value
:
string
|
null
)
:
void
Parameters
value
:
string
|
null
Returns
void
has
Reminders
get
hasReminders
()
:
boolean
Returns
boolean
set
hasReminders
(
value
:
boolean
)
:
void
Parameters
value
:
boolean
Returns
void
id
get
id
()
:
string
Returns
string
is
All
Day
get
isAllDay
()
:
boolean
Returns
boolean
set
isAllDay
(
value
:
boolean
)
:
void
Parameters
value
:
boolean
Returns
void
is
Completed
get
isCompleted
()
:
boolean
Returns
boolean
set
isCompleted
(
value
:
boolean
)
:
void
Parameters
value
:
boolean
Returns
void
is
Recurring
get
isRecurring
()
:
boolean
Returns
boolean
location
get
location
()
:
string
|
null
Returns
string
|
null
set
location
(
value
:
string
|
null
)
:
void
Parameters
value
:
string
|
null
Returns
void
priority
get
priority
()
:
number
Returns
number
set
priority
(
value
:
number
)
:
void
Parameters
value
:
number
Returns
void
recurrence
Exceptions
get
recurrenceExceptions
()
:
readonly
RecurrenceException
[]
Returns
readonly
RecurrenceException
[]
recurrence
Rule
get
recurrenceRule
()
:
RecurrenceRule
|
null
Returns
RecurrenceRule
|
null
set
recurrenceRule
(
value
:
RecurrenceRule
|
null
)
:
void
Parameters
value
:
RecurrenceRule
|
null
Returns
void
start
Time
get
startTime
()
:
Date
|
null
Returns
Date
|
null
set
startTime
(
value
:
Date
|
null
)
:
void
Parameters
value
:
Date
|
null
Returns
void
tags
get
tags
()
:
string
[]
|
null
Returns
string
[]
|
null
set
tags
(
value
:
string
[]
|
null
)
:
void
Parameters
value
:
string
[]
|
null
Returns
void
time
Zone
get
timeZone
()
:
string
|
null
Returns
string
|
null
set
timeZone
(
value
:
string
|
null
)
:
void
Parameters
value
:
string
|
null
Returns
void
title
get
title
()
:
string
|
null
Returns
string
|
null
set
title
(
value
:
string
|
null
)
:
void
Parameters
value
:
string
|
null
Returns
void
visibility
get
visibility
()
:
CalendarItemVisibility
Returns
CalendarItemVisibility
set
visibility
(
value
:
CalendarItemVisibility
)
:
void
Parameters
value
:
CalendarItemVisibility
Returns
void
Methods
add
Property
addProperty
(
property
:
CustomProperty
)
:
void
Parameters
property
:
CustomProperty
Returns
void
cancel
Occurrence
cancelOccurrence
(
originalStartTime
:
Date
)
:
void
Parameters
originalStartTime
:
Date
Returns
void
clear
Exceptions
clearExceptions
()
:
void
Returns
void
clone
clone
(
newId
:
string
|
null
)
:
CalendarTask
Parameters
newId
:
string
|
null
Returns
CalendarTask
get
Exception
getException
(
originalStartTime
:
Date
)
:
RecurrenceException
|
null
Parameters
originalStartTime
:
Date
Returns
RecurrenceException
|
null
get
Property
By
Name
getPropertyByName
(
name
:
string
)
:
CustomProperty
|
null
Parameters
name
:
string
Returns
CustomProperty
|
null
get
Property
Value
getPropertyValue
(
name
:
string
)
:
any
Parameters
name
:
string
Returns
any
remove
Exception
removeException
(
originalStartTime
:
Date
)
:
void
Parameters
originalStartTime
:
Date
Returns
void
remove
Property
removeProperty
(
property
:
CustomProperty
)
:
void
Parameters
property
:
CustomProperty
Returns
void
set
Exception
setException
(
exception
:
RecurrenceException
)
:
void
Parameters
exception
:
RecurrenceException
Returns
void
set
Property
Value
setPropertyValue
(
name
:
string
,
value
:
any
)
:
void
Parameters
name
:
string
value
:
any
Returns
void
to
Any
toAny
()
:
any
Returns
any
Static
from
Any
fromAny
(
data
:
any
)
:
CalendarTask
Parameters
data
:
any
Returns
CalendarTask
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
data
end
Time
Changed$
changed$
start
Time
Changed$
type
Accessors
calendar
Id
color
completed
At
description
end
Time
external
Source
has
Reminders
id
is
All
Day
is
Completed
is
Recurring
location
priority
recurrence
Exceptions
recurrence
Rule
start
Time
tags
time
Zone
title
visibility
Methods
add
Property
cancel
Occurrence
clear
Exceptions
clone
get
Exception
get
Property
By
Name
get
Property
Value
remove
Exception
remove
Property
set
Exception
set
Property
Value
to
Any
from
Any
Docs
Gantt Chart
Resource Scheduler
Event Calendar
TimelineKit API
Loading...
Color index into the theme's taskColors array, or a custom color definition.