diff --git a/packages/devextreme-angular/src/ui/scheduler/index.ts b/packages/devextreme-angular/src/ui/scheduler/index.ts index 7a1c57e9d7b6..12ef40e8702a 100644 --- a/packages/devextreme-angular/src/ui/scheduler/index.ts +++ b/packages/devextreme-angular/src/ui/scheduler/index.ts @@ -26,7 +26,7 @@ import dxScheduler from 'devextreme/ui/scheduler'; import dxSortable from 'devextreme/ui/sortable'; import dxDraggable from 'devextreme/ui/draggable'; import DataSource from 'devextreme/data/data_source'; -import { AllDayPanelMode, ViewType, dxSchedulerAppointment, AppointmentFormProperties, CellAppointmentsLimit, AppointmentAddedEvent, AppointmentAddingEvent, AppointmentClickEvent, AppointmentContextMenuEvent, AppointmentDblClickEvent, AppointmentDeletedEvent, AppointmentDeletingEvent, AppointmentFormOpeningEvent, AppointmentRenderedEvent, AppointmentTooltipShowingEvent, AppointmentUpdatedEvent, AppointmentUpdatingEvent, CellClickEvent, CellContextMenuEvent, ContentReadyEvent, DisposingEvent, InitializedEvent, OptionChangedEvent, RecurrenceEditMode, dxSchedulerScrolling, dxSchedulerToolbar } from 'devextreme/ui/scheduler'; +import { AllDayPanelMode, ViewType, Appointment, AppointmentFormProperties, CellAppointmentsLimit, AppointmentAddedEvent, AppointmentAddingEvent, AppointmentClickEvent, AppointmentContextMenuEvent, AppointmentDblClickEvent, AppointmentDeletedEvent, AppointmentDeletingEvent, AppointmentFormOpeningEvent, AppointmentRenderedEvent, AppointmentTooltipShowingEvent, AppointmentUpdatedEvent, AppointmentUpdatingEvent, CellClickEvent, CellContextMenuEvent, ContentReadyEvent, DisposingEvent, InitializedEvent, OptionChangedEvent, RecurrenceEditMode, dxSchedulerScrolling, dxSchedulerToolbar } from 'devextreme/ui/scheduler'; import { event } from 'devextreme/events/events.types'; import { DataSourceOptions } from 'devextreme/data/data_source'; import { Store } from 'devextreme/data/store'; @@ -327,10 +327,10 @@ export class DxSchedulerComponent extends DxComponent implements OnDestroy, OnCh */ @Input() - get dataSource(): Array | DataSource | DataSourceOptions | null | Store | string { + get dataSource(): Array | DataSource | DataSourceOptions | null | Store | string { return this._getOption('dataSource'); } - set dataSource(value: Array | DataSource | DataSourceOptions | null | Store | string) { + set dataSource(value: Array | DataSource | DataSourceOptions | null | Store | string) { this._setOption('dataSource', value); } @@ -1166,7 +1166,7 @@ export class DxSchedulerComponent extends DxComponent implements OnDestroy, OnCh * This member supports the internal infrastructure and is not intended to be used directly from your code. */ - @Output() dataSourceChange: EventEmitter | DataSource | DataSourceOptions | null | Store | string>; + @Output() dataSourceChange: EventEmitter | DataSource | DataSourceOptions | null | Store | string>; /** diff --git a/packages/devextreme-vue/src/scheduler.ts b/packages/devextreme-vue/src/scheduler.ts index 9118bd8c3e81..ef6cc9143584 100644 --- a/packages/devextreme-vue/src/scheduler.ts +++ b/packages/devextreme-vue/src/scheduler.ts @@ -9,7 +9,7 @@ import dxDraggable from "devextreme/ui/draggable"; import { AllDayPanelMode, ViewType, - dxSchedulerAppointment, + Appointment, CellAppointmentsLimit, AppointmentAddedEvent, AppointmentAddingEvent, @@ -231,7 +231,7 @@ const componentConfig = { currentView: String as PropType, customizeDateNavigatorText: Function as PropType<((info: { endDate: Date, startDate: Date, text: string }) => string)>, dataCellTemplate: {}, - dataSource: [Array, Object, String] as PropType | DataSource | DataSourceOptions | null | Store | string | Record>, + dataSource: [Array, Object, String] as PropType | DataSource | DataSourceOptions | null | Store | string | Record>, dateCellTemplate: {}, dateSerializationFormat: String, descriptionExpr: String, diff --git a/packages/devextreme/js/ui/scheduler.d.ts b/packages/devextreme/js/ui/scheduler.d.ts index 10e71d244b0d..49f9f3edb356 100644 --- a/packages/devextreme/js/ui/scheduler.d.ts +++ b/packages/devextreme/js/ui/scheduler.d.ts @@ -55,12 +55,10 @@ interface AppointmentDraggingEvent { export interface TargetedAppointmentInfo { /** * @docid - * @type dxSchedulerAppointment */ readonly appointmentData: Appointment; /** * @docid - * @type dxSchedulerAppointment */ readonly targetedAppointmentData?: Appointment; } @@ -111,7 +109,6 @@ export type SchedulerPredefinedDateNavigatorItem = 'prev' | 'next' | 'dateInterv export type AppointmentAddedEvent = EventInfo & { /** * @docid _ui_scheduler_AppointmentAddedEvent.appointmentData - * @type dxSchedulerAppointment */ readonly appointmentData: Appointment; /** @docid _ui_scheduler_AppointmentAddedEvent.error */ @@ -127,7 +124,6 @@ export type AppointmentAddedEvent = EventInfo & { export type AppointmentAddingEvent = EventInfo & { /** * @docid _ui_scheduler_AppointmentAddingEvent.appointmentData - * @type dxSchedulerAppointment */ readonly appointmentData: Appointment; /** @@ -179,7 +175,6 @@ export type AppointmentDblClickEvent = Cancelable & NativeEventInfo & { /** * @docid _ui_scheduler_AppointmentDeletedEvent.appointmentData - * @type dxSchedulerAppointment */ readonly appointmentData: Appointment; /** @docid _ui_scheduler_AppointmentDeletedEvent.error */ @@ -195,7 +190,6 @@ export type AppointmentDeletedEvent = EventInfo & { export type AppointmentDeletingEvent = EventInfo & { /** * @docid _ui_scheduler_AppointmentDeletingEvent.appointmentData - * @type dxSchedulerAppointment */ readonly appointmentData: Appointment; /** @@ -214,7 +208,6 @@ export type AppointmentDeletingEvent = EventInfo & { export type AppointmentFormOpeningEvent = Cancelable & EventInfo & { /** * @docid _ui_scheduler_AppointmentFormOpeningEvent.appointmentData - * @type dxSchedulerAppointment */ readonly appointmentData?: Appointment; /** @docid _ui_scheduler_AppointmentFormOpeningEvent.form */ @@ -269,7 +262,6 @@ export type AppointmentRenderedEvent = EventInfo & TargetedAppointm export type AppointmentUpdatedEvent = EventInfo & { /** * @docid _ui_scheduler_AppointmentUpdatedEvent.appointmentData - * @type dxSchedulerAppointment */ readonly appointmentData: Appointment; /** @docid _ui_scheduler_AppointmentUpdatedEvent.error */ @@ -427,7 +419,6 @@ export type AppointmentCollectorTemplateData = { readonly appointmentCount: number; /** * @docid - * @type Array */ readonly items: Appointment[]; /** @@ -587,7 +578,7 @@ export interface dxSchedulerOptions extends WidgetOptions { * @docid * @default null * @public - * @type string|Array|Store|DataSource|DataSourceOptions|null + * @type string|Array|Store|DataSource|DataSourceOptions|null */ dataSource?: DataSourceLike | null; /** @@ -1254,21 +1245,18 @@ export default class dxScheduler extends Widget { /** * @docid * @publicName addAppointment(appointment) - * @param1 appointment:dxSchedulerAppointment * @public */ addAppointment(appointment: Appointment): void; /** * @docid * @publicName deleteAppointment(appointment) - * @param1 appointment:dxSchedulerAppointment * @public */ deleteAppointment(appointment: Appointment): void; /** * @docid * @publicName deleteRecurrence(appointment, date, recurrenceEditMode) - * @param1 appointmentData:dxSchedulerAppointment * @public */ deleteRecurrence( @@ -1286,7 +1274,6 @@ export default class dxScheduler extends Widget { /** * @docid * @publicName getOccurrences(startDate, endDate, appointments) - * @param3 appointments:Array * @public */ getOccurrences(startDate: Date, endDate: Date, appointments: Appointment[]): Occurrence[]; @@ -1335,45 +1322,30 @@ export default class dxScheduler extends Widget { /** * @docid * @publicName showAppointmentPopup(appointmentData, createNewAppointment, currentAppointmentData) - * @param1 appointmentData:dxSchedulerAppointment|undefined - * @param2 createNewAppointment:Boolean|undefined - * @param3 currentAppointmentData:dxSchedulerAppointment|undefined * @public */ showAppointmentPopup(appointmentData?: Appointment, createNewAppointment?: boolean, currentAppointmentData?: Appointment): void; /** * @docid * @publicName showAppointmentTooltip(appointmentData, target, currentAppointmentData) - * @param1 appointmentData:dxSchedulerAppointment * @param2 target:string|Element|jQuery - * @param3 currentAppointmentData:dxSchedulerAppointment|undefined * @public */ showAppointmentTooltip(appointmentData: Appointment, target: string | UserDefinedElement, currentAppointmentData?: Appointment): void; /** * @docid * @publicName updateAppointment(target, appointment) - * @param1 target:dxSchedulerAppointment - * @param2 appointment:dxSchedulerAppointment * @public */ updateAppointment(target: Appointment, appointment: Appointment): void; } /** + * @docid * @public - * @docid dxSchedulerAppointment - * @namespace DevExpress.ui - * @inherits CollectionWidgetItem * @type object */ -export type Appointment = dxSchedulerAppointment; - -/** - * @namespace DevExpress.ui - * @deprecated Use the Scheduler's Appointment type instead - */ -export type dxSchedulerAppointment = CollectionWidgetItem & { +export type Appointment = CollectionWidgetItem & { /** * @docid * @public @@ -1461,7 +1433,6 @@ export type Occurrence = { /** * @docid * @public - * @type dxSchedulerAppointment */ appointmentData: Appointment; }; diff --git a/packages/devextreme/ts/aliases.d.ts b/packages/devextreme/ts/aliases.d.ts index 4484af09af53..438f28de06d3 100644 --- a/packages/devextreme/ts/aliases.d.ts +++ b/packages/devextreme/ts/aliases.d.ts @@ -227,8 +227,8 @@ declare namespace DevExpress.ui { /** @deprecated Use DevExpress.ui.dxResponsiveBoxItem */ export type dxResponsiveBoxItemTemplate = dxResponsiveBoxItem; - /** @deprecated Use DevExpress.ui.dxSchedulerAppointment */ - export type dxSchedulerAppointmentTemplate = dxSchedulerAppointment; + /** @deprecated Use DevExpress.ui.dxScheduler.Appointment */ + export type dxSchedulerAppointmentTemplate = dxScheduler.Appointment; /** @deprecated Use DevExpress.ui.dxTabsItem */ export type dxTabsItemTemplate = dxTabsItem; diff --git a/packages/devextreme/ts/dx.all.d.ts b/packages/devextreme/ts/dx.all.d.ts index cf441bcef1cd..63354058a7a5 100644 --- a/packages/devextreme/ts/dx.all.d.ts +++ b/packages/devextreme/ts/dx.all.d.ts @@ -8649,10 +8649,6 @@ declare module DevExpress.pdfExporter { extends DevExpress.common.Export.excel.DataGridCell {} } declare module DevExpress.ui { - /** - * [descr:dxSchedulerAppointment] - */ - export type Appointment = dxSchedulerAppointment; /** * [descr:ColCountResponsible] * @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution. @@ -25892,16 +25888,16 @@ declare module DevExpress.ui { /** * [descr:dxScheduler.addAppointment(appointment)] */ - addAppointment(appointment: Appointment): void; + addAppointment(appointment: DevExpress.ui.dxScheduler.Appointment): void; /** * [descr:dxScheduler.deleteAppointment(appointment)] */ - deleteAppointment(appointment: Appointment): void; + deleteAppointment(appointment: DevExpress.ui.dxScheduler.Appointment): void; /** * [descr:dxScheduler.deleteRecurrence(appointment, date, recurrenceEditMode)] */ deleteRecurrence( - appointmentData: Appointment, + appointmentData: DevExpress.ui.dxScheduler.Appointment, date: Date | string, recurrenceEditMode: DevExpress.ui.dxScheduler.RecurrenceEditMode ): void; @@ -25916,7 +25912,7 @@ declare module DevExpress.ui { getOccurrences( startDate: Date, endDate: Date, - appointments: Appointment[] + appointments: DevExpress.ui.dxScheduler.Appointment[] ): DevExpress.ui.dxScheduler.Occurrence[]; /** * [descr:dxScheduler.getStartViewDate()] @@ -25950,25 +25946,85 @@ declare module DevExpress.ui { * [descr:dxScheduler.showAppointmentPopup(appointmentData, createNewAppointment, currentAppointmentData)] */ showAppointmentPopup( - appointmentData?: Appointment, + appointmentData?: DevExpress.ui.dxScheduler.Appointment, createNewAppointment?: boolean, - currentAppointmentData?: Appointment + currentAppointmentData?: DevExpress.ui.dxScheduler.Appointment ): void; /** * [descr:dxScheduler.showAppointmentTooltip(appointmentData, target, currentAppointmentData)] */ showAppointmentTooltip( - appointmentData: Appointment, + appointmentData: DevExpress.ui.dxScheduler.Appointment, target: string | DevExpress.core.UserDefinedElement, - currentAppointmentData?: Appointment + currentAppointmentData?: DevExpress.ui.dxScheduler.Appointment ): void; /** * [descr:dxScheduler.updateAppointment(target, appointment)] */ - updateAppointment(target: Appointment, appointment: Appointment): void; + updateAppointment( + target: DevExpress.ui.dxScheduler.Appointment, + appointment: DevExpress.ui.dxScheduler.Appointment + ): void; } module dxScheduler { export type AllDayPanelMode = 'all' | 'allDay' | 'hidden'; + /** + * [descr:Appointment] + */ + export type Appointment = CollectionWidgetItem & { + /** + * [descr:Appointment.allDay] + */ + allDay?: boolean; + /** + * [descr:Appointment.description] + */ + description?: string; + /** + * [descr:Appointment.disabled] + */ + disabled?: boolean; + /** + * [descr:Appointment.endDate] + */ + endDate?: Date | string; + /** + * [descr:Appointment.endDateTimeZone] + */ + endDateTimeZone?: string; + /** + * [descr:Appointment.html] + */ + html?: string; + /** + * [descr:Appointment.recurrenceException] + */ + recurrenceException?: string; + /** + * [descr:Appointment.recurrenceRule] + */ + recurrenceRule?: string; + /** + * [descr:Appointment.startDate] + */ + startDate?: Date | string; + /** + * [descr:Appointment.startDateTimeZone] + */ + startDateTimeZone?: string; + /** + * [descr:Appointment.template] + */ + template?: template; + /** + * [descr:Appointment.text] + */ + text?: string; + /** + * [descr:Appointment.visible] + */ + visible?: boolean; + } & Record; /** * [descr:_ui_scheduler_AppointmentAddedEvent] */ @@ -26351,64 +26407,6 @@ declare module DevExpress.ui { | 'week' | 'workWeek'; } - /** - * @deprecated Use the Scheduler's Appointment type instead - * @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution. - */ - export type dxSchedulerAppointment = CollectionWidgetItem & { - /** - * [descr:dxSchedulerAppointment.allDay] - */ - allDay?: boolean; - /** - * [descr:dxSchedulerAppointment.description] - */ - description?: string; - /** - * [descr:dxSchedulerAppointment.disabled] - */ - disabled?: boolean; - /** - * [descr:dxSchedulerAppointment.endDate] - */ - endDate?: Date | string; - /** - * [descr:dxSchedulerAppointment.endDateTimeZone] - */ - endDateTimeZone?: string; - /** - * [descr:dxSchedulerAppointment.html] - */ - html?: string; - /** - * [descr:dxSchedulerAppointment.recurrenceException] - */ - recurrenceException?: string; - /** - * [descr:dxSchedulerAppointment.recurrenceRule] - */ - recurrenceRule?: string; - /** - * [descr:dxSchedulerAppointment.startDate] - */ - startDate?: Date | string; - /** - * [descr:dxSchedulerAppointment.startDateTimeZone] - */ - startDateTimeZone?: string; - /** - * [descr:dxSchedulerAppointment.template] - */ - template?: template; - /** - * [descr:dxSchedulerAppointment.text] - */ - text?: string; - /** - * [descr:dxSchedulerAppointment.visible] - */ - visible?: boolean; - } & Record; /** * [descr:dxSchedulerOptions] * @deprecated [depNote:dxSchedulerOptions] @@ -26542,7 +26540,7 @@ declare module DevExpress.ui { /** * [descr:dxSchedulerOptions.dataSource] */ - dataSource?: DevExpress.data.DataSourceLike | null; + dataSource?: DevExpress.data.DataSourceLike | null; /** * [descr:dxSchedulerOptions.dateCellTemplate] */