@genspectrum/dashboard-components 0.19.2 → 0.19.4

package/dist/components.d.ts

@@ -233,6 +233,36 @@ declare class ErrorEvent_2 extends Event {
 }
 export { ErrorEvent_2 as ErrorEvent }
 
+/**
+ * ## Context
+ *
+ * This component shows the Coding Sequence (CDS) of a genome using a gff3 file as input.
+ * The CDS shows which parts of the genome are translated into proteins.
+ *
+ */
+export declare class GenomeDataViewerComponent extends PreactLitAdapter {
+    /**
+     * Required
+     *
+     * The source of the gff3 file. Any spec-compliant gff3 should be accepted, however we use the same format as Nextclade.
+     * See https://docs.nextstrain.org/projects/nextclade/en/stable/user/input-files/03-genome-annotation.html for more information.
+     * We only use the CDS and gene features from the gff3 file, if you have other features in the gff3 file they will be ignored.
+     * Also note that if a CDS has a gene feature as a parent, the gene feature will be ignored.
+     */
+    gff3Source: string;
+    /**
+     * The length of the genome, if this is not given it will be computed from the `sequence-region` line of the start of the gff3 file.
+     */
+    genomeLength: number | undefined;
+    /**
+     * The width of the component.
+     *
+     * Visit https://genspectrum.github.io/dashboard-components/?path=/docs/concepts-size-of-components--docs for more information.
+     */
+    width: string;
+    render(): JSX_2.Element;
+}
+
 /**
  *
  * ## Context
@@ -722,6 +752,103 @@ export declare class MutationsOverTimeComponent extends PreactLitAdapterWithGrid
     render(): JSX_2.Element;
 }
 
+/**
+ *
+ * ## Context
+ *
+ * This component lets the user specify filters for a `float` or `int` field in LAPIS.
+ * It consists of two text input fields and a slider.
+ *
+ * The slider must be restricted to a certain range.
+ * Users can however still enter values outside of this range in the text input fields.
+ *
+ * @fires {CustomEvent<Record<string, string | undefined>>} gs-number-range-filter-changed
+ * Fired when the slider is released,
+ * `onBlur` on the input fields after the user has typed a valid range in the input fields,
+ * or when one of the input fields is cleared.
+ * The `details` of this event contain an object with `${lapisField}From` and `${lapisField}To` as keys.
+ * The values are the numbers from the input fields or `undefined` if the input field is empty:
+ * ```
+ * {
+ *     [`${lapisField}From`]: number | undefined
+ *     [`${lapisField}To`]: number | undefined
+ * }
+ * ```
+ * Example:
+ * ```
+ * {
+ *     ageFrom: 18,
+ *     ageTo: undefined
+ * }
+ * ```
+ *
+ * @fires {CustomEvent<Record<string, string | undefined>>} gs-number-range-value-changed
+ * Similar to the `gs-number-range-filter-changed` event,
+ * but contains an `event.detail` that has a fixed format:
+ * ```
+ * {
+ *     min: number | undefined
+ *     max: number | undefined
+ * }
+ * ```
+ * This event should be used when you want to control this component externally.
+ * The `event.detail` can be used as the value of the component.
+ * Example:
+ * ```
+ * {
+ *     min: 18,
+ *     max: undefined
+ * }
+ * ```
+ */
+export declare class NumberRangeFilterComponent extends PreactLitAdapter {
+    /**
+     * The value to use for this number filter.
+     *
+     * Must be of the form:
+     * ```
+     * {
+     *     [`${lapisField}From`]: number | undefined
+     *     [`${lapisField}To`]: number | undefined
+     * }
+     * ```
+     *
+     * This is the same format that the `gs-number-value-changed` event will emit.
+     */
+    value: {
+        min?: number;
+        max?: number;
+    };
+    /**
+     * Required.
+     *
+     * The LAPIS field name to use for this text filter.
+     * The field must exist on this LAPIS instance.
+     */
+    lapisField: string;
+    /**
+     * The `min` value to use for the slider.
+     */
+    sliderMin: number;
+    /**
+     * The `max` value to use for the slider.
+     */
+    sliderMax: number;
+    /**
+     * The `step` value to use for the slider.
+     *
+     * This attribute has no effect on the text input.
+     */
+    sliderStep: number;
+    /**
+     * The width of the component.
+     *
+     * Visit https://genspectrum.github.io/dashboard-components/?path=/docs/concepts-size-of-components--docs for more information.
+     */
+    width: string;
+    render(): JSX_2.Element;
+}
+
 /**
  * ## Context
  *
@@ -1402,7 +1529,7 @@ export { }
 
 declare global {
     interface HTMLElementEventMap {
-        'gs-error': ErrorEvent;
+        [gsEventNames.error]: ErrorEvent;
     }
 }
 
@@ -1423,6 +1550,22 @@ declare global {
 }
 
 
+declare global {
+    interface HTMLElementTagNameMap {
+        'gs-genome-data-viewer': GenomeDataViewerComponent;
+    }
+}
+
+
+declare global {
+    namespace JSX {
+        interface IntrinsicElements {
+            'gs-genome-data-viewer': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+        }
+    }
+}
+
+
 declare global {
     interface HTMLElementTagNameMap {
         'gs-mutation-comparison-component': MutationComparisonComponent;
@@ -1553,7 +1696,11 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-statistics': StatisticsComponent;
+        'gs-date-range-filter': DateRangeFilterComponent;
+    }
+    interface HTMLElementEventMap {
+        [gsEventNames.dateRangeFilterChanged]: CustomEvent<Record<string, string>>;
+        [gsEventNames.dateRangeOptionChanged]: DateRangeOptionChangedEvent;
     }
 }
 
@@ -1561,7 +1708,7 @@ declare global {
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            'gs-statistics': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+            'gs-date-range-filter': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
         }
     }
 }
@@ -1569,7 +1716,10 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-wastewater-mutations-over-time': WastewaterMutationsOverTimeComponent;
+        'gs-location-filter': LocationFilterComponent;
+    }
+    interface HTMLElementEventMap {
+        [gsEventNames.locationChanged]: LocationChangedEvent;
     }
 }
 
@@ -1577,7 +1727,7 @@ declare global {
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            'gs-wastewater-mutations-over-time': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+            'gs-location-filter': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
         }
     }
 }
@@ -1585,10 +1735,7 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-location-filter': LocationFilterComponent;
-    }
-    interface HTMLElementEventMap {
-        'gs-location-changed': LocationChangedEvent;
+        'gs-statistics': StatisticsComponent;
     }
 }
 
@@ -1596,7 +1743,7 @@ declare global {
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            'gs-location-filter': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+            'gs-statistics': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
         }
     }
 }
@@ -1604,11 +1751,10 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-date-range-filter': DateRangeFilterComponent;
+        'gs-text-filter': TextFilterComponent;
     }
     interface HTMLElementEventMap {
-        'gs-date-range-filter-changed': CustomEvent<Record<string, string>>;
-        'gs-date-range-option-changed': DateRangeOptionChangedEvent;
+        [gsEventNames.textFilterChanged]: TextFilterChangedEvent;
     }
 }
 
@@ -1616,7 +1762,7 @@ declare global {
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            'gs-date-range-filter': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+            'gs-text-filter': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
         }
     }
 }
@@ -1624,10 +1770,10 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-text-filter': TextFilterComponent;
+        'gs-lineage-filter': LineageFilterComponent;
     }
     interface HTMLElementEventMap {
-        'gs-text-filter-changed': TextFilterChangedEvent;
+        [gsEventNames.lineageFilterChanged]: LineageFilterChangedEvent;
     }
 }
 
@@ -1635,7 +1781,7 @@ declare global {
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            'gs-text-filter': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+            'gs-lineage-filter': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
         }
     }
 }
@@ -1646,7 +1792,7 @@ declare global {
         'gs-mutation-filter': MutationFilterComponent;
     }
     interface HTMLElementEventMap {
-        'gs-mutation-filter-changed': CustomEvent<MutationsFilter>;
+        [gsEventNames.mutationFilterChanged]: CustomEvent<MutationsFilter>;
     }
 }
 
@@ -1662,10 +1808,11 @@ declare global {
 
 declare global {
     interface HTMLElementTagNameMap {
-        'gs-lineage-filter': LineageFilterComponent;
+        'gs-number-range-filter': NumberRangeFilterComponent;
     }
     interface HTMLElementEventMap {
-        'gs-lineage-filter-changed': LineageFilterChangedEvent;
+        [gsEventNames.numberRangeFilterChanged]: NumberRangeFilterChangedEvent;
+        [gsEventNames.numberRangeValueChanged]: NumberRangeValueChangedEvent;
     }
 }
 
@@ -1673,7 +1820,23 @@ declare global {
 declare global {
     namespace JSX {
         interface IntrinsicElements {
-            'gs-lineage-filter': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+            'gs-number-range-filter': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
+        }
+    }
+}
+
+
+declare global {
+    interface HTMLElementTagNameMap {
+        'gs-wastewater-mutations-over-time': WastewaterMutationsOverTimeComponent;
+    }
+}
+
+
+declare global {
+    namespace JSX {
+        interface IntrinsicElements {
+            'gs-wastewater-mutations-over-time': DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>;
         }
     }
 }