Last updated

API / geotoolkit / contour / datasource / ContourDataSource / ContourDataSource

Class: ContourDataSource

datasource.ContourDataSource.ContourDataSource

This 'interface' class extends abstract definition of contour data, which includes information about model limits and contour grid. This interface can be implemented for ZMAP and TSURF data

Hierarchy

Table of contents

Constructors
Methods

Contents

Constructors

new ContourDataSource()

Protected new ContourDataSource()

Overrides

AbstractContourDataSource.constructor

Methods

freeGrid

Abstract freeGrid(grid): void

Release memory occupied by the grid.

Parameters

Name Type Description
gridContourAbstractGridThe grid that contains points.

Returns

void

Inherited from

AbstractContourDataSource.freeGrid


getClassName

getClassName(): string

Returns

string

Inherited from

AbstractContourDataSource.getClassName


getGridType

Abstract getGridType(): ContourGridType

Gets the type of grid.

Returns

ContourGridType


getMax

getMax(): number

Gets the maximum z-value.

Returns

number

max The maximum of the data.


getMin

getMin(): number

Gets the minimum z-value.

Returns

number

min The minimum of the data.


getModelLimits

Abstract getModelLimits(): Rect

Gets the model limits of contour data.

Returns

Rect

modelLimits The rectangle that contains all data grids,

Inherited from

AbstractContourDataSource.getModelLimits


getObjectName

getObjectName(): string

Gets the object name

Returns

string

name The name of the object


getProperties

getProperties(): AnyRecord

Gets the datasource properties

Returns

AnyRecord

properties datasource properties

Inherited from

AbstractContourDataSource.getProperties


loadGrid

Abstract loadGrid(): ContourAbstractGrid

Loads grid into memory.

Returns

ContourAbstractGrid

grid The loaded grid.

Inherited from

AbstractContourDataSource.loadGrid


setMax

setMax(max): ContourDataSource

Sets the maximum z-value.

Parameters

Name Type Description
maxnumberThe maximum of the data

Returns

ContourDataSource

this


setMin

setMin(min): ContourDataSource

Sets the minimum z-value.

Parameters

Name Type Description
minnumberThe minimum of the data.

Returns

ContourDataSource

this


setObjectName

setObjectName(name): ContourDataSource

Sets the object name

Parameters

Name Type Description
namestringThe name of the object

Returns

ContourDataSource

this


setProperties

setProperties(properties): ContourDataSource

Sets the datasource properties

Parameters

Name Type Description
propertiesAnyRecorddatasource properties

Returns

ContourDataSource

this

Inherited from

AbstractContourDataSource.setProperties


updateArea

Abstract updateArea(): void

Updates area.

Returns

void


getClassName

Static getClassName(): string

Returns

string

Inherited from

AbstractContourDataSource.getClassName