API reference / @zaes/metoc/editor

@zaes/metoc/editor

Drawing and editing for @zaes/metoc: the editor, undo and redo, and the field list a properties dialog reads. The gestures and undo are @zaes/symbology-editor's, bound here to METOC (METOC_EDITING); the field registry is METOC's own. It works on any map that implements MetocMapHost, such as the OpenLayers and MapLibre renderers in @zaes/metoc, through attachMetocEditor, and imports no map library itself. The root entry never imports it.

Classes

Interfaces

Type Aliases

EditMode

type EditMode = "idle" | "drawing" | "dragVertex" | "dragGraphic" | "rotate" | "resize";

EditorAction

type EditorAction = "draw" | "move" | "reshape" | "rotate" | "resize" | "delete" | "duplicate";

What the operator can do to graphics, each of which a host may forbid.

EditorListener

type EditorListener = (event) => void;

change: repaint the overlay. drawend: a graphic was finished. commit: a gesture that changed the collection has ended — the moment a host records an undo step. rejected: a graphic could not be finished, with the reason (refused when EditorOptions.beforeChange turned it down).

Parameters

event

| { type: "change"; } | { id: string; type: "drawend"; } | { type: "commit"; } | { reason: string; type: "rejected"; }

Returns

void

EditorOverlay

type EditorOverlay = SymbolEditorOverlay<MetocFeature>;

What the editor draws for a METOC graphic being drawn or selected.

HistoryListener

type HistoryListener = () => void;

Undo and redo

Snapshots of a collection, taken at checkpoints rather than on every change. A drag moves a point dozens of times; the operator thinks of it as one edit, so the host checkpoints when the editor announces a commit (the end of a gesture), and after a properties edit settles. A checkpoint that changes nothing records nothing.

Snapshots are the saved form — toGeoJSON() — so undo restores exactly what a save and load would, ids included, and needs no knowledge of what changed.

Returns

void

MetocEditorChange

type MetocEditorChange = EditorChange<MetocFeature>;

A change the editor is about to make, as MetocEditorOptions.beforeChange sees it.

MetocEditorOptions

type MetocEditorOptions = EditorOptions<MetocFeature>;

How a host shapes the editor: handle sizes, snapping, allowed actions, a veto, keys.

Variables

HANDLE_RADIUS_PX

const HANDLE_RADIUS_PX: 7 = 7;

HIT_TOLERANCE_PX

const HIT_TOLERANCE_PX: 8 = 8;

Default pixel sizes.

INSERT_HANDLE_RADIUS_PX

const INSERT_HANDLE_RADIUS_PX: 5 = 5;

METOC_COLOR_ROLE_NAMES

const METOC_COLOR_ROLE_NAMES: Readonly<Record<MetocColorRole, string>>;

What to call a colour role in a UI.

METOC_EDITING

const METOC_EDITING: EditorFamily<"metoc", MetocProperties>;

METOC as the editor sees it.

METOC_VALUE_FIELDS

const METOC_VALUE_FIELDS: Readonly<Partial<Record<MetocGraphicName, MetocValueField>>>;

The value field's wording, per graphic, as the catalog states it.

Functions

attachMetocEditor()

function attachMetocEditor(host, editor): () => void;

Edit on a map. Returns the function that detaches: the host's events stop reaching the editor and its overlay is cleared. The editor itself, its collection and its selection survive, so a host can switch engines and attach the same editor to the next one.

Parameters

host

MapHost

editor

MetocInteraction

Returns

() => void

editorOverlay()

function editorOverlay<K, P>(editor, resolution): HostOverlay;

The editor's overlay as marks at a resolution, in the family's chrome colours.

Type Parameters

K

K extends string

P

P extends object

Parameters

editor

SymbolInteraction<K, P>

resolution

number

Returns

HostOverlay

getMetocFields()

function getMetocFields(name): MetocFieldSet;

The inputs a properties dialog shows for a graphic.

Parameters

name

Returns

MetocFieldSet

stationChoices()

function stationChoices(): object;

The symbols a station plot's pickers offer, in catalog order: the cloud coverage symbols for its sky cover, the pressure tendency symbols, and the weather symbols for its present weather.

Returns

object

cloudCover

cloudCover: (
  | "LowPressureCenter"
  | "CycloneCenter"
  | "TropopauseLow"
  | "HighPressureCenter"
  | "AnticycloneCenter"
  | "TropopauseHigh"
  | "ColdFront"
  | "UpperColdFront"
  | "ColdFrontogenesis"
  | "ColdFrontolysis"
  | "WarmFront"
  | "UpperWarmFront"
  | "WarmFrontogenesis"
  | "WarmFrontolysis"
  | "OccludedFront"
  | "UpperOccludedFront"
  | "OccludedFrontolysis"
  | "StationaryFront"
  | "UpperStationaryFront"
  | "StationaryFrontogenesis"
  | "StationaryFrontolysis"
  | "TroughAxis"
  | "Trough"
  | "RidgeAxis"
  | "SevereSquallLine"
  | "InstabilityLine"
  | "ShearLine"
  | "InterTropicalConvergenceZone"
  | "ConvergenceLine"
  | "InterTropicalDiscontinuity"
  | "CalmWinds"
  | "WindBarb"
  | "StationPlot"
  | "JetStream"
  | "StreamLine"
  | "IsobarSurface"
  | "ContourUpperAir"
  | "Isotherm"
  | "Isotach"
  | "Isodrosotherm"
  | "Thickness"
  | "OperatorDefinedFreeformLine"
  | "TropicalStormWindArea"
  | "InstrumentFlightRule"
  | "MarginalVisualFlightRule"
  | "Turbulence"
  | "Icing"
  | "LiquidPrecipitation"
  | "ConvectivePrecipitation"
  | "FreezingPrecipitation"
  | "Thunderstorm"
  | "Fog"
  | "DustOrSand"
  | "OperatorDefinedFreeformArea"
  | "PressureRiseThenFallHigher"
  | "PressureRiseThenSteady"
  | "PressureRise"
  | "PressureRiseThenRiseHigher"
  | "PressureSteady"
  | "PressureFallThenRiseLower"
  | "PressureFallThenSteady"
  | "PressureFall"
  | "PressureRiseThenFallLower"
  | "TurbulenceLight"
  | "TurbulenceModerate"
  | "TurbulenceSevere"
  | "TurbulenceExtreme"
  | "TurbulenceMountainWaves"
  | "IcingClearLight"
  | "IcingClearModerate"
  | "IcingClearSevere"
  | "IcingRimeLight"
  | "IcingRimeModerate"
  | "IcingRimeSevere"
  | "IcingMixedLight"
  | "IcingMixedModerate"
  | "IcingMixedSevere"
  | "CloudClearSky"
  | "CloudFew"
  | "CloudScattered"
  | "CloudBroken"
  | "CloudOvercast"
  | "CloudSkyObscured"
  | "RainIntermittentLight"
  | "RainContinuousLight"
  | "RainIntermittentModerate"
  | "RainContinuousModerate"
  | "RainIntermittentHeavy"
  | "RainContinuousHeavy"
  | "FreezingRainLight"
  | "FreezingRainModerateHeavy"
  | "RainShowersLight"
  | "RainShowersModerateHeavy"
  | "RainShowersTorrential"
  | "DrizzleIntermittentLight"
  | "DrizzleContinuousLight"
  | "DrizzleIntermittentModerate"
  | "DrizzleContinuousModerate"
  | "DrizzleIntermittentHeavy"
  | "DrizzleContinuousHeavy"
  | "FreezingDrizzleLight"
  | "FreezingDrizzleModerateHeavy"
  | "RainOrDrizzleAndSnowLight"
  | "RainOrDrizzleAndSnowModerateHeavy"
  | "RainAndSnowShowersLight"
  | "RainAndSnowShowersModerateHeavy"
  | "SnowIntermittentLight"
  | "SnowContinuousLight"
  | "SnowIntermittentModerate"
  | "SnowContinuousModerate"
  | "SnowIntermittentHeavy"
  | "SnowContinuousHeavy"
  | "BlowingSnowLightModerate"
  | "BlowingSnowHeavy"
  | "SnowGrains"
  | "SnowShowersLight"
  | "SnowShowersModerateHeavy"
  | "HailLight"
  | "HailModerateHeavy"
  | "IceCrystals"
  | "IcePelletsLight"
  | "IcePelletsModerate"
  | "IcePelletsHeavy"
  | "Inversion"
  | "ThunderstormNoPrecipitation"
  | "ThunderstormLightModerateRainSnow"
  | "ThunderstormHeavyRainSnow"
  | "ThunderstormLightModerateHail"
  | "ThunderstormHeavyHail"
  | "FunnelCloud"
  | "Squall"
  | "Lightning"
  | "FogShallowPatches"
  | "FogShallowContinuous"
  | "FogPatchy"
  | "FogSkyVisible"
  | "FogSkyObscured"
  | "FreezingFogSkyVisible"
  | "FreezingFogSkyObscured"
  | "Mist"
  | "Smoke"
  | "Haze"
  | "DustOrSandLightModerate"
  | "DustOrSandSevere"
  | "DustDevil"
  | "BlowingDustOrSand"
  | "TropicalDepression"
  | "TropicalStorm"
  | "HurricaneTyphoon"
  | "VolcanicEruption"
  | "VolcanicAsh"
  | "TropopauseLevel"
  | "FreezingLevel"
  | "PrecipitationUnknown"
  | "GroundDry"
  | "GroundMoist"
  | "GroundWet"
  | "GroundFlooded"
  | "GroundFrozen"
  | "GroundGlaze"
  | "GroundLooseDustNotCovering"
  | "GroundThinLooseDust"
  | "GroundThickLooseDust"
  | "GroundExtremelyDry"
  | "GroundPredominantlyIce"
  | "GroundCompactSnowLessHalf"
  | "GroundCompactSnowAtLeastHalf"
  | "GroundCompactSnowEven"
  | "GroundCompactSnowUneven"
  | "GroundLooseSnowLessHalf"
  | "GroundLooseSnowAtLeastHalf"
  | "GroundLooseSnowEven"
  | "GroundLooseSnowUneven"
  | "GroundSnowDeepDrifts"
  | "ManyIcebergs"
  | "IcebergBeltsStrips"
  | "IcebergGeneral"
  | "ManyIcebergsGeneral"
  | "BergyBit"
  | "ManyBergyBits"
  | "Growler"
  | "ManyGrowlers"
  | "Floeberg"
  | "IceIsland"
  | "BergyWater"
  | "WaterWithRadarTargets"
  | "IceFree"
  | "IceConvergence"
  | "IceDivergence"
  | "IceShearing"
  | "IceDrift"
  | "SeaIce"
  | "IceThicknessObserved"
  | "IceThicknessEstimated"
  | "MeltPuddles"
  | "SnowCover"
  | "Sastrugi"
  | "RidgesHummocks"
  | "Rafting"
  | "JammedBrashBarrier"
  | "Soundings"
  | "BerthsOnshore"
  | "BerthsAnchor"
  | "AnchoragePoint"
  | "CallInPoint"
  | "FishingHarbor"
  | "FishWeirs"
  | "FishStakes"
  | "LandingPlace"
  | "OffshoreLoadingPoint"
  | "LandingRing"
  | "FerryCrossing"
  | "CableFerryCrossing"
  | "Dolphin"
  | "Beacon"
  | "BuoyDefault"
  | "Marker"
  | "PerchesStakesPoint"
  | "NavigationLight"
  | "LightVessel"
  | "Lighthouse"
  | "RockSubmerged"
  | "RockAwashed"
  | "FoulGroundPoint"
  | "KelpPoint"
  | "SnagsStumps"
  | "WreckUncovers"
  | "WreckSubmerged"
  | "EddiesOverfalls"
  | "BottomSand"
  | "BottomMud"
  | "BottomClay"
  | "BottomSilt"
  | "BottomStones"
  | "BottomGravel"
  | "BottomPebbles"
  | "BottomCobbles"
  | "BottomRock"
  | "BottomCoral"
  | "BottomShell"
  | "QualifyingFine"
  | "QualifyingMedium"
  | "QualifyingCoarse"
  | "WaterTurbulence"
  | "TideDataPoint"
  | "TideGauge"
  | "Ford"
  | "Lock"
  | "OilGasRig"
  | "PilePost"
  | "LimitsVisualObservation"
  | "LimitsUndercast"
  | "LimitsRadarObservation"
  | "ObservedIceEdge"
  | "EstimatedIceEdge"
  | "IceEdgeFromRadar"
  | "IceCracks"
  | "IceCracksSpecific"
  | "IceLead"
  | "IceFrozenLead"
  | "DepthCurve"
  | "DepthContour"
  | "DepthArea"
  | "Coastline"
  | "Island"
  | "Beach"
  | "Water"
  | "ForeshoreLine"
  | "ForeshoreArea"
  | "AnchorageLine"
  | "AnchorageArea"
  | "PierWharfQuay"
  | "FishTrapsArea"
  | "Drydock"
  | "OffshoreLoadingLine"
  | "OffshoreLoadingArea"
  | "RampAboveWater"
  | "RampBelowWater"
  | "BreakwaterAboveWater"
  | "BreakwaterBelowWater"
  | "Seawall"
  | "PerchesStakesArea"
  | "LeadingLine"
  | "UnderwaterDanger"
  | "FoulGroundArea"
  | "KelpArea"
  | "Breakers"
  | "Reef"
  | "DiscoloredWater"
  | "CurrentFlowEbb"
  | "CurrentFlowFlood"
  | "VdrLevel1to2"
  | "VdrLevel2to3"
  | "VdrLevel3to4"
  | "VdrLevel4to5"
  | "VdrLevel5to6"
  | "VdrLevel6to7"
  | "VdrLevel7to8"
  | "VdrLevel8to9"
  | "VdrLevel9to10"
  | "BeachSlopeFlat"
  | "BeachSlopeGentle"
  | "BeachSlopeModerate"
  | "BeachSlopeSteep"
  | "MiwSolidRock"
  | "MiwClay"
  | "MiwVeryCoarseSand"
  | "MiwCoarseSand"
  | "MiwMediumSand"
  | "MiwFineSand"
  | "MiwVeryFineSand"
  | "MiwVeryFineSilt"
  | "MiwFineSilt"
  | "MiwMediumSilt"
  | "MiwCoarseSilt"
  | "MiwBoulders"
  | "MiwCobblesOysterShells"
  | "MiwPebblesShells"
  | "MiwSandAndShells"
  | "MiwLand"
  | "MiwNoData"
  | "MiwRoughnessSmooth"
  | "MiwRoughnessModerate"
  | "MiwRoughnessRough"
  | "MiwClutterLow"
  | "MiwClutterMedium"
  | "MiwClutterHigh"
  | "MiwImpactBurial0"
  | "MiwImpactBurial0to10"
  | "MiwImpactBurial10to20"
  | "MiwImpactBurial20to75"
  | "MiwImpactBurialOver75"
  | "MiwCategoryA"
  | "MiwCategoryB"
  | "MiwCategoryC"
  | "MiwTypeA1"
  | "MiwTypeA2"
  | "MiwTypeA3"
  | "MiwTypeB1"
  | "MiwTypeB2"
  | "MiwTypeB3"
  | "MiwTypeC1"
  | "MiwTypeC2"
  | "MiwTypeC3"
  | "MaritimeLimitBoundary"
  | "MaritimeArea"
  | "RestrictedArea"
  | "SweptArea"
  | "TrainingArea"
  | "OperatorDefinedMaritimeArea"
  | "SubmarineCable"
  | "SubmergedCrib"
  | "Canal"
  | "OilGasRigField"
  | "Pipeline"
  | "S412WindWarningNearGale"
  | "S412WindWarningGale"
  | "S412WindWarningStorm"
  | "S412WindWarningHurricane"
  | "S412WaveWarning2To4m"
  | "S412WaveWarning4To6m"
  | "S412WaveWarning6To9m"
  | "S412WaveWarning9To14m"
  | "S412WaveWarningOver14m"
  | "S412IceAccretionModerate"
  | "S412IceAccretionSevere"
  | "S412RestrictedVisibility"
  | "S412Thunderstorm"
  | "S411IceFree"
  | "S411OpenWater"
  | "S411VeryOpenDrift"
  | "S411OpenDrift"
  | "S411ClosePack"
  | "S411VeryClosePack"
  | "S411CompactIce"
  | "S411ConcentrationUnknown"
  | "S411StageIceFree"
  | "S411NewIce"
  | "S411Nilas"
  | "S411YoungIce"
  | "S411GreyIce"
  | "S411GreyWhiteIce"
  | "S411FirstYearIce"
  | "S411ThinFirstYearIce"
  | "S411ThinFirstYearStage1"
  | "S411ThinFirstYearStage2"
  | "S411MediumFirstYearIce"
  | "S411ThickFirstYearIce"
  | "S411OldIce"
  | "S411SecondYearIce"
  | "S411MultiYearIce"
  | "S411GlacierIce"
  | "S411StageUnknown"
  | "S411IcebergArea"
  | "S411IceKeel"
  | "S411GroundedHummock"
  | "S411StripsAndPatches"
  | "S411StageOfMelt"
  | "S411IceLeadPoint"
  | "S411IceFracturePoint"
  | "S411IceEdge"
  | "S411LimitOfOpenWater"
  | "S411LimitOfAllKnownIce"
  | "S411IcebergLimit"
  | "S411IceRidgeLine"
  | "S411IceLeadLine"
  | "S411IceFractureLine"
  | "S411IceCrackLine")[];

pressureTendency

pressureTendency: (
  | "LowPressureCenter"
  | "CycloneCenter"
  | "TropopauseLow"
  | "HighPressureCenter"
  | "AnticycloneCenter"
  | "TropopauseHigh"
  | "ColdFront"
  | "UpperColdFront"
  | "ColdFrontogenesis"
  | "ColdFrontolysis"
  | "WarmFront"
  | "UpperWarmFront"
  | "WarmFrontogenesis"
  | "WarmFrontolysis"
  | "OccludedFront"
  | "UpperOccludedFront"
  | "OccludedFrontolysis"
  | "StationaryFront"
  | "UpperStationaryFront"
  | "StationaryFrontogenesis"
  | "StationaryFrontolysis"
  | "TroughAxis"
  | "Trough"
  | "RidgeAxis"
  | "SevereSquallLine"
  | "InstabilityLine"
  | "ShearLine"
  | "InterTropicalConvergenceZone"
  | "ConvergenceLine"
  | "InterTropicalDiscontinuity"
  | "CalmWinds"
  | "WindBarb"
  | "StationPlot"
  | "JetStream"
  | "StreamLine"
  | "IsobarSurface"
  | "ContourUpperAir"
  | "Isotherm"
  | "Isotach"
  | "Isodrosotherm"
  | "Thickness"
  | "OperatorDefinedFreeformLine"
  | "TropicalStormWindArea"
  | "InstrumentFlightRule"
  | "MarginalVisualFlightRule"
  | "Turbulence"
  | "Icing"
  | "LiquidPrecipitation"
  | "ConvectivePrecipitation"
  | "FreezingPrecipitation"
  | "Thunderstorm"
  | "Fog"
  | "DustOrSand"
  | "OperatorDefinedFreeformArea"
  | "PressureRiseThenFallHigher"
  | "PressureRiseThenSteady"
  | "PressureRise"
  | "PressureRiseThenRiseHigher"
  | "PressureSteady"
  | "PressureFallThenRiseLower"
  | "PressureFallThenSteady"
  | "PressureFall"
  | "PressureRiseThenFallLower"
  | "TurbulenceLight"
  | "TurbulenceModerate"
  | "TurbulenceSevere"
  | "TurbulenceExtreme"
  | "TurbulenceMountainWaves"
  | "IcingClearLight"
  | "IcingClearModerate"
  | "IcingClearSevere"
  | "IcingRimeLight"
  | "IcingRimeModerate"
  | "IcingRimeSevere"
  | "IcingMixedLight"
  | "IcingMixedModerate"
  | "IcingMixedSevere"
  | "CloudClearSky"
  | "CloudFew"
  | "CloudScattered"
  | "CloudBroken"
  | "CloudOvercast"
  | "CloudSkyObscured"
  | "RainIntermittentLight"
  | "RainContinuousLight"
  | "RainIntermittentModerate"
  | "RainContinuousModerate"
  | "RainIntermittentHeavy"
  | "RainContinuousHeavy"
  | "FreezingRainLight"
  | "FreezingRainModerateHeavy"
  | "RainShowersLight"
  | "RainShowersModerateHeavy"
  | "RainShowersTorrential"
  | "DrizzleIntermittentLight"
  | "DrizzleContinuousLight"
  | "DrizzleIntermittentModerate"
  | "DrizzleContinuousModerate"
  | "DrizzleIntermittentHeavy"
  | "DrizzleContinuousHeavy"
  | "FreezingDrizzleLight"
  | "FreezingDrizzleModerateHeavy"
  | "RainOrDrizzleAndSnowLight"
  | "RainOrDrizzleAndSnowModerateHeavy"
  | "RainAndSnowShowersLight"
  | "RainAndSnowShowersModerateHeavy"
  | "SnowIntermittentLight"
  | "SnowContinuousLight"
  | "SnowIntermittentModerate"
  | "SnowContinuousModerate"
  | "SnowIntermittentHeavy"
  | "SnowContinuousHeavy"
  | "BlowingSnowLightModerate"
  | "BlowingSnowHeavy"
  | "SnowGrains"
  | "SnowShowersLight"
  | "SnowShowersModerateHeavy"
  | "HailLight"
  | "HailModerateHeavy"
  | "IceCrystals"
  | "IcePelletsLight"
  | "IcePelletsModerate"
  | "IcePelletsHeavy"
  | "Inversion"
  | "ThunderstormNoPrecipitation"
  | "ThunderstormLightModerateRainSnow"
  | "ThunderstormHeavyRainSnow"
  | "ThunderstormLightModerateHail"
  | "ThunderstormHeavyHail"
  | "FunnelCloud"
  | "Squall"
  | "Lightning"
  | "FogShallowPatches"
  | "FogShallowContinuous"
  | "FogPatchy"
  | "FogSkyVisible"
  | "FogSkyObscured"
  | "FreezingFogSkyVisible"
  | "FreezingFogSkyObscured"
  | "Mist"
  | "Smoke"
  | "Haze"
  | "DustOrSandLightModerate"
  | "DustOrSandSevere"
  | "DustDevil"
  | "BlowingDustOrSand"
  | "TropicalDepression"
  | "TropicalStorm"
  | "HurricaneTyphoon"
  | "VolcanicEruption"
  | "VolcanicAsh"
  | "TropopauseLevel"
  | "FreezingLevel"
  | "PrecipitationUnknown"
  | "GroundDry"
  | "GroundMoist"
  | "GroundWet"
  | "GroundFlooded"
  | "GroundFrozen"
  | "GroundGlaze"
  | "GroundLooseDustNotCovering"
  | "GroundThinLooseDust"
  | "GroundThickLooseDust"
  | "GroundExtremelyDry"
  | "GroundPredominantlyIce"
  | "GroundCompactSnowLessHalf"
  | "GroundCompactSnowAtLeastHalf"
  | "GroundCompactSnowEven"
  | "GroundCompactSnowUneven"
  | "GroundLooseSnowLessHalf"
  | "GroundLooseSnowAtLeastHalf"
  | "GroundLooseSnowEven"
  | "GroundLooseSnowUneven"
  | "GroundSnowDeepDrifts"
  | "ManyIcebergs"
  | "IcebergBeltsStrips"
  | "IcebergGeneral"
  | "ManyIcebergsGeneral"
  | "BergyBit"
  | "ManyBergyBits"
  | "Growler"
  | "ManyGrowlers"
  | "Floeberg"
  | "IceIsland"
  | "BergyWater"
  | "WaterWithRadarTargets"
  | "IceFree"
  | "IceConvergence"
  | "IceDivergence"
  | "IceShearing"
  | "IceDrift"
  | "SeaIce"
  | "IceThicknessObserved"
  | "IceThicknessEstimated"
  | "MeltPuddles"
  | "SnowCover"
  | "Sastrugi"
  | "RidgesHummocks"
  | "Rafting"
  | "JammedBrashBarrier"
  | "Soundings"
  | "BerthsOnshore"
  | "BerthsAnchor"
  | "AnchoragePoint"
  | "CallInPoint"
  | "FishingHarbor"
  | "FishWeirs"
  | "FishStakes"
  | "LandingPlace"
  | "OffshoreLoadingPoint"
  | "LandingRing"
  | "FerryCrossing"
  | "CableFerryCrossing"
  | "Dolphin"
  | "Beacon"
  | "BuoyDefault"
  | "Marker"
  | "PerchesStakesPoint"
  | "NavigationLight"
  | "LightVessel"
  | "Lighthouse"
  | "RockSubmerged"
  | "RockAwashed"
  | "FoulGroundPoint"
  | "KelpPoint"
  | "SnagsStumps"
  | "WreckUncovers"
  | "WreckSubmerged"
  | "EddiesOverfalls"
  | "BottomSand"
  | "BottomMud"
  | "BottomClay"
  | "BottomSilt"
  | "BottomStones"
  | "BottomGravel"
  | "BottomPebbles"
  | "BottomCobbles"
  | "BottomRock"
  | "BottomCoral"
  | "BottomShell"
  | "QualifyingFine"
  | "QualifyingMedium"
  | "QualifyingCoarse"
  | "WaterTurbulence"
  | "TideDataPoint"
  | "TideGauge"
  | "Ford"
  | "Lock"
  | "OilGasRig"
  | "PilePost"
  | "LimitsVisualObservation"
  | "LimitsUndercast"
  | "LimitsRadarObservation"
  | "ObservedIceEdge"
  | "EstimatedIceEdge"
  | "IceEdgeFromRadar"
  | "IceCracks"
  | "IceCracksSpecific"
  | "IceLead"
  | "IceFrozenLead"
  | "DepthCurve"
  | "DepthContour"
  | "DepthArea"
  | "Coastline"
  | "Island"
  | "Beach"
  | "Water"
  | "ForeshoreLine"
  | "ForeshoreArea"
  | "AnchorageLine"
  | "AnchorageArea"
  | "PierWharfQuay"
  | "FishTrapsArea"
  | "Drydock"
  | "OffshoreLoadingLine"
  | "OffshoreLoadingArea"
  | "RampAboveWater"
  | "RampBelowWater"
  | "BreakwaterAboveWater"
  | "BreakwaterBelowWater"
  | "Seawall"
  | "PerchesStakesArea"
  | "LeadingLine"
  | "UnderwaterDanger"
  | "FoulGroundArea"
  | "KelpArea"
  | "Breakers"
  | "Reef"
  | "DiscoloredWater"
  | "CurrentFlowEbb"
  | "CurrentFlowFlood"
  | "VdrLevel1to2"
  | "VdrLevel2to3"
  | "VdrLevel3to4"
  | "VdrLevel4to5"
  | "VdrLevel5to6"
  | "VdrLevel6to7"
  | "VdrLevel7to8"
  | "VdrLevel8to9"
  | "VdrLevel9to10"
  | "BeachSlopeFlat"
  | "BeachSlopeGentle"
  | "BeachSlopeModerate"
  | "BeachSlopeSteep"
  | "MiwSolidRock"
  | "MiwClay"
  | "MiwVeryCoarseSand"
  | "MiwCoarseSand"
  | "MiwMediumSand"
  | "MiwFineSand"
  | "MiwVeryFineSand"
  | "MiwVeryFineSilt"
  | "MiwFineSilt"
  | "MiwMediumSilt"
  | "MiwCoarseSilt"
  | "MiwBoulders"
  | "MiwCobblesOysterShells"
  | "MiwPebblesShells"
  | "MiwSandAndShells"
  | "MiwLand"
  | "MiwNoData"
  | "MiwRoughnessSmooth"
  | "MiwRoughnessModerate"
  | "MiwRoughnessRough"
  | "MiwClutterLow"
  | "MiwClutterMedium"
  | "MiwClutterHigh"
  | "MiwImpactBurial0"
  | "MiwImpactBurial0to10"
  | "MiwImpactBurial10to20"
  | "MiwImpactBurial20to75"
  | "MiwImpactBurialOver75"
  | "MiwCategoryA"
  | "MiwCategoryB"
  | "MiwCategoryC"
  | "MiwTypeA1"
  | "MiwTypeA2"
  | "MiwTypeA3"
  | "MiwTypeB1"
  | "MiwTypeB2"
  | "MiwTypeB3"
  | "MiwTypeC1"
  | "MiwTypeC2"
  | "MiwTypeC3"
  | "MaritimeLimitBoundary"
  | "MaritimeArea"
  | "RestrictedArea"
  | "SweptArea"
  | "TrainingArea"
  | "OperatorDefinedMaritimeArea"
  | "SubmarineCable"
  | "SubmergedCrib"
  | "Canal"
  | "OilGasRigField"
  | "Pipeline"
  | "S412WindWarningNearGale"
  | "S412WindWarningGale"
  | "S412WindWarningStorm"
  | "S412WindWarningHurricane"
  | "S412WaveWarning2To4m"
  | "S412WaveWarning4To6m"
  | "S412WaveWarning6To9m"
  | "S412WaveWarning9To14m"
  | "S412WaveWarningOver14m"
  | "S412IceAccretionModerate"
  | "S412IceAccretionSevere"
  | "S412RestrictedVisibility"
  | "S412Thunderstorm"
  | "S411IceFree"
  | "S411OpenWater"
  | "S411VeryOpenDrift"
  | "S411OpenDrift"
  | "S411ClosePack"
  | "S411VeryClosePack"
  | "S411CompactIce"
  | "S411ConcentrationUnknown"
  | "S411StageIceFree"
  | "S411NewIce"
  | "S411Nilas"
  | "S411YoungIce"
  | "S411GreyIce"
  | "S411GreyWhiteIce"
  | "S411FirstYearIce"
  | "S411ThinFirstYearIce"
  | "S411ThinFirstYearStage1"
  | "S411ThinFirstYearStage2"
  | "S411MediumFirstYearIce"
  | "S411ThickFirstYearIce"
  | "S411OldIce"
  | "S411SecondYearIce"
  | "S411MultiYearIce"
  | "S411GlacierIce"
  | "S411StageUnknown"
  | "S411IcebergArea"
  | "S411IceKeel"
  | "S411GroundedHummock"
  | "S411StripsAndPatches"
  | "S411StageOfMelt"
  | "S411IceLeadPoint"
  | "S411IceFracturePoint"
  | "S411IceEdge"
  | "S411LimitOfOpenWater"
  | "S411LimitOfAllKnownIce"
  | "S411IcebergLimit"
  | "S411IceRidgeLine"
  | "S411IceLeadLine"
  | "S411IceFractureLine"
  | "S411IceCrackLine")[];

weather

weather: (
  | "LowPressureCenter"
  | "CycloneCenter"
  | "TropopauseLow"
  | "HighPressureCenter"
  | "AnticycloneCenter"
  | "TropopauseHigh"
  | "ColdFront"
  | "UpperColdFront"
  | "ColdFrontogenesis"
  | "ColdFrontolysis"
  | "WarmFront"
  | "UpperWarmFront"
  | "WarmFrontogenesis"
  | "WarmFrontolysis"
  | "OccludedFront"
  | "UpperOccludedFront"
  | "OccludedFrontolysis"
  | "StationaryFront"
  | "UpperStationaryFront"
  | "StationaryFrontogenesis"
  | "StationaryFrontolysis"
  | "TroughAxis"
  | "Trough"
  | "RidgeAxis"
  | "SevereSquallLine"
  | "InstabilityLine"
  | "ShearLine"
  | "InterTropicalConvergenceZone"
  | "ConvergenceLine"
  | "InterTropicalDiscontinuity"
  | "CalmWinds"
  | "WindBarb"
  | "StationPlot"
  | "JetStream"
  | "StreamLine"
  | "IsobarSurface"
  | "ContourUpperAir"
  | "Isotherm"
  | "Isotach"
  | "Isodrosotherm"
  | "Thickness"
  | "OperatorDefinedFreeformLine"
  | "TropicalStormWindArea"
  | "InstrumentFlightRule"
  | "MarginalVisualFlightRule"
  | "Turbulence"
  | "Icing"
  | "LiquidPrecipitation"
  | "ConvectivePrecipitation"
  | "FreezingPrecipitation"
  | "Thunderstorm"
  | "Fog"
  | "DustOrSand"
  | "OperatorDefinedFreeformArea"
  | "PressureRiseThenFallHigher"
  | "PressureRiseThenSteady"
  | "PressureRise"
  | "PressureRiseThenRiseHigher"
  | "PressureSteady"
  | "PressureFallThenRiseLower"
  | "PressureFallThenSteady"
  | "PressureFall"
  | "PressureRiseThenFallLower"
  | "TurbulenceLight"
  | "TurbulenceModerate"
  | "TurbulenceSevere"
  | "TurbulenceExtreme"
  | "TurbulenceMountainWaves"
  | "IcingClearLight"
  | "IcingClearModerate"
  | "IcingClearSevere"
  | "IcingRimeLight"
  | "IcingRimeModerate"
  | "IcingRimeSevere"
  | "IcingMixedLight"
  | "IcingMixedModerate"
  | "IcingMixedSevere"
  | "CloudClearSky"
  | "CloudFew"
  | "CloudScattered"
  | "CloudBroken"
  | "CloudOvercast"
  | "CloudSkyObscured"
  | "RainIntermittentLight"
  | "RainContinuousLight"
  | "RainIntermittentModerate"
  | "RainContinuousModerate"
  | "RainIntermittentHeavy"
  | "RainContinuousHeavy"
  | "FreezingRainLight"
  | "FreezingRainModerateHeavy"
  | "RainShowersLight"
  | "RainShowersModerateHeavy"
  | "RainShowersTorrential"
  | "DrizzleIntermittentLight"
  | "DrizzleContinuousLight"
  | "DrizzleIntermittentModerate"
  | "DrizzleContinuousModerate"
  | "DrizzleIntermittentHeavy"
  | "DrizzleContinuousHeavy"
  | "FreezingDrizzleLight"
  | "FreezingDrizzleModerateHeavy"
  | "RainOrDrizzleAndSnowLight"
  | "RainOrDrizzleAndSnowModerateHeavy"
  | "RainAndSnowShowersLight"
  | "RainAndSnowShowersModerateHeavy"
  | "SnowIntermittentLight"
  | "SnowContinuousLight"
  | "SnowIntermittentModerate"
  | "SnowContinuousModerate"
  | "SnowIntermittentHeavy"
  | "SnowContinuousHeavy"
  | "BlowingSnowLightModerate"
  | "BlowingSnowHeavy"
  | "SnowGrains"
  | "SnowShowersLight"
  | "SnowShowersModerateHeavy"
  | "HailLight"
  | "HailModerateHeavy"
  | "IceCrystals"
  | "IcePelletsLight"
  | "IcePelletsModerate"
  | "IcePelletsHeavy"
  | "Inversion"
  | "ThunderstormNoPrecipitation"
  | "ThunderstormLightModerateRainSnow"
  | "ThunderstormHeavyRainSnow"
  | "ThunderstormLightModerateHail"
  | "ThunderstormHeavyHail"
  | "FunnelCloud"
  | "Squall"
  | "Lightning"
  | "FogShallowPatches"
  | "FogShallowContinuous"
  | "FogPatchy"
  | "FogSkyVisible"
  | "FogSkyObscured"
  | "FreezingFogSkyVisible"
  | "FreezingFogSkyObscured"
  | "Mist"
  | "Smoke"
  | "Haze"
  | "DustOrSandLightModerate"
  | "DustOrSandSevere"
  | "DustDevil"
  | "BlowingDustOrSand"
  | "TropicalDepression"
  | "TropicalStorm"
  | "HurricaneTyphoon"
  | "VolcanicEruption"
  | "VolcanicAsh"
  | "TropopauseLevel"
  | "FreezingLevel"
  | "PrecipitationUnknown"
  | "GroundDry"
  | "GroundMoist"
  | "GroundWet"
  | "GroundFlooded"
  | "GroundFrozen"
  | "GroundGlaze"
  | "GroundLooseDustNotCovering"
  | "GroundThinLooseDust"
  | "GroundThickLooseDust"
  | "GroundExtremelyDry"
  | "GroundPredominantlyIce"
  | "GroundCompactSnowLessHalf"
  | "GroundCompactSnowAtLeastHalf"
  | "GroundCompactSnowEven"
  | "GroundCompactSnowUneven"
  | "GroundLooseSnowLessHalf"
  | "GroundLooseSnowAtLeastHalf"
  | "GroundLooseSnowEven"
  | "GroundLooseSnowUneven"
  | "GroundSnowDeepDrifts"
  | "ManyIcebergs"
  | "IcebergBeltsStrips"
  | "IcebergGeneral"
  | "ManyIcebergsGeneral"
  | "BergyBit"
  | "ManyBergyBits"
  | "Growler"
  | "ManyGrowlers"
  | "Floeberg"
  | "IceIsland"
  | "BergyWater"
  | "WaterWithRadarTargets"
  | "IceFree"
  | "IceConvergence"
  | "IceDivergence"
  | "IceShearing"
  | "IceDrift"
  | "SeaIce"
  | "IceThicknessObserved"
  | "IceThicknessEstimated"
  | "MeltPuddles"
  | "SnowCover"
  | "Sastrugi"
  | "RidgesHummocks"
  | "Rafting"
  | "JammedBrashBarrier"
  | "Soundings"
  | "BerthsOnshore"
  | "BerthsAnchor"
  | "AnchoragePoint"
  | "CallInPoint"
  | "FishingHarbor"
  | "FishWeirs"
  | "FishStakes"
  | "LandingPlace"
  | "OffshoreLoadingPoint"
  | "LandingRing"
  | "FerryCrossing"
  | "CableFerryCrossing"
  | "Dolphin"
  | "Beacon"
  | "BuoyDefault"
  | "Marker"
  | "PerchesStakesPoint"
  | "NavigationLight"
  | "LightVessel"
  | "Lighthouse"
  | "RockSubmerged"
  | "RockAwashed"
  | "FoulGroundPoint"
  | "KelpPoint"
  | "SnagsStumps"
  | "WreckUncovers"
  | "WreckSubmerged"
  | "EddiesOverfalls"
  | "BottomSand"
  | "BottomMud"
  | "BottomClay"
  | "BottomSilt"
  | "BottomStones"
  | "BottomGravel"
  | "BottomPebbles"
  | "BottomCobbles"
  | "BottomRock"
  | "BottomCoral"
  | "BottomShell"
  | "QualifyingFine"
  | "QualifyingMedium"
  | "QualifyingCoarse"
  | "WaterTurbulence"
  | "TideDataPoint"
  | "TideGauge"
  | "Ford"
  | "Lock"
  | "OilGasRig"
  | "PilePost"
  | "LimitsVisualObservation"
  | "LimitsUndercast"
  | "LimitsRadarObservation"
  | "ObservedIceEdge"
  | "EstimatedIceEdge"
  | "IceEdgeFromRadar"
  | "IceCracks"
  | "IceCracksSpecific"
  | "IceLead"
  | "IceFrozenLead"
  | "DepthCurve"
  | "DepthContour"
  | "DepthArea"
  | "Coastline"
  | "Island"
  | "Beach"
  | "Water"
  | "ForeshoreLine"
  | "ForeshoreArea"
  | "AnchorageLine"
  | "AnchorageArea"
  | "PierWharfQuay"
  | "FishTrapsArea"
  | "Drydock"
  | "OffshoreLoadingLine"
  | "OffshoreLoadingArea"
  | "RampAboveWater"
  | "RampBelowWater"
  | "BreakwaterAboveWater"
  | "BreakwaterBelowWater"
  | "Seawall"
  | "PerchesStakesArea"
  | "LeadingLine"
  | "UnderwaterDanger"
  | "FoulGroundArea"
  | "KelpArea"
  | "Breakers"
  | "Reef"
  | "DiscoloredWater"
  | "CurrentFlowEbb"
  | "CurrentFlowFlood"
  | "VdrLevel1to2"
  | "VdrLevel2to3"
  | "VdrLevel3to4"
  | "VdrLevel4to5"
  | "VdrLevel5to6"
  | "VdrLevel6to7"
  | "VdrLevel7to8"
  | "VdrLevel8to9"
  | "VdrLevel9to10"
  | "BeachSlopeFlat"
  | "BeachSlopeGentle"
  | "BeachSlopeModerate"
  | "BeachSlopeSteep"
  | "MiwSolidRock"
  | "MiwClay"
  | "MiwVeryCoarseSand"
  | "MiwCoarseSand"
  | "MiwMediumSand"
  | "MiwFineSand"
  | "MiwVeryFineSand"
  | "MiwVeryFineSilt"
  | "MiwFineSilt"
  | "MiwMediumSilt"
  | "MiwCoarseSilt"
  | "MiwBoulders"
  | "MiwCobblesOysterShells"
  | "MiwPebblesShells"
  | "MiwSandAndShells"
  | "MiwLand"
  | "MiwNoData"
  | "MiwRoughnessSmooth"
  | "MiwRoughnessModerate"
  | "MiwRoughnessRough"
  | "MiwClutterLow"
  | "MiwClutterMedium"
  | "MiwClutterHigh"
  | "MiwImpactBurial0"
  | "MiwImpactBurial0to10"
  | "MiwImpactBurial10to20"
  | "MiwImpactBurial20to75"
  | "MiwImpactBurialOver75"
  | "MiwCategoryA"
  | "MiwCategoryB"
  | "MiwCategoryC"
  | "MiwTypeA1"
  | "MiwTypeA2"
  | "MiwTypeA3"
  | "MiwTypeB1"
  | "MiwTypeB2"
  | "MiwTypeB3"
  | "MiwTypeC1"
  | "MiwTypeC2"
  | "MiwTypeC3"
  | "MaritimeLimitBoundary"
  | "MaritimeArea"
  | "RestrictedArea"
  | "SweptArea"
  | "TrainingArea"
  | "OperatorDefinedMaritimeArea"
  | "SubmarineCable"
  | "SubmergedCrib"
  | "Canal"
  | "OilGasRigField"
  | "Pipeline"
  | "S412WindWarningNearGale"
  | "S412WindWarningGale"
  | "S412WindWarningStorm"
  | "S412WindWarningHurricane"
  | "S412WaveWarning2To4m"
  | "S412WaveWarning4To6m"
  | "S412WaveWarning6To9m"
  | "S412WaveWarning9To14m"
  | "S412WaveWarningOver14m"
  | "S412IceAccretionModerate"
  | "S412IceAccretionSevere"
  | "S412RestrictedVisibility"
  | "S412Thunderstorm"
  | "S411IceFree"
  | "S411OpenWater"
  | "S411VeryOpenDrift"
  | "S411OpenDrift"
  | "S411ClosePack"
  | "S411VeryClosePack"
  | "S411CompactIce"
  | "S411ConcentrationUnknown"
  | "S411StageIceFree"
  | "S411NewIce"
  | "S411Nilas"
  | "S411YoungIce"
  | "S411GreyIce"
  | "S411GreyWhiteIce"
  | "S411FirstYearIce"
  | "S411ThinFirstYearIce"
  | "S411ThinFirstYearStage1"
  | "S411ThinFirstYearStage2"
  | "S411MediumFirstYearIce"
  | "S411ThickFirstYearIce"
  | "S411OldIce"
  | "S411SecondYearIce"
  | "S411MultiYearIce"
  | "S411GlacierIce"
  | "S411StageUnknown"
  | "S411IcebergArea"
  | "S411IceKeel"
  | "S411GroundedHummock"
  | "S411StripsAndPatches"
  | "S411StageOfMelt"
  | "S411IceLeadPoint"
  | "S411IceFracturePoint"
  | "S411IceEdge"
  | "S411LimitOfOpenWater"
  | "S411LimitOfAllKnownIce"
  | "S411IcebergLimit"
  | "S411IceRidgeLine"
  | "S411IceLeadLine"
  | "S411IceFractureLine"
  | "S411IceCrackLine")[];

References

Pixel

Re-exports Pixel

PointerInput

Re-exports PointerInput

ViewAdapter

Re-exports ViewAdapter

Enumerations

Classes

Interfaces

Classes

Interfaces

Classes

Interfaces

Classes

Interfaces

@zaes/metoc/editor ​

@zaes/metoc/editor ​

Classes ​

Interfaces ​

Type Aliases ​

EditMode ​

EditorAction ​

EditorListener ​

Parameters ​

event ​

Returns ​

EditorOverlay ​

HistoryListener ​

Undo and redo ​

Returns ​

MetocEditorChange ​

MetocEditorOptions ​

Variables ​

HANDLE_RADIUS_PX ​

HIT_TOLERANCE_PX ​

INSERT_HANDLE_RADIUS_PX ​

METOC_COLOR_ROLE_NAMES ​

METOC_EDITING ​

METOC_VALUE_FIELDS ​

Functions ​

attachMetocEditor() ​

Parameters ​

host ​

editor ​

Returns ​

editorOverlay() ​

Type Parameters ​

K ​

P ​

Parameters ​

editor ​

resolution ​

Returns ​

getMetocFields() ​

Parameters ​

name ​

Returns ​

stationChoices() ​

Returns ​

cloudCover ​

pressureTendency ​

weather ​

References ​

Pixel ​

PointerInput ​

ViewAdapter ​

@zaes/metoc/editor

@zaes/metoc/editor

Classes

Interfaces

Type Aliases

EditMode

EditorAction

EditorListener

Parameters

event

Returns

EditorOverlay

HistoryListener

Undo and redo

Returns

MetocEditorChange

MetocEditorOptions

Variables

HANDLE_RADIUS_PX

HIT_TOLERANCE_PX

INSERT_HANDLE_RADIUS_PX

METOC_COLOR_ROLE_NAMES

METOC_EDITING

METOC_VALUE_FIELDS

Functions

attachMetocEditor()

Parameters

host

editor

Returns

editorOverlay()

Type Parameters

K

P

Parameters

editor

resolution

Returns

getMetocFields()

Parameters

name

Returns

stationChoices()

Returns

cloudCover

pressureTendency

weather

References

Pixel

PointerInput

ViewAdapter