RainViewer
==========



This service provides access to the `RainViewer <https://www.rainviewer.com/api.html>`__ aggregated database.
RainViewer provides access to recent and forecasted weather radar maps all around the world.



.. toctree::
    :maxdepth: 2
    :titlesonly:
    :caption: RPC Categories





RPCS
----

.. function:: RainViewer.getColorSchemes()

    Get the list of valid color schemes for the :func:`RainViewer.getOverlay` RPC.

    **Returns:** ``List<ColorScheme>`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__ | `ColorScheme </docs/fundamentals/rpc-arg-types.html#ColorScheme>`__) - The list of valid color schemes.


.. function:: RainViewer.getOverlay(latitude: Latitude, longitude: Longitude, width: BoundedInteger<1>, height: BoundedInteger<1>, zoom: BoundedInteger<1, 25>, timeOffset: TimeOffset?, options: Object?)

    Gets a transparent overlay that can be placed directly on to of a map provided by :func:`GoogleMaps.getMap`
    to display recent or forecasted weather radar data.

    **Arguments:**

    - ``latitude: Latitude`` (`Latitude </docs/fundamentals/rpc-arg-types.html#Latitude>`__) - Latitude of the returned map (centered).
    - ``longitude: Longitude`` (`Longitude </docs/fundamentals/rpc-arg-types.html#Longitude>`__) - Longitude of the returned map (centered).
    - ``width: BoundedInteger<1>`` (`BoundedInteger </docs/fundamentals/rpc-arg-types.html#BoundedInteger>`__) - Width (in pixels) of the returned map.
    - ``height: BoundedInteger<1>`` (`BoundedInteger </docs/fundamentals/rpc-arg-types.html#BoundedInteger>`__) - Height (in pixels) of the returned map.
    - ``zoom: BoundedInteger<1, 25>`` (`BoundedInteger </docs/fundamentals/rpc-arg-types.html#BoundedInteger>`__) - The zoom level of the returned image (see the :doc:`/services/GoogleMaps/index` service).
    - ``timeOffset: TimeOffset?`` (`TimeOffset </docs/fundamentals/rpc-arg-types.html#TimeOffset>`__) - The time offset of the desired forecast (defaults to ``now``, which represents current weather).
    - ``options: Object?`` (`Object </docs/fundamentals/rpc-arg-types.html#Object>`__) - Additional drawing options.

        - ``smooth: Boolean?`` (`Boolean </docs/fundamentals/rpc-arg-types.html#Boolean>`__) - If set to true, smooths the radar overlay in the returned image to be more aesthetically pleasing (default true).
        - ``showSnow: Boolean?`` (`Boolean </docs/fundamentals/rpc-arg-types.html#Boolean>`__) - If set to true, renders snow as a separate color from normal precipitation (default false).
        - ``colorScheme: ColorScheme?`` (`ColorScheme </docs/fundamentals/rpc-arg-types.html#ColorScheme>`__) - An integer denoting the color scheme to use in the returned image (default 4).


    **Returns:** ``Image`` (`Image </docs/fundamentals/rpc-arg-types.html#Image>`__) - The rendered radar data overlay.


.. function:: RainViewer.getTimeOffsets()

    Get the list of valid radar time offsets for the :func:`RainViewer.getOverlay` RPC.
    The returned time offsets are in chronological order.

    **Returns:** ``List<TimeOffset>`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__ | `TimeOffset </docs/fundamentals/rpc-arg-types.html#TimeOffset>`__) - The list of valid time offsets in chronological order.