RealEarth

https://realearth.ssec.wisc.edu/doc/
Admin
RealEarth is a geospatial visualization platform providing REST APIs and JavaScript tools to access,...
Tokens:6,340
Snippets:54
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET /api/products

Source: https://realearth.ssec.wisc.edu/doc/api.php

Provides metadata about the given products.

```APIDOC
## GET /api/products

### Description
Provides metadata about the given products.

### Method
GET

### Endpoint
/api/products

### Parameters
#### Query Parameters
- **products** (string) - Optional - List of product IDs (e.g., product1,product2,...)
- **search** (string) - Optional - String to match in product name and description
- **timespan** (string) - Optional - Time span limiting "times" return values (e.g., [-]#(dhmst) or negative offset from end)
- **exclude** (string) - Optional - List of fields to exclude
```

--------------------------------

### GET /api/latest

Source: https://realearth.ssec.wisc.edu/doc/api.php

Provides the latest absolute product time.

```APIDOC
## GET /api/latest

### Description
Provides the latest absolute product time.

### Method
GET

### Endpoint
/api/latest

### Parameters
#### Query Parameters
- **products** (string) - Required - List of product IDs (e.g., product1,product2,...)
```

--------------------------------

### GET /api/time

Source: https://realearth.ssec.wisc.edu/doc/api.php

Provides the nearest recent absolute product time.

```APIDOC
## GET /api/time

### Description
Provides the nearest recent absolute product time.

### Method
GET

### Endpoint
/api/time

### Parameters
#### Query Parameters
- **products** (string) - Required - List of product IDs (e.g., product1,product2,...)
- **time** (string) - Optional - Absolute anchor time (YYYY-MM-DD+hh:mm[:ss])
```

--------------------------------

### GET /api/legend

Source: https://realearth.ssec.wisc.edu/doc/api.php

Provides legend images for specified products.

```APIDOC
## GET /api/legend

### Description
Provides legend images. Legend images are 320 pixels wide but may vary in height.

### Method
GET

### Endpoint
/api/legend

### Parameters
#### Query Parameters
- **products** (string) - Required - List of product IDs
- **orientation** (string) - Optional - Orientation of multiple legends (vertical, horizontal)
```

--------------------------------

### GET /api/times

Source: https://realearth.ssec.wisc.edu/doc/api.php

Provides the complete list of available times.

```APIDOC
## GET /api/times

### Description
Provides the complete list of available times.

### Method
GET

### Endpoint
/api/times

### Parameters
#### Query Parameters
- **products** (string) - Required - List of product IDs (e.g., product1,product2,...)
```

--------------------------------

### GET /api/probe

Source: https://realearth.ssec.wisc.edu/doc/api.php

Provides formatted data values for specified products in HTML format.

```APIDOC
## GET /api/probe

### Description
Provides formatted data values for specified products.

### Method
GET

### Endpoint
/api/probe

### Parameters
#### Query Parameters
- **products** (string) - Required - List of product IDs (product1,product2,...).
- **lat** (number) - Required (if id not provided) - Latitude.
- **lon** (number) - Required (if id not provided) - Longitude.
- **id** (string) - Required (if lat/lon not provided) - Shape ID.
- **time** (string) - Optional - Absolute time to probe (YYYY-MM-DD+hh:mm[:ss]).
```

--------------------------------

### GET /api/data

Source: https://realearth.ssec.wisc.edu/doc/api.php

Provides raw data values for specified products in JSON format.

```APIDOC
## GET /api/data

### Description
Provides raw data values for specified products.

### Method
GET

### Endpoint
/api/data

### Parameters
#### Query Parameters
- **products** (string) - Required - List of product IDs (product1,product2,...).
- **lat** (number) - Required (if id not provided) - Latitude.
- **lon** (number) - Required (if id not provided) - Longitude.
- **id** (string) - Required (if lat/lon not provided) - Shape ID.
- **time** (string) - Optional - Absolute time to probe (YYYY-MM-DD+hh:mm[:ss]).
```

