@genspectrum/dashboard-components 0.8.4 → 0.9.0

package/dist/{genspectrum-components.d.ts → components.d.ts}

@@ -99,53 +99,6 @@ export declare class App extends LitElement {
     createRenderRoot(): this;
 }
 
-/**
- * A date range option that can be used in the `gs-date-range-selector` component.
- */
-export declare type DateRangeOption = {
-    /** The label of the date range option that will be shown to the user */
-    label: string;
-    /**
-     * The start date of the date range in the format `YYYY-MM-DD`.
-     * If not set, the date range selector will default to the `earliestDate` property.
-     */
-    dateFrom?: string;
-    /**
-     * The end date of the date range in the format `YYYY-MM-DD`.
-     * If not set, the date range selector will default to the current date.
-     */
-    dateTo?: string;
-};
-
-/**
- * Presets for the `gs-date-range-selector` component that can be used as `dateRangeOptions`.
- */
-export declare const dateRangeOptionPresets: {
-    last2Weeks: {
-        label: string;
-        dateFrom: string | undefined;
-    };
-    lastMonth: {
-        label: string;
-        dateFrom: string | undefined;
-    };
-    last2Months: {
-        label: string;
-        dateFrom: string | undefined;
-    };
-    last3Months: {
-        label: string;
-        dateFrom: string | undefined;
-    };
-    last6Months: {
-        label: string;
-        dateFrom: string | undefined;
-    };
-    allTimes: {
-        label: string;
-    };
-};
-
 /**
  * ## Context
  * This component is a group of input fields designed to specify date range filters
@@ -159,7 +112,7 @@ export declare const dateRangeOptionPresets: {
  * Setting a value in either of the date pickers will set the select field to "custom",
  * which represents an arbitrary date range.
  *
- * @fires {CustomEvent<{ `${dateColumn}From`: string; `${dateColumn}To`: string; }>} gs-date-range-changed
+ * @fires {CustomEvent<{ `${dateColumn}From`: string; `${dateColumn}To`: string; }>} gs-date-range-filter-changed
  * Fired when:
  * - The select field is changed,
  * - A date is selected in either of the date pickers,
@@ -174,6 +127,18 @@ export declare const dateRangeOptionPresets: {
  * }
  *  ```
  *  will be fired.
+ *
+ *  Use this event, when you want to use the filter directly as a LAPIS filter.
+ *
+ *
+ * @fires {CustomEvent<{ string | {dateFrom: string, dateTo: string}}>} gs-date-range-option-changed
+ * Fired when:
+ * - The select field is changed,
+ * - A date is selected in either of the date pickers,
+ * - A date was typed into either of the date input fields, and the input field loses focus ("on blur").
+ * Contains the selected dateRangeOption or when users select custom values it contains the selected dates.
+ *
+ * Use this event, when you want to control this component in your JS application.
  */
 export declare class DateRangeSelectorComponent extends PreactLitAdapter {
     /**
@@ -1094,7 +1059,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-number-sequences-over-time': NumberSequencesOverTimeComponent;
+        'gs-aggregate-component': AggregateComponent;
     }
 }
 
@@ -1102,7 +1067,7 @@ declare global {
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            'gs-number-sequences-over-time': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+            'gs-aggregate-component': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
         }
     }
 }
@@ -1110,7 +1075,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-aggregate-component': AggregateComponent;
+        'gs-number-sequences-over-time': NumberSequencesOverTimeComponent;
     }
 }
 
@@ -1118,7 +1083,7 @@ declare global {
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            'gs-aggregate-component': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+            'gs-number-sequences-over-time': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
         }
     }
 }
@@ -1145,7 +1110,8 @@ declare global {
         'gs-date-range-selector': DateRangeSelectorComponent;
     }
     interface HTMLElementEventMap {
-        'gs-date-range-changed': CustomEvent<Record<string, string>>;
+        'gs-date-range-filter-changed': CustomEvent<Record<string, string>>;
+        'gs-date-range-option-changed': DateRangeOptionChangedEvent;
     }
 }
 
@@ -1199,10 +1165,10 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-lineage-filter': LineageFilterComponent;
+        'gs-mutation-filter': MutationFilterComponent;
     }
     interface HTMLElementEventMap {
-        'gs-lineage-filter-changed': CustomEvent<Record<string, string>>;
+        'gs-mutation-filter-changed': CustomEvent<SelectedMutationFilterStrings>;
     }
 }
 
@@ -1210,7 +1176,7 @@ declare global {
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            'gs-lineage-filter': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+            'gs-mutation-filter': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
         }
     }
 }
@@ -1218,10 +1184,10 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-mutation-filter': MutationFilterComponent;
+        'gs-lineage-filter': LineageFilterComponent;
     }
     interface HTMLElementEventMap {
-        'gs-mutation-filter-changed': CustomEvent<SelectedMutationFilterStrings>;
+        'gs-lineage-filter-changed': CustomEvent<Record<string, string>>;
     }
 }
 
@@ -1229,7 +1195,7 @@ declare global {
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            'gs-mutation-filter': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+            'gs-lineage-filter': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
         }
     }
 }