@syncfusion/ej2-schedule 30.2.7 → 31.1.17

package/dist/ts/schedule/models/fields.ts

@@ -0,0 +1,149 @@
+import { Property, ChildProperty, Complex } from '@syncfusion/ej2-base';
+import { FieldOptionsModel } from './field-options-model';
+import { FieldOptions } from './field-options';
+
+/**
+ * A class that holds the collection of event fields that requires to be mapped with the dataSource
+ * fields along with its available configuration settings. Each field in it accepts both string and object
+ *  data type. When each of the field is assigned with simple `string` value, it is assumed that the dataSource field
+ *  name is mapped with it. If the `object` type is defined on each fields, then the validation related settings and mapping of
+ *  those fields with dataSource can be given altogether within it.
+ */
+export class Field extends ChildProperty<Field> {
+    /**
+     * The `id` field needs to be defined as mandatory, when the Schedule is bound to remote data and
+     *  it is optional, if the same is bound with JSON data. This field usually assigns ID value to each of the events.
+     *
+     * @default null
+     */
+    @Property('Id')
+    public id: string;
+
+    /**
+     * The `isBlock` field allows you to block certain time interval on the Scheduler.
+     * It is a boolean type property accepting either true or false values.
+     * When set to true, creates a block range for the specified time interval and disables the event scheduling actions on that time range.
+     *
+     * @default null
+     */
+    @Property('IsBlock')
+    public isBlock: string;
+
+    /**
+     * The `subject` field is optional, and usually assigns the subject text to each of the events.
+     *
+     * @default { name: null, default: null, title: null, validation: {}  }
+     */
+    @Complex<FieldOptionsModel>({ name: 'Subject' }, FieldOptions)
+    public subject: FieldOptionsModel;
+
+    /**
+     * The `startTime` field defines the start time of an event and it is mandatory to provide it for any of the valid event objects.
+     *
+     * @default { name: null, default: null, title: null, validation: {} }
+     */
+    @Complex<FieldOptionsModel>({ name: 'StartTime' }, FieldOptions)
+    public startTime: FieldOptionsModel;
+
+    /**
+     * The `endTime` field defines the end time of an event and it is mandatory to provide the end time for any of the valid event objects.
+     *
+     * @default { name: null, default: null, title: null, validation: {} }
+     */
+    @Complex<FieldOptionsModel>({ name: 'EndTime' }, FieldOptions)
+    public endTime: FieldOptionsModel;
+
+    /**
+     * It maps the `startTimezone` field from the dataSource and usually accepts the valid
+     * [`IANA timezone names`](https://docs.actian.com/ingres/11.0/index.html#page/Ing_Install/IANA_World_Regions_and_Time_Zone_Names.htm).
+     *  It is assumed that the value provided for this field is taken into consideration while processing
+     *  the `startTime` field. When this field is not mapped with any timezone names,
+     *  then the events will be processed based on the timezone assigned to the Schedule.
+     *
+     * @default { name: null, default: null, title: null, validation: {} }
+     */
+    @Complex<FieldOptionsModel>({ name: 'StartTimezone' }, FieldOptions)
+    public startTimezone: FieldOptionsModel;
+
+    /**
+     * It maps the `endTimezone` field from the dataSource and usually accepts the valid
+     * [`IANA timezone names`](https://docs.actian.com/ingres/11.0/index.html#page/Ing_Install/IANA_World_Regions_and_Time_Zone_Names.htm).
+     *  It is assumed that the value provided for this field is taken into consideration while processing the `endTime` field.
+     *  When this field is not mapped with any timezone names, then the events will be processed based on the timezone assigned
+     *  to the Schedule.
+     *
+     * @default { name: null, default: null, title: null, validation: {} }
+     */
+    @Complex<FieldOptionsModel>({ name: 'EndTimezone' }, FieldOptions)
+    public endTimezone: FieldOptionsModel;
+
+    /**
+     * It maps the `location` field from the dataSource and the location field value will be displayed over
+     *  events, while given it for an event object.
+     *
+     * @default { name: null, default: null, title: null, validation: {} }
+     */
+    @Complex<FieldOptionsModel>({ name: 'Location' }, FieldOptions)
+    public location: FieldOptionsModel;
+
+    /**
+     * It maps the `description` field from the dataSource and denotes the event description which is optional.
+     *
+     * @default { name: null, default: null, title: null, validation: {} }
+     */
+    @Complex<FieldOptionsModel>({ name: 'Description' }, FieldOptions)
+    public description: FieldOptionsModel;
+
+    /**
+     * The `isAllDay` field is mapped from the dataSource and is used to denote whether an event is created
+     * for an entire day or for specific time alone.
+     *
+     * @default { name: null, default: null, title: null, validation: {} }
+     */
+    @Complex<FieldOptionsModel>({ name: 'IsAllDay' }, FieldOptions)
+    public isAllDay: FieldOptionsModel;
+
+    /**
+     * It maps the `recurrenceID` field from dataSource and usually holds the ID value of the parent
+     *  recurrence event. It is applicable only for the edited occurrence events.
+     *
+     * @default { name: null, default: null, title: null, validation: {} }
+     */
+    @Complex<FieldOptionsModel>({ name: 'RecurrenceID' }, FieldOptions)
+    public recurrenceID: FieldOptionsModel;
+
+    /**
+     * It maps the `recurrenceRule` field from dataSource and is used to uniquely identify whether the
+     *  event belongs to a recurring event type or normal ones.
+     *
+     * @default { name: null, default: null, title: null, validation: {} }
+     */
+    @Complex<FieldOptionsModel>({ name: 'RecurrenceRule' }, FieldOptions)
+    public recurrenceRule: FieldOptionsModel;
+
+    /**
+     * It maps the `recurrenceException` field from dataSource and is used to hold the exception dates
+     *  which needs to be excluded from recurring type.
+     *
+     * @default { name: null, default: null, title: null, validation: {} }
+     */
+    @Complex<FieldOptionsModel>({ name: 'RecurrenceException' }, FieldOptions)
+    public recurrenceException: FieldOptionsModel;
+
+    /**
+     * The `isReadonly` field is mapped from the dataSource and is used to prevent the CRUD actions on specific events.
+     *
+     * @default null
+     */
+    @Property('IsReadonly')
+    public isReadonly: string;
+
+    /**
+     * The `followingID` field is mapped from dataSource and usually holds the ID value of the main parent event.
+     *
+     * @default null
+     */
+    @Property('FollowingID')
+    public followingID: string;
+
+}

