Skip to content

API reference

Top-level exports of @yodolabs/plateau-r3f:

groupexports
Components<Plateau>, <HazardLayer>, <FootprintLayer>, <FallbackExtrusionLayer>, <TileDebugLayer>, <FloodLayer> <InlandFloodLayer> <TsunamiLayer> <StormSurgeLayer> <LandslideLayer>
HooksuseBuilding, useBuildings, usePlateauContext, usePlateauContextOptional
RuntimecreatePlateauRuntime, defaultResolver, loadArtifacts
StylecompileColorBy, compileRamp, parseColor, buildTileColorTexture, createStyleTable, createStyleTableCache, createWorkerStyleDecoder
HazardsregisterHazardLayer, getHazardLayer, listHazardLayers, compileHazardLayer, HAZARD_FIELD_SPECS, ALL_HAZARD_TYPES
FallbackdecideFallback, FallbackExtrusionLayer
LifecyclecanTransition
ShaderPLATEAU_FEATURE_ID_ATTRIBUTE, types ShaderExtension, ShaderLike
Storeselectors.* (selectStatus, selectIsReady, selectVisibleTileUris, selectEnabledLayerIds, selectWarnings, ...)
TypesPlateauProps, HazardLayerProps, FootprintLayerProps, BuildingAttributes, BuildingKey, BuildingFilter, BuildingSource, ColorBy, ColorRamp, ColorRampColorBy, BuiltinColorBy, HazardType, HazardCoverageConfidence, FallbackPolicy, FallbackMode, TileLifecycleState, TileRuntimeHandle, TileColorTexture, Manifest, TileIndex, Attribution, PlateauStoreState, Rgba8

Drill down via the sidebar.

MIT License. PLATEAU data © Project PLATEAU / MLIT — CC BY 4.0.