API / geotoolkit / schematics / labeling / DefaultComponentsFilter / DefaultComponentsFilter
labeling.DefaultComponentsFilter.DefaultComponentsFilter
Default components filter implementation
Deprecated
since 4.0. Use LabelsFilter instead.
Example
// The component filter's parameter 'mdsizedevice' defines how small (in pixels) is component's height which is to be labeled.
import {DefaultComponentsFilter} from '@int/geotoolkit/schematics/labeling/DefaultComponentsFilter';
wellBoreWithLabels.getLabelingStrategy().setOptions({
'componentsfilter': new DefaultComponentsFilter({'mdsizedevice': 100})
});Constructors
- [new DefaultComponentsFilter(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.schematics.labeling.defaultcomponentsfilter.defaultcomponentsfilter.md#new defaultcomponentsfilter(options))
Css Properties
| Name | Type | Description |
|---|---|---|
mdsizedevice | number | Smallest component MD-size to have label (in device space) |
orientation | string | Orientation |
viewmode | ViewMode | View mode |
Constructors
• new DefaultComponentsFilter(options?)
| Name | Type | Description |
|---|---|---|
Optional options | Options | options |
Methods
▸ filterComponents(iterator, context): Iterator<ComponentNode>
Gets iterator over filtered components
| Name | Type | Description |
|---|---|---|
iterator | Iterator<ComponentNode> | input components iterator |
context | RenderingContext | rendering context |
iterator over components to label
IComponentsFilter.filterComponents
▸ getClassName(): string
string
IComponentsFilter.getClassName
▸ getOptions(): any
Returns options (deep copy)
any
[options] options see DefaultComponentsFilter.getProperties
▸ getProperties(): OptionsOut
Returns all the properties pertaining to this object
properties
▸ reset(options?): DefaultComponentsFilter
Resets itself using given options
| Name | Type | Description |
|---|---|---|
Optional options | ResetOptions | options |
▸ setProperties(properties?): DefaultComponentsFilter
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional properties | Options | properties |
this
▸ Static getClassName(): string
string