package/dist/ts/schedule/models/group-model.d.ts

@@ -0,0 +1,69 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';
+
+/**
+ * Interface for a class Group
+ */
+export interface GroupModel {
+
+    /**
+     * When set to `true`, groups the resources by date where each day renders all the resource names under it.
+     *
+     * @default false
+     */
+    byDate?: boolean;
+
+    /**
+     * Decides whether to allow the resource hierarchy to group by ID. It is set to `true` by default and when set to false,
+     *  all the resources under child collection will be mapped against each available parent.
+     *
+     * @default true
+     */
+    byGroupID?: boolean;
+
+    /**
+     * Allows creation and editing of linked appointments assigned to multiple resources. When set to `true`,
+     *  a single appointment object instance will be maintained in schedule dataSource that are created for
+     *  multiple resources, whereas displayed individually on UI.
+     *
+     * @default false
+     */
+    allowGroupEdit?: boolean;
+
+    /**
+     * Accepts the collection of resource names assigned to each resources and allows the grouping order on schedule based on it.
+     *
+     * @default []
+     */
+    resources?: string[];
+
+    /**
+     * Decides whether to display the resource grouping layout in normal or compact mode in mobile devices. When set to `false`,
+     *  the default grouping layout on desktop will be displayed on mobile devices with scrolling enabled.
+     *
+     * @default true
+     */
+    enableCompactView?: boolean;
+
+    /**
+     * Template option to customize the tooltip that displays over the resource header bar. By default, no tooltip will be
+     *  displayed on resource header bar. It accepts either the string or HTMLElement as template design content and
+     *  parse it appropriately before displaying it onto the tooltip. All the resource fields mapped for resource dataSource
+     *  can be accessed within this template code.
+     *
+     * @default null
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    headerTooltipTemplate?: string | Function;
+
+    /**
+     * Decides whether to show/hide the non-working days. It is set to `false` by default and when set to `true`, it hides the non-working days.
+     * This property is applicable for `Day`, `Week`, `WorkWeek` and `month` views, which are grouped under date.
+     *
+     * @default false
+     */
+    hideNonWorkingDays?: boolean;
+
+}

