Class: NVDocument
Defined in: nvdocument.ts:456
NVDocument class (main)
Constructors
Constructor
new NVDocument(): NVDocument;
Defined in: nvdocument.ts:482
Returns
NVDocument
Properties
| Property | Type | Default value | Defined in |
|---|---|---|---|
completedAngles | CompletedAngle[] | [] | nvdocument.ts:477 |
completedMeasurements | CompletedMeasurement[] | [] | nvdocument.ts:476 |
data | DocumentData | undefined | nvdocument.ts:457 |
drawBitmap | Uint8Array | null | nvdocument.ts:473 |
imageOptionsMap | Map<any, any> | undefined | nvdocument.ts:474 |
meshDataObjects? | ( | NVMesh | NVConnectome)[] | undefined | nvdocument.ts:471 |
meshes | ( | NVMesh | NVConnectome)[] | [] | nvdocument.ts:472 |
meshOptionsMap | Map<any, any> | undefined | nvdocument.ts:475 |
scene | Scene | undefined | nvdocument.ts:468 |
volumes | NVImage[] | [] | nvdocument.ts:470 |
Accessors
customData
Get Signature
get customData(): string;
Defined in: nvdocument.ts:646
Returns
string
Set Signature
set customData(data: string): void;
Defined in: nvdocument.ts:650
Parameters
| Parameter | Type |
|---|---|
data | string |
Returns
void
encodedDrawingBlob
Get Signature
get encodedDrawingBlob(): string;
Defined in: nvdocument.ts:610
Gets the base 64 encoded blob of the associated drawing
Returns
string
encodedImageBlobs
Get Signature
get encodedImageBlobs(): string[];
Defined in: nvdocument.ts:603
Gets the base 64 encoded blobs of associated images
Returns
string[]
imageOptionsArray
Get Signature
get imageOptionsArray(): ImageFromUrlOptions[];
Defined in: nvdocument.ts:596
Returns
labels
Get Signature
get labels(): NVLabel3D[];
Defined in: nvdocument.ts:635
Gets the 3D labels of the Niivue instance
Returns
NVLabel3D[]
Set Signature
set labels(labels: NVLabel3D[]): void;
Defined in: nvdocument.ts:642
Sets the 3D labels of the Niivue instance
Parameters
| Parameter | Type |
|---|---|
labels | NVLabel3D[] |
Returns
void
opts
Get Signature
get opts(): NVConfigOptions;
Defined in: nvdocument.ts:617
Gets the options of the Niivue instance
Returns
Set Signature
set opts(opts: NVConfigOptions): void;
Defined in: nvdocument.ts:627
Sets the options of the Niivue instance
Parameters
| Parameter | Type |
|---|---|
opts | NVConfigOptions |
Returns
void
previewImageDataURL
Get Signature
get previewImageDataURL(): string;
Defined in: nvdocument.ts:577
Gets preview image blob
Returns
string
dataURL of preview image
Set Signature
set previewImageDataURL(dataURL: string): void;
Defined in: nvdocument.ts:585
Sets preview image blob
Parameters
| Parameter | Type | Description |
|---|---|---|
dataURL | string | encoded preview image |
Returns
void
title
Get Signature
get title(): string;
Defined in: nvdocument.ts:569
Title of the document
Returns
string
Set Signature
set title(title: string): void;
Defined in: nvdocument.ts:592
Parameters
| Parameter | Type | Description |
|---|---|---|
title | string | title of document |
Returns
void
Methods
addImageOptions()
addImageOptions(image: NVImage, imageOptions: ImageFromUrlOptions): void;
Defined in: nvdocument.ts:671
Adds an image and the options an image was created with
Parameters
| Parameter | Type |
|---|---|
image | NVImage |
imageOptions | ImageFromUrlOptions |
Returns
void
download()
download(
fileName: string,
compress: boolean,
opts: object): Promise<void>;
Defined in: nvdocument.ts:761
Parameters
| Parameter | Type |
|---|---|
fileName | string |
compress | boolean |
opts | { embedImages: boolean; } |
opts.embedImages | boolean |
Returns
Promise<void>
fetchLinkedData()
fetchLinkedData(): Promise<void>;
Defined in: nvdocument.ts:715
Fetch any image data that is missing from this document.
Returns
Promise<void>
getImageOptions()
getImageOptions(image: NVImage): ImageFromUrlOptions;
Defined in: nvdocument.ts:748
Returns the options for the image if it was added by url
Parameters
| Parameter | Type |
|---|---|
image | NVImage |
Returns
hasImage()
hasImage(image: NVImage): boolean;
Defined in: nvdocument.ts:657
Checks if document has an image by id
Parameters
| Parameter | Type |
|---|---|
image | NVImage |
Returns
boolean
hasImageFromUrl()
hasImageFromUrl(url: string): boolean;
Defined in: nvdocument.ts:664
Checks if document has an image by url
Parameters
| Parameter | Type |
|---|---|
url | string |
Returns
boolean
json()
json(embedImages: boolean, embedDrawing: boolean): ExportDocumentData;
Defined in: nvdocument.ts:755
Serialise the document by delegating to NVSerializer.
Parameters
| Parameter | Type | Default value |
|---|---|---|
embedImages | boolean | true |
embedDrawing | boolean | true |
Returns
removeImage()
removeImage(image: NVImage): void;
Defined in: nvdocument.ts:701
Removes image from the document as well as its options
Parameters
| Parameter | Type |
|---|---|
image | NVImage |
Returns
void
removeOptsChangeCallback()
removeOptsChangeCallback(): void;
Defined in: nvdocument.ts:824
Removes the opts change callback
Returns
void
setOptsChangeCallback()
setOptsChangeCallback(callback: (propertyName: keyof NVConfigOptions, newValue:
| string
| number
| boolean
| number[]
| Float32Array
| number[]
| MouseEventConfig
| TouchEventConfig
| [[number, number], [number, number]], oldValue:
| string
| number
| boolean
| number[]
| Float32Array
| number[]
| MouseEventConfig
| TouchEventConfig
| [[number, number], [number, number]]) => void): void;
Defined in: nvdocument.ts:816
Sets the callback function to be called when opts properties change
Parameters
| Parameter | Type |
|---|---|
callback | (propertyName: keyof NVConfigOptions, newValue: | string | number | boolean | number[] | Float32Array | number[] | MouseEventConfig | TouchEventConfig | [[number, number], [number, number]], oldValue: | string | number | boolean | number[] | Float32Array | number[] | MouseEventConfig | TouchEventConfig | [[number, number], [number, number]]) => void |
Returns
void
loadFromFile()
static loadFromFile(file: Blob): Promise<NVDocument>;
Defined in: nvdocument.ts:789
Parameters
| Parameter | Type |
|---|---|
file | Blob |
Returns
Promise<NVDocument>
loadFromJSON()
static loadFromJSON(data: DocumentData): Promise<NVDocument>;
Defined in: nvdocument.ts:809
Factory method to return an instance of NVDocument from JSON. Delegates the main parsing to NVSerializer, then applies NVDocument-specific post-processing (opts decode, scene defaults, clone measurements/angles).
Parameters
| Parameter | Type |
|---|---|
data | DocumentData |
Returns
Promise<NVDocument>
loadFromUrl()
static loadFromUrl(url: string): Promise<NVDocument>;
Defined in: nvdocument.ts:773
Factory method to return an instance of NVDocument from a URL
Parameters
| Parameter | Type |
|---|---|
url | string |
Returns
Promise<NVDocument>