@nasa-terra/components 0.0.43 → 0.0.44

package/cdn/vscode.html-custom-data.json

@@ -2,23 +2,6 @@
   "$schema": "https://raw.githubusercontent.com/microsoft/vscode-html-languageservice/main/docs/customData.schema.json",
   "version": 1.1,
   "tags": [
-    {
-      "name": "terra-browse-variables",
-      "description": "Browse through the NASA CMR or Giovanni catalogs.\n---\n",
-      "attributes": [
-        {
-          "name": "catalog",
-          "description": "Allows the user to switch the catalog between different providers\nTODO: add support for CMR catalog and make it the default",
-          "values": [{ "name": "giovanni" }]
-        }
-      ],
-      "references": [
-        {
-          "name": "Documentation",
-          "url": "https://disc.gsfc.nasa.gov/components/browse-variables"
-        }
-      ]
-    },
     {
       "name": "terra-button",
       "description": "Buttons represent actions that are available to the user.\n---\n\n\n### **Methods:**\n - **click()** - Simulates a click on the button.\n- **focus(options: _FocusOptions_)** - Sets focus on the button.\n- **blur()** - Removes focus from the button.\n- **checkValidity()** - Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid.\n- **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.\n- **reportValidity()** - Checks for validity and shows the browser's validation message if the control is invalid.\n- **setCustomValidity(message: _string_)** - Sets a custom validation message. Pass an empty string to restore validity.\n\n### **Slots:**\n - _default_ - The button's label.\n- **prefix** - A presentational prefix icon or similar element.\n- **suffix** - A presentational suffix icon or similar element.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **prefix** - The container that wraps the prefix.\n- **label** - The button's label.\n- **suffix** - The container that wraps the suffix.\n- **caret** - The button's caret icon, an `<sl-icon>` element.\n- **spinner** - The spinner that shows when the button is in the loading state.",
@@ -251,6 +234,93 @@
         }
       ]
     },
+    {
+      "name": "terra-browse-variables",
+      "description": "Browse through the NASA CMR or Giovanni catalogs.\n---\n",
+      "attributes": [
+        {
+          "name": "catalog",
+          "description": "Allows the user to switch the catalog between different providers\nTODO: add support for CMR catalog and make it the default",
+          "values": [{ "name": "giovanni" }]
+        }
+      ],
+      "references": [
+        {
+          "name": "Documentation",
+          "url": "https://disc.gsfc.nasa.gov/components/browse-variables"
+        }
+      ]
+    },
+    {
+      "name": "terra-data-rods",
+      "description": "A component for visualizing Hydrology Data Rods time series using the GES DISC Giovanni API\n---\n",
+      "attributes": [
+        {
+          "name": "variable-entry-id",
+          "description": "a variable entry ID (ex: GPM_3IMERGHH_06_precipitationCal)",
+          "values": []
+        },
+        {
+          "name": "collection",
+          "description": "a collection entry id (ex: GPM_3IMERGHH_06)\nonly required if you don't include a variableEntryId",
+          "values": []
+        },
+        {
+          "name": "variable",
+          "description": "a variable short name to plot (ex: precipitationCal)\nonly required if you don't include a variableEntryId",
+          "values": []
+        },
+        {
+          "name": "start-date",
+          "description": "The start date for the time series plot. (ex: 2021-01-01)",
+          "values": []
+        },
+        {
+          "name": "end-date",
+          "description": "The end date for the time series plot. (ex: 2021-01-01)",
+          "values": []
+        },
+        {
+          "name": "location",
+          "description": "The point location in \"lat,lon\" format.",
+          "values": []
+        },
+        {
+          "name": "bearer-token",
+          "description": "The token to be used for authentication with remote servers.\nThe component provides the header \"Authorization: Bearer\" (the request header and authentication scheme).\nThe property's value will be inserted after \"Bearer\" (the authentication scheme).",
+          "values": []
+        }
+      ],
+      "references": [
+        {
+          "name": "Documentation",
+          "url": "https://disc.gsfc.nasa.gov/components/data-rods"
+        }
+      ]
+    },
+    {
+      "name": "terra-date-range-slider",
+      "description": "Short summary of the component's intended use.\n---\n\n\n### **Slots:**\n - _default_ - The default slot.\n- **example** - An example slot.\n\n### **CSS Properties:**\n - **--example** - An example CSS custom property. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
+      "attributes": [
+        { "name": "time-scale", "values": [{ "name": "TimeScale" }] },
+        { "name": "min-date", "values": [] },
+        { "name": "max-date", "values": [] },
+        {
+          "name": "start-date",
+          "description": "The start date for the time series plot.",
+          "values": []
+        },
+        { "name": "end-date", "values": [] },
+        { "name": "disabled", "values": [] },
+        { "name": "has-pips", "values": [] }
+      ],
+      "references": [
+        {
+          "name": "Documentation",
+          "url": "https://disc.gsfc.nasa.gov/components/date-range-slider"
+        }
+      ]
+    },
     {
       "name": "terra-date-picker",
       "description": "A date picker component that supports single date selection or date range selection.\n---\n\n\n### **Slots:**\n - _default_ - The default slot.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **input** - The date input element.",
@@ -321,29 +391,6 @@
         }
       ]
     },
