View Source GoogleApi.AirQuality.V1.Model.AirQualityIndex (google_api_air_quality v0.3.1)
The basic object for representing different air quality metrics. When brought together, these metrics provide a snapshot about the current air quality conditions. There are multiple indexes in the world serving different purposes and groups interested in measuring different aspects of air quality.
Attributes
-
aqi
(type:integer()
, default:nil
) - The index's numeric score. Examples: 10, 100. The value is not normalized and should only be interpreted in the context of its related air-quality index. For non-numeric indexes, this field will not be returned. Note: This field should be used for calculations, graph display, etc. For displaying the index score, you should use the AQI display field. -
aqiDisplay
(type:String.t
, default:nil
) - Textual representation of the index numeric score, that may include prefix or suffix symbols, which usually represents the worst index score. Example: >100 or 10+. Note: This field should be used when you want to display the index score. For non-numeric indexes, this field is empty. -
category
(type:String.t
, default:nil
) - Textual classification of the index numeric score interpretation. For example: "Excellent air quality". -
code
(type:String.t
, default:nil
) - The index's code. This field represents the index for programming purposes by using snake case instead of spaces. Examples: "uaqi", "fra_atmo". -
color
(type:GoogleApi.AirQuality.V1.Model.Color.t
, default:nil
) - The color used to represent the AQI numeric score. -
displayName
(type:String.t
, default:nil
) - A human readable representation of the index name. Example: "AQI (US)" -
dominantPollutant
(type:String.t
, default:nil
) - The chemical symbol of the dominant pollutant. For example: "CO".
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
Functions
Unwrap a decoded JSON object into its complex fields.