@syncfusion/ej2-schedule 30.2.4 → 31.1.17

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

@@ -0,0 +1,122 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';import { DataManager, Query } from '@syncfusion/ej2-data';
+
+/**
+ * Interface for a class Resources
+ */
+export interface ResourcesModel {
+
+    /**
+     * A value that binds to the resource field of event object.
+     *
+     * @default null
+     */
+    field?: string;
+
+    /**
+     * It holds the title of the resource field to be displayed on the schedule event editor window.
+     *
+     * @default null
+     */
+    title?: string;
+
+    /**
+     * It represents a unique resource name for differentiating various resource objects while grouping.
+     *
+     * @default null
+     */
+    name?: string;
+
+    /**
+     * When set to true, allows multiple selection of resource names, thus creating multiple instances of same appointment for the
+     *  selected resources.
+     *
+     * @default false
+     */
+    allowMultiple?: boolean;
+
+    /**
+     * Assigns the resource dataSource
+     * The data can be passed either as an array of JavaScript objects,
+     * or else can create an instance of [`DataManager`](http://ej2.syncfusion.com/documentation/data/api-dataManager.html)
+     * in case of processing remote data and can be assigned to the `dataSource` property.
+     * With the remote data assigned to dataSource, check the available
+     *  [adaptors](http://ej2.syncfusion.com/documentation/data/adaptors.html) to customize the data processing.
+     *
+     * @default []
+     */
+    dataSource?: Record<string, any>[] | DataManager;
+
+    /**
+     * Defines the external [`query`](http://ej2.syncfusion.com/documentation/data/api-query.html)
+     * that will be executed along with the data processing.
+     *
+     * @default null
+     */
+    query?: Query;
+
+    /**
+     * It maps the `id` field from the dataSource and is used to uniquely identify the resources.
+     *
+     * @default 'Id'
+     */
+    idField?: string;
+
+    /**
+     * It maps the `text` field from the dataSource, which is used to specify the resource names.
+     *
+     * @default 'Text'
+     */
+    textField?: string;
+
+    /**
+     * It maps the `expanded` field from the dataSource, which is used to specify whether each resource levels
+     * in timeline view needs to be maintained in an expanded or collapsed state by default.
+     *
+     * @default 'Expanded'
+     */
+    expandedField?: string;
+
+    /**
+     * It maps the `groupID` field from the dataSource, which is used to specify under which parent resource,
+     *  the child should be grouped.
+     *
+     * @default 'GroupID'
+     */
+    groupIDField?: string;
+
+    /**
+     * It maps the `color` field from the dataSource, which is used to specify colors for the resources.
+     *
+     * @default 'Color'
+     */
+    colorField?: string;
+
+    /**
+     * It maps the `startHour` field from the dataSource, which is used to specify different work start hour for each resources.
+     *
+     * @default 'StartHour'
+     */
+    startHourField?: string;
+
+    /**
+     * It maps the `endHour` field from the dataSource, which is used to specify different work end hour for each resources.
+     *
+     * @default 'EndHour'
+     */
+    endHourField?: string;
+
+    /**
+     * It maps the working days field from the dataSource, which is used to specify different working days for each resources.
+     *
+     * @default 'WorkDays'
+     */
+    workDaysField?: string;
+
+    /**
+     * It maps the `cssClass` field from the dataSource, which is used to specify different styles to each resource appointments.
+     *
+     * @default 'CssClass'
+     */
+    cssClassField?: string;
+
+}

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

