@smplrspace/smplr-loader 2.24.1-beta.1 → 2.25.0

package/dist/generated/smplr.d.ts

@@ -27,6 +27,7 @@ declare interface BaseDataLayer<T, D extends UnknownData> {
     onClick?: (dataElement: T & D, event: PointerEvent) => void;
     onHover?: (dataElement: T & D, event: LimitedPointerEvent) => void;
     onHoverOut?: (dataElement: T & D, event: LimitedPointerEvent) => void;
+    legend?: LegendConfig;
 }
 
 declare type CameraMode = '2d' | '3d'
@@ -38,6 +39,14 @@ declare interface CategoryScaleOptions<C extends string> {
     nodata?: string;
 }
 
+declare const categorySwatches: <C extends string>({ categories, nodata, excludeNoData, noDataLabel, }: CategoryScaleOptions<C> & {
+    excludeNoData?: boolean | undefined;
+    noDataLabel?: string | undefined;
+}) => {
+    color: string;
+    label: string;
+}[];
+
 declare interface ClientOptions {
     organizationId: string;
     clientToken: string;
@@ -47,16 +56,33 @@ declare namespace Color {
     export {
         drawLegend,
         Legend,
+        cssToSmplrColor,
+        smplrToCssColor,
         NumericScale,
         numericScale,
         categoryScale,
+        categorySwatches,
         ragScale,
-        cssToSmplrColor,
-        smplrToCssColor
+        ragSwatches
     }
 }
 export { Color }
 
+declare interface ColorSwatches extends Pick<ColorSwatchesProps, 'swatches'> {
+    type: 'swatches';
+}
+
+declare interface ColorSwatchesProps {
+    swatches: {
+        color: string;
+        label: string;
+        group?: string;
+    }[];
+    size?: number;
+    correctColor?: boolean;
+    noLabels?: boolean;
+}
+
 declare const cssToSmplrColor: (c: string) => string;
 
 declare interface CubeOptions<D> {
@@ -305,8 +331,24 @@ declare interface IconDataLayer<D extends UnknownData = NoData> extends BaseData
     disableElevationCorrection?: boolean;
 }
 
+declare interface IconLegend extends Pick<IconsSwatchesProps, 'icons'> {
+    type: 'icons';
+}
+
+declare interface IconsSwatchesProps {
+    icons: {
+        url: string;
+        label: string;
+        group?: string;
+    }[];
+    height?: number;
+    noLabels?: boolean;
+}
+
 declare const Legend: FC<LegendProps>;
 
+declare type LegendConfig = NumericLegend | ColorSwatches | IconLegend;
+
 declare interface LegendProps {
     colorScale: (n: number | null | undefined) => string;
     domain?: [number, number];
@@ -391,6 +433,10 @@ declare type NoData = Record<string, never>;
 declare interface NonInteractiveDataLayer<T, D extends UnknownData> {
 }
 
+declare interface NumericLegend extends Pick<LegendProps, 'colorScale' | 'domain' | 'ticks'> {
+    type: 'numeric';
+}
+
 declare enum NumericScale {
     OrRd = "OrRd",
     PuBu = "PuBu",
@@ -743,6 +789,14 @@ declare interface RAGScaleOptions<C extends string> {
     nodata?: string;
 }
 
+declare const ragSwatches: <C extends string>({ categories, colors, nodata, excludeNoData, noDataLabel, }: RAGScaleOptions<C> & {
+    excludeNoData?: boolean | undefined;
+    noDataLabel?: string | undefined;
+}) => {
+    color: string;
+    label: string;
+}[];
+
 declare interface RenderOptions {
     compass?: boolean
     annotations?: boolean
@@ -914,7 +968,7 @@ declare interface Vector3Coord extends Vector2Coord {
     z: number;
 }
 
-export declare const version = "2.24.1-beta.1";
+export declare const version = "2.25.0";
 
 declare interface ViewerOptions {
     mode?: CameraMode;
@@ -926,6 +980,7 @@ declare interface ViewerOptions {
     autoRotate?: boolean;
     hideNavigationButtons?: boolean;
     hideLevelPicker?: boolean;
+    legendPosition?: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
     compass?: boolean;
     annotations?: boolean;
     renderOptions?: RenderOptions;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smplrspace/smplr-loader",
-  "version": "2.24.1-beta.1",
+  "version": "2.25.0",
   "description": "NPM package to load a typed Smplr.js from CDN easily",
   "type": "module",
   "files": [