Variable satelliteConst

Type Declaration

• • (options?: SatelliteOptions): StyleSpecification

  • Parameters

    • Optionaloptions: SatelliteOptions

    Returns StyleSpecification

• ReadonlycolorKeys: readonly (keyof ColorsOptions)[]

  Color key names accepted by osmOverlay.colors.

• Readonlylanguages: (tileJSON: TileJSONSpecification) => string[]

  Return language codes available in a given TileJSON. The overlay is an osm() style, so its labels read the same fields.

• ReadonlyresolveOptions: (options?: SatelliteOptions) => ResolvedSatellite

  Resolve raw SatelliteOptions to a fully validated ResolvedSatellite.

• Readonlyslots: Readonly<
      {
          belowLabels: "slot-below-labels";
          belowRaster: "slot-below-raster";
          belowSymbols: "slot-below-symbols";
      },
  >

  Stable layer IDs for use as MapLibre beforeId.

• get defaults(): ResolvedSatellite

  Fully resolved defaults.

• get layerGroups(): LayerGroupMap

  Maps each group of osmOverlay.layers to the layer IDs it controls in the overlay: osm.layerGroups with only the layers the overlay draws. Groups it drops entirely (land, water, sites, airport, buildings) are absent, and tunnels are missing from roads and transit.rail.

• get textGroups(): LayerGroupMap

  Maps each topic of osmOverlay.text to the text layer IDs its label style sets. The overlay is an osm() style and keeps every text layer, so these are osm's.

• minimizeOptions: (options?: SatelliteOptions) => SatelliteOptions

  The smallest options object that builds the same style. Overlay colours are compared against the overlay's palette — gray unless osmOverlay.theme says otherwise.

• toCode: (options?: SatelliteOptions, codeOptions?: CodeOptions) => string

  A runnable @versatiles/style snippet for these options, minimised first.

• validateOptions: (options?: SatelliteOptions) => ValidationResult<ResolvedSatellite>

  Check options without throwing, reporting every problem at once. See osm.validateOptions.