A Tasks tracks general asynchronous tasks running within a Viewer.

Overview

• Each Viewer has a Tasks component, available via the Viewer's Viewer/tasks:property property, within which it will create and destroy Task components to indicate what processes it's running internally.
• You can also manage your own Task components within that, to indicate what application-level processes you are running.

Example

This example shows how to manage tasks and subscribe to their life cycles.

// Create a Viewer
var viewer = new BIMSURFER.Viewer({ element: "myDiv" });

// Get the Tasks tracker
var tasks = viewer.tasks;

// Subscribe to all task creations
tasks.on("started", function(task) {
    console.log("Task started: " + task.id +", " + task.description);
});

// Subscribe to all task completions
tasks.on("completed", function(task) {
     console.log("Task completed: " + task.id +", " + task.description);
});

// Subscribe to all task failures
tasks.on("failed", function(task) {
    console.log("Task failed: " + task.id +", " + task.description);
});

// Create and start Task "foo"
var taskFoo = tasks.create({
    id: "foo", // Optional, unique ID generated automatically when omitted
    description: "Loading something"
});

// Create and start Task "bar"
var taskBar = tasks.create({
    id: "bar",
    description: "Loading something else"
});

// Subscribe to completion of Task "foo"
taskFoo.on("completed", function(task) {
    console.log("Task completed: " + task.id +", " + task.description);
});

// Subscribe to failure of a specific task
taskFoo.on("failed", function(task) {
    console.log("Task failed: " + task.id +", " + task.description);
});

// Set Task "foo" as completed, via the Tasks
// Fires the "completed" handler we registered above, also fires "completed" on the Task itself
tasks.setCompleted("foo");

// Set Task "bar" as failed, this time directly on the Task in question
myTask2.setFailed();