Variable osmConst

Type Declaration

• • (options?: OsmOptions): StyleSpecification

  • Parameters

    • Optionaloptions: OsmOptions

    Returns StyleSpecification

• ReadonlycolorKeys: readonly (keyof ColorsOptions)[]

  All color key names accepted by ColorsOptions.

• Readonlycolors: (palette: Palette) => ResolvedColors

  Return a palette's resolved colors.

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

  Return the language codes available in a given TileJSON.

• Readonlypalettes: readonly Palette[]

  All available palette names: five light themes, each followed by its -dark theme.

• ReadonlyresolveOptions: (options?: OsmOptions) => ResolvedOsm

  Resolve raw OsmOptions to a fully validated ResolvedOsm.

• Readonlyslots: Readonly<
      {
          belowFills: "slot-below-fills";
          belowLabels: "slot-below-labels";
          belowStreets: "slot-below-streets";
          belowSymbols: "slot-below-symbols";
      },
  >

  Stable layer IDs for use as MapLibre beforeId.

• supportsLandcover: (tileJSON: TileJSONSpecification) => boolean

  Whether a tileset can back features.landcover: its land layer starts below the zoom where plain Shortbread's first land kind appears, so it carries the low-zoom landcover extension.

• Readonlytileset: {
      build: (
          source: string | TileJSONSpecification,
          urls: SchemaUrls,
      ) => StyleSpecification;
      id: string;
      sourceLayers: string[];
  }

  How guessStyle recognises a Shortbread tileset and builds a style for it.

• get defaults(): ResolvedOsm

  Fully resolved defaults (theme: 'colorful').

• get layerGroups(): LayerGroupMap

  Maps each LayerGroupOptions key to the layer IDs it controls.

• get textGroups(): LayerGroupMap

  Maps each topic of text (water.rivers, pois.transit, …) to the text layer IDs its label style sets. Built from the same group tags as layerGroups.