Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://js.devexpress.com/Vue/Documentation/ApiReference/UI_Components/dxScheduler/Methods/ below:

Vue Scheduler Methods | Vue Documentation

This section describes methods used to manipulate the UI component.

Adds an appointment.

The appointment; should have the same structure as objects in the dataSource.

Postpones rendering that can negatively affect performance until the endUpdate() method is called.

The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.

Specifies the device-dependent default configuration properties for this component.

The component's default device properties.

Object structure:

Device

Function

Device parameters.
When you specify a function, get information about the current device from the argument. Return true if the properties should be applied to the device.

Object

Options to be applied.

defaultOptions is a static method that the UI component class supports. The following code demonstrates how to specify default properties for all instances of the Scheduler UI component in an application executed on the desktop.

DevExpress.ui.dxScheduler.defaultOptions({ 
    device: { deviceType: "desktop" },
    options: {
        // Here go the Scheduler properties
    }
});

import Scheduler, { Properties } from "devextreme/ui/scheduler";
// ...
export class AppComponent {
    constructor () {
        Scheduler.defaultOptions<Properties>({
            device: { deviceType: "desktop" },
            options: {
                // Here go the Scheduler properties
            }
        });
    }
}

<template>
    <div>
        <DxScheduler id="scheduler1" />
        <DxScheduler id="scheduler2" />
    </div>
</template>
<script>
import DxScheduler from "devextreme-vue/scheduler";
import Scheduler from "devextreme/ui/scheduler";

Scheduler.defaultOptions({
    device: { deviceType: "desktop" },
    options: {
        // Here go the Scheduler properties
    }
});

export default {
    components: {
        DxScheduler
    }
}
</script>

import dxScheduler from "devextreme/ui/scheduler";
import Scheduler from "devextreme-react/scheduler";

dxScheduler.defaultOptions({
    device: { deviceType: "desktop" },
    options: {
        // Here go the Scheduler properties
    }
});

export default function App() {
    return (
        <div>
            <Scheduler id="scheduler1" />
            <Scheduler id="scheduler2" />
        </div>
    )
}

You can also set rules for multiple device types:

const devicesConfig = [
    { deviceType: 'desktop' },
    { deviceType: 'tablet' },
    { deviceType: 'phone' },
];

devicesConfig.forEach(deviceConfig => {
    DevExpress.ui.dxScheduler.defaultOptions({ 
        device: deviceConfig,
        options: {
            // Here go the Scheduler properties
        }
    });
});

import Scheduler, { Properties } from "devextreme/ui/scheduler";
// ...
export class AppComponent {
    constructor () {
        const devicesConfig = [
            { deviceType: 'desktop' },
            { deviceType: 'tablet' },
            { deviceType: 'phone' },
        ];

        devicesConfig.forEach(deviceConfig => {
            Scheduler.defaultOptions<Properties>({
                device: deviceConfig,
                options: {
                    // Here go the Scheduler properties
                }
            });
        });
    }
}

<template>
    <div>
        <DxScheduler />
    </div>
</template>
<script>
import DxScheduler from "devextreme-vue/scheduler";
import Scheduler from "devextreme/ui/scheduler";

const devicesConfig = [
    { deviceType: 'desktop' },
    { deviceType: 'tablet' },
    { deviceType: 'phone' },
];

devicesConfig.forEach(deviceConfig => {
    Scheduler.defaultOptions({
        device: deviceConfig,
        options: {
            // Here go the Scheduler properties
        }
    });
});

export default {
    components: {
        DxScheduler
    }
}
</script>

import dxScheduler from "devextreme/ui/scheduler";
import Scheduler from "devextreme-react/scheduler";

const devicesConfig = [
    { deviceType: 'desktop' },
    { deviceType: 'tablet' },
    { deviceType: 'phone' },
];

devicesConfig.forEach(deviceConfig => {
    dxScheduler.defaultOptions({
        device: deviceConfig,
        options: {
            // Here go the Scheduler properties
        }
    });
});

export default function App() {
    return (
        <div>
            <Scheduler />
        </div>
    )
}

Deletes an appointment from the timetable and its object from the data source.

View Demo

If you delete a recurring appointment from the data source, all its occurrences are also deleted from the timetable:

$(function() {
    var appointments = [{
        text: "Website Re-Design Plan",
        startDate: new Date(2018, 4, 25, 9, 00),
        endDate: new Date(2018, 4, 25, 9, 30),
        recurrenceRule: "FREQ=DAILY;COUNT=10"
    }, 
    // ...
    ];

    var scheduler = $("#schedulerContainer").dxScheduler({
        dataSource: appointments,
        currentDate: new Date(2018, 4, 25)
    }).dxScheduler("instance");

    $("#deleteButton").dxButton({
        text: "Delete",
        onClick: function () {
            scheduler.deleteAppointment(appointments[0]);
        }
    });
});

<dx-button
    text="Delete"
    (onClick)="deleteAppointment()">
</dx-button>
<dx-scheduler
    [(dataSource)]="appointments"
    [currentDate]="currentDate">
</dx-scheduler>

import { Component, ViewChild } from "@angular/core";
import { Appointment, Service } from './app.service';
import { DxSchedulerComponent } from "devextreme-angular";
@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent  {
    @ViewChild(DxSchedulerComponent, { static: false }) scheduler: DxSchedulerComponent;
    // Prior to Angular 8
    // @ViewChild(DxSchedulerComponent) scheduler: DxSchedulerComponent;
    currentDate: Date = new Date(2018, 4, 25);
    appointments: Appointment[];

    constructor(service: Service) {
        this.appointments = service.getAppointments();
    }

    deleteAppointment() {
        this.scheduler.instance.deleteAppointment(this.appointments[0]);
    }
}

import { Injectable } from "@angular/core";

export class Appointment {
    text: string;
    startDate: Date;
    endDate: Date;
    recurrenceRule?: string;
}

let appointments: Appointment[] = [{
    text: "Website Re-Design Plan",
    startDate: new Date(2018, 4, 25, 9, 0),
    endDate: new Date(2018, 4, 25, 9, 30),
    recurrenceRule: "FREQ=DAILY;COUNT=10"
}, 
// ...
];

@Injectable()
export class Service {
    getAppointments(): Appointment[] {
        return appointments;
    }
}

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { 
    DxButtonModule, 
    DxSchedulerModule
} from "devextreme-angular";

import { Service } from './app.service';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxButtonModule,
        DxSchedulerModule
    ],
    providers: [
        Service
    ],
    bootstrap: [AppComponent]
})
export class AppModule { }

<template>
    <div>
        <DxButton 
            text="Delete" 
            @click="deleteAppointment" />
        <DxScheduler :ref="schedulerRef"
            :data-source="dataSource"
            :current-date="currentDate" />
    </div>
</template>
<script>
import 'devextreme/dist/css/dx.light.css';

import DxScheduler from 'devextreme-vue/scheduler';
import DxButton from 'devextreme-vue/button';
import { appointments } from './data.js';

const schedulerRef = "scheduler";

export default {
    components: {
        DxScheduler,
        DxButton
    },
    data() {
        return {
            schedulerRef,
            currentDate: new Date(2018, 4, 25),
            dataSource: appointments
        };
    },
    methods: {
        deleteAppointment() {
            this.scheduler.deleteAppointment(appointments[0]);
        } 
    },
    computed: {
        scheduler: function() {
            return this.$refs[schedulerRef].instance;
        }
    }
};
</script>

export const appointments = [{
    text: "Website Re-Design Plan",
    startDate: new Date(2018, 4, 25, 9, 0),
    endDate: new Date(2018, 4, 25, 9, 30),
    recurrenceRule: "FREQ=DAILY;COUNT=10"
}, 
// ...
];

import React from 'react';
import 'devextreme/dist/css/dx.light.css';
import Scheduler from 'devextreme-react/scheduler';
import Button from 'devextreme-react/button';
import { appointments } from './data.js';

const currentDate = new Date(2018, 4, 25);

class App extends React.Component {
    constructor(props) {
        super(props);

        this.schedulerRef = React.createRef();

        this.deleteAppointment = () => {
            this.scheduler.deleteAppointment(appointments[0]);
        }
    }

    get scheduler() {
        return this.schedulerRef.current.instance();
    }

    render() {
        return (
            <div>
                <Button text="Delete" onClick={this.deleteAppointment} />
                <Scheduler ref={this.schedulerRef}
                    dataSource={appointments}
                    defaultCurrentDate={currentDate} />
            </div>
        );
    }
}
export default App;

export const appointments = [{
    text: "Website Re-Design Plan",
    startDate: new Date(2018, 4, 25, 9, 0),
    endDate: new Date(2018, 4, 25, 9, 30),
    recurrenceRule: "FREQ=DAILY;COUNT=10"
}, 
// ...
];

• onAppointmentDeleting
• onAppointmentDeleted

Deletes a recurring appointment occurrence.

The initial appointment.

A date for which to delete a recurrence.

An edit mode for recurring appointments.

$(function() {
    const appointments = [{
        text: "Website Re-Design Plan",
        startDate: new Date(2018, 4, 25, 9, 00),
        endDate: new Date(2018, 4, 25, 9, 30),
        recurrenceRule: "FREQ=DAILY;COUNT=10"
    }, 
    // ...
    ];

    const scheduler = $("#schedulerContainer").dxScheduler({
        dataSource: appointments,
        // ...
        onAppointmentClick: function(e) {
            if (condition){
                e.component.deleteRecurrence(e.appointmentData, e.targetedAppointmentData.startDate, 'occurrence');
            }
        }
    }).dxScheduler("instance");
});

<dx-scheduler ...
    [dataSource]="appointments"
    (onAppointmentClick)="deleteRecurrence($event)">
</dx-scheduler>

import { Component } from "@angular/core";
import { Appointment, Service } from './app.service';
@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent  {
    appointments: Appointment[];

    constructor(service: Service) {
        this.appointments = service.getAppointments();
    }

    deleteAppointment(e) {
        e.component.deleteRecurrence(e.appointmentData, e.targetedAppointmentData.startDate, 'occurrence');
    }
}

import { Injectable } from "@angular/core";

export class Appointment {
    text: string;
    startDate: Date;
    endDate: Date;
    recurrenceRule?: string;
}

let appointments: Appointment[] = [{
    text: "Website Re-Design Plan",
    startDate: new Date(2018, 4, 25, 9, 0),
    endDate: new Date(2018, 4, 25, 9, 30),
    recurrenceRule: "FREQ=DAILY;COUNT=10"
}, 
// ...
];

@Injectable()
export class Service {
    getAppointments(): Appointment[] {
        return appointments;
    }
}

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxSchedulerModule } from "devextreme-angular";

import { Service } from './app.service';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxSchedulerModule
    ],
    providers: [
        Service
    ],
    bootstrap: [AppComponent]
})
export class AppModule { }

<template>
    <DxScheduler ...
        :data-source="dataSource"
        @appointment-click="deleteRecurrence"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';
import DxScheduler from 'devextreme-vue/scheduler';
import { appointments } from './data.js';

export default {
    components: {
        DxScheduler
    },
    data() {
        return {
            dataSource: appointments
        };
    },
    methods: {
        deleteRecurrence(e) {
            e.component.deleteRecurrence(e.appointmentData, e.targetedAppointmentData.startDate, 'occurrence');
        } 
    }
};
</script>

export const appointments = [{
    text: "Website Re-Design Plan",
    startDate: new Date(2018, 4, 25, 9, 0),
    endDate: new Date(2018, 4, 25, 9, 30),
    recurrenceRule: "FREQ=DAILY;COUNT=10"
}, 
// ...
];

import React, { useCallback } from 'react';
import Scheduler from 'devextreme-react/scheduler';
import { appointments } from './data.js';

function App() {
    const deleteRecurrence = useCallback((e) => { 
        e.component.deleteRecurrence(e.appointmentData, e.targetedAppointmentData.startDate, 'occurrence');
    }, []);

    return (
        <Scheduler ...
            dataSource={appointments}
            onAppointmentClick={deleteRecurrence} 
        />
    );
}

export default App;

export const appointments = [{
    text: "Website Re-Design Plan",
    startDate: new Date(2018, 4, 25, 9, 0),
    endDate: new Date(2018, 4, 25, 9, 30),
    recurrenceRule: "FREQ=DAILY;COUNT=10"
}, 
// ...
];

Disposes of all the resources allocated to the Scheduler instance.

After calling this method, remove the DOM element associated with the UI component:

$("#myScheduler").dxScheduler("dispose");
$("#myScheduler").remove();

Use conditional rendering instead of this method:

<dx-scheduler ...
    *ngIf="condition">
</dx-scheduler>

Use conditional rendering instead of this method:

<template>
    <DxScheduler ...
        v-if="condition">
    </DxScheduler>
</template>

<script>
import DxScheduler from 'devextreme-vue/scheduler';

export default {
    components: {
        DxScheduler
    }
}
</script>

Use conditional rendering instead of this method:

import React from 'react';

import Scheduler from 'devextreme-react/scheduler';

function DxScheduler(props) {
    if (!props.shouldRender) {
        return null;
    }

    return (
        <Scheduler ... >    
        </Scheduler>
    );
}

class App extends React.Component {
    render() {
        return (
            <DxScheduler shouldRender="condition" />
        );
    }
}
export default App;

Gets the root UI component element.

Refreshes the UI component after a call of the beginUpdate() method.

The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.

Sets focus on the UI component.

Gets the current view's end date.

Gets the instance of a UI component found using its DOM node.

The UI component's container.

The UI component's instance.

getInstance is a static method that the UI component class supports. The following code demonstrates how to get the Scheduler instance found in an element with the myScheduler ID:

// Modular approach
import Scheduler from "devextreme/ui/scheduler";
...
let element = document.getElementById("myScheduler");
let instance = Scheduler.getInstance(element) as Scheduler;

// Non-modular approach
let element = document.getElementById("myScheduler");
let instance = DevExpress.ui.dxScheduler.getInstance(element);

• 3rd-Party Frameworks Integration API

Gets the current view's start date.

Hides an appointment details form.

Specifies whether to save changes.

Gets the UI component's instance. Use it to access other methods of the UI component.

This UI component's instance.

Detaches all event handlers from a single event.

The object for which this method is called.

Detaches a particular event handler from a single event.

The event's name.

The event's handler.

The object for which this method is called.

Subscribes to an event.

The event's name.

The event's handler.

The object for which this method is called.

Use this method to subscribe to one of the events listed in the Events section.

Subscribes to events.

Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}

The object for which this method is called.

Use this method to subscribe to several events with one method call. Available events are listed in the Events section.

Gets the value of a single property.

The property's name or full path.

Return Value: any

This property's value.

Updates the value of a single property.

The property's name or full path.

optionValue: any

This property's new value.

Updates the values of several properties.

Options with their new values.

Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically.

Use the DataSource reload method to reload data in Scheduler. To get a DataSource, you can call the getDataSource() method. Change the dataSource property of the corresponding resources item if you need to update resource data.

Resets a property to its default value.

Scrolls the current view to a specified position. Available for all views except "agenda". You should specify the height property to use this method.

A date and time to which to scroll.

If appointments are grouped by resources, specifies a group ID (optional).

If true, scrolls the view to the all-day panel of the specified group. Applies only if the all-day panel is visible.

The following example shows how to use this method:

// Scroll to January 14, 2021
scrollTo(new Date(2021, 0, 14));
// Scroll to the second group at 5:30 p.m. on January 14, 2021
scrollTo(new Date(2021, 0, 14, 17, 30), {groupId: 2})
// Scroll to the all-day panel of the second group
scrollTo(new Date(2021, 0, 14, 17, 30), {groupId: 2}, true);

If you need to navigate to a date outside the current view, use the

property instead.

• Group Appointments by Resources
• currentView
• scrolling
• crossScrollingEnabled

Use the scrollTo(dategroupallDay) method instead.

Scrolls the current view to a specific day and time.

An hour component.

A minute component.

A date component.

If the specified date is outside the current date range, the method scrolls the view to the specified time.

This method requires that the markup is already rendered. To scroll the Scheduler at launch, call this method in the

function.

Shows the appointment details form.

The initial appointment.

Boolean

| undefined

Specifies whether a new appointment is created when editing is finished.

The appointment's data object.
The difference between this and appointmentData fields is explained in the onAppointmentClick description.

If invoked without parameters, the method shows a new appointment window. Its start and end dates are prepopulated in accordance with the currentDate value. The default appointment duration is 30 minutes.

View Demo

Shows a tooltip for a target element.

The initial appointment.

The target element.

The appointment's data object.
The difference between this and appointmentData fields is explained in the onAppointmentClick description.

Updates an appointment.

The appointment to be updated.

The appointment with updated data.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4