clone

an offline map explorer where each world, from a game map to a city's open data, ships as one .atlas file

feat/atlas-next-horizon
atlas / analysis / semconv / keys.ts
keys.ts 4.5K
1// Code generated by spec/gen from spec/registry.yaml. DO NOT EDIT.2//3// The published attribute vocabulary, as the TypeScript lanes speak it4// (issue #5 §3.2: analysis/ depends on its own math and the published5// attribute vocabulary; render/ depends on analysis/ and published6// contracts). These are the keys and nothing else -- no checker, no7// validation, no reader. A lane that wants to know what a key means8// reads docs/semconv/REGISTRY.md, which is cut from the same spec.910/** The namespace every governed key carries. */11export const NAMESPACE = "atlas.";1213/** The conventions version a bundle declares in its manifest. */14export const CONVENTIONS_VERSION = 2;1516/**17 * `collection`, stable. What shape of thing the collection holds. Declared18 * once per collection; every feature in it is that kind, and readers pick19 * rendering and UX by this key instead of sniffing geometry types.20 */21export const KEY_GEOMETRY_KIND = "atlas.geometry.kind";2223/**24 * `collection`, experimental. Whether an area collection's features wear25 * their names on the map always, or quietly — only on highlight, selection,26 * or an explicit reveal. Area collections only; absent means `always` for27 * areas, and paths are always quiet.28 */29export const KEY_LABEL_POLICY = "atlas.label.policy";3031/**32 * `collection`, stable. How a point collection's features draw: markers, or33 * floating text labels. Absent means `pin`; no payload carries a34 * display-type field, and only ingestion still reads one to speak this key35 * for old captures.36 */37export const KEY_RENDER_AS = "atlas.render.as";3839/**40 * `collection`, stable. Standard-library icon for a collection without41 * artwork. Resolved to embedded bytes at build time; a reader only sees the42 * resolved asset.43 */44export const KEY_ICON_STD = "atlas.icon.std";4546/**47 * `collection`, stable. Whether the icon asset is a monochrome glyph the48 * reader tints, or a picture drawn as-is. Names what a file suffix used to49 * imply.50 */51export const KEY_ICON_KIND = "atlas.icon.kind";5253/**54 * `world`, stable. The rim a world's markers wear to stay legible against55 * its art.56 */57export const KEY_ICON_OUTSET = "atlas.icon.outset";5859/** `world`, stable. What the raster pictures. Absent means `plane`. */60export const KEY_GEOMETRY_SURFACE = "atlas.geometry.surface";6162/**63 * `world`, stable. How a sphere was flattened. Required when surface is64 * `sphere`.65 */66export const KEY_GEOMETRY_PROJECTION = "atlas.geometry.projection";6768/** `world`, stable. The raster window the projection fills. */69export const KEY_GEOMETRY_EQUIRECT_PX = "atlas.geometry.equirect.px";7071/** `world`, stable. The ground that window pictures. */72export const KEY_GEOMETRY_EQUIRECT_DEG = "atlas.geometry.equirect.deg";7374/**75 * `world`, experimental. The raster window a Web-Mercator cut fills. Where76 * `equirect` declares y linear in degrees, `mercator` declares y linear in77 * projected latitude — `asinh(tan lat)` — the flattening a real-world tile78 * window actually is.79 */80export const KEY_GEOMETRY_MERCATOR_PX = "atlas.geometry.mercator.px";8182/**83 * `world`, experimental. The ground the Mercator window pictures, in degrees84 * at its edges.85 */86export const KEY_GEOMETRY_MERCATOR_DEG = "atlas.geometry.mercator.deg";8788/** `world`, experimental. The body pictured. */89export const KEY_GEOMETRY_BODY = "atlas.geometry.body";9091/** `world`, experimental. The body's mean radius. */92export const KEY_GEOMETRY_RADIUS_KM = "atlas.geometry.radius_km";9394/**95 * `feature`, experimental. True planetary latitude as published96 * (planetocentric). Provenance and card material; rendering derives from the97 * world-level mapping.98 */99export const KEY_GEO_LAT = "atlas.geo.lat";100101/**102 * `feature`, experimental. True planetary longitude as published103 * (east-positive).104 */105export const KEY_GEO_LON = "atlas.geo.lon";106107/**108 * `feature`, experimental. The USGS twelve-digit hydrologic unit — the109 * subwatershed — the feature's ground lies wholly within, from the national110 * Watershed Boundary Dataset. A feature spanning subwatersheds carries no111 * key rather than a misleading one.112 */113export const KEY_HYDRO_HUC12 = "atlas.hydro.huc12";114115/**116 * `collection`, experimental. The ground width of a path collection's117 * features: a trail is a line and a weight, and the weight lets a reader118 * draw the path as one continuous stroke.119 */120export const KEY_STROKE_WIDTH_PX = "atlas.stroke.width_px";121122/**123 * `collection`, experimental. A collection's merge identity across sources.124 * Absent, the icon key stands in.125 */126export const KEY_COLLECTION_KEY = "atlas.collection.key";