Last updated

API / geotoolkit / map / features / filters / VisibilityArea / VisibilityArea

Class: VisibilityArea

filters.VisibilityArea.VisibilityArea

VisibilityArea can be applied to the Point features only. It filters out:

  1. features outside of canvas rendering area
  2. overlapped map features (optionally)
  3. Non-point like features
    The filter assumes feature geometries having 'x' and 'y' components to use as anchored shape anchor.

Implements

Table of contents

Constructors
Methods

Contents

Constructors

new VisibilityArea(shape, options)

new VisibilityArea(shape, options?)

Parameters

Name Type Description
shapeAnchoredShapeanchored shape as a template
Optional optionsOptionsoptions (see "setOptions" method for details)
Methods

filterFeatures

filterFeatures(iterator, context, layer?): Iterator<AbstractFeature>

Gets iterator over filtered features

Parameters

Name Type Description
iteratorIterator<AbstractFeature>input features iterator
contextRenderingContextrendering context
Optional layerAbstractFeatureLayerfeature layer (not used)

Returns

Iterator<AbstractFeature>

iterator over features to render

Implementation of

IFilter.filterFeatures


getClassName

getClassName(): string

Returns

string

Implementation of

IFilter.getClassName


getOptions

getOptions(): Required<Options>

Gets options

Returns

Required<Options>

options


reset

reset(): VisibilityArea

Resets itself

Returns

VisibilityArea

Implementation of

IFilter.reset


setOptions

setOptions(options?): VisibilityArea

Sets options

Parameters

Name Type Description
Optional optionsOptionsoptions

Returns

VisibilityArea


getClassName

Static getClassName(): string

Returns

string