--------------------------------

### GET /api/extents

Source: https://realearth.ssec.wisc.edu/doc/api.php

Provides the geographic extents.

```APIDOC
## GET /api/extents

### Description
Provides the geographic extents.

### Method
GET

### Endpoint
/api/extents

### Parameters
#### Query Parameters
- **products** (string) - Required - List of product IDs (e.g., product1,product2,...)
- **format** (string) - Optional - Output format (json, image, png)
```

--------------------------------

### GET /api/image (Individual Tiles)

Source: https://realearth.ssec.wisc.edu/doc/api.php

Provides access to raster tiles based on tile pyramid coordinates.

```APIDOC
## GET /api/image

### Description
Provides access to raster tiles. Supported formats include PNG (default), GIF, and JPEG.

### Method
GET

### Endpoint
/api/image

### Parameters
#### Query Parameters
- **products** (string) - Required - List of product IDs with optional opacity suffix (e.g., product1.50,product2.75)
- **x** (integer) - Required - Tile pyramid column
- **y** (integer) - Required - Tile pyramid row
- **z** (integer) - Required - Tile pyramid zoom
- **time** (string) - Optional - Absolute time to display (YYYY-MM-DD+hh:mm[:ss])
- **format** (string) - Optional - Image format (png, gif, jpeg)
```

--------------------------------

### GET /api/shapes

Source: https://realearth.ssec.wisc.edu/doc/api.php

Provides access to geometry from products defined by geo-located shapes in GeoJSON format.

```APIDOC
## GET /api/shapes

### Description
Provides access to geometry from products defined by geo-located shapes.

### Method
GET

### Endpoint
/api/shapes

### Parameters
#### Query Parameters
- **products** (string) - Required - Single product ID (plural accepted for compatibility).
- **time** (string) - Optional - Absolute time to display (YYYY-MM-DD+hh:mm[:ss]).
- **databounds** (string) - Optional - Bounding box latitudes as S,W,N,E.
```

--------------------------------

### GET /api/image (Arbitrary Bounds)

Source: https://realearth.ssec.wisc.edu/doc/api.php

Provides access to raster images with arbitrary bounds, supporting additional formats like GeoTIFF.

```APIDOC
## GET /api/image

### Description
Provides access to raster images with arbitrary bounds. Images created with this call will be watermarked.

### Method
GET

### Endpoint
/api/image

### Parameters
#### Query Parameters
- **products** (string) - Required - List of product IDs with optional opacity suffix
- **width** (integer) - Required - Image width in pixels
- **height** (integer) - Required - Image height in pixels
- **center** (string) - Optional - Center latitude and longitude (latitude,longitude)
- **zoom** (integer) - Optional - Zoom level (0-20)
- **bounds** (string) - Optional - Bounding box latitudes/longitudes as S,W,N,E
- **time** (string) - Optional - Absolute time to display (YYYY-MM-DD+hh:mm[:ss])
- **format** (string) - Optional - Image format (png, gif, jpeg, geotiff)
```

--------------------------------

### Initialize RealEarth with Options

Source: https://realearth.ssec.wisc.edu/doc/jsapi.php

Implementation showing how to pass an options object to the View Controller to customize products, center, basemap, and UI elements.

```html
<script type="application/javascript" src="https://realearth.ssec.wisc.edu/js/RELoader.js"></script> <div id="re_canvas">Loading RealEarth...</div> <script type="application/javascript">  $(document).ready(function() {   var options = {     products: 'ABI-Flood-DCOM',     center: '43,-89',     basemap: 'bw',     labels: 'latlongrid',     zoom: 4,     ui: false   }   var reController = new ssec.realearth.ViewController('re_canvas', options); });
```

--------------------------------

### Initialize RealEarth View Controller

Source: https://realearth.ssec.wisc.edu/doc/jsapi.php

Basic implementation to load the RealEarth library and initialize the View Controller within a specified HTML element.