package/dist/ts/schedule/models/group.d.ts

@@ -0,0 +1,60 @@
+import { ChildProperty } from '@syncfusion/ej2-base';
+/**
+ * A class that holds the resource grouping related configurations on Schedule.
+ */
+export declare class Group extends ChildProperty<Group> {
+    /**
+     * When set to `true`, groups the resources by date where each day renders all the resource names under it.
+     *
+     * @default false
+     */
+    byDate: boolean;
+    /**
+     * Decides whether to allow the resource hierarchy to group by ID. It is set to `true` by default and when set to false,
+     *  all the resources under child collection will be mapped against each available parent.
+     *
+     * @default true
+     */
+    byGroupID: boolean;
+    /**
+     * Allows creation and editing of linked appointments assigned to multiple resources. When set to `true`,
+     *  a single appointment object instance will be maintained in schedule dataSource that are created for
+     *  multiple resources, whereas displayed individually on UI.
+     *
+     * @default false
+     */
+    allowGroupEdit: boolean;
+    /**
+     * Accepts the collection of resource names assigned to each resources and allows the grouping order on schedule based on it.
+     *
+     * @default []
+     */
+    resources: string[];
+    /**
+     * Decides whether to display the resource grouping layout in normal or compact mode in mobile devices. When set to `false`,
+     *  the default grouping layout on desktop will be displayed on mobile devices with scrolling enabled.
+     *
+     * @default true
+     */
+    enableCompactView: boolean;
+    /**
+     * Template option to customize the tooltip that displays over the resource header bar. By default, no tooltip will be
+     *  displayed on resource header bar. It accepts either the string or HTMLElement as template design content and
+     *  parse it appropriately before displaying it onto the tooltip. All the resource fields mapped for resource dataSource
+     *  can be accessed within this template code.
+     *
+     * @default null
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    headerTooltipTemplate: string | Function;
+    /**
+     * Decides whether to show/hide the non-working days. It is set to `false` by default and when set to `true`, it hides the non-working days.
+     * This property is applicable for `Day`, `Week`, `WorkWeek` and `month` views, which are grouped under date.
+     *
+     * @default false
+     */
+    hideNonWorkingDays: boolean;
+}

package/dist/ts/schedule/models/group.ts

@@ -0,0 +1,75 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';
+
+/**
+ * A class that holds the resource grouping related configurations on Schedule.
+ */
+export class Group extends ChildProperty<Group> {
+    /**
+     * When set to `true`, groups the resources by date where each day renders all the resource names under it.
+     *
+     * @default false
+     */
+    @Property(false)
+    public byDate: boolean;
+
+    /**
+     * Decides whether to allow the resource hierarchy to group by ID. It is set to `true` by default and when set to false,
+     *  all the resources under child collection will be mapped against each available parent.
+     *
+     * @default true
+     */
+    @Property(true)
+    public byGroupID: boolean;
+
+    /**
+     * Allows creation and editing of linked appointments assigned to multiple resources. When set to `true`,
+     *  a single appointment object instance will be maintained in schedule dataSource that are created for
+     *  multiple resources, whereas displayed individually on UI.
+     *
+     * @default false
+     */
+    @Property(false)
+    public allowGroupEdit: boolean;
+
+    /**
+     * Accepts the collection of resource names assigned to each resources and allows the grouping order on schedule based on it.
+     *
+     * @default []
+     */
+    @Property([])
+    public resources: string[];
+
+    /**
+     * Decides whether to display the resource grouping layout in normal or compact mode in mobile devices. When set to `false`,
+     *  the default grouping layout on desktop will be displayed on mobile devices with scrolling enabled.
+     *
+     * @default true
+     */
+    @Property(true)
+    public enableCompactView: boolean;
+
+    /**
+     * Template option to customize the tooltip that displays over the resource header bar. By default, no tooltip will be
+     *  displayed on resource header bar. It accepts either the string or HTMLElement as template design content and
+     *  parse it appropriately before displaying it onto the tooltip. All the resource fields mapped for resource dataSource
+     *  can be accessed within this template code.
+     *
+     * @default null
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    @Property()
+    public headerTooltipTemplate: string | Function;
+
+    /**
+     * Decides whether to show/hide the non-working days. It is set to `false` by default and when set to `true`, it hides the non-working days.
+     * This property is applicable for `Day`, `Week`, `WorkWeek` and `month` views, which are grouped under date.
+     *
+     * @default false
+     */
+    @Property(false)
+    public hideNonWorkingDays: boolean;
+
+}

