AWFWeatherMapConfig

Objective-C

@interface AWFWeatherMapConfig : NSObject

Swift

class AWFWeatherMapConfig : NSObject

An AWFWeatherMapConfig object provides all of the configurable settings to a {@link AWFWeatherMap} instance. This object is usually applied to a weather map object at initialization.

The default implementation of a AWFWeatherMapConfig object assigns all of the default values needed by a weather map instance. In order to override these default settings, you must subclass AWFWeatherMapConfig and assign your custom values in your subclass’s implementation.

  • Initializes and returns a map configuration instance with the default settings.

    Declaration

    Objective-C

    + (nonnull instancetype)config;

    Return Value

    The intialized map configuration instance.

General Options

  • Update interval to update active map layers when auto-refresh is enabled for the weather map.

    See

    AWFWeatherMap

    Declaration

    Objective-C

    @property (nonatomic) NSTimeInterval refreshInterval;

    Swift

    var refreshInterval: TimeInterval { get set }

Overlays

  • The map level at which to place tile overlays.

    The default value for this property is MKOverlayLevelAboveRoads.

    Declaration

    Objective-C

    @property (nonatomic) MKOverlayLevel tileOverlayLevel;

    Swift

    var tileOverlayLevel: Int32 { get set }

  • The opacity to apply to the weather map tile overlays. Default value is 0.9.

    Declaration

    Objective-C

    @property (nonatomic) CGFloat tileOverlayAlpha;

    Swift

    var tileOverlayAlpha: CGFloat { get set }

  • Returns whether higher-quality raster overlay imagery should be requested for retina devices. Note that enabling this will result in sightly longer response times for raster tile requests. The default is YES.

    Declaration

    Objective-C

    @property (nonatomic) BOOL shouldUseRetinaImagery;

    Swift

    var shouldUseRetinaImagery: Bool { get set }

  • Returns whether higher-quality raster overlay imagery should be requested for retina devices for animations. Note that enabling this will result in sightly longer response times for raster tiles and animation data requests. The default is YES.

    Declaration

    Objective-C

    @property (nonatomic) BOOL shouldUseRetinaImageryForAnimation;

    Swift

    var shouldUseRetinaImageryForAnimation: Bool { get set }

  • Whether to display state province lines over the weather layers. The default value is NO.

    Declaration

    Objective-C

    @property (nonatomic) BOOL showsStateProvinceLines;

    Swift

    var showsStateProvinceLines: Bool { get set }

  • Whether to display county lines over the weather layers. The default value is NO.

    Declaration

    Objective-C

    @property (nonatomic) BOOL showsCountyLines;

    Swift

    var showsCountyLines: Bool { get set }

  • Whether water should be masked out from surface-based weather layers (e.g. surface temperatures, dew points, etc). The default value is YES.

    Declaration

    Objective-C

    @property (nonatomic) BOOL shouldApplyWaterMaskToSurfaceLayers;

    Swift

    var shouldApplyWaterMaskToSurfaceLayers: Bool { get set }

  • Whether past layers should always remain visible, even for future time intervals. Default value is NO.

    Declaration

    Objective-C

    @property (nonatomic) BOOL shouldAlwaysShowPastLayers;

    Swift

    var shouldAlwaysShowPastLayers: Bool { get set }

  • Whether future layers should always remain visible, even for past time intervals. Default value is NO.

    Declaration

    Objective-C

    @property (nonatomic) BOOL shouldAlwaysShowFutureLayers;

    Swift

    var shouldAlwaysShowFutureLayers: Bool { get set }

  • A Boolean value indicating whether data values should be displayed using Metric values when applicable. The default value is NO.

    Declaration

    Objective-C

    @property (nonatomic, getter=isMetric) BOOL metric;

    Swift

    var isMetric: Bool { get set }

Annotations

  • Determines whether point and shape data should be reloaded when the visible map region changes.

    Declaration

    Objective-C

    @property (nonatomic) BOOL shouldReloadDataOnRegionChange;

    Swift

    var shouldReloadDataOnRegionChange: Bool { get set }

  • The minimum distance required in screen points the map region must change before point and shape data is reloaded.

    Declaration

    Objective-C

    @property (nonatomic) CGFloat distanceRequiredToReloadData;

    Swift

    var distanceRequiredToReloadData: CGFloat { get set }

Animation/Timeline

  • A Boolean that determines whether overlays can be animated on the weather map.

    The default value of this property is YES.

    Declaration

    Objective-C

    @property (nonatomic) BOOL animationEnabled;

    Swift

    var animationEnabled: Bool { get set }

  • The length of the animation in seconds.

    The default value of this property is 2.0 seconds.

    Declaration

    Objective-C

    @property (nonatomic) NSTimeInterval animationDuration;

    Swift

    var animationDuration: TimeInterval { get set }

  • The number of seconds to hold the last frame of the animation before replaying from the beginning.

    The default value of this property is 2.0 seconds.

    Declaration

    Objective-C

    @property (nonatomic) NSTimeInterval animationEndDelay;

    Swift

    var animationEndDelay: TimeInterval { get set }

  • A Boolean that determines whether image overlays should crossfade between intervals during animation playback.

    The default value of this property is NO.

    Declaration

    Objective-C

    @property (nonatomic) BOOL animationCrossfadeEnabled;

    Swift

    var animationCrossfadeEnabled: Bool { get set }

  • The maximum number of images to request for an animation.

    If the total number of images available within the animation’s time range is greater than this value, the image intervals will be adjusted to be evenly spaced so that the total number of images never exceeds this value. Assigning a relative low value to this property will result in faster animation load times, whereas larger numbers will result in smoother animations for timelines with larger time ranges.

    The default value of this property is 20.

    Declaration

    Objective-C

    @property (nonatomic) NSInteger maximumIntervalsForAnimation;

    Swift

    var maximumIntervalsForAnimation: Int { get set }

  • The time interval offset to start the animation timeline relative to the current date and time, in seconds.

    This value must be less than the value for timelineEndOffsetFromNow. A timeline with the same start and end time offsets will not animate.

    The default value of this property is -7200, or -2 * AWF_HOUR (2 hours ago).

    Declaration

    Objective-C

    @property (nonatomic) NSTimeInterval timelineStartOffsetFromNow;

    Swift

    var timelineStartOffsetFromNow: TimeInterval { get set }

  • The time interval offset for the animation timeline to end relative to the current date and time, in seconds.

    This value must be greater than the value for timelineStartOffsetFromNow. A timeline with the same start and end time offsets will not animate.

    The default value of this property is 0 (current time).

    Declaration

    Objective-C

    @property (nonatomic) NSTimeInterval timelineEndOffsetFromNow;

    Swift

    var timelineEndOffsetFromNow: TimeInterval { get set }

  • Determines whether or not scrubbing the timeline also updates the active data layers.

    If an animation has successfully loaded all data required for playback, scrubbing the timeline will result in smooth transitions between intervals. However, if animation data has not yet been loaded, then scrubbing the timeline will result in a choppy transition between intervals as the overlay is invalidated and redrawn at each interval. This applies to image and tile data layers only.

    Declaration

    Objective-C

    @property (nonatomic) BOOL timelineScrubbingEnabled;

    Swift

    var timelineScrubbingEnabled: Bool { get set }

  • A Boolean value that determines whether the weather map should show animation loading progress, meaning the visible data will update to the last loaded interval during the loading process. Default value is YES.

    Declaration

    Objective-C

    @property (nonatomic) BOOL showAnimationLoadingProgress;

    Swift

    var showAnimationLoadingProgress: Bool { get set }

  • A Boolean value indicating whether to display text point data on the map while tile data is animating. The default is NO.

    Declaration

    Objective-C

    @property (nonatomic) BOOL showTextDataWhileAnimating;

    Swift

    var showTextDataWhileAnimating: Bool { get set }

  • A Boolean value that determines if the animation should automatically begin playing when all required data has loaded. Default value is YES.

    Declaration

    Objective-C

    @property (nonatomic) BOOL automaticallyStartAnimationOnLoad;

    Swift

    var automaticallyStartAnimationOnLoad: Bool { get set }

  • A Boolean value indicating whether an active animation should reload and restart when the visible map region changes. Default value is YES.

    Declaration

    Objective-C

    @property (nonatomic) BOOL shouldRestartAnimationOnRegionChange;

    Swift

    var shouldRestartAnimationOnRegionChange: Bool { get set }

  • A Boolean value indicating whether existing animation data should be removed from the map and replaced by the latest data when the animation is stopped. This option pertains primarily with raster data, such as image and tile overlays. Default value is NO.

    Note that existin animation data will still be removed and reset whenever the visible region of the map changes regardless of the value for this property.

    Declaration

    Objective-C

    @property (nonatomic) BOOL shouldRemoveAnimationDataWhenStopped;

    Swift

    var shouldRemoveAnimationDataWhenStopped: Bool { get set }

Long Press Gesture

  • A Boolean value that indicates whether the weather map should show the animated circle during a long press gesture on the map.

    Declaration

    Objective-C

    @property (nonatomic) BOOL showsAnnotationDuringLongPress;

    Swift

    var showsAnnotationDuringLongPress: Bool { get set }

  • A Boolean value that indicates whether the weather map should show an annotation on the map at the location of a long press gesture.

    Declaration

    Objective-C

    @property (nonatomic) BOOL showsAnnotationForLongPress;

    Swift

    var showsAnnotationForLongPress: Bool { get set }

  • The annotation style to use for the long press gesture when enabled.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) AWFAnnotationStyle *longPressAnnotationStyle;

    Swift

    var longPressAnnotationStyle: AWFAnnotationStyle? { get set }

Mapbox Configuration

  • The Mapbox layer identifier under which Aeris tile overlays will be inserted. If this value is nil, then Aeris layers will be added at the top of the layer stack.

    Refer to the Mapbox GL SDK for iOS documentation for additional information.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSString *mapboxOverlayInsertionLayerIdentifier;

    Swift

    var mapboxOverlayInsertionLayerIdentifier: String? { get set }

  • Mapbox URL of the map style to display.

    Refer to the Mapbox GL SDK for iOS documentation for additional information.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSURL *mapboxStyleUrl;

    Swift

    var mapboxStyleUrl: URL? { get set }