```html
<script type="application/javascript" src="https://realearth.ssec.wisc.edu/js/RELoader.js"></script> <div id="re_canvas">Loading RealEarth...</div> <script type="application/javascript">  $(document).ready(function() {   var reController = new ssec.realearth.ViewController('re_canvas'); });
```

--------------------------------

### Initialize MyProductSelector

Source: https://realearth.ssec.wisc.edu/doc/jsapi.php

This snippet loads the RealEarth loader, defines the canvas container, and initializes the ViewController with a custom MyProductSelector instance.

```html
<script type="application/javascript" src="https://realearth.ssec.wisc.edu/js/RELoader.js"></script> <div id="re_canvas">Loading RealEarth...</div> <script type="application/javascript">  $(document).ready(function() {   var options = {     selector: false,     ui: true   }   var reController = new ssec.realearth.ViewController('re_canvas', options);   var mySelector = new MyProductSelector(reController);   reController.setSelectorObject(mySelector); });
```

--------------------------------

### setProducts(product_id, [product_id])

Source: https://realearth.ssec.wisc.edu/doc/jsapi.php

Adds the specified product IDs, creating new layers in the given order if they do not exist.

```APIDOC
## setProducts(product_ids)

### Description
Add the specified product IDs, creating new layers in the given order if they do not exist.

### Parameters
- **product_ids** (string) - Required - CSV of Product IDs
```

--------------------------------

### getProducts()

Source: https://realearth.ssec.wisc.edu/doc/jsapi.php

Returns a CSV string representing the current product IDs.

```APIDOC
## getProducts()

### Description
Returns a CSV string representing the current product IDs.

### Returns
- **string** - CSV string of product IDs
```

--------------------------------

### ssec.realearth.ViewController

Source: https://realearth.ssec.wisc.edu/doc/jsapi.php

Constructor for initializing the RealEarth map view within a specified DOM element.

```APIDOC
## new ssec.realearth.ViewController(elementId, options)

### Description
Initializes a new RealEarth map controller instance attached to the provided DOM element ID.

### Parameters
- **elementId** (string) - Required - The ID of the div element where the map will be rendered.
- **options** (object) - Optional - Configuration object for map settings.

### Options
- **animate** (boolean) - Enable animation.
- **animationmode** (string) - Animation mode: 'time' or 'layer'.
- **animationrock** (boolean) - Enable animation rocking.
- **animationspeed** (number) - Animation speed (0-100).
- **basemap** (string) - Initial basemap ID.
- **center** (string) - Initial latitude and longitude (e.g., '43,-89').
- **products** (string) - Comma-separated list of product IDs to display.
- **ui** (boolean) - Enable or disable the user interface.
- **zoom** (number) - Initial zoom level (1-20).
```

--------------------------------

### setProductOpacity(product_id, opacity)

Source: https://realearth.ssec.wisc.edu/doc/jsapi.php

Sets the opacity of a product layer.

```APIDOC
## setProductOpacity(product_id, opacity)

### Description
Set the opacity of a product layer.

### Parameters
- **product_id** (string) - Required - Product ID
- **opacity** (integer) - Required - Opacity
```

--------------------------------

### addProduct(product_id, order, callback)

Source: https://realearth.ssec.wisc.edu/doc/jsapi.php

Adds the specified product ID, creating a new layer if it does not exist.

```APIDOC
## addProduct(product_id, order, callback)

### Description
Add the specified product ID, creating a new layer if it does not exist.

### Parameters
- **product_id** (string) - Required - Product ID
- **order** (integer) - Optional - Layer order
- **callback** (function) - Optional - Callback function
```

--------------------------------

### Javascript API Configuration Keywords

Source: https://realearth.ssec.wisc.edu/doc/api.php

A reference of available configuration keywords used to control the behavior and display of the RealEarth map interface.

