Last updated

API / geotoolkit / scene / filters / InArray / InArray

Class: InArray

filters.InArray.InArray

Define a simple filter based on array

Implements

Table of contents

Constructors
Methods

Contents

Constructors

new InArray(array)

new InArray(array?)

Parameters

Name Type
Optional arrayNode[]
Methods

begin

begin(): InArray

Begin filtering. If a filter should be applied to children nodes it needs to be added to context and removed in the method end

Example

// Implementation of the filter to be applied for children
begin (context?: RenderingContext) {
context.addFilter(this);
}

Returns

InArray

this

Implementation of

IFilter.begin


end

end(): InArray

End filtering. If a filter should be applied to children nodes it needs to be added to context and removed in the method end

Example

// Implementation of the filter to be applied for children
end (context?: RenderingContext) {
context.removeFilter(this);
}

Returns

InArray

this

Implementation of

IFilter.end


filter

filter(node): boolean

Checks if the node should be drawn.

All children nodes will be given the chance to render or not to render.

Parameters

Name Type Description
nodeNodenode to check

Returns

boolean

flag filter flag ("true" to render node; "false" otherwise)

Implementation of

IFilter.filter


getArray

getArray(): Node[]

Get array to be used

Returns

Node[]

array


getClassName

getClassName(): string

Returns

string

Implementation of

IFilter.getClassName


setArray

setArray(array): InArray

Set array to be used

Parameters

Name Type Description
arrayNode[]array

Returns

InArray


getClassName

Static getClassName(): string

Returns

string