In This Topic ▼

getImageData Method

Summary

Returns the image data at the specified location and size.

Syntax

TypeScript

JavaScript

AnnDataProvider.prototype.getImageData = function( 
   container, 
   bounds 
)

getImageData( 
   container: AnnContainer, 
   bounds: LeadRectD 
): number[];

Parameters

container

The reference AnnContainer.

bounds

The location and size in container on where to get the image data. This is in container coordinates.

Return Value

A byte array that contains the image data.

Remarks

Derived classes must implement GetImageData to extract the data of the image being annotated at the specified location and size and SetImageData to reapply this same data to the image.

The data is application specific since it will only be stored as is inside the caller annotation object (for example, AnnRedactionObject during realize/restore). The format of the data and how it is obtained or applied is hidden from the annotations framework. A typical would be to copy the pixel data from the image then convert it to a standard format such as PNG and return it from GetImageData.

The automation framework will call GetImageData only if the value of CanRead is true and SetImageData only if the value of CanWrite is true.

Requirements

Target Platforms

Reference

AnnDataProvider Class

AnnDataProvider Members

Leadtools.Annotations.Engine Namespace

Download our FREE evaluation

Help Version 22.0.2023.1.31

Leadtools.Annotations.Engine Assembly

Introduction

Getting Started

Namespaces

Leadtools.Annotations.Engine Namespace

Assemblies