```APIDOC
## Javascript API Keywords

### Description
Configuration keywords used to initialize and control the RealEarth map display, animation settings, and data product selection.

### Keywords
- **animate** (Boolean) - Flag to specify Animation.
- **animationmode** (Mode type) - Animation mode (time, layer). Default: time.
- **animationrock** (Boolean) - Flag to specify Animation rocking.
- **animationspeed** (Number) - Animation speed (0-100). Default: 50.
- **autoprobe** (Boolean) - Flag to control autoprobe of raster pixel values.
- **basemap** (Basemap ID) - Initial basemap to display.
- **basemaps** (Basemap ID list) - Basemaps to be made available.
- **bounds** (South,West,North,East) - Initial lat/lon bounds of display.
- **center** (Latitude,Longitude) - Latitude and longitude to display. Default: 38,-97.
- **centerproduct** (Product ID) - Product to set center.
- **centervalue** (ID value) - Value to set center.
- **collection** (Collection ID) - Initial collection to display.
- **databounds** (South,West,North,East) - Lat/lon bounds of the data to load (shape data only).
- **keyboard** (Boolean) - Flag to control keyboard interaction.
- **labels** (Label ID) - Label to use in display (line, latlongrid, [Components]).
- **legend** (Boolean) - Flag to set legend display. Default: 1.
- **logo** (Boolean) - Flag to specify logo overlay on large images. Default: 1.
- **preloaddata** (Boolean) - Flag to control preload of next frame.
- **products** (Product ID list) - Products to display.
- **selector** (Boolean) - Flag to enable/disable Product Selector. Default: 1.
- **time** (Y-M-D H:m[:s]) - Anchor time for display and animation.
- **timeproduct** (Product ID) - Product to define animation times.
- **timerange** (Y-M-D h:m[:s],Y-M-D h:m[:s]) - Time range for animation.
- **timespan** (#(dhmst)) - Time span relative to anchor for animation period. Default: 6t.
- **timestep** #(dhms) - Time step for animation. Default: 1h.
- **ui** (Boolean) - Flag to enable/disable the User Interface. Default: 1.
- **waitdata** (Boolean) - Flag to control wait for data before next frame.
- **welcome** (Boolean) - Flag to enable/disable Welcome Sheet. Default: 1.
- **zoom** (Number) - Initial zoom level of display (1-20). Default: 4.
```

--------------------------------

### unhideProduct(product_id)

Source: https://realearth.ssec.wisc.edu/doc/jsapi.php

Unhides a hidden product layer.

```APIDOC
## unhideProduct(product_id)

### Description
Unhide a hidden product layer.

### Parameters
- **product_id** (string) - Required - Product ID
```

--------------------------------

### jumpToFrame(frame)

Source: https://realearth.ssec.wisc.edu/doc/jsapi.php

Goes to the specified frame of the animation.

```APIDOC
## jumpToFrame(frame)

### Description
Go to the specified frame of the animation.

### Parameters
- **frame** (integer) - Required - Frame number
```

--------------------------------

### setDwell(dwell)

Source: https://realearth.ssec.wisc.edu/doc/jsapi.php

Sets the dwell time for the animation.

```APIDOC
## setDwell(dwell)

### Description
Set dwell time.

### Parameters
- **dwell** (float) - Required - Seconds
```

--------------------------------

### hideProduct(product_id)

Source: https://realearth.ssec.wisc.edu/doc/jsapi.php

Hides a product layer without removing it.

```APIDOC
## hideProduct(product_id)

### Description
Hide a product layer without removing it.

### Parameters
- **product_id** (string) - Required - Product ID
```

--------------------------------

### removeProduct(product_id, refresh)

Source: https://realearth.ssec.wisc.edu/doc/jsapi.php

Removes the specified product ID.

```APIDOC
## removeProduct(product_id, refresh)

### Description
Remove the specified product ID.

### Parameters
- **product_id** (string) - Required - Product ID
- **refresh** (boolean) - Optional - Flag controlling UI refresh
```
Tokens:
Raw