Last updated

API / geotoolkit / scene / filters / ScaleRange / ScaleRange

Class: ScaleRange

filters.ScaleRange.ScaleRange

Filter nodes based on range of scale factor

Implements

Table of contents

Constructors
Methods

Contents

Constructors

new ScaleRange(options)

new ScaleRange(options?)

Parameters

Name Type
Optional optionsOptions
Methods

begin

begin(): ScaleRange

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

ScaleRange

this

Implementation of

IFilter.begin


end

end(): ScaleRange

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

ScaleRange

this

Implementation of

IFilter.end


filter

filter(node, context?): 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
Optional contextRenderingContextrendering context

Returns

boolean

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

Implementation of

IFilter.filter


getClassName

getClassName(): string

Returns

string

Implementation of

IFilter.getClassName


getOptions

getOptions(): Options

Gets options

Returns

Options

options options


setOptions

setOptions(options?): ScaleRange

Sets options

Parameters

Name Type Description
Optional optionsOptionsoptions

Returns

ScaleRange

this


getClassName

Static getClassName(): string

Returns

string