ZipMultiDataSetReader

Source (.js)Source (.d.ts)

Introduction

vtkZipMultiDataSetReader reads a zip archive produced by vtkZipMultiDataSetWriter: a datasets.json metadata file alongside one binary file per data array.

Methods

extend

Method used to decorate a given object (publicAPI+model) with vtkZipMultiDataSetReader characteristics.

Argument	Type	Required	Description
publicAPI		Yes	object on which methods will be bounds (public)
model		Yes	object on which data structure will be bounds (protected)
initialValues	IZipMultiDataSetReaderInitialValues	No	(default: {})

getBaseURL

getDataAccessHelper

getUrl

Get the url of the zip to load.

loadData

Fetch and parse the zip at the currently set url.

Argument	Type	Required	Description
option	IZipMultiDataSetReaderOptions	No

newInstance

Method used to create a new instance of vtkZipMultiDataSetReader

Argument	Type	Required	Description
initialValues	IZipMultiDataSetReaderInitialValues	No	for pre-setting some of its content

parseAsArrayBuffer

Unzip the given buffer, reading datasets.json and every array_* entry it contains.

Argument	Type	Required	Description
arrayBuffer	ArrayBuffer	Yes	The content to parse.

requestData

Argument	Type	Required	Description
inData		Yes
outData		Yes

setDataAccessHelper

Argument	Type	Required	Description
dataAccessHelper		Yes

setUrl

Set the url of the zip to load and fetch it.

Argument	Type	Required	Description
url	String	Yes	the url of the zip to load.
option	IZipMultiDataSetReaderOptions	No