@versatiles/style
    Preparing search index...

    Variable osmConst

    osm: (options?: OsmOptions) => StyleSpecification & {
        colorKeys: readonly (keyof ColorsOptions)[];
        colors: (palette: Palette) => ResolvedColors;
        languages: (tileJSON: TileJSONSpecification) => string[];
        palettes: readonly Palette[];
        resolveOptions: (options?: OsmOptions) => ResolvedOsm;
        slots: Readonly<
            {
                belowFills: "slot-below-fills";
                belowLabels: "slot-below-labels";
                belowStreets: "slot-below-streets";
                belowSymbols: "slot-below-symbols";
            },
        >;
        supportsLandcover: (tileJSON: TileJSONSpecification) => boolean;
        tileset: {
            build: (
                source: string | TileJSONSpecification,
                urls: SchemaUrls,
            ) => StyleSpecification;
            id: string;
            sourceLayers: string[];
        };
        get defaults(): ResolvedOsm;
        get layerGroups(): LayerGroupMap;
        get textGroups(): LayerGroupMap;
    } & {
        minimizeOptions: (options?: OsmOptions) => OsmOptions;
        toCode: (options?: OsmOptions, codeOptions?: CodeOptions) => string;
        validateOptions: (options?: OsmOptions) => ValidationResult<ResolvedOsm>;
    } = ...

    osm() with the authoring helpers attached.

    They live here rather than on the function object itself so that the browser bundle, whose entry is browser.ts, can leave them out: attached, they are a property of an exported object and nothing can tree-shake them away. Only a tool that stores or emits options needs them; a page that just builds a style does not, and every consumer of the CDN bundle is the latter.

    Type Declaration

    • 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.

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

      The smallest options object that builds the same style: every value equal to its default is dropped, colours compared against the chosen palette. For storing a style in a URL or config.

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

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

      target: 'browser' writes the <script> form for a plain HTML page that loads the CDN bundle, instead of the ES module a bundler would take.

    • validateOptions: (options?: OsmOptions) => ValidationResult<ResolvedOsm>

      Check options without throwing, reporting every problem at once as data rather than as a message to parse. resolveOptions stays the call for a program that cannot proceed: it throws on the first problem.

    Settings
    Member Visibility