LuciadCPillar C# 2024.1.04
Luciad.Layers.Features.FeatureQueryConfiguration Class Reference

The FeatureQueryConfiguration specifies which conditions to use for feature querying based on the map's current scale. More...

Inheritance diagram for Luciad.Layers.Features.FeatureQueryConfiguration:

Classes

class  Builder
 Builder for the FeatureQueryConfiguration class. More...
 

Public Member Functions

void Dispose ()
 
Luciad.Expressions.Expression GetCondition (uint scaleLevel)
 Returns the model query condition at a certain scale level, or null if no condition is set for this scale level i.e. More...
 

Static Public Member Functions

static Luciad.Layers.Features.FeatureQueryConfiguration.Builder NewBuilder ()
 Returns a new builder for creating a FeatureQueryConfiguration. More...
 

Properties

System.Collections.Generic.IList< Luciad.Maps.MapScaleScaleBreaks [get]
 The scales at which the model query condition changes, ordered from zoomed out to zoomed in. More...
 
uint ScaleLevelCount [get]
 The scale level count. More...
 

Detailed Description

The FeatureQueryConfiguration specifies which conditions to use for feature querying based on the map's current scale.

Member Function Documentation

◆ Dispose()

void Luciad.Layers.Features.FeatureQueryConfiguration.Dispose ( )
inline

◆ GetCondition()

Luciad.Expressions.Expression Luciad.Layers.Features.FeatureQueryConfiguration.GetCondition ( uint  scaleLevel)
inline

Returns the model query condition at a certain scale level, or null if no condition is set for this scale level i.e.

all features are selected.

Parameters
scaleLevelthe desired scale level to retrieve the condition for. This value must be smaller than the count returned by FeatureQueryConfiguration.ScaleLevelCount. If not, an exception is thrown.
Returns
the model query condition at a certain scale level, or null if no condition is set for this scale level i.e. all features are selected.
Exceptions
System.ArgumentExceptionIf scaleLevel parameter is greater or equal than the scale level count.
Since
2020.2
See also
FeatureQueryConfiguration.ScaleLevelCount

◆ NewBuilder()

static Luciad.Layers.Features.FeatureQueryConfiguration.Builder Luciad.Layers.Features.FeatureQueryConfiguration.NewBuilder ( )
inlinestatic

Returns a new builder for creating a FeatureQueryConfiguration.

Returns
a new builder for creating a FeatureQueryConfiguration.

Property Documentation

◆ ScaleBreaks

System.Collections.Generic.IList<Luciad.Maps.MapScale> Luciad.Layers.Features.FeatureQueryConfiguration.ScaleBreaks
get

The scales at which the model query condition changes, ordered from zoomed out to zoomed in.

[get]

Returns the scales at which the model query condition changes, ordered from zoomed out to zoomed in. This set contains every min or max scale that was passed to the builder through FeatureQueryConfiguration.Builder.AddCondition once. The values MapScale.maxZoomedOut() or MapScale.maxZoomedIn() are an exception and will never be contained in this set, as these values are considered to be the bounds of valid scale values and therefore not an actual scale break.

Scale breaks define the borders of the defined scale levels. This means that there is one more scale level than there are scale breaks. Imagine for example that 3 scale levels were added:

  • [MaxZoomedOut, scaleBreak1] -> condition1
  • [scaleBreak1, scaleBreak2] -> condition2
  • [scaleBreak2, MaxZoomedIn] -> condition3

These 3 scale levels correspond with:

◆ ScaleLevelCount

uint Luciad.Layers.Features.FeatureQueryConfiguration.ScaleLevelCount
get

The scale level count.

[get]

Returns the scale level count. This is the number of scale breaks + 1.

Since
2020.2 [get]
See also
FeatureQueryConfiguration.GetCondition