Options
All
  • Public
  • Public/Protected
  • All
Menu

This is a calendar interval mixin.

Can be either a static time interval (if startDate/endDate are specified and no recurrentStartDate provided) or recurrent time interval (has recurrentStartDate provided).

By default it defines a non-working period (isWorking field has default value false), but can also define an explicit working time, for example to override some previous period.

You probably don't need to create instances of this mixin directly, instead you pass its configuration object to the AbstractCalendarMixin.addInterval

Hierarchy

Index

Properties

$project

The project instance, this entity belongs to.

availability

availability: AvailabilityRange[]

Working time for the interval.

cls

cls: string

A CSS class to add to the element visualizing this interval.

color

color: string

The interval color (the value is used in the calendar editor popup).

endDate

endDate: Date

The end date of the fixed (not recurrent) time interval.

iconCls

iconCls: string

A CSS class used to add an icon to the element visualizing this interval.

isWorking

isWorking: boolean

The "is working" flag, which defines what kind of interval this is - either working or non-working. Default value is false, denoting non-working intervals.

name

name: string

The name of the recurrent time interval. Might be used in the UI when visualizing intervals.

priority

priority: number

The priority of the interval.

recurrentDatesTimeZone

recurrentDatesTimeZone: string | number

A time zone in which recurrentStartDate and recurrentEndDate rules are specified, as an IANA time zone (i.e. Europe/Stockholm). If not provided, the rules are specified in the project's time zone, or in the local time zone when the project has none.

A UTC offset in minutes (i.e. -120) is only supported in the legacy time zone mode.

recurrentEndDate

recurrentEndDate: string

The end date of the recurrent time interval. Should be specified as any expression recognized by the CalendarIntervalParser.parseText parser.

The field value can be omitted when recurrentStartDate has a recurrence rule provided. In this case the interval will be calculated based on start date schedule only. And then the effective interval end will be calculated as the end of the day found based on the start date schedule.

recurrentStartDate

recurrentStartDate: string

The start date of the recurrent time interval. Should be specified as any expression recognized by the CalendarIntervalParser.parseText parser.

startDate

startDate: Date

The start date of the fixed (not recurrent) time interval.

type

type: CalendarIntervalType

Interval type (can be either a week or an exception).

Methods

getAssignmentStore

  • getAssignmentStore(): this["project"]["assignmentStore"]
  • Convenience method to get the instance of the assignment store in the project instance, this entity belongs to.

    Returns this["project"]["assignmentStore"]

getCalendarManagerStore

  • getCalendarManagerStore(): this["project"]["calendarManagerStore"]
  • Convenience method to get the instance of the calendar manager store in the project instance, this entity belongs to.

    Returns this["project"]["calendarManagerStore"]

getDependencyStore

  • getDependencyStore(): this["project"]["dependencyStore"]
  • Convenience method to get the instance of the dependency store in the project instance, this entity belongs to.

    Returns this["project"]["dependencyStore"]

getEventStore

  • getEventStore(): this["project"]["eventStore"]
  • Convenience method to get the instance of the event store in the project instance, this entity belongs to.

    Returns this["project"]["eventStore"]

getProject

  • getProject(): this["project"]

getResourceStore

  • getResourceStore(): this["project"]["resourceStore"]
  • Convenience method to get the instance of the resource store in the project instance, this entity belongs to.

    Returns this["project"]["resourceStore"]

isRecurrent

  • isRecurrent(): boolean

isStatic

  • isStatic(): boolean

joinProject

  • joinProject(): void
  • Template method, which is called when model is joining the project (through joining some store that has already joined the project)

    Returns void

leaveProject

  • leaveProject(isReplacing?: boolean): void
  • Template method, which is called when model is leaving the project (through leaving some store usually)

    Parameters

    • Default value isReplacing: boolean = false

    Returns void

Private parseDateSchedule

  • parseDateSchedule(value: any): any

setProject

  • setProject(project: this["project"]): this["project"]
  • The method to set the project instance, this entity belongs to.

    Parameters

    • project: this["project"]

    Returns this["project"]

Generated using TypeDoc