-    {
-      "name": "terra-date-range-slider",
-      "description": "Short summary of the component's intended use.\n---\n\n\n### **Slots:**\n - _default_ - The default slot.\n- **example** - An example slot.\n\n### **CSS Properties:**\n - **--example** - An example CSS custom property. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
-      "attributes": [
-        { "name": "time-scale", "values": [{ "name": "TimeScale" }] },
-        { "name": "min-date", "values": [] },
-        { "name": "max-date", "values": [] },
-        {
-          "name": "start-date",
-          "description": "The start date for the time series plot.",
-          "values": []
-        },
-        { "name": "end-date", "values": [] },
-        { "name": "disabled", "values": [] },
-        { "name": "has-pips", "values": [] }
-      ],
-      "references": [
-        {
-          "name": "Documentation",
-          "url": "https://disc.gsfc.nasa.gov/components/date-range-slider"
-        }
-      ]
-    },
     {
       "name": "terra-icon",
       "description": "Icons are symbols that can be used to represent various options within an application.\n---\n\n\n### **Events:**\n - **terra-load** - Emitted when the icon has loaded.\n- **terra-error** - Emitted when the icon fails to load due to an error.\n\n### **CSS Parts:**\n - **svg** - The internal SVG element.",
@@ -558,11 +605,21 @@
           "description": "spatial picker label",
           "values": []
         },