package/dist/ts/schedule/models/header-rows-model.d.ts

@@ -0,0 +1,33 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';import { HeaderRowType } from '../base/type';
+
+/**
+ * Interface for a class HeaderRows
+ */
+export interface HeaderRowsModel {
+
+    /**
+     * It defines the header row type, which accepts either of the following values.
+     * * `Year`: Denotes the year row in the header bar.
+     * * `Month`: Denotes the month row in the header bar.
+     * * `Week`: Denotes the week row in the header bar.
+     * * `Date`: Denotes the date row in the header bar.
+     * * `Hour`: Denotes the hour row in the header bar.
+     *
+     * @default null
+     */
+    option?: HeaderRowType;
+
+    /**
+     * Template option to customize the individual header rows. It accepts either the string or HTMLElement as template design
+     *  content and parse it appropriately before displaying it onto the header cells. The field that
+     *  can be accessed via this template is `date`.
+     *
+     * @default null
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    template?: string | Function;
+
+}

package/dist/ts/schedule/models/header-rows.d.ts

@@ -0,0 +1,30 @@
+import { ChildProperty } from '@syncfusion/ej2-base';
+import { HeaderRowType } from '../base/type';
+/**
+ * A class that represents the header rows related configurations on timeline views.
+ */
+export declare class HeaderRows extends ChildProperty<HeaderRows> {
+    /**
+     * It defines the header row type, which accepts either of the following values.
+     * * `Year`: Denotes the year row in the header bar.
+     * * `Month`: Denotes the month row in the header bar.
+     * * `Week`: Denotes the week row in the header bar.
+     * * `Date`: Denotes the date row in the header bar.
+     * * `Hour`: Denotes the hour row in the header bar.
+     *
+     * @default null
+     */
+    option: HeaderRowType;
+    /**
+     * Template option to customize the individual header rows. It accepts either the string or HTMLElement as template design
+     *  content and parse it appropriately before displaying it onto the header cells. The field that
+     *  can be accessed via this template is `date`.
+     *
+     * @default null
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    template: string | Function;
+}

package/dist/ts/schedule/models/header-rows.ts

@@ -0,0 +1,35 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';
+import { HeaderRowType } from '../base/type';
+
+/**
+ * A class that represents the header rows related configurations on timeline views.
+ */
+export class HeaderRows extends ChildProperty<HeaderRows> {
+    /**
+     * It defines the header row type, which accepts either of the following values.
+     * * `Year`: Denotes the year row in the header bar.
+     * * `Month`: Denotes the month row in the header bar.
+     * * `Week`: Denotes the week row in the header bar.
+     * * `Date`: Denotes the date row in the header bar.
+     * * `Hour`: Denotes the hour row in the header bar.
+     *
+     * @default null
+     */
+    @Property()
+    public option: HeaderRowType;
+
+    /**
+     * Template option to customize the individual header rows. It accepts either the string or HTMLElement as template design
+     *  content and parse it appropriately before displaying it onto the header cells. The field that
+     *  can be accessed via this template is `date`.
+     *
+     * @default null
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    @Property()
+    public template: string | Function;
+
+}

package/dist/ts/schedule/models/models.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Export model files
+ */
+export * from './work-hours-model';
+export * from './time-scale-model';
+export * from './views-model';
+export * from './event-settings-model';
+export * from './fields-model';
+export * from './field-options-model';
+export * from './group-model';
+export * from './resources-model';
+export * from './quick-info-templates-model';
+export * from './header-rows-model';
+export * from './toolbar-model';

package/dist/ts/schedule/models/models.ts

@@ -0,0 +1,15 @@
+/**
+ * Export model files
+ */
+
+export * from './work-hours-model';
+export * from './time-scale-model';
+export * from './views-model';
+export * from './event-settings-model';
+export * from './fields-model';
+export * from './field-options-model';
+export * from './group-model';
+export * from './resources-model';
+export * from './quick-info-templates-model';
+export * from './header-rows-model';
+export * from './toolbar-model';

package/dist/ts/schedule/models/quick-info-templates-model.d.ts

@@ -0,0 +1,52 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';import { TemplateType } from '../base/type';
+
+/**
+ * Interface for a class QuickInfoTemplates
+ */
+export interface QuickInfoTemplatesModel {
+
+    /**
+     * Template option to customize the header section of quick popup.
+     * The applicable template types are,
+     * * `Both`: Denotes the template applies both to the event and cell.
+     * * `Cell`: Denotes the template applies only to the cell.
+     * * `Event`: Denotes the template applies to the event alone.
+     *
+     *  @default 'Both'
+     */
+    templateType?: TemplateType;
+
+    /**
+     * Template option to customize the header section of quick popup.
+     *
+     * @default null
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    header?: string | Function;
+
+    /**
+     * Template option to customize the content area of the quick popup.
+     *
+     * @default null
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    content?: string | Function;
+
+    /**
+     * Template option to customize the footer section of quick popup.
+     *
+     * @default null
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    footer?: string | Function;
+
+}

package/dist/ts/schedule/models/quick-info-templates.d.ts

@@ -0,0 +1,47 @@
+import { ChildProperty } from '@syncfusion/ej2-base';
+import { TemplateType } from '../base/type';
+/**
+ * A class that defines the template options available to customize the quick popup of scheduler.
+ */
+export declare class QuickInfoTemplates extends ChildProperty<QuickInfoTemplates> {
+    /**
+     * Template option to customize the header section of quick popup.
+     * The applicable template types are,
+     * * `Both`: Denotes the template applies both to the event and cell.
+     * * `Cell`: Denotes the template applies only to the cell.
+     * * `Event`: Denotes the template applies to the event alone.
+     *
+     *  @default 'Both'
+     */
+    templateType: TemplateType;
+    /**
+     * Template option to customize the header section of quick popup.
+     *
+     * @default null
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    header: string | Function;
+    /**
+     * Template option to customize the content area of the quick popup.
+     *
+     * @default null
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    content: string | Function;
+    /**
+     * Template option to customize the footer section of quick popup.
+     *
+     * @default null
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    footer: string | Function;
+}

package/dist/ts/schedule/models/quick-info-templates.ts

@@ -0,0 +1,56 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';
+import { TemplateType } from '../base/type';
+
+/**
+ * A class that defines the template options available to customize the quick popup of scheduler.
+ */
+export class QuickInfoTemplates extends ChildProperty<QuickInfoTemplates> {
+    /**
+     * Template option to customize the header section of quick popup.
+     * The applicable template types are,
+     * * `Both`: Denotes the template applies both to the event and cell.
+     * * `Cell`: Denotes the template applies only to the cell.
+     * * `Event`: Denotes the template applies to the event alone.
+     *
+     *  @default 'Both'
+     */
+    @Property('Both')
+    public templateType: TemplateType;
+
+    /**
+     * Template option to customize the header section of quick popup.
+     *
+     * @default null
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    @Property()
+    public header: string | Function;
+
+    /**
+     * Template option to customize the content area of the quick popup.
+     *
+     * @default null
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    @Property()
+    public content: string | Function;
+
+    /**
+     * Template option to customize the footer section of quick popup.
+     *
+     * @default null
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    @Property()
+    public footer: string | Function;
+
+}