@syncfusion/ej2-schedule 31.1.17 → 31.1.21

package/dist/ts/schedule/models/event-settings.ts

@@ -1,187 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import { Property, ChildProperty, Complex } from '@syncfusion/ej2-base';
-import { Query, DataManager } from '@syncfusion/ej2-data';
-import { SortComparerFunction } from '../base/interface';
-import { SpannedEventPlacement } from '../base/type';
-import { Field } from './fields';
-import { FieldModel } from './fields-model';
-
-/**
- * Holds the configuration of event related options and dataSource binding to Schedule.
- */
-export class EventSettings extends ChildProperty<EventSettings> {
-    /**
-     * It accepts either the string or HTMLElement as template design content and parse it appropriately before displaying
-     *  it onto the event background. All the event fields mapped to Schedule from dataSource can be accessed within this template code.
-     * {% codeBlock src="schedule/event-template-api/index.ts" %}{% endcodeBlock %}
-     *
-     * @default null
-     * @angularType string | object
-     * @reactType string | function | JSX.Element
-     * @vueType string | function
-     * @aspType string
-     */
-    @Property()
-    public template: string | Function;
-
-    /**
-     * With this property, the event data will be bound to Schedule.
-     * The event 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;
-
-    /**
-     * Defines the collection of default event fields to be bind to the Schedule.
-     *
-     * @default null
-     */
-    @Complex<FieldModel>({}, Field)
-    public fields: FieldModel;
-
-    /**
-     * When set to `true` will display the normal tooltip over the events with its subject, location, start and end time.
-     *
-     * @default false
-     */
-    @Property(false)
-    public enableTooltip: boolean;
-
-    /**
-     * Defines the option to render the spanned events (more than 24 hours) in either `AllDayRow` or `TimeSlot`. By default it renders in `AllDayRow`.
-     * This property is applicable for `Day`, `Week` and `WorkWeek` views only. The possible values for this property as follows
-     * * `AllDayRow`: Denotes the rendering of spanned events in an all-day row.
-     * * `TimeSlot`: Denotes the rendering of spanned events in an time slot row.
-     * {% codeBlock src='schedule/spannedEventPlacement/index.md' %}{% endcodeBlock %}
-     *
-     * @default 'AllDayRow'
-     */
-    @Property('AllDayRow')
-    public spannedEventPlacement: SpannedEventPlacement;
-
-    /**
-     * Sets a minimum duration for an event where the events are rendered for this minimum duration when the duration of the event is lesser than this value.
-     *  It accepts duration value in minutes. This property is only applicable when the event duration is lesser than this property duration.
-     *
-     * @default 1
-     */
-    @Property(1)
-    public minimumEventDuration: number;
-
-    /**
-     * It accepts either the string or HTMLElement as template design content and parse it appropriately before displaying it onto tooltip.
-     *  All the event fields mapped with Schedule dataSource can be accessed within this template code.
-     * {% codeBlock src="schedule/tooltip-template-api/index.ts" %}{% endcodeBlock %}
-     *
-     * @default null
-     * @angularType string | object
-     * @reactType string | function | JSX.Element
-     * @vueType string | function
-     * @aspType string
-     */
-    @Property()
-    public tooltipTemplate: string | Function;
-
-    /**
-     * Defines the resource name, to decides the color of which particular resource level is to be applied on appointments, when
-     *  grouping is enabled on scheduler.
-     * {% codeBlock src="schedule/resource-color-field-api/index.ts" %}{% endcodeBlock %}
-     *
-     * @default null
-     */
-    @Property()
-    public resourceColorField: string;
-
-    /**
-     * When set to `true` will edit the future events only instead of editing entire series.
-     *
-     * @default false
-     */
-    @Property(false)
-    public editFollowingEvents: boolean;
-
-    /**
-     * When set to `false` the add action will be restricted.
-     *
-     * @default true
-     */
-    @Property(true)
-    public allowAdding: boolean;
-
-    /**
-     * When set to `false` the edit action will be restricted.
-     *
-     * @default true
-     */
-    @Property(true)
-    public allowEditing: boolean;
-
-    /**
-     * When set to `false` the delete action will be restricted.
-     *
-     * @default true
-     */
-    @Property(true)
-    public allowDeleting: boolean;
-
-    /**
-     * It enables the event to occupy the full height in timeline views and
-     * full width in vertical views, excluding the header of the cell.
-     *
-     * @default false
-     */
-    @Property(false)
-    public enableMaxHeight: boolean;
-
-    /**
-     * This property enables the event to occupy the full height that remaining from the header and more indicator.
-     * More than one appointment are available on the cell the more indicator is created.
-     *
-     * @default false
-     */
-    @Property(false)
-    public enableIndicator: boolean;
-
-    /**
-     * This property ignores or include the Events element bottom white space.
-     *
-     * @default false
-     */
-    @Property(false)
-    public ignoreWhitespace: boolean;
-
-    /**
-     * Defines the custom sort comparer function.
-     * The sort comparer function has the same functionality like
-     * [`Array.sort`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) sort comparer.
-     *
-     * @default null
-     */
-    @Property()
-    public sortComparer: SortComparerFunction;
-
-    /**
-     * Gets or sets a value that determines whether the start date and end date filter conditions should be included in the query itself when requesting data from the server, or passed as query parameters in the API call.
-     * When set to <c>true</c> the filter conditions will be part of the query itself, potentially reducing the size of the request and minimizing the time needed to parse the response.
-     * However, it can also lead to longer query strings, which could result in issues with maximum URL length or server limitations on query string length.
-     *
-     * @default false
-     */
-    @Property()
-    public includeFiltersInQuery: boolean;
-}