+        {
+          "name": "spatial-constraints",
+          "description": "Spatial constraints for the map (default: '-180, -90, 180, 90')",
+          "values": []
+        },
         { "name": "is-expanded", "values": [] },
         {
           "name": "inline",
           "description": "Whether the map should be shown inline, or as part of the normal content flow\nthe default is false, the map is positioned absolute under the input",
           "values": []
+        },
+        {
+          "name": "show-map-on-focus",
+          "description": "Whether the map should show automatically when the input is focused",
+          "values": []
         }
       ],
       "references": [
@@ -577,33 +634,18 @@
       "description": "A component for visualizing time series data using the GES DISC Giovanni API.\n---\n\n\n### **Events:**\n - **terra-time-series-data-change** - Emitted whenever time series data has been fetched from Giovanni",
       "attributes": [
         {
-          "name": "collection",
-          "description": "a collection entry id (ex: GPM_3IMERGHH_06)",
-          "values": []
-        },
-        {
-          "name": "collectionLongName",
-          "description": "a collection long name (ex: \"NLDAS Primary Forcing Data L4 Hourly 0.125 x 0.125 degree V2.0 (NLDAS_FORA0125_H) at GES DISC\")",
+          "name": "variable-entry-id",
+          "description": "a variable entry ID (ex: GPM_3IMERGHH_06_precipitationCal)",
           "values": []
         },
         {
-          "name": "datasetLandingPage",
-          "description": "the dataset landing page for the collection",
+          "name": "collection",
+          "description": "a collection entry id (ex: GPM_3IMERGHH_06)\nonly required if you don't include a variableEntryId",
           "values": []
         },
         {
           "name": "variable",
-          "description": "a variable short name to plot (ex: precipitationCal)",
-          "values": []
-        },
-        {
-          "name": "variableLandingPage",
-          "description": "the variable landing page",
-          "values": []
-        },
-        {
-          "name": "variableLongName",
-          "description": "a variable long name to plot (e.g., \"Longwave radiation flux downwards (surface)\")",
+          "description": "a variable short name to plot (ex: precipitationCal)\nonly required if you don't include a variableEntryId",
           "values": []
         },
         {
@@ -621,7 +663,6 @@
           "description": "The point location in \"lat,lon\" format.",
           "values": []
         },
-        { "name": "units", "description": "Units", "values": [] },
         {
           "name": "bearer-token",
           "description": "The token to be used for authentication with remote servers.\nThe component provides the header \"Authorization: Bearer\" (the request header and authentication scheme).\nThe property's value will be inserted after \"Bearer\" (the authentication scheme).",
@@ -636,8 +677,8 @@
       ]
     },
     {
-      "name": "terra-variable-combobox",
-      "description": "Fuzzy-search for dataset variables in combobox with list autocomplete.\n---\n\n\n### **Events:**\n - **terra-combobox-change** - Emitted when an option is selected.\n\n### **Methods:**\n - **valueChanged(oldValue: _string_, newValue: _string_)** - This component's value is read by other components.\nInternally, the variable metdata has slight differences that require adapting.\n\n### **CSS Properties:**\n - **--host-height** - The height of the host element. _(default: undefined)_\n- **--help-height** - The height of the search help element. _(default: undefined)_\n- **--label-height** - The height of the input's label element. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - A `search` element, the component's base.\n- **combobox** - An `input` element used for searching.\n- **button** - A `button` used for toggling the listbox's visibility.\n- **listbox** - A `ul` that holds the clickable options.",
+      "name": "terra-variable-keyword-search",
+      "description": "Fuzzy-search for dataset keywords in combobox with list autocomplete.\n---\n\n\n### **Events:**\n - **terra-variable-keyword-search-change** - Emitted when an option is selected.\n- **terra-search** - Emitted when the component is triggering a search (like a form triggering submit).\n\n### **CSS Properties:**\n - **--host-height** - The height of the host element. _(default: undefined)_\n- **--label-height** - The height of the input's label element. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - A `search` element, the component's base.\n- **combobox** - An `input` element used for searching.\n- **button** - A `button` used for toggling the listbox's visibility.\n- **listbox** - A `ul` that holds the clickable options.",
       "attributes": [
         {
           "name": "label",
@@ -649,42 +690,28 @@
           "description": "Set a placeholder for the combobox with this.\nDefaults to the label's value.",
           "values": []
         },
-        {
-          "name": "hide-help",
-          "description": "Hide the combobox's help text.\nWhen hidden, not rendered at all.",
-          "values": []
-        },
         {
           "name": "hide-label",
           "description": "Hide the combobox's label text.\nWhen hidden, still presents to screen readers.",
           "values": []
         },
         {
-          "name": "use-tags",
-          "description": "Determines if the variable combobox uses tags or plain text to display the query.",
-          "values": []
-        },
-        {
-          "name": "value",
-          "description": "Represents the EntryID (<collection-name>_<variable-name>) of the selected variable.\nOther components (like the time-series graphing component) will use this.",
-          "values": []
+          "name": "searchConfig",
+          "description": "type can be `Boolean`, `String`, `Number`, `Object`, or `Array`",
+          "values": [{ "name": "object" }]
         },
-        {
-          "name": "bearer-token",
-          "description": "The token to be used for authentication with remote servers.\nThe component provides the header \"Authorization: Bearer\" (the request header and authentication scheme).\nThe property's value will be inserted after \"Bearer\" (the authentication scheme).",
-          "values": []
-        }
+        { "name": "value", "values": [] }
       ],
       "references": [
         {
           "name": "Documentation",
-          "url": "https://disc.gsfc.nasa.gov/components/variable-combobox"
+          "url": "https://disc.gsfc.nasa.gov/components/variable-keyword-search"
         }
       ]
     },
     {
-      "name": "terra-variable-keyword-search",
-      "description": "Fuzzy-search for dataset keywords in combobox with list autocomplete.\n---\n\n\n### **Events:**\n - **terra-variable-keyword-search-change** - Emitted when an option is selected.\n- **terra-search** - Emitted when the component is triggering a search (like a form triggering submit).\n\n### **CSS Properties:**\n - **--host-height** - The height of the host element. _(default: undefined)_\n- **--label-height** - The height of the input's label element. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - A `search` element, the component's base.\n- **combobox** - An `input` element used for searching.\n- **button** - A `button` used for toggling the listbox's visibility.\n- **listbox** - A `ul` that holds the clickable options.",
+      "name": "terra-variable-combobox",
+      "description": "Fuzzy-search for dataset variables in combobox with list autocomplete.\n---\n\n\n### **Events:**\n - **terra-combobox-change** - Emitted when an option is selected.\n\n### **Methods:**\n - **valueChanged(oldValue: _string_, newValue: _string_)** - This component's value is read by other components.\nInternally, the variable metdata has slight differences that require adapting.\n\n### **CSS Properties:**\n - **--host-height** - The height of the host element. _(default: undefined)_\n- **--help-height** - The height of the search help element. _(default: undefined)_\n- **--label-height** - The height of the input's label element. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - A `search` element, the component's base.\n- **combobox** - An `input` element used for searching.\n- **button** - A `button` used for toggling the listbox's visibility.\n- **listbox** - A `ul` that holds the clickable options.",
       "attributes": [
         {
           "name": "label",
@@ -696,22 +723,36 @@
           "description": "Set a placeholder for the combobox with this.\nDefaults to the label's value.",
           "values": []
         },
+        {
+          "name": "hide-help",
+          "description": "Hide the combobox's help text.\nWhen hidden, not rendered at all.",
+          "values": []
+        },
         {
           "name": "hide-label",
           "description": "Hide the combobox's label text.\nWhen hidden, still presents to screen readers.",
           "values": []
         },
         {
-          "name": "searchConfig",
-          "description": "type can be `Boolean`, `String`, `Number`, `Object`, or `Array`",
-          "values": [{ "name": "object" }]
+          "name": "use-tags",
+          "description": "Determines if the variable combobox uses tags or plain text to display the query.",
+          "values": []
         },
-        { "name": "value", "values": [] }
+        {
+          "name": "value",
+          "description": "Represents the EntryID (<collection-name>_<variable-name>) of the selected variable.\nOther components (like the time-series graphing component) will use this.",
+          "values": []
+        },
+        {
+          "name": "bearer-token",
+          "description": "The token to be used for authentication with remote servers.\nThe component provides the header \"Authorization: Bearer\" (the request header and authentication scheme).\nThe property's value will be inserted after \"Bearer\" (the authentication scheme).",
+          "values": []
+        }
       ],
       "references": [
         {
           "name": "Documentation",
-          "url": "https://disc.gsfc.nasa.gov/components/variable-keyword-search"
+          "url": "https://disc.gsfc.nasa.gov/components/variable-combobox"
         }
       ]
     }