XMLReader
Introduction
vtkXMLReader is a source object that parses a VTK XML input file.
Methods
extend
Method used to decorate a given object (publicAPI+model) with vtkXMLReader 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 | IXMLReaderInitialValues | No | (default: {}) |
getBaseURL
getDataAccessHelper
getUrl
Get the url of the object to load.
loadData
Load the object data.
| Argument | Type | Required | Description |
|---|---|---|---|
options | IXMLReaderOptions | No |
parse
Parse data.
| Argument | Type | Required | Description |
|---|---|---|---|
content | String or ArrayBuffer | Yes | The content to parse. |
parseAsArrayBuffer
Parse data as ArrayBuffer.
| Argument | Type | Required | Description |
|---|---|---|---|
content | ArrayBuffer | Yes | The content to parse. |
parseAsText
Parse data as text.
| Argument | Type | Required | Description |
|---|---|---|---|
content | String | Yes | The content to parse. |
processCells
| Argument | Type | Required | Description |
|---|---|---|---|
size | Number | Yes | |
containerElem | HTMLElement | Yes | |
compressor | String | Yes | |
byteOrder | String | Yes | |
headerType | String | Yes | |
binaryBuffer | ArrayBuffer | Yes |
processDataArray
| Argument | Type | Required | Description |
|---|---|---|---|
size | Number | Yes | |
dataArrayElem | HTMLElement | Yes | |
compressor | String | Yes | |
byteOrder | String | Yes | |
headerType | String | Yes | |
binaryBuffer | ArrayBuffer | Yes |
processFieldData
| Argument | Type | Required | Description |
|---|---|---|---|
size | Number | Yes | |
fieldElem | HTMLElement | Yes | |
fieldContainer | HTMLElement | Yes | |
compressor | String | Yes | |
byteOrder | String | Yes | |
headerType | String | Yes | |
binaryBuffer | ArrayBuffer | Yes |
requestData
| Argument | Type | Required | Description |
|---|---|---|---|
inData | Yes | ||
outData | Yes |
setDataAccessHelper
| Argument | Type | Required | Description |
|---|---|---|---|
dataAccessHelper | Yes |
setUrl
Set the url of the object to load.
| Argument | Type | Required | Description |
|---|---|---|---|
url | String | Yes | the url of the object to load. |
option | IXMLReaderOptions | No | The XML reader options. |