package/dist/ts/schedule/models/field-options-model.d.ts

@@ -1,37 +0,0 @@
-import { Property, ChildProperty } from '@syncfusion/ej2-base';
-
-/**
- * Interface for a class FieldOptions
- */
-export interface FieldOptionsModel {
-
-    /**
-     * Denotes the field name to be mapped from the dataSource for every event fields.
-     *
-     * @default null
-     */
-    name?: string;
-
-    /**
-     * Assigns the specific default value to the fields, when no values are provided to those fields from dataSource.
-     *
-     * @default null
-     */
-    default?: string;
-
-    /**
-     * Assigns the label values to be displayed for the event editor fields.
-     *
-     * @default null
-     */
-    title?: string;
-
-    /**
-     * Defines the validation rules to be applied on the event fields within the event editor.
-     * {% codeBlock src="schedule/validation-api/index.ts" %}{% endcodeBlock %}
-     *
-     * @default {}
-     */
-    validation?: Record<string, any>;
-
-}

package/dist/ts/schedule/models/field-options.d.ts

@@ -1,31 +0,0 @@
-import { ChildProperty } from '@syncfusion/ej2-base';
-/**
- * Configuration that applies on each appointment field options of scheduler.
- */
-export declare class FieldOptions extends ChildProperty<FieldOptions> {
-    /**
-     * Denotes the field name to be mapped from the dataSource for every event fields.
-     *
-     * @default null
-     */
-    name: string;
-    /**
-     * Assigns the specific default value to the fields, when no values are provided to those fields from dataSource.
-     *
-     * @default null
-     */
-    default: string;
-    /**
-     * Assigns the label values to be displayed for the event editor fields.
-     *
-     * @default null
-     */
-    title: string;
-    /**
-     * Defines the validation rules to be applied on the event fields within the event editor.
-     * {% codeBlock src="schedule/validation-api/index.ts" %}{% endcodeBlock %}
-     *
-     * @default {}
-     */
-    validation: Record<string, any>;
-}

package/dist/ts/schedule/models/field-options.ts

@@ -1,41 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import { Property, ChildProperty } from '@syncfusion/ej2-base';
-
-/**
- * Configuration that applies on each appointment field options of scheduler.
- */
-export class FieldOptions extends ChildProperty<FieldOptions> {
-    /**
-     * Denotes the field name to be mapped from the dataSource for every event fields.
-     *
-     * @default null
-     */
-    @Property()
-    public name: string;
-
-    /**
-     * Assigns the specific default value to the fields, when no values are provided to those fields from dataSource.
-     *
-     * @default null
-     */
-    @Property()
-    public default: string;
-
-    /**
-     * Assigns the label values to be displayed for the event editor fields.
-     *
-     * @default null
-     */
-    @Property()
-    public title: string;
-
-    /**
-     * Defines the validation rules to be applied on the event fields within the event editor.
-     * {% codeBlock src="schedule/validation-api/index.ts" %}{% endcodeBlock %}
-     *
-     * @default {}
-     */
-    @Property({})
-    public validation: Record<string, any>;
-
-}

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

@@ -1,129 +0,0 @@
-import { Property, ChildProperty, Complex } from '@syncfusion/ej2-base';import { FieldOptionsModel } from './field-options-model';import { FieldOptions } from './field-options';
-
-/**
- * Interface for a class Field
- */
-export interface FieldModel {
-
-    /**
-     * 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
-     */
-    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
-     */
-    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: {}  }
-     */
-    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: {} }
-     */
-    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: {} }
-     */
-    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: {} }
-     */
-    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: {} }
-     */
-    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: {} }
-     */
-    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: {} }
-     */
-    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: {} }
-     */
-    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: {} }
-     */
-    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: {} }
-     */
-    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: {} }
-     */
-    recurrenceException?: FieldOptionsModel;
-
-    /**
-     * The `isReadonly` field is mapped from the dataSource and is used to prevent the CRUD actions on specific events.
-     *
-     * @default null
-     */
-    isReadonly?: string;
-
-    /**
-     * The `followingID` field is mapped from dataSource and usually holds the ID value of the main parent event.
-     *
-     * @default null
-     */
-    followingID?: string;
-
-}

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

@@ -1,117 +0,0 @@
-import { ChildProperty } from '@syncfusion/ej2-base';
-import { FieldOptionsModel } from './field-options-model';
-/**
- * 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 declare 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
-     */
-    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
-     */
-    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: {}  }
-     */
-    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: {} }
-     */
-    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: {} }
-     */
-    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: {} }
-     */
-    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: {} }
-     */
-    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: {} }
-     */
-    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: {} }
-     */
-    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: {} }
-     */
-    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: {} }
-     */
-    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: {} }
-     */
-    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: {} }
-     */
-    recurrenceException: FieldOptionsModel;
-    /**
-     * The `isReadonly` field is mapped from the dataSource and is used to prevent the CRUD actions on specific events.
-     *
-     * @default null
-     */
-    isReadonly: string;
-    /**
-     * The `followingID` field is mapped from dataSource and usually holds the ID value of the main parent event.
-     *
-     * @default null
-     */
-    followingID: string;
-}