@@ -0,0 +1,106 @@
+import { ChildProperty } from '@syncfusion/ej2-base';
+import { DataManager, Query } from '@syncfusion/ej2-data';
+/**
+ * A class that represents the resource related configurations and its data binding options.
+ */
+export declare class Resources extends ChildProperty<Resources> {
+    /**
+     * A value that binds to the resource field of event object.
+     *
+     * @default null
+     */
+    field: string;
+    /**
+     * It holds the title of the resource field to be displayed on the schedule event editor window.
+     *
+     * @default null
+     */
+    title: string;
+    /**
+     * It represents a unique resource name for differentiating various resource objects while grouping.
+     *
+     * @default null
+     */
+    name: string;
+    /**
+     * When set to true, allows multiple selection of resource names, thus creating multiple instances of same appointment for the
+     *  selected resources.
+     *
+     * @default false
+     */
+    allowMultiple: boolean;
+    /**
+     * Assigns the resource dataSource
+     * The data can be passed either as an array of JavaScript objects,
+     * or else can create an instance of [`DataManager`](http://ej2.syncfusion.com/documentation/data/api-dataManager.html)
+     * in case of processing remote data and can be assigned to the `dataSource` property.
+     * With the remote data assigned to dataSource, check the available
+     *  [adaptors](http://ej2.syncfusion.com/documentation/data/adaptors.html) to customize the data processing.
+     *
+     * @default []
+     */
+    dataSource: Record<string, any>[] | DataManager;
+    /**
+     * Defines the external [`query`](http://ej2.syncfusion.com/documentation/data/api-query.html)
+     * that will be executed along with the data processing.
+     *
+     * @default null
+     */
+    query: Query;
+    /**
+     * It maps the `id` field from the dataSource and is used to uniquely identify the resources.
+     *
+     * @default 'Id'
+     */
+    idField: string;
+    /**
+     * It maps the `text` field from the dataSource, which is used to specify the resource names.
+     *
+     * @default 'Text'
+     */
+    textField: string;
+    /**
+     * It maps the `expanded` field from the dataSource, which is used to specify whether each resource levels
+     * in timeline view needs to be maintained in an expanded or collapsed state by default.
+     *
+     * @default 'Expanded'
+     */
+    expandedField: string;
+    /**
+     * It maps the `groupID` field from the dataSource, which is used to specify under which parent resource,
+     *  the child should be grouped.
+     *
+     * @default 'GroupID'
+     */
+    groupIDField: string;
+    /**
+     * It maps the `color` field from the dataSource, which is used to specify colors for the resources.
+     *
+     * @default 'Color'
+     */
+    colorField: string;
+    /**
+     * It maps the `startHour` field from the dataSource, which is used to specify different work start hour for each resources.
+     *
+     * @default 'StartHour'
+     */
+    startHourField: string;
+    /**
+     * It maps the `endHour` field from the dataSource, which is used to specify different work end hour for each resources.
+     *
+     * @default 'EndHour'
+     */
+    endHourField: string;
+    /**
+     * It maps the working days field from the dataSource, which is used to specify different working days for each resources.
+     *
+     * @default 'WorkDays'
+     */
+    workDaysField: string;
+    /**
+     * It maps the `cssClass` field from the dataSource, which is used to specify different styles to each resource appointments.
+     *
+     * @default 'CssClass'
+     */
+    cssClassField: string;
+}

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

@@ -0,0 +1,138 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { Property, ChildProperty } from '@syncfusion/ej2-base';
+import { DataManager, Query } from '@syncfusion/ej2-data';
+
+/**
+ * A class that represents the resource related configurations and its data binding options.
+ */
+export class Resources extends ChildProperty<Resources> {
+    /**
+     * A value that binds to the resource field of event object.
+     *
+     * @default null
+     */
+    @Property()
+    public field: string;
+
+    /**
+     * It holds the title of the resource field to be displayed on the schedule event editor window.
+     *
+     * @default null
+     */
+    @Property()
+    public title: string;
+
+    /**
+     * It represents a unique resource name for differentiating various resource objects while grouping.
+     *
+     * @default null
+     */
+    @Property()
+    public name: string;
+
+    /**
+     * When set to true, allows multiple selection of resource names, thus creating multiple instances of same appointment for the
+     *  selected resources.
+     *
+     * @default false
+     */
+    @Property(false)
+    public allowMultiple: boolean;
+
+    /**
+     * Assigns the resource dataSource
+     * The data can be passed either as an array of JavaScript objects,
+     * or else can create an instance of [`DataManager`](http://ej2.syncfusion.com/documentation/data/api-dataManager.html)
+     * in case of processing remote data and can be assigned to the `dataSource` property.
+     * With the remote data assigned to dataSource, check the available
+     *  [adaptors](http://ej2.syncfusion.com/documentation/data/adaptors.html) to customize the data processing.
+     *
+     * @default []
+     */
+    @Property([])
+    public dataSource: Record<string, any>[] | DataManager;
+
+    /**
+     * Defines the external [`query`](http://ej2.syncfusion.com/documentation/data/api-query.html)
+     * that will be executed along with the data processing.
+     *
+     * @default null
+     */
+    @Property()
+    public query: Query;
+
+    /**
+     * It maps the `id` field from the dataSource and is used to uniquely identify the resources.
+     *
+     * @default 'Id'
+     */
+    @Property('Id')
+    public idField: string;
+
+    /**
+     * It maps the `text` field from the dataSource, which is used to specify the resource names.
+     *
+     * @default 'Text'
+     */
+    @Property('Text')
+    public textField: string;
+
+    /**
+     * It maps the `expanded` field from the dataSource, which is used to specify whether each resource levels
+     * in timeline view needs to be maintained in an expanded or collapsed state by default.
+     *
+     * @default 'Expanded'
+     */
+    @Property('Expanded')
+    public expandedField: string;
+
+    /**
+     * It maps the `groupID` field from the dataSource, which is used to specify under which parent resource,
+     *  the child should be grouped.
+     *
+     * @default 'GroupID'
+     */
+    @Property('GroupID')
+    public groupIDField: string;
+
+    /**
+     * It maps the `color` field from the dataSource, which is used to specify colors for the resources.
+     *
+     * @default 'Color'
+     */
+    @Property('Color')
+    public colorField: string;
+
+    /**
+     * It maps the `startHour` field from the dataSource, which is used to specify different work start hour for each resources.
+     *
+     * @default 'StartHour'
+     */
+    @Property('StartHour')
+    public startHourField: string;
+
+    /**
+     * It maps the `endHour` field from the dataSource, which is used to specify different work end hour for each resources.
+     *
+     * @default 'EndHour'
+     */
+    @Property('EndHour')
+    public endHourField: string;
+
+    /**
+     * It maps the working days field from the dataSource, which is used to specify different working days for each resources.
+     *
+     * @default 'WorkDays'
+     */
+    @Property('WorkDays')
+    public workDaysField: string;
+
+    /**
+     * It maps the `cssClass` field from the dataSource, which is used to specify different styles to each resource appointments.
+     *
+     * @default 'CssClass'
+     */
+    @Property('CssClass')
+    public cssClassField: string;
+
+}

package/dist/ts/schedule/models/time-scale-model.d.ts

@@ -0,0 +1,57 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';
+
+/**
+ * Interface for a class TimeScale
+ */
+export interface TimeScaleModel {
+
+    /**
+     * When set to `true`, allows the schedule to display the appointments accurately against the exact time duration.
+     *  If set to `false`, all the appointments of a day will be displayed one below the other.
+     *
+     * @default true
+     */
+    enable?: boolean;
+
+    /**
+     * Defines the time duration on which the time axis to be displayed either in 1 hour or 30 minutes interval and so on.
+     *  It accepts the values in minutes.
+     *
+     * @default 60
+     */
+    interval?: number;
+
+    /**
+     * Decides the number of slot count to be split for the specified time interval duration.
+     *
+     * @default 2
+     */
+    slotCount?: number;
+
+    /**
+     * The template option to be applied for minor time slot. Here, the
+     *  template accepts either the string or HTMLElement as template design and then the parsed design is displayed
+     *  onto the time cells. The time details can be accessed within this template.
+     *
+     * @default null
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    minorSlotTemplate?: string | Function;
+
+    /**
+     * The template option to be applied for major time slot. Here, the
+     *  template accepts either the string or HTMLElement as template design and then the parsed design is displayed
+     *  onto the time cells. The time details can be accessed within this template.
+     *
+     * @default null
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    majorSlotTemplate?: string | Function;
+
+}

package/dist/ts/schedule/models/time-scale.d.ts

@@ -0,0 +1,50 @@
+import { ChildProperty } from '@syncfusion/ej2-base';
+/**
+ * A class that represents the configuration of options related to timescale on scheduler.
+ */
+export declare class TimeScale extends ChildProperty<TimeScale> {
+    /**
+     * When set to `true`, allows the schedule to display the appointments accurately against the exact time duration.
+     *  If set to `false`, all the appointments of a day will be displayed one below the other.
+     *
+     * @default true
+     */
+    enable: boolean;
+    /**
+     * Defines the time duration on which the time axis to be displayed either in 1 hour or 30 minutes interval and so on.
+     *  It accepts the values in minutes.
+     *
+     * @default 60
+     */
+    interval: number;
+    /**
+     * Decides the number of slot count to be split for the specified time interval duration.
+     *
+     * @default 2
+     */
+    slotCount: number;
+    /**
+     * The template option to be applied for minor time slot. Here, the
+     *  template accepts either the string or HTMLElement as template design and then the parsed design is displayed
+     *  onto the time cells. The time details can be accessed within this template.
+     *
+     * @default null
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    minorSlotTemplate: string | Function;
+    /**
+     * The template option to be applied for major time slot. Here, the
+     *  template accepts either the string or HTMLElement as template design and then the parsed design is displayed
+     *  onto the time cells. The time details can be accessed within this template.
+     *
+     * @default null
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    majorSlotTemplate: string | Function;
+}

package/dist/ts/schedule/models/time-scale.ts

@@ -0,0 +1,61 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';
+
+/**
+ * A class that represents the configuration of options related to timescale on scheduler.
+ */
+export class TimeScale extends ChildProperty<TimeScale> {
+    /**
+     * When set to `true`, allows the schedule to display the appointments accurately against the exact time duration.
+     *  If set to `false`, all the appointments of a day will be displayed one below the other.
+     *
+     * @default true
+     */
+    @Property(true)
+    public enable: boolean;
+
+    /**
+     * Defines the time duration on which the time axis to be displayed either in 1 hour or 30 minutes interval and so on.
+     *  It accepts the values in minutes.
+     *
+     * @default 60
+     */
+    @Property(60)
+    public interval: number;
+
+    /**
+     * Decides the number of slot count to be split for the specified time interval duration.
+     *
+     * @default 2
+     */
+    @Property(2)
+    public slotCount: number;
+
+    /**
+     * The template option to be applied for minor time slot. Here, the
+     *  template accepts either the string or HTMLElement as template design and then the parsed design is displayed
+     *  onto the time cells. The time details can be accessed within this template.
+     *
+     * @default null
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    @Property()
+    public minorSlotTemplate: string | Function;
+
+    /**
+     * The template option to be applied for major time slot. Here, the
+     *  template accepts either the string or HTMLElement as template design and then the parsed design is displayed
+     *  onto the time cells. The time details can be accessed within this template.
+     *
+     * @default null
+     * @angularType string | object
+     * @reactType string | function | JSX.Element
+     * @vueType string | function
+     * @aspType string
+     */
+    @Property()
+    public majorSlotTemplate: string | Function;
+
+}