|
| 1 | +<!-- This file was autogenerated from Atmosphere.tsx do not modify --> |
| 2 | +## <MapboxGL.Atmosphere /> |
| 3 | +### |
| 4 | + |
| 5 | +### props |
| 6 | +| Prop | Type | Default | Required | Description | |
| 7 | +| ---- | :--: | :-----: | :------: | :----------: | |
| 8 | +| style | `FIX ME UNKNOWN TYPE` | `none` | `true` | FIX ME NO DESCRIPTION | |
| 9 | + |
| 10 | +### methods |
| 11 | +#### getStyle() |
| 12 | + |
| 13 | + |
| 14 | + |
| 15 | +##### arguments |
| 16 | +| Name | Type | Required | Description | |
| 17 | +| ---- | :--: | :------: | :----------: | |
| 18 | + |
| 19 | + |
| 20 | + |
| 21 | +#### baseProps() |
| 22 | + |
| 23 | + |
| 24 | + |
| 25 | +##### arguments |
| 26 | +| Name | Type | Required | Description | |
| 27 | +| ---- | :--: | :------: | :----------: | |
| 28 | + |
| 29 | + |
| 30 | + |
| 31 | + |
| 32 | +### styles |
| 33 | + |
| 34 | +* <a href="#range">range</a><br/> |
| 35 | +* <a href="#color">color</a><br/> |
| 36 | +* <a href="#highcolor">highColor</a><br/> |
| 37 | +* <a href="#spacecolor">spaceColor</a><br/> |
| 38 | +* <a href="#horizonblend">horizonBlend</a><br/> |
| 39 | +* <a href="#starintensity">starIntensity</a><br/> |
| 40 | + |
| 41 | +___ |
| 42 | + |
| 43 | +#### range |
| 44 | +Name: `range` |
| 45 | + |
| 46 | +#### Description |
| 47 | +The start and end distance range in which fog fades from fully transparent to fully opaque. The distance to the point at the center of the map is defined as zero, so that negative range values are closer to the camera, and positive values are farther away. |
| 48 | + |
| 49 | +#### Type |
| 50 | +`array<number>` |
| 51 | +#### Default Value |
| 52 | +`[0.5,10]` |
| 53 | + |
| 54 | +#### Minimum |
| 55 | +`-20` |
| 56 | + |
| 57 | + |
| 58 | +#### Maximum |
| 59 | +`20` |
| 60 | + |
| 61 | +#### Expression |
| 62 | + |
| 63 | +Parameters: `zoom` |
| 64 | +___ |
| 65 | + |
| 66 | +#### Name |
| 67 | + |
| 68 | +`rangeTransition` |
| 69 | + |
| 70 | +#### Description |
| 71 | + |
| 72 | +The transition affecting any changes to this layer’s range propery. |
| 73 | + |
| 74 | +#### Type |
| 75 | + |
| 76 | +`{ duration, delay }` |
| 77 | + |
| 78 | +#### Units |
| 79 | +`milliseconds` |
| 80 | + |
| 81 | +#### Default Value |
| 82 | +`{duration: 300, delay: 0}` |
| 83 | + |
| 84 | + |
| 85 | +___ |
| 86 | + |
| 87 | +#### color |
| 88 | +Name: `color` |
| 89 | + |
| 90 | +#### Description |
| 91 | +The color of the atmosphere region immediately below the horizon and within the `range` and above the horizon and within `horizonBlend`. Using opacity is recommended only for smoothly transitioning fog on/off as anything less than 100% opacity results in more tiles loaded and drawn. |
| 92 | + |
| 93 | +#### Type |
| 94 | +`color` |
| 95 | +#### Default Value |
| 96 | +`#ffffff` |
| 97 | + |
| 98 | + |
| 99 | +#### Expression |
| 100 | + |
| 101 | +Parameters: `zoom` |
| 102 | +___ |
| 103 | + |
| 104 | +#### Name |
| 105 | + |
| 106 | +`colorTransition` |
| 107 | + |
| 108 | +#### Description |
| 109 | + |
| 110 | +The transition affecting any changes to this layer’s color propery. |
| 111 | + |
| 112 | +#### Type |
| 113 | + |
| 114 | +`{ duration, delay }` |
| 115 | + |
| 116 | +#### Units |
| 117 | +`milliseconds` |
| 118 | + |
| 119 | +#### Default Value |
| 120 | +`{duration: 300, delay: 0}` |
| 121 | + |
| 122 | + |
| 123 | +___ |
| 124 | + |
| 125 | +#### highColor |
| 126 | +Name: `highColor` |
| 127 | + |
| 128 | +#### Description |
| 129 | +The color of the atmosphere region above the horizon, `highColor` extends further above the horizon than the `color` property and its spread can be controlled with `horizonBlend`. The opacity can be set to `0` to remove the high atmosphere color contribution. |
| 130 | + |
| 131 | +#### Type |
| 132 | +`color` |
| 133 | +#### Default Value |
| 134 | +`#245cdf` |
| 135 | + |
| 136 | + |
| 137 | +#### Expression |
| 138 | + |
| 139 | +Parameters: `zoom` |
| 140 | +___ |
| 141 | + |
| 142 | +#### Name |
| 143 | + |
| 144 | +`highColorTransition` |
| 145 | + |
| 146 | +#### Description |
| 147 | + |
| 148 | +The transition affecting any changes to this layer’s highColor propery. |
| 149 | + |
| 150 | +#### Type |
| 151 | + |
| 152 | +`{ duration, delay }` |
| 153 | + |
| 154 | +#### Units |
| 155 | +`milliseconds` |
| 156 | + |
| 157 | +#### Default Value |
| 158 | +`{duration: 300, delay: 0}` |
| 159 | + |
| 160 | + |
| 161 | +___ |
| 162 | + |
| 163 | +#### spaceColor |
| 164 | +Name: `spaceColor` |
| 165 | + |
| 166 | +#### Description |
| 167 | +The color of the region above the horizon and after the end of the `horizonBlend` contribution. The opacity can be set to `0` to have a transparent background. |
| 168 | + |
| 169 | +#### Type |
| 170 | +`color` |
| 171 | +#### Default Value |
| 172 | +`interpolate,linear,zoom,4,#010b19,7,#367ab9` |
| 173 | + |
| 174 | + |
| 175 | +#### Expression |
| 176 | + |
| 177 | +Parameters: `zoom` |
| 178 | +___ |
| 179 | + |
| 180 | +#### Name |
| 181 | + |
| 182 | +`spaceColorTransition` |
| 183 | + |
| 184 | +#### Description |
| 185 | + |
| 186 | +The transition affecting any changes to this layer’s spaceColor propery. |
| 187 | + |
| 188 | +#### Type |
| 189 | + |
| 190 | +`{ duration, delay }` |
| 191 | + |
| 192 | +#### Units |
| 193 | +`milliseconds` |
| 194 | + |
| 195 | +#### Default Value |
| 196 | +`{duration: 300, delay: 0}` |
| 197 | + |
| 198 | + |
| 199 | +___ |
| 200 | + |
| 201 | +#### horizonBlend |
| 202 | +Name: `horizonBlend` |
| 203 | + |
| 204 | +#### Description |
| 205 | +Horizon blend applies a smooth fade from the color of the atmosphere to the color of space. A value of zero leaves a sharp transition from atmosphere to space. Increasing the value blends the color of atmosphere into increasingly high angles of the sky. |
| 206 | + |
| 207 | +#### Type |
| 208 | +`number` |
| 209 | +#### Default Value |
| 210 | +`interpolate,linear,zoom,4,0.2,7,0.1` |
| 211 | + |
| 212 | +#### Minimum |
| 213 | +`0` |
| 214 | + |
| 215 | + |
| 216 | +#### Maximum |
| 217 | +`1` |
| 218 | + |
| 219 | +#### Expression |
| 220 | + |
| 221 | +Parameters: `zoom` |
| 222 | +___ |
| 223 | + |
| 224 | +#### Name |
| 225 | + |
| 226 | +`horizonBlendTransition` |
| 227 | + |
| 228 | +#### Description |
| 229 | + |
| 230 | +The transition affecting any changes to this layer’s horizonBlend propery. |
| 231 | + |
| 232 | +#### Type |
| 233 | + |
| 234 | +`{ duration, delay }` |
| 235 | + |
| 236 | +#### Units |
| 237 | +`milliseconds` |
| 238 | + |
| 239 | +#### Default Value |
| 240 | +`{duration: 300, delay: 0}` |
| 241 | + |
| 242 | + |
| 243 | +___ |
| 244 | + |
| 245 | +#### starIntensity |
| 246 | +Name: `starIntensity` |
| 247 | + |
| 248 | +#### Description |
| 249 | +A value controlling the star intensity where `0` will show no stars and `1` will show stars at their maximum intensity. |
| 250 | + |
| 251 | +#### Type |
| 252 | +`number` |
| 253 | +#### Default Value |
| 254 | +`interpolate,linear,zoom,5,0.35,6,0` |
| 255 | + |
| 256 | +#### Minimum |
| 257 | +`0` |
| 258 | + |
| 259 | + |
| 260 | +#### Maximum |
| 261 | +`1` |
| 262 | + |
| 263 | +#### Expression |
| 264 | + |
| 265 | +Parameters: `zoom` |
| 266 | +___ |
| 267 | + |
| 268 | +#### Name |
| 269 | + |
| 270 | +`starIntensityTransition` |
| 271 | + |
| 272 | +#### Description |
| 273 | + |
| 274 | +The transition affecting any changes to this layer’s starIntensity propery. |
| 275 | + |
| 276 | +#### Type |
| 277 | + |
| 278 | +`{ duration, delay }` |
| 279 | + |
| 280 | +#### Units |
| 281 | +`milliseconds` |
| 282 | + |
| 283 | +#### Default Value |
| 284 | +`{duration: 300, delay: 0}` |
| 285 | + |
| 286 | + |
0 commit comments