@maplibre-yaml/core
Declarative web maps with YAML configuration: the schemas, parser,
renderer, interactions, and data layer behind <ml-map>.
The <ml-map> element itself lives in @maplibre-yaml/core/components
(or auto-registers via @maplibre-yaml/core/register); the Zod schemas are
also available standalone from @maplibre-yaml/core/schemas.
Classes
Section titled “Classes”- BaseConnection
- ChromeLayout
- ConfigResolutionError
- ControlsManager
- DataFetcher
- DataMerger
- EmitError
- EventEmitter
- ExportClassRegistry
- ExtensionRegistry
- InteractionRegistry
- LayerManager
- LegendBuilder
- LoadingManager
- MapRenderer
- MarkersManager
- MaxRetriesExceededError
- MemoryCache
- ParamsBuilder
- PollingManager
- PopupBuilder
- RetryManager
- SSEConnection
- StreamManager
- WebSocketConnection
- YAMLParser
Interfaces
Section titled “Interfaces”- AttachInteractionsOptions
- CacheConfig
- CacheEntry
- CacheStats
- CameraModel
- CapabilityPolicy
- ChromeMount
- ConnectionConfig
- ConnectionEvents
- EffectBlock
- EffectIssue
- EffectLayerRef
- EffectLowering
- EffectsAttachment
- EffectsHost
- EmitAsset
- EmitImageRef
- EmitResult
- EmitWarning
- EventHandlerCallbacks
- ExpandResult
- ExportClassDefinition
- ExportContext
- ExportLowering
- ExtensionBlock
- ExtensionDefinition
- ExtensionWarning
- ExtractResult
- FetcherConfig
- FetchOptions
- FetchResult
- FitToLowering
- HatchTileOptions
- HtmlMarker
- Interaction
- InteractionContext
- InteractionDenial
- InteractionDeps
- InteractionRuntime
- InteractionsHandle
- InteractionsProjection
- LayerManagerCallbacks
- LayerModel
- LayerPlacement
- LoadingConfig
- LoadingEvents
- LoadingState
- LoweredFitTo
- LoweredMarkers
- MapModel
- MapRendererEvents
- MapRendererOptions
- MarkersLowering
- MarkersManagerCallbacks
- MergeOptions
- MergeResult
- ParameterMeta
- ParamsPanelCallbacks
- ParamsPanelConfig
- ParseError
- ParseResult
- PinOptions
- PollingConfig
- PollingState
- ProjectedLayerInteractions
- RetryCallbacks
- RetryConfig
- RuntimeHalf
- ShowPopupOptions
- SourceModel
- SpriteIndexEntry
- SpriteLayoutItem
- SpriteSheetLayout
- SSEConfig
- StreamConfig
- StreamState
- StyleHalf
- SugarError
- ToggleableLayer
- V1MapInput
- WebSocketConfig
Type Aliases
Section titled “Type Aliases”- BasemapFetcher
- Block
- Bounds
- Chapter
- ChapterAction
- ChapterLayers
- ChromeCorner
- ClickConfig
- ConnectionState
- ControlPosition
- ControlsConfig
- EmitConfig
- EmitMode
- EmitPayload
- EmitWarningKind
- EventHandler
- ExportClass
- FitToConfig
- FlyToConfig
- GlobalConfig
- ImageConfig
- ImagesConfig
- InteractionHostHandlers
- InteractiveConfig
- LegendConfig
- LightConfig
- MapBlock
- MapBlockV2
- MapConfig
- MapFullPageBlock
- MarkerConfig
- MergeStrategy
- MixedBlock
- Page
- Parameters
- ParseErrorCode
- PopupContent
- ProjectedInteractiveConfig
- ProjectionConfig
- RootConfig
- SafeParseAnyResult
- ScrollytellingBlock
- SkyConfig
- StandalonePopupConfig
- State
- SugarKey
- TerrainConfig
- TrustContext
- ZoomToFeatureConfig
Variables
Section titled “Variables”- BackgroundLayerSchema
- BaseLayerPropertiesSchema
- BBoxSchema
- BlockSchema
- ChapterActionSchema
- ChapterLayersSchema
- ChapterSchema
- CHROME_CORNERS
- CircleLayerSchema
- CLICK_INTERACTIONS
- COLOR_RELIEF_RUNTIME_FLOOR
- ColorOrExpressionSchema
- ColorReliefLayerSchema
- ColorSchema
- ContentBlockSchema
- ContentElementSchema
- ContentItemSchema
- ControlPositionSchema
- ControlsConfigSchema
- DEFAULT_PIN_COLOR
- DEFAULT_PIN_HEIGHT
- DEFAULT_PIN_WIDTH
- DEFAULT_POLICY
- DOCUMENT_SPRITE_ID
- EFFECT_ON_EMIT
- EmitConfigSchema
- EmitPayloadItemSchema
- exportClasses
- ExpressionSchema
- FeatureCollectionSchema
- FeatureSchema
- FillExtrusionLayerSchema
- FillLayerSchema
- FIT_TO_REFERENCE_VIEWPORT
- FitToSchema
- GeoJSONSchema
- GeoJSONSourceSchema
- GeometrySchema
- GlobalConfigSchema
- GLOBE_RUNTIME_FLOOR
- HeatmapLayerSchema
- HillshadeLayerSchema
- HOVER_FEATURE_STATE_KEY
- HOVER_INTERACTIONS
- htmlTag
- ImageConfigSchema
- ImageSourceSchema
- ImagesSchema
- InteractiveConfigSchema
- LatitudeSchema
- LAYER_RUNTIME_KEYS
- LayerOrReferenceSchema
- LayerReferenceSchema
- LayerRuntimeSchema
- LayerSchema
- LayerSourceSchema
- LayerV2Schema
- LegendConfigSchema
- LegendItemSchema
- LightSchema
- LineLayerSchema
- LineStringSchema
- LINK_TARGETS
- LngLatBoundsSchema
- LngLatSchema
- LoadingConfigSchema
- loadingStyles
- LongitudeSchema
- MapBlockSchema
- MapBlockV2Schema
- MapConfigSchema
- MapFullPageBlockSchema
- MARKERS_LAYER_ID
- MARKERS_SOURCE_ID
- MarkerSchema
- MarkersSchema
- MAX_GEOMETRY_COLLECTION_DEPTH
- MixedBlockSchema
- MultiLineStringSchema
- MultiPointSchema
- MultiPolygonSchema
- NumberOrExpressionSchema
- PageSchema
- ParametersSchema
- parseYAMLConfig
- PointSchema
- PolygonSchema
- POPUP_TAGS
- PopupContentItemSchema
- PopupContentSchema
- PopupsSchema
- PositionSchema
- ProjectionSchema
- RasterDEMSourceSchema
- RasterLayerSchema
- RasterSourceSchema
- RootSchema
- RuntimeMapSchema
- RuntimeV2Schema
- safeParseAny
- safeParseYAMLConfig
- ScrollytellingBlockSchema
- SKY_RUNTIME_FLOOR
- SkySchema
- SOURCE_RUNTIME_KEYS
- SourceRuntimeSchema
- SourceV2Schema
- StandalonePopupSchema
- STATE_RUNTIME_FLOOR
- StateSchema
- StreamConfigSchema
- StyleV2Schema
- SUGAR_KEYS
- SymbolLayerSchema
- TERRAIN_RUNTIME_FLOOR
- TerrainSchema
- ValidTagNames
- VectorSourceSchema
- VideoSourceSchema
- YAML_PARSE_OPTIONS
- ZoomLevelSchema
Functions
Section titled “Functions”- allowsHtml
- allowsOrigin
- applyRuntimeGate
- assetName
- attachInteractions
- attachSpriteAssets
- attachSpriteImages
- buildFitToLowering
- buildMarkersLowering
- buildSpriteIndex
- cameraForBounds
- contentHash8
- createInteractionRegistry
- createSimpleMapConfig
- dedupeAssets
- denormalizeConfig
- denormalizeLayers
- denormalizeOptions
- denormalizeSources
- detectSugarKey
- escapeHtml
- expandGeoSugar
- finalizeSpriteBaseUrl
- geojsonBounds
- geometryBounds
- getEffectsHost
- hasPanelContent
- hatchTileSvg
- html
- imageAssetName
- injectLoadingStyles
- isHtmlMarker
- isMapConfigComplete
- isSugarError
- loadDocumentImages
- lowerEffectLayer
- lowerFitTo
- lowerMarkers
- meetsVersion
- mergeBasemap
- normalizeLayer
- normalizeMapBlock
- normalizeSource
- onEffectsHost
- pinSvg
- project
- projectInteractions
- projectStyle
- readV2Block
- registerEffectsHost
- resolveBasemap
- resolveMapBlock
- resolveMapConfig
- safeUrl
- supportsState
- toModel