Skip To Content ArcGIS for Developers Sign In Dashboard

EncMarinerSettings QML Type

An Electronic Navigation Chart (ENC) mariner settings object. More...

Import Statement: import Esri.ArcGISRuntime 100.6
Since: Esri.ArcGISRuntime 100.2
Inherits:

Object

Properties

Signals

Methods

Detailed Description

// sets ENC settings using QML declaration
EncLayer {
    encEnvironmentSettings.displaySettings.marinerSettings.deepContour: 2.0
}

// sets ENC settings using JS function
function setupEncEnvironmentSettings() {
    EncEnvironmentSettings.displaySettings.marinerSettings.deepContour = 2.0;
}

Note: You cannot declare or create a component of this type in QML code. Use EncDisplaySettings to get an instance.

See also EncLayer.

Property Documentation

areaSymbolizationType : Enums.EncAreaSymbolizationType

The type of area symbolization.

This controls the line symbol style for areas. This is used to specify whether areas should be symbolized with plain or traditional (symbolized) symbols.

The default value is Symbolized.

Note: "Symbolized" area symbolization renders area symbols using the traditional paper chart symbology. Plain reduces clutter.

See also Enums.EncAreaSymbolizationType.


colorScheme : Enums.EncColorScheme

The color scheme.

The S52 standard allows for switching between three color modes: Day, Dusk and Night.

The default value is Day.

Note: This affects the color scheme used on all layers in the map.

See also Enums.EncColorScheme.


dataQuality : bool

A value indicating whether to the display the quality of data.

The default value is false, meaning that quality of data will not be displayed.


deepContour : double

The deep contour depth in meters.

This must be greater than or equal to the safety contour value. An error will occur otherwise.

When four (rather than two) depth shades are used, this controls the boundary between safe and deep areas.

The default value is 30 (meters).


displayCategories : EncDisplayCategories

The S-52 display category (base/standard/other).

The actual status for individual objects within a category may be inconsistent with the setting for the category.

The default is that all three categories are enabled.


displayDepthUnits : Enums.EncDisplayDepthUnits

The depth units for soundings and contours for display.

The default value is meters.

See also Enums.EncDisplayDepthUnits.


displayNobjnm : bool

A value indicating whether to display the national names.

This is text group 31 per IHO S-52 Annex A.

The default value is true, meaning national names will be displayed.


honorScamin : bool

A value indicating whether the 'SCAMIN' (scale min) S-57 feature attribute will be honored.

If disabled, all ENC features will be rendered regardless of scale.

The default value is true, meaning the 'SCAMIN' attribute will be honored.


isolatedDangers : bool

A value indicating whether to display the isolated dangers in shallow water.

The default value is false, meaning isolated dangers will not be shown in shallow water.


labelContours : bool

A value indicating whether to display the depth contour labels, including the safety contour label.

This is viewing group 33021, 33022 per IHO S-52 Annex A.

The default value is true, meaning the depth contour labels will be displayed.


labelSafetyContours : bool

A value indicating whether to display the safety contour labels.

The default value is true, meaning the safety contour labels will be displayed.


lowAccuracy : bool

A value indicating whether to use low accuracy symbols (CATZOC).

This is viewing group 31010 per IHO S-52 Annex A.

The default value is true, meaning vectors marked as 'low accuracy data' will be symbolized differently. When set to false, low accuracy data will be visually indistinguishable from other data.


pointSymbolizationType : Enums.EncPointSymbolizationType

The point feature symbolization type.

This is used to specify whether point features should be symbolized with simplified or paperchart symbols.

Paperchart symbolization is based on traditional paper charts. Simplified symbols are more compact and visible.

The default value is paperchart.

See also Enums.EncPointSymbolizationType.


safetyContour : double

The depth of the safety contour in meters.

The safety contour separates safe from unsafe areas.

The default value is 30.


shallowContour : double

The depth of the shallow contour in meters.

This must be less than or equal to the safety contour value. An error will occur otherwise.

When four (rather than two) depth shades are used, this value controls the separation between shallow and unsafe areas.

The default value is 2.


shallowDepthPattern : bool

A value indicating whether to symbolize the shallow depth pattern.

The default value is false, meaning the shallow depth pattern will not be symbolized.


twoDepthShades : bool

A value indicating whether to display the two depth shades.

The default value is true, meaning two rather than four depth shades will be used.


Signal Documentation

areaSymbolizationTypeChanged()

Emitted when the areaSymbolizationType property changes.


colorSchemeChanged()

Emitted when the colorScheme property changes.


dataQualityChanged()

Emitted when the dataQuality property changes.


deepContourChanged()

Emitted when the deepContour property changes.


displayCategoriesChanged()

Emitted when the displayCategories property changes.


displayDepthUnitsChanged()

Emitted when the displayDepthUnits property changes.


displayNobjnmChanged()

Emitted when the displayNobjnm property changes.


honorScaminChanged()

Emitted when the honorScamin property changes.


isolatedDangersChanged()

Emitted when the isolatedDangers property changes.


labelContoursChanged()

Emitted when the labelContours property changes.


labelSafetyContoursChanged()

Emitted when the labelSafetyContours property changes.


lowAccuracyChanged()

Emitted when the lowAccuracy property changes.


pointSymbolizationTypeChanged()

Emitted when the pointSymbolizationType property changes.


safetyContourChanged()

Emitted when the safetyContour property changes.


shallowContourChanged()

Emitted when the shallowContour property changes.


shallowDepthPatternChanged()

Emitted when the shallowDepthPattern property changes.


twoDepthShadesChanged()

Emitted when the twoDepthShades property changes.


Method Documentation

void resetToDefaults()

Resets all S52 display properties.



Feedback on this topic?