@cfasim-ui/charts 0.7.5 → 0.7.7

package/dist/tooltip-position.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/us-cities/data.d.ts

@@ -0,0 +1,2 @@
+import { UsCity } from './index.js';
+export declare const usCities: UsCity[];

package/dist/us-cities/index.d.ts

@@ -0,0 +1,51 @@
+import { CityMarker } from '../ChoroplethMap/cityLayout.js';
+import { usCities } from './data.js';
+/**
+ * A US city record from the bundled Natural Earth dataset. `population` is an
+ * approximate estimate used only for ranking; it is never displayed.
+ */
+export interface UsCity {
+    /** City name, e.g. `"Austin"`. */
+    name: string;
+    /** `[longitude, latitude]`. */
+    coordinates: [number, number];
+    /** Approximate population (Natural Earth `POP_MAX`), used for ranking. */
+    population: number;
+    /** 2-digit state FIPS code, e.g. `"48"` for Texas. */
+    stateFips: string;
+    /** 2-letter USPS abbreviation, e.g. `"TX"`. */
+    stateAbbr: string;
+    /** True for a state capital (or the national capital). */
+    capital: boolean;
+    /** True only for Washington, DC. */
+    nationalCapital: boolean;
+}
+export { usCities };
+/** Options shared by the marker selectors. */
+export interface CityMarkerOptions {
+    /** Maximum number of non-capital cities to include. */
+    limit?: number;
+    /**
+     * Assign a per-city `minZoom` by population rank (default `true`) so cities
+     * reveal progressively as you zoom in. Set `false` for a flat layer where
+     * every city shares the map's `citiesMinZoom`.
+     */
+    tiered?: boolean;
+}
+/**
+ * Markers for the national map: Washington, DC (starred) plus the `limit`
+ * most-populous US cities as plain dots — state capitals are *not* starred at
+ * the national level, only DC is. Pass directly to `<ChoroplethMap :cities>`.
+ *
+ * By default (`tiered`) each city also gets a `minZoom` by population rank, so
+ * on a zoomable map the biggest cities show first and more reveal as you zoom
+ * in (the capital always shows). Pass `{ tiered: false }` for a flat layer.
+ */
+export declare function nationalCityMarkers(options?: CityMarkerOptions): CityMarker[];
+/**
+ * Markers for a single-state map: that state's capital (starred) plus its
+ * most-populous cities, capital first. `stateFips` is the 2-digit FIPS code.
+ * Tiered by population like `nationalCityMarkers` (the capital always shows);
+ * pass `{ tiered: false }` to opt out.
+ */
+export declare function stateCityMarkers(stateFips: string, options?: CityMarkerOptions): CityMarker[];

package/dist/us-cities/us-cities.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/us-cities.d.ts

@@ -0,0 +1 @@
+export { usCities, nationalCityMarkers, stateCityMarkers, type UsCity, type CityMarkerOptions, } from './us-cities/index.js';