workerCount Property (DocumentViewerView)

Summary

Indicates the number of view workers.

Syntax

JavaScript Syntax

Object.defineProperty(DocumentViewerView.prototype, 'workerCount', 
	get: function(), 
	set: function(value) 
)

TypeScript Syntax

workerCount: number;

Property Value

The number of view workers, default value is 4. This value cannot be less than 1.

Remarks

Then this class loads the images of the pages one at a time (through the use of DocumentPage.GetImage.

Getting an image involves making a call to the Documents service using DocumentPage.GetImage to get the image data, loading it internally and waiting for it to be ready then rendering it on the image viewer.

During this waiting part, this class can start loading another image if needed up to WorkerCount. The maximum numbers of images being loaded that has not been processed will not exceed the value set in WorkerCount.

The higher the number, the more stress on the service (and the client machine connection) and the default value of 4 is a good compromise between speed and system load. To reduce service stress, consider LazyLoad.

Requirements

Target Platforms

See Also