From 49caa6cb396b7a6efc271212797e5ae969afbce2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Minh=20Nguy=E1=BB=85n?= Date: Sun, 15 Jan 2017 15:56:10 -0800 Subject: macos-v0.3.0-rc.1 --- index.html | 20 +- .../Categories/NSValue(MGLAdditions).html | 960 ++++ .../NSValue(MGLCircleStyleLayerAdditions).html | 753 +++ .../NSValue(MGLFillStyleLayerAdditions).html | 654 +++ .../NSValue(MGLLineStyleLayerAdditions).html | 848 ++++ .../NSValue(MGLSymbolStyleLayerAdditions).html | 1537 +++++++ macos/0.3.0-rc.1/Classes/MGLAccountManager.html | 670 +++ macos/0.3.0-rc.1/Classes/MGLAnnotationImage.html | 804 ++++ macos/0.3.0-rc.1/Classes/MGLAttributionInfo.html | 820 ++++ .../Classes/MGLBackgroundStyleLayer.html | 689 +++ macos/0.3.0-rc.1/Classes/MGLCircleStyleLayer.html | 891 ++++ .../Classes/MGLClockDirectionFormatter.html | 694 +++ .../Classes/MGLCompassDirectionFormatter.html | 691 +++ .../0.3.0-rc.1/Classes/MGLCoordinateFormatter.html | 766 ++++ macos/0.3.0-rc.1/Classes/MGLFillStyleLayer.html | 879 ++++ .../Classes/MGLForegroundStyleLayer.html | 687 +++ macos/0.3.0-rc.1/Classes/MGLLineStyleLayer.html | 1204 +++++ macos/0.3.0-rc.1/Classes/MGLMapCamera.html | 920 ++++ macos/0.3.0-rc.1/Classes/MGLMapView.html | 4792 ++++++++++++++++++++ macos/0.3.0-rc.1/Classes/MGLMultiPoint.html | 1188 +++++ macos/0.3.0-rc.1/Classes/MGLMultiPolygon.html | 659 +++ macos/0.3.0-rc.1/Classes/MGLMultiPolyline.html | 661 +++ macos/0.3.0-rc.1/Classes/MGLOfflinePack.html | 846 ++++ macos/0.3.0-rc.1/Classes/MGLOfflineStorage.html | 952 ++++ macos/0.3.0-rc.1/Classes/MGLPointAnnotation.html | 608 +++ macos/0.3.0-rc.1/Classes/MGLPointCollection.html | 791 ++++ macos/0.3.0-rc.1/Classes/MGLPolygon.html | 794 ++++ macos/0.3.0-rc.1/Classes/MGLPolyline.html | 653 +++ macos/0.3.0-rc.1/Classes/MGLRasterSource.html | 772 ++++ macos/0.3.0-rc.1/Classes/MGLRasterStyleLayer.html | 880 ++++ macos/0.3.0-rc.1/Classes/MGLShape.html | 886 ++++ macos/0.3.0-rc.1/Classes/MGLShapeCollection.html | 669 +++ macos/0.3.0-rc.1/Classes/MGLShapeSource.html | 1066 +++++ macos/0.3.0-rc.1/Classes/MGLSource.html | 679 +++ macos/0.3.0-rc.1/Classes/MGLStyle.html | 2437 ++++++++++ .../0.3.0-rc.1/Classes/MGLStyleConstantValue.html | 741 +++ macos/0.3.0-rc.1/Classes/MGLStyleFunction.html | 888 ++++ macos/0.3.0-rc.1/Classes/MGLStyleLayer.html | 798 ++++ macos/0.3.0-rc.1/Classes/MGLStyleValue.html | 776 ++++ macos/0.3.0-rc.1/Classes/MGLSymbolStyleLayer.html | 2840 ++++++++++++ .../Classes/MGLTilePyramidOfflineRegion.html | 821 ++++ macos/0.3.0-rc.1/Classes/MGLTileSource.html | 938 ++++ macos/0.3.0-rc.1/Classes/MGLVectorStyleLayer.html | 754 +++ macos/0.3.0-rc.1/Content Primitives.html | 867 ++++ macos/0.3.0-rc.1/Content Sources.html | 844 ++++ .../0.3.0-rc.1/Enums/MGLCircleScaleAlignment.html | 622 +++ .../Enums/MGLCircleTranslationAnchor.html | 622 +++ macos/0.3.0-rc.1/Enums/MGLErrorCode.html | 691 +++ .../0.3.0-rc.1/Enums/MGLFillTranslationAnchor.html | 622 +++ .../0.3.0-rc.1/Enums/MGLIconRotationAlignment.html | 665 +++ macos/0.3.0-rc.1/Enums/MGLIconTextFit.html | 694 +++ .../0.3.0-rc.1/Enums/MGLIconTranslationAnchor.html | 622 +++ macos/0.3.0-rc.1/Enums/MGLLineCap.html | 662 +++ macos/0.3.0-rc.1/Enums/MGLLineJoin.html | 662 +++ .../0.3.0-rc.1/Enums/MGLLineTranslationAnchor.html | 622 +++ macos/0.3.0-rc.1/Enums/MGLMapDebugMaskOptions.html | 805 ++++ macos/0.3.0-rc.1/Enums/MGLOfflinePackState.html | 746 +++ macos/0.3.0-rc.1/Enums/MGLSymbolPlacement.html | 623 +++ macos/0.3.0-rc.1/Enums/MGLTextAnchor.html | 874 ++++ macos/0.3.0-rc.1/Enums/MGLTextJustification.html | 658 +++ macos/0.3.0-rc.1/Enums/MGLTextPitchAlignment.html | 658 +++ .../0.3.0-rc.1/Enums/MGLTextRotationAlignment.html | 665 +++ macos/0.3.0-rc.1/Enums/MGLTextTransform.html | 658 +++ .../0.3.0-rc.1/Enums/MGLTextTranslationAnchor.html | 622 +++ .../0.3.0-rc.1/Enums/MGLTileCoordinateSystem.html | 628 +++ macos/0.3.0-rc.1/Enums/MGLUserTrackingMode.html | 692 +++ macos/0.3.0-rc.1/Formatters.html | 674 +++ macos/0.3.0-rc.1/Geometry.html | 1106 +++++ macos/0.3.0-rc.1/Guides.html | 535 +++ macos/0.3.0-rc.1/Maps.html | 782 ++++ macos/0.3.0-rc.1/Offline Maps.html | 786 ++++ macos/0.3.0-rc.1/Other Categories.html | 720 +++ macos/0.3.0-rc.1/Other Classes.html | 668 +++ macos/0.3.0-rc.1/Other Constants.html | 1539 +++++++ macos/0.3.0-rc.1/Other Enums.html | 1314 ++++++ macos/0.3.0-rc.1/Other Type Definitions.html | 794 ++++ macos/0.3.0-rc.1/Protocols/MGLAnnotation.html | 729 +++ macos/0.3.0-rc.1/Protocols/MGLFeature.html | 801 ++++ macos/0.3.0-rc.1/Protocols/MGLMapViewDelegate.html | 1930 ++++++++ macos/0.3.0-rc.1/Protocols/MGLOverlay.html | 698 +++ macos/0.3.0-rc.1/Shapes and Annotations.html | 1226 +++++ macos/0.3.0-rc.1/Structs/MGLCoordinateBounds.html | 619 +++ macos/0.3.0-rc.1/Structs/MGLCoordinateSpan.html | 619 +++ .../0.3.0-rc.1/Structs/MGLOfflinePackProgress.html | 776 ++++ macos/0.3.0-rc.1/Style Layers.html | 1057 +++++ macos/0.3.0-rc.1/Styling the Map.html | 653 +++ macos/0.3.0-rc.1/css/highlight.css | 187 + macos/0.3.0-rc.1/css/jazzy.css | 493 ++ .../docsets/Mapbox.docset/Contents/Info.plist | 20 + .../Categories/NSValue(MGLAdditions).html | 960 ++++ .../NSValue(MGLCircleStyleLayerAdditions).html | 753 +++ .../NSValue(MGLFillStyleLayerAdditions).html | 654 +++ .../NSValue(MGLLineStyleLayerAdditions).html | 848 ++++ .../NSValue(MGLSymbolStyleLayerAdditions).html | 1537 +++++++ .../Documents/Classes/MGLAccountManager.html | 670 +++ .../Documents/Classes/MGLAnnotationImage.html | 804 ++++ .../Documents/Classes/MGLAttributionInfo.html | 820 ++++ .../Documents/Classes/MGLBackgroundStyleLayer.html | 689 +++ .../Documents/Classes/MGLCircleStyleLayer.html | 891 ++++ .../Classes/MGLClockDirectionFormatter.html | 694 +++ .../Classes/MGLCompassDirectionFormatter.html | 691 +++ .../Documents/Classes/MGLCoordinateFormatter.html | 766 ++++ .../Documents/Classes/MGLFillStyleLayer.html | 879 ++++ .../Documents/Classes/MGLForegroundStyleLayer.html | 687 +++ .../Documents/Classes/MGLLineStyleLayer.html | 1204 +++++ .../Resources/Documents/Classes/MGLMapCamera.html | 920 ++++ .../Resources/Documents/Classes/MGLMapView.html | 4792 ++++++++++++++++++++ .../Resources/Documents/Classes/MGLMultiPoint.html | 1188 +++++ .../Documents/Classes/MGLMultiPolygon.html | 659 +++ .../Documents/Classes/MGLMultiPolyline.html | 661 +++ .../Documents/Classes/MGLOfflinePack.html | 846 ++++ .../Documents/Classes/MGLOfflineStorage.html | 952 ++++ .../Documents/Classes/MGLPointAnnotation.html | 608 +++ .../Documents/Classes/MGLPointCollection.html | 791 ++++ .../Resources/Documents/Classes/MGLPolygon.html | 794 ++++ .../Resources/Documents/Classes/MGLPolyline.html | 653 +++ .../Documents/Classes/MGLRasterSource.html | 772 ++++ .../Documents/Classes/MGLRasterStyleLayer.html | 880 ++++ .../Resources/Documents/Classes/MGLShape.html | 886 ++++ .../Documents/Classes/MGLShapeCollection.html | 669 +++ .../Documents/Classes/MGLShapeSource.html | 1066 +++++ .../Resources/Documents/Classes/MGLSource.html | 679 +++ .../Resources/Documents/Classes/MGLStyle.html | 2437 ++++++++++ .../Documents/Classes/MGLStyleConstantValue.html | 741 +++ .../Documents/Classes/MGLStyleFunction.html | 888 ++++ .../Resources/Documents/Classes/MGLStyleLayer.html | 798 ++++ .../Resources/Documents/Classes/MGLStyleValue.html | 776 ++++ .../Documents/Classes/MGLSymbolStyleLayer.html | 2840 ++++++++++++ .../Classes/MGLTilePyramidOfflineRegion.html | 821 ++++ .../Resources/Documents/Classes/MGLTileSource.html | 938 ++++ .../Documents/Classes/MGLVectorStyleLayer.html | 754 +++ .../Resources/Documents/Content Primitives.html | 867 ++++ .../Resources/Documents/Content Sources.html | 844 ++++ .../Documents/Enums/MGLCircleScaleAlignment.html | 622 +++ .../Enums/MGLCircleTranslationAnchor.html | 622 +++ .../Resources/Documents/Enums/MGLErrorCode.html | 691 +++ .../Documents/Enums/MGLFillTranslationAnchor.html | 622 +++ .../Documents/Enums/MGLIconRotationAlignment.html | 665 +++ .../Resources/Documents/Enums/MGLIconTextFit.html | 694 +++ .../Documents/Enums/MGLIconTranslationAnchor.html | 622 +++ .../Resources/Documents/Enums/MGLLineCap.html | 662 +++ .../Resources/Documents/Enums/MGLLineJoin.html | 662 +++ .../Documents/Enums/MGLLineTranslationAnchor.html | 622 +++ .../Documents/Enums/MGLMapDebugMaskOptions.html | 805 ++++ .../Documents/Enums/MGLOfflinePackState.html | 746 +++ .../Documents/Enums/MGLSymbolPlacement.html | 623 +++ .../Resources/Documents/Enums/MGLTextAnchor.html | 874 ++++ .../Documents/Enums/MGLTextJustification.html | 658 +++ .../Documents/Enums/MGLTextPitchAlignment.html | 658 +++ .../Documents/Enums/MGLTextRotationAlignment.html | 665 +++ .../Documents/Enums/MGLTextTransform.html | 658 +++ .../Documents/Enums/MGLTextTranslationAnchor.html | 622 +++ .../Documents/Enums/MGLTileCoordinateSystem.html | 628 +++ .../Documents/Enums/MGLUserTrackingMode.html | 692 +++ .../Contents/Resources/Documents/Formatters.html | 674 +++ .../Contents/Resources/Documents/Geometry.html | 1106 +++++ .../Contents/Resources/Documents/Guides.html | 535 +++ .../Contents/Resources/Documents/Maps.html | 782 ++++ .../Contents/Resources/Documents/Offline Maps.html | 786 ++++ .../Resources/Documents/Other Categories.html | 720 +++ .../Resources/Documents/Other Classes.html | 668 +++ .../Resources/Documents/Other Constants.html | 1539 +++++++ .../Contents/Resources/Documents/Other Enums.html | 1314 ++++++ .../Documents/Other Type Definitions.html | 794 ++++ .../Documents/Protocols/MGLAnnotation.html | 729 +++ .../Resources/Documents/Protocols/MGLFeature.html | 801 ++++ .../Documents/Protocols/MGLMapViewDelegate.html | 1930 ++++++++ .../Resources/Documents/Protocols/MGLOverlay.html | 698 +++ .../Documents/Shapes and Annotations.html | 1226 +++++ .../Documents/Structs/MGLCoordinateBounds.html | 619 +++ .../Documents/Structs/MGLCoordinateSpan.html | 619 +++ .../Documents/Structs/MGLOfflinePackProgress.html | 776 ++++ .../Contents/Resources/Documents/Style Layers.html | 1057 +++++ .../Resources/Documents/Styling the Map.html | 653 +++ .../Contents/Resources/Documents/css/highlight.css | 187 + .../Contents/Resources/Documents/css/jazzy.css | 493 ++ .../Resources/Documents/fonts/opensans-bold.eot | Bin 0 -> 24122 bytes .../Resources/Documents/fonts/opensans-bold.woff | Bin 0 -> 28584 bytes .../Resources/Documents/fonts/opensans-regular.eot | Bin 0 -> 23625 bytes .../Documents/fonts/opensans-regular.woff | Bin 0 -> 27964 bytes .../Resources/Documents/for-style-authors.html | 1195 +++++ .../Contents/Resources/Documents/img/carat.png | Bin 0 -> 274 bytes .../Contents/Resources/Documents/img/dash.png | Bin 0 -> 1338 bytes .../Contents/Resources/Documents/img/github.svg | 4 + .../Contents/Resources/Documents/img/link.svg | 12 + .../Contents/Resources/Documents/img/mapbox.svg | 21 + .../Contents/Resources/Documents/img/minus.svg | 12 + .../Contents/Resources/Documents/img/plus.svg | 12 + .../Resources/Documents/img/screenshot.jpg | Bin 0 -> 445665 bytes .../Contents/Resources/Documents/index.html | 657 +++ .../Resources/Documents/infoplist-keys.html | 546 +++ .../Contents/Resources/Documents/js/jazzy.js | 47 + .../Contents/Resources/Documents/js/jquery.min.js | 4 + .../Contents/Resources/Documents/search.json | 1 + .../Contents/Resources/Documents/undocumented.json | 439 ++ .../Documents/working-with-geojson-data.html | 690 +++ .../Mapbox.docset/Contents/Resources/docSet.dsidx | Bin 0 -> 155648 bytes macos/0.3.0-rc.1/docsets/Mapbox.tgz | Bin 0 -> 1255510 bytes macos/0.3.0-rc.1/fonts/opensans-bold.eot | Bin 0 -> 24122 bytes macos/0.3.0-rc.1/fonts/opensans-bold.woff | Bin 0 -> 28584 bytes macos/0.3.0-rc.1/fonts/opensans-regular.eot | Bin 0 -> 23625 bytes macos/0.3.0-rc.1/fonts/opensans-regular.woff | Bin 0 -> 27964 bytes macos/0.3.0-rc.1/for-style-authors.html | 1195 +++++ macos/0.3.0-rc.1/img/carat.png | Bin 0 -> 274 bytes macos/0.3.0-rc.1/img/dash.png | Bin 0 -> 1338 bytes macos/0.3.0-rc.1/img/github.svg | 4 + macos/0.3.0-rc.1/img/link.svg | 12 + macos/0.3.0-rc.1/img/mapbox.svg | 21 + macos/0.3.0-rc.1/img/minus.svg | 12 + macos/0.3.0-rc.1/img/plus.svg | 12 + macos/0.3.0-rc.1/img/screenshot.jpg | Bin 0 -> 445665 bytes macos/0.3.0-rc.1/index.html | 657 +++ macos/0.3.0-rc.1/infoplist-keys.html | 546 +++ macos/0.3.0-rc.1/js/jazzy.js | 47 + macos/0.3.0-rc.1/js/jquery.min.js | 4 + macos/0.3.0-rc.1/search.json | 1 + macos/0.3.0-rc.1/undocumented.json | 439 ++ macos/0.3.0-rc.1/working-with-geojson-data.html | 690 +++ macos/docsets/Mapbox.xml | 1 + macos/index.html | 1 + 220 files changed, 161093 insertions(+), 1 deletion(-) create mode 100644 macos/0.3.0-rc.1/Categories/NSValue(MGLAdditions).html create mode 100644 macos/0.3.0-rc.1/Categories/NSValue(MGLCircleStyleLayerAdditions).html create mode 100644 macos/0.3.0-rc.1/Categories/NSValue(MGLFillStyleLayerAdditions).html create mode 100644 macos/0.3.0-rc.1/Categories/NSValue(MGLLineStyleLayerAdditions).html create mode 100644 macos/0.3.0-rc.1/Categories/NSValue(MGLSymbolStyleLayerAdditions).html create mode 100644 macos/0.3.0-rc.1/Classes/MGLAccountManager.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLAnnotationImage.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLAttributionInfo.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLBackgroundStyleLayer.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLCircleStyleLayer.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLClockDirectionFormatter.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLCompassDirectionFormatter.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLCoordinateFormatter.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLFillStyleLayer.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLForegroundStyleLayer.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLLineStyleLayer.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLMapCamera.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLMapView.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLMultiPoint.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLMultiPolygon.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLMultiPolyline.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLOfflinePack.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLOfflineStorage.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLPointAnnotation.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLPointCollection.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLPolygon.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLPolyline.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLRasterSource.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLRasterStyleLayer.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLShape.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLShapeCollection.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLShapeSource.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLSource.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLStyle.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLStyleConstantValue.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLStyleFunction.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLStyleLayer.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLStyleValue.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLSymbolStyleLayer.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLTilePyramidOfflineRegion.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLTileSource.html create mode 100644 macos/0.3.0-rc.1/Classes/MGLVectorStyleLayer.html create mode 100644 macos/0.3.0-rc.1/Content Primitives.html create mode 100644 macos/0.3.0-rc.1/Content Sources.html create mode 100644 macos/0.3.0-rc.1/Enums/MGLCircleScaleAlignment.html create mode 100644 macos/0.3.0-rc.1/Enums/MGLCircleTranslationAnchor.html create mode 100644 macos/0.3.0-rc.1/Enums/MGLErrorCode.html create mode 100644 macos/0.3.0-rc.1/Enums/MGLFillTranslationAnchor.html create mode 100644 macos/0.3.0-rc.1/Enums/MGLIconRotationAlignment.html create mode 100644 macos/0.3.0-rc.1/Enums/MGLIconTextFit.html create mode 100644 macos/0.3.0-rc.1/Enums/MGLIconTranslationAnchor.html create mode 100644 macos/0.3.0-rc.1/Enums/MGLLineCap.html create mode 100644 macos/0.3.0-rc.1/Enums/MGLLineJoin.html create mode 100644 macos/0.3.0-rc.1/Enums/MGLLineTranslationAnchor.html create mode 100644 macos/0.3.0-rc.1/Enums/MGLMapDebugMaskOptions.html create mode 100644 macos/0.3.0-rc.1/Enums/MGLOfflinePackState.html create mode 100644 macos/0.3.0-rc.1/Enums/MGLSymbolPlacement.html create mode 100644 macos/0.3.0-rc.1/Enums/MGLTextAnchor.html create mode 100644 macos/0.3.0-rc.1/Enums/MGLTextJustification.html create mode 100644 macos/0.3.0-rc.1/Enums/MGLTextPitchAlignment.html create mode 100644 macos/0.3.0-rc.1/Enums/MGLTextRotationAlignment.html create mode 100644 macos/0.3.0-rc.1/Enums/MGLTextTransform.html create mode 100644 macos/0.3.0-rc.1/Enums/MGLTextTranslationAnchor.html create mode 100644 macos/0.3.0-rc.1/Enums/MGLTileCoordinateSystem.html create mode 100644 macos/0.3.0-rc.1/Enums/MGLUserTrackingMode.html create mode 100644 macos/0.3.0-rc.1/Formatters.html create mode 100644 macos/0.3.0-rc.1/Geometry.html create mode 100644 macos/0.3.0-rc.1/Guides.html create mode 100644 macos/0.3.0-rc.1/Maps.html create mode 100644 macos/0.3.0-rc.1/Offline Maps.html create mode 100644 macos/0.3.0-rc.1/Other Categories.html create mode 100644 macos/0.3.0-rc.1/Other Classes.html create mode 100644 macos/0.3.0-rc.1/Other Constants.html create mode 100644 macos/0.3.0-rc.1/Other Enums.html create mode 100644 macos/0.3.0-rc.1/Other Type Definitions.html create mode 100644 macos/0.3.0-rc.1/Protocols/MGLAnnotation.html create mode 100644 macos/0.3.0-rc.1/Protocols/MGLFeature.html create mode 100644 macos/0.3.0-rc.1/Protocols/MGLMapViewDelegate.html create mode 100644 macos/0.3.0-rc.1/Protocols/MGLOverlay.html create mode 100644 macos/0.3.0-rc.1/Shapes and Annotations.html create mode 100644 macos/0.3.0-rc.1/Structs/MGLCoordinateBounds.html create mode 100644 macos/0.3.0-rc.1/Structs/MGLCoordinateSpan.html create mode 100644 macos/0.3.0-rc.1/Structs/MGLOfflinePackProgress.html create mode 100644 macos/0.3.0-rc.1/Style Layers.html create mode 100644 macos/0.3.0-rc.1/Styling the Map.html create mode 100644 macos/0.3.0-rc.1/css/highlight.css create mode 100644 macos/0.3.0-rc.1/css/jazzy.css create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Info.plist create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Categories/NSValue(MGLAdditions).html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Categories/NSValue(MGLCircleStyleLayerAdditions).html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Categories/NSValue(MGLFillStyleLayerAdditions).html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Categories/NSValue(MGLLineStyleLayerAdditions).html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Categories/NSValue(MGLSymbolStyleLayerAdditions).html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLAccountManager.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLAnnotationImage.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLAttributionInfo.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLBackgroundStyleLayer.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLCircleStyleLayer.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLClockDirectionFormatter.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLCompassDirectionFormatter.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLCoordinateFormatter.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLFillStyleLayer.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLForegroundStyleLayer.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLLineStyleLayer.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLMapCamera.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLMapView.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLMultiPoint.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLMultiPolygon.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLMultiPolyline.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLOfflinePack.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLOfflineStorage.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLPointAnnotation.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLPointCollection.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLPolygon.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLPolyline.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLRasterSource.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLRasterStyleLayer.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLShape.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLShapeCollection.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLShapeSource.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLSource.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLStyle.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLStyleConstantValue.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLStyleFunction.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLStyleLayer.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLStyleValue.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLSymbolStyleLayer.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLTilePyramidOfflineRegion.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLTileSource.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLVectorStyleLayer.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Content Primitives.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Content Sources.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLCircleScaleAlignment.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLCircleTranslationAnchor.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLErrorCode.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLFillTranslationAnchor.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLIconRotationAlignment.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLIconTextFit.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLIconTranslationAnchor.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLLineCap.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLLineJoin.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLLineTranslationAnchor.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLMapDebugMaskOptions.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLOfflinePackState.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLSymbolPlacement.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLTextAnchor.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLTextJustification.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLTextPitchAlignment.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLTextRotationAlignment.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLTextTransform.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLTextTranslationAnchor.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLTileCoordinateSystem.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLUserTrackingMode.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Formatters.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Geometry.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Guides.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Maps.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Offline Maps.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Other Categories.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Other Classes.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Other Constants.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Other Enums.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Other Type Definitions.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Protocols/MGLAnnotation.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Protocols/MGLFeature.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Protocols/MGLMapViewDelegate.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Protocols/MGLOverlay.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Shapes and Annotations.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Structs/MGLCoordinateBounds.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Structs/MGLCoordinateSpan.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Structs/MGLOfflinePackProgress.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Style Layers.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Styling the Map.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/css/highlight.css create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/css/jazzy.css create mode 100755 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/fonts/opensans-bold.eot create mode 100755 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/fonts/opensans-bold.woff create mode 100755 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/fonts/opensans-regular.eot create mode 100755 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/fonts/opensans-regular.woff create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/for-style-authors.html create mode 100755 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/img/carat.png create mode 100755 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/img/dash.png create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/img/github.svg create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/img/link.svg create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/img/mapbox.svg create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/img/minus.svg create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/img/plus.svg create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/img/screenshot.jpg create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/index.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/infoplist-keys.html create mode 100755 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/js/jazzy.js create mode 100755 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/js/jquery.min.js create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/search.json create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/undocumented.json create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/working-with-geojson-data.html create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/docSet.dsidx create mode 100644 macos/0.3.0-rc.1/docsets/Mapbox.tgz create mode 100755 macos/0.3.0-rc.1/fonts/opensans-bold.eot create mode 100755 macos/0.3.0-rc.1/fonts/opensans-bold.woff create mode 100755 macos/0.3.0-rc.1/fonts/opensans-regular.eot create mode 100755 macos/0.3.0-rc.1/fonts/opensans-regular.woff create mode 100644 macos/0.3.0-rc.1/for-style-authors.html create mode 100755 macos/0.3.0-rc.1/img/carat.png create mode 100755 macos/0.3.0-rc.1/img/dash.png create mode 100644 macos/0.3.0-rc.1/img/github.svg create mode 100644 macos/0.3.0-rc.1/img/link.svg create mode 100644 macos/0.3.0-rc.1/img/mapbox.svg create mode 100644 macos/0.3.0-rc.1/img/minus.svg create mode 100644 macos/0.3.0-rc.1/img/plus.svg create mode 100644 macos/0.3.0-rc.1/img/screenshot.jpg create mode 100644 macos/0.3.0-rc.1/index.html create mode 100644 macos/0.3.0-rc.1/infoplist-keys.html create mode 100755 macos/0.3.0-rc.1/js/jazzy.js create mode 100755 macos/0.3.0-rc.1/js/jquery.min.js create mode 100644 macos/0.3.0-rc.1/search.json create mode 100644 macos/0.3.0-rc.1/undocumented.json create mode 100644 macos/0.3.0-rc.1/working-with-geojson-data.html create mode 100644 macos/docsets/Mapbox.xml create mode 100644 macos/index.html diff --git a/index.html b/index.html index eca5a0f488..18d83fcc59 100644 --- a/index.html +++ b/index.html @@ -1 +1,19 @@ - + + + + + Mapbox GL Native + + + + +

Mapbox GL Native

+ + + + + diff --git a/macos/0.3.0-rc.1/Categories/NSValue(MGLAdditions).html b/macos/0.3.0-rc.1/Categories/NSValue(MGLAdditions).html new file mode 100644 index 0000000000..d0b03bb860 --- /dev/null +++ b/macos/0.3.0-rc.1/Categories/NSValue(MGLAdditions).html @@ -0,0 +1,960 @@ + + + + NSValue(MGLAdditions) Category Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + NSValue(MGLAdditions) Category Reference +
+
+ +
+ +
+ +
+
+

NSValue(MGLAdditions)

 +
+
+ 
@interface NSValue (MGLAdditions)
+ +
+
+

Methods for round-tripping values for Mapbox-defined types.

+ +
+
+ +
+
+
+
+ + + +

Working with Geographic Coordinate Values

+ +
+
    +
  • + +
    +
    +
    +

    Creates a new value object containing the specified Core Location geographic +coordinate structure.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)valueWithMGLCoordinate:
+    (CLLocationCoordinate2D)coordinate;
    + +
    +
    +

    Swift

    + 
    convenience init(mglCoordinate coordinate: CLLocationCoordinate2D)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + coordinate + + +
    +

    The value for the new object.

    + +
    +
    +
    +
    +

    Return Value

    +

    A new value object that contains the geographic coordinate information.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + MGLCoordinateValue + +
    +
    +
    +
    +

    The Core Location geographic coordinate structure representation of the value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, atomic) CLLocationCoordinate2D MGLCoordinateValue;
    + +
    +
    +

    Swift

    + 
    var mglCoordinateValue: CLLocationCoordinate2D { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Creates a new value object containing the specified Mapbox coordinate span +structure.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)valueWithMGLCoordinateSpan:(MGLCoordinateSpan)span;
    + +
    +
    +

    Swift

    + 
    convenience init(mglCoordinateSpan span: MGLCoordinateSpan)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + span + + +
    +

    The value for the new object.

    + +
    +
    +
    +
    +

    Return Value

    +

    A new value object that contains the coordinate span information.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    The Mapbox coordinate span structure representation of the value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, atomic) MGLCoordinateSpan MGLCoordinateSpanValue;
    + +
    +
    +

    Swift

    + 
    var mglCoordinateSpanValue: MGLCoordinateSpan { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Creates a new value object containing the specified Mapbox coordinate bounds +structure.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)valueWithMGLCoordinateBounds:
+    (MGLCoordinateBounds)bounds;
    + +
    +
    +

    Swift

    + 
    convenience init(mglCoordinateBounds bounds: MGLCoordinateBounds)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + bounds + + +
    +

    The value for the new object.

    + +
    +
    +
    +
    +

    Return Value

    +

    A new value object that contains the coordinate bounds information.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    The Mapbox coordinate bounds structure representation of the value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, atomic) MGLCoordinateBounds MGLCoordinateBoundsValue;
    + +
    +
    +

    Swift

    + 
    var mglCoordinateBoundsValue: MGLCoordinateBounds { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Working with Offline Map Values

+ +
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Categories/NSValue(MGLCircleStyleLayerAdditions).html b/macos/0.3.0-rc.1/Categories/NSValue(MGLCircleStyleLayerAdditions).html new file mode 100644 index 0000000000..faebff911e --- /dev/null +++ b/macos/0.3.0-rc.1/Categories/NSValue(MGLCircleStyleLayerAdditions).html @@ -0,0 +1,753 @@ + + + + NSValue(MGLCircleStyleLayerAdditions) Category Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + NSValue(MGLCircleStyleLayerAdditions) Category Reference +
+
+ +
+ +
+ +
+
+

NSValue(MGLCircleStyleLayerAdditions)

 +
+
+ 
@interface NSValue (MGLCircleStyleLayerAdditions)
+ +
+
+

Methods for wrapping an enumeration value for a style layer attribute in an +MGLCircleStyleLayer object and unwrapping its raw value.

+ +
+
+ +
+
+
+
+ + + +

Working with Circle Style Layer Attribute Values

+ +
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Categories/NSValue(MGLFillStyleLayerAdditions).html b/macos/0.3.0-rc.1/Categories/NSValue(MGLFillStyleLayerAdditions).html new file mode 100644 index 0000000000..c00a760be1 --- /dev/null +++ b/macos/0.3.0-rc.1/Categories/NSValue(MGLFillStyleLayerAdditions).html @@ -0,0 +1,654 @@ + + + + NSValue(MGLFillStyleLayerAdditions) Category Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + NSValue(MGLFillStyleLayerAdditions) Category Reference +
+
+ +
+ +
+ +
+
+

NSValue(MGLFillStyleLayerAdditions)

 +
+
+ 
@interface NSValue (MGLFillStyleLayerAdditions)
+ +
+
+

Methods for wrapping an enumeration value for a style layer attribute in an +MGLFillStyleLayer object and unwrapping its raw value.

+ +
+
+ +
+
+
+
+ + + +

Working with Fill Style Layer Attribute Values

+ +
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Categories/NSValue(MGLLineStyleLayerAdditions).html b/macos/0.3.0-rc.1/Categories/NSValue(MGLLineStyleLayerAdditions).html new file mode 100644 index 0000000000..911fa25c13 --- /dev/null +++ b/macos/0.3.0-rc.1/Categories/NSValue(MGLLineStyleLayerAdditions).html @@ -0,0 +1,848 @@ + + + + NSValue(MGLLineStyleLayerAdditions) Category Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + NSValue(MGLLineStyleLayerAdditions) Category Reference +
+
+ +
+ +
+ +
+
+

NSValue(MGLLineStyleLayerAdditions)

 +
+
+ 
@interface NSValue (MGLLineStyleLayerAdditions)
+ +
+
+

Methods for wrapping an enumeration value for a style layer attribute in an +MGLLineStyleLayer object and unwrapping its raw value.

+ +
+
+ +
+
+
+
+ + + +

Working with Line Style Layer Attribute Values

+ +
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Categories/NSValue(MGLSymbolStyleLayerAdditions).html b/macos/0.3.0-rc.1/Categories/NSValue(MGLSymbolStyleLayerAdditions).html new file mode 100644 index 0000000000..d069915899 --- /dev/null +++ b/macos/0.3.0-rc.1/Categories/NSValue(MGLSymbolStyleLayerAdditions).html @@ -0,0 +1,1537 @@ + + + + NSValue(MGLSymbolStyleLayerAdditions) Category Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + NSValue(MGLSymbolStyleLayerAdditions) Category Reference +
+
+ +
+ +
+ +
+
+

NSValue(MGLSymbolStyleLayerAdditions)

 +
+
+ 
@interface NSValue (MGLSymbolStyleLayerAdditions)
+ +
+
+

Methods for wrapping an enumeration value for a style layer attribute in an +MGLSymbolStyleLayer object and unwrapping its raw value.

+ +
+
+ +
+
+
+
+ + + +

Working with Symbol Style Layer Attribute Values

+ +
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLAccountManager.html b/macos/0.3.0-rc.1/Classes/MGLAccountManager.html new file mode 100644 index 0000000000..e5451cb3e9 --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLAccountManager.html @@ -0,0 +1,670 @@ + + + + MGLAccountManager Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLAccountManager Class Reference +
+
+ +
+ +
+ +
+
+

MGLAccountManager

 +
+
+ 
@interface MGLAccountManager : NSObject
+ +
+
+

The MGLAccountManager object provides a global way to set a Mapbox API access +token.

+ +
+
+ +
+
+
+
+ + + +

Authorizing Access

+ +
+
    +
  • +
    + + + + +setAccessToken: + +
    +
    +
    +
    +

    Set the +Mapbox access token +to be used by all instances of MGLMapView in the current application.

    + +

    Mapbox-hosted vector tiles and styles require an API access token, which you +can obtain from the +Mapbox account page. +Access tokens associate requests to Mapbox’s vector tile and style APIs with +your Mapbox account. They also deter other developers from using your styles +without your permission.

    + +
    +

    Note

    +

    You must set the access token before attempting to load any Mapbox-hosted +style. Therefore, you should generally set it before creating an instance of +MGLMapView. The recommended way to set an access token is to add an entry to +your application’s Info.plist file with the key MGLMapboxAccessToken and +the type String. Alternatively, you may call this method from your +application delegate’s -applicationDidFinishLaunching: method.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (void)setAccessToken:(nullable NSString *)accessToken;
    + +
    +
    +

    Swift

    + 
    class func setAccessToken(_ accessToken: String?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + accessToken + + +
    +

    A Mapbox access token. Calling this method with a value of + nil has no effect.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + +accessToken + +
    +
    +
    +
    +

    Returns the +Mapbox access token +in use by instances of MGLMapView in the current application.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nullable NSString *)accessToken;
    + +
    +
    +

    Swift

    + 
    class func accessToken() -> String?
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLAnnotationImage.html b/macos/0.3.0-rc.1/Classes/MGLAnnotationImage.html new file mode 100644 index 0000000000..0ef68ba869 --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLAnnotationImage.html @@ -0,0 +1,804 @@ + + + + MGLAnnotationImage Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLAnnotationImage Class Reference +
+
+ +
+ +
+ +
+
+

MGLAnnotationImage

 +
+
+ 
@interface MGLAnnotationImage : NSObject <NSSecureCoding>
+ +
+
+

The MGLAnnotationImage class is responsible for presenting point-based +annotations visually on an MGLMapView instance. Annotation image objects pair +NSImage objects with annotation-related metadata. They may be recycled later +and put into a reuse queue that is maintained by the map view.

+ +
+
+ +
+
+
+
+ + + +

Initializing and Preparing the Image Object

+ +
+
    +
  • + +
    +
    +
    +

    Initializes and returns a new annotation image object.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)annotationImageWithImage:(nonnull NSImage *)image
+                                 reuseIdentifier:
+                                     (nonnull NSString *)reuseIdentifier;
    + +
    +
    +

    Swift

    + 
    convenience init(image: NSImage, reuseIdentifier: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + image + + +
    +

    The image to display for the annotation.

    + +
    +
    + + reuseIdentifier + + +
    +

    The string that identifies this annotation image in the + reuse queue.

    + +
    +
    +
    +
    +

    Return Value

    +

    The initialized annotation image object or nil if there was a problem + initializing the object.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Getting and Setting Attributes

+ +
+
    +
  • +
    + + + + image + +
    +
    +
    +
    +

    The image to display for the annotation.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) NSImage *_Nonnull image;
    + +
    +
    +

    Swift

    + 
    var image: NSImage { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + reuseIdentifier + +
    +
    +
    +
    +

    The string that identifies this annotation image in the reuse queue. +(read-only)

    + +

    You specify the reuse identifier when you create the image object. You use this +type later to retrieve an annotation image object that was created previously +but which is currently unused because its annotation is not on-screen.

    + +

    If you define distinctly different types of annotations (with distinctly +different annotation images to go with them), you can differentiate between the +annotation types by specifying different reuse identifiers for each one.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) NSString *_Nonnull reuseIdentifier;
    + +
    +
    +

    Swift

    + 
    var reuseIdentifier: String { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + selectable + +
    +
    +
    +
    +

    A Boolean value indicating whether the annotation is selectable.

    + +

    The default value of this property is YES. If the value of this property is +NO, the annotation image ignores click events and cannot be selected.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (getter=isSelectable, assign, readwrite, nonatomic) BOOL selectable;
    + +
    +
    +

    Swift

    + 
    var isSelectable: Bool { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + cursor + +
    +
    +
    +
    +

    The cursor that appears above any annotation using this annotation image.

    + +

    By default, this property is set to nil, representing the current cursor.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, nullable) NSCursor *cursor;
    + +
    +
    +

    Swift

    + 
    var cursor: NSCursor? { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLAttributionInfo.html b/macos/0.3.0-rc.1/Classes/MGLAttributionInfo.html new file mode 100644 index 0000000000..49b2b0d575 --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLAttributionInfo.html @@ -0,0 +1,820 @@ + + + + MGLAttributionInfo Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLAttributionInfo Class Reference +
+
+ +
+ +
+ +
+
+

MGLAttributionInfo

 +
+
+ 
@interface MGLAttributionInfo : NSObject
+ +
+
+

Information about an attribution statement, usually a copyright or trademark +statement, associated with a map content source.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + -initWithTitle:URL: + +
    +
    +
    +
    +

    Returns an initialized attribution info object with the given title and URL.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithTitle:(nonnull NSAttributedString *)title
+                                  URL:(nullable NSURL *)URL;
    + +
    +
    +

    Swift

    + 
    init(title: NSAttributedString, url URL: URL?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + title + + +
    +

    The attribution statement’s title.

    + +
    +
    + + URL + + +
    +

    A URL to more information about the entity named in the attribution.

    + +
    +
    +
    +
    +

    Return Value

    +

    An initialized attribution info object.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + title + +
    +
    +
    +
    +

    The attribution statement’s attributed title text.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) NSAttributedString *_Nonnull title;
    + +
    +
    +

    Swift

    + 
    var title: NSAttributedString { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + URL + +
    +
    +
    +
    +

    The URL to more information about the entity named in the attribution.

    + +

    If this property is set, the attribution statement should be displayed as a +hyperlink or action button. Otherwise, if it is nil, the attribution +statement should be displayed as plain text.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, nullable) NSURL *URL;
    + +
    +
    +

    Swift

    + 
    var url: URL? { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + feedbackLink + +
    +
    +
    +
    +

    A Boolean value indicating whether the attribution statement is a shortcut to a +feedback tool.

    + +

    If this property is set, the statement should be treated as a way for the user +to provide feedback rather than an attribution statement.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (getter=isFeedbackLink, assign, readwrite, nonatomic)
+    BOOL feedbackLink;
    + +
    +
    +

    Swift

    + 
    var isFeedbackLink: Bool { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns a copy of the URL property modified to account for the given center +coordinate and zoom level.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nullable NSURL *)feedbackURLAtCenterCoordinate:
+                        (CLLocationCoordinate2D)centerCoordinate
+                                        zoomLevel:(double)zoomLevel;
    + +
    +
    +

    Swift

    + 
    func feedbackURL(atCenter centerCoordinate: CLLocationCoordinate2D, zoomLevel: Double) -> URL?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + centerCoordinate + + +
    +

    The map’s center coordinate.

    + +
    +
    + + zoomLevel + + +
    +

    The map’s zoom level. See the MGLMapView.zoomLevel property + for more information.

    + +
    +
    +
    +
    +

    Return Value

    +

    A modified URL containing a fragment that points to the specified + viewport. If the feedbackLink property is set to NO, this method returns + nil.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLBackgroundStyleLayer.html b/macos/0.3.0-rc.1/Classes/MGLBackgroundStyleLayer.html new file mode 100644 index 0000000000..29bfeecfb4 --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLBackgroundStyleLayer.html @@ -0,0 +1,689 @@ + + + + MGLBackgroundStyleLayer Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLBackgroundStyleLayer Class Reference +
+
+ +
+ +
+ +
+
+

MGLBackgroundStyleLayer

 +
+
+ 
@interface MGLBackgroundStyleLayer : MGLStyleLayer
+ +
+
+

An MGLBackgroundStyleLayer is a style layer that covers the entire map. Use a +background style layer to configure a color or pattern to show below all other +map content. If the style’s other layers use the Mapbox Streets source, the +background style layer is responsible for drawing land, whereas the oceans and +other bodies of water are drawn by MGLFillStyleLayer objects.

+ +

A background style layer is typically the bottommost layer in a style, because +it covers the entire map and can occlude any layers below it. You can therefore +access it by getting the last item in the MGLStyle.layers array.

+ +

If the background style layer is transparent or omitted from the style, any +portion of the map view that does not show another style layer is transparent.

+ +
+
+ +
+
+
+
+ + + +

Accessing the Paint Attributes

+ +
+
    +
  • +
    + + + + backgroundColor + +
    +
    +
    +
    +

    The color with which the background will be drawn.

    + +

    The default value of this property is an MGLStyleValue object containing +NSColor.blackColor. Set this property to nil to reset it to the default +value.

    + +

    This property is only applied to the style if backgroundPattern is set to +nil. Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSColor *> *backgroundColor;
    + +
    +
    +

    Swift

    + 
    var backgroundColor: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + backgroundOpacity + +
    +
    +
    +
    +

    The opacity at which the background will be drawn.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 1. Set this property to nil to reset +it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *backgroundOpacity;
    + +
    +
    +

    Swift

    + 
    var backgroundOpacity: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + backgroundPattern + +
    +
    +
    +
    +

    Name of image in style images to use for drawing an image background. For +seamless patterns, image width and height must be a factor of two (2, 4, 8, +…, 512).

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSString *> *backgroundPattern;
    + +
    +
    +

    Swift

    + 
    var backgroundPattern: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLCircleStyleLayer.html b/macos/0.3.0-rc.1/Classes/MGLCircleStyleLayer.html new file mode 100644 index 0000000000..5040bfcaed --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLCircleStyleLayer.html @@ -0,0 +1,891 @@ + + + + MGLCircleStyleLayer Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLCircleStyleLayer Class Reference +
+
+ +
+ +
+ +
+
+

MGLCircleStyleLayer

 +
+
+ 
@interface MGLCircleStyleLayer : MGLVectorStyleLayer
+ +
+
+

An MGLCircleStyleLayer is a style layer that renders one or more filled +circles on the map.

+ +

Use a circle style layer to configure the visual appearance of point or point +collection features in vector tiles loaded by an MGLVectorSource object or +MGLPointAnnotation, MGLPointFeature, MGLPointCollection, or +MGLPointCollectionFeature instances in an MGLShapeSource object.

+ +

A circle style layer renders circles whose radii are measured in screen units. +To display circles on the map whose radii correspond to real-world distances, +use many-sided regular polygons and configure their appearance using an +MGLFillStyleLayer object.

+ +

You can access an existing circle style layer using the +-[MGLStyle layerWithIdentifier:] method if you know its identifier; +otherwise, find it using the MGLStyle.layers property. You can also create a +new circle style layer and add it to the style using a method such as +-[MGLStyle addLayer:].

+ +

Example

+
let layer = MGLCircleStyleLayer(identifier: circles, source: population)
+layer.sourceLayerIdentifier = population
+layer.circleColor = MGLStyleValue(rawValue: .green)
+layer.circleRadius = MGLStyleValue(interpolationBase: 1.75, stops: [
+    12: MGLStyleValue(rawValue: 2),
+    22: MGLStyleValue(rawValue: 180)
+])
+layer.circleOpacity = MGLStyleValue(rawValue: 0.7)
+layer.predicate = NSPredicate(format: %K == %@, marital-status, married)
+mapView.style?.addLayer(layer)
+

+ +
+
+ +
+
+
+
+ + + +

Accessing the Paint Attributes

+ +
+
    +
  • +
    + + + + circleBlur + +
    +
    +
    +
    +

    Amount to blur the circle. 1 blurs the circle such that only the centerpoint is +full opacity.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 0. Set this property to nil to reset +it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *circleBlur;
    + +
    +
    +

    Swift

    + 
    var circleBlur: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + circleColor + +
    +
    +
    +
    +

    The fill color of the circle.

    + +

    The default value of this property is an MGLStyleValue object containing +NSColor.blackColor. Set this property to nil to reset it to the default +value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSColor *> *circleColor;
    + +
    +
    +

    Swift

    + 
    var circleColor: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + circleOpacity + +
    +
    +
    +
    +

    The opacity at which the circle will be drawn.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 1. Set this property to nil to reset +it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *circleOpacity;
    + +
    +
    +

    Swift

    + 
    var circleOpacity: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + circleRadius + +
    +
    +
    +
    +

    Circle radius.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 5. Set this property to nil to reset +it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *circleRadius;
    + +
    +
    +

    Swift

    + 
    var circleRadius: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + circleScaleAlignment + +
    +
    +
    +
    +

    Controls the scaling behavior of the circle when the map is pitched.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing MGLCircleScaleAlignmentMap. Set this property to +nil to reset it to the default value.

    + +

    This attribute corresponds to the circle-pitch-scale +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *circleScaleAlignment;
    + +
    +
    +

    Swift

    + 
    var circleScaleAlignment: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + circleTranslation + +
    +
    +
    +
    +

    The geometry’s offset.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing a CGVector struct set to 0 points rightward and 0 +points upward. Set this property to nil to reset it to the default value.

    + +

    This attribute corresponds to the circle-translate +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *circleTranslation;
    + +
    +
    +

    Swift

    + 
    var circleTranslation: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Controls the translation reference point.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing MGLCircleTranslationAnchorMap. Set this property +to nil to reset it to the default value.

    + +

    This property is only applied to the style if circleTranslation is non-nil. +Otherwise, it is ignored.

    + +

    This attribute corresponds to the circle-translate-anchor +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *circleTranslationAnchor;
    + +
    +
    +

    Swift

    + 
    var circleTranslationAnchor: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLClockDirectionFormatter.html b/macos/0.3.0-rc.1/Classes/MGLClockDirectionFormatter.html new file mode 100644 index 0000000000..0603db191a --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLClockDirectionFormatter.html @@ -0,0 +1,694 @@ + + + + MGLClockDirectionFormatter Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLClockDirectionFormatter Class Reference +
+
+ +
+ +
+ +
+
+

MGLClockDirectionFormatter

 +
+
+ 
@interface MGLClockDirectionFormatter : NSFormatter
+ +
+
+

The MGLClockDirectionFormatter class provides properly formatted descriptions +of headings relative to the user, known as clock positions. For +example, a value of 90 may be formatted as “3 o’clock”, depending on the +locale.

+ +

Use this class to create localized heading strings when displaying directions +relative to the user’s current location and heading. To format a direction +irrespective of the user’s orientation, use MGLCompassDirectionFormatter +instead.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + unitStyle + +
    +
    +
    +
    +

    The unit style used by this formatter.

    + +

    This property defaults to NSFormattingUnitStyleMedium.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) NSFormattingUnitStyle unitStyle;
    + +
    +
    +

    Swift

    + 
    var unitStyle: Formatter.UnitStyle { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -stringFromDirection: + +
    +
    +
    +
    +

    Returns a clock position string for the provided value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull NSString *)stringFromDirection:(CLLocationDirection)direction;
    + +
    +
    +

    Swift

    + 
    func string(fromDirection direction: CLLocationDirection) -> String
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + direction + + +
    +

    The heading, measured in degrees, where 0° means “straight + ahead” and 90° means “directly to your right”.

    + +
    +
    +
    +
    +

    Return Value

    +

    The clock position string appropriately formatted for the receiver’s + locale.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    This method is not supported for the MGLDirectionFormatter class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (BOOL)getObjectValue:(out id _Nullable *_Nullable)obj
+             forString:(nonnull NSString *)string
+      errorDescription:(out NSString *_Nullable *_Nullable)error;
    + +
    +
    +

    Swift

    + 
    func getObjectValue(_ obj: AutoreleasingUnsafeMutablePointer
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLCompassDirectionFormatter.html b/macos/0.3.0-rc.1/Classes/MGLCompassDirectionFormatter.html new file mode 100644 index 0000000000..2ec4d23d8d --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLCompassDirectionFormatter.html @@ -0,0 +1,691 @@ + + + + MGLCompassDirectionFormatter Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLCompassDirectionFormatter Class Reference +
+
+ +
+ +
+ +
+
+

MGLCompassDirectionFormatter

 +
+
+ 
@interface MGLCompassDirectionFormatter : NSFormatter
+ +
+
+

The MGLCompassDirectionFormatter class provides properly formatted +descriptions of absolute headings. For example, a value of 90 may be +formatted as “east”, depending on the locale.

+ +

Use this class to create localized heading strings when displaying directions +irrespective of the user’s current location. To format a direction relative to +the user’s current location, use MGLClockDirectionFormatter instead.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + unitStyle + +
    +
    +
    +
    +

    The unit style used by this formatter.

    + +

    This property defaults to NSFormattingUnitStyleMedium.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) NSFormattingUnitStyle unitStyle;
    + +
    +
    +

    Swift

    + 
    var unitStyle: Formatter.UnitStyle { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -stringFromDirection: + +
    +
    +
    +
    +

    Returns a heading string for the provided value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull NSString *)stringFromDirection:(CLLocationDirection)direction;
    + +
    +
    +

    Swift

    + 
    func string(fromDirection direction: CLLocationDirection) -> String
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + direction + + +
    +

    The heading, measured in degrees, where 0° means “due north” + and 90° means “due east”.

    + +
    +
    +
    +
    +

    Return Value

    +

    The heading string appropriately formatted for the formatter’s locale.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    This method is not supported for the MGLDirectionFormatter class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (BOOL)getObjectValue:(out id _Nullable *_Nullable)obj
+             forString:(nonnull NSString *)string
+      errorDescription:(out NSString *_Nullable *_Nullable)error;
    + +
    +
    +

    Swift

    + 
    func getObjectValue(_ obj: AutoreleasingUnsafeMutablePointer
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLCoordinateFormatter.html b/macos/0.3.0-rc.1/Classes/MGLCoordinateFormatter.html new file mode 100644 index 0000000000..c23315b220 --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLCoordinateFormatter.html @@ -0,0 +1,766 @@ + + + + MGLCoordinateFormatter Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLCoordinateFormatter Class Reference +
+
+ +
+ +
+ +
+
+

MGLCoordinateFormatter

 +
+
+ 
@interface MGLCoordinateFormatter : NSFormatter
+ +
+
+

The MGLCoordinateFormatter class provides properly formatted descriptions of +geographic coordinate pairs. Use this class to create localized coordinate +strings when displaying location information to users.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + allowsMinutes + +
    +
    +
    +
    +

    Determines whether the output may contain minutes of arc when nonzero.

    + +

    The default value of this property is YES, causing the receiver to include +minutes of arc in its output. If allowsSeconds is YES, this property is +ignored and the output always includes minutes of arc.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) BOOL allowsMinutes;
    + +
    +
    +

    Swift

    + 
    var allowsMinutes: Bool { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + allowsSeconds + +
    +
    +
    +
    +

    Determines whether the output may contain seconds of arc when nonzero.

    + +

    The default value of this property is YES, causing the receiver to include +seconds of arc in its output.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) BOOL allowsSeconds;
    + +
    +
    +

    Swift

    + 
    var allowsSeconds: Bool { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + unitStyle + +
    +
    +
    +
    +

    The unit style used by this formatter.

    + +

    The default value of this property is NSFormattingUnitStyleMedium.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) NSFormattingUnitStyle unitStyle;
    + +
    +
    +

    Swift

    + 
    var unitStyle: Formatter.UnitStyle { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns a coordinate string for the provided value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull NSString *)stringFromCoordinate:(CLLocationCoordinate2D)coordinate;
    + +
    +
    +

    Swift

    + 
    func string(from coordinate: CLLocationCoordinate2D) -> String
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + coordinate + + +
    +

    The coordinate’s value.

    + +
    +
    +
    +
    +

    Return Value

    +

    The coordinate string appropriately formatted for the formatter’s + locale.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    This method is not supported for the MGLCoordinateFormatter class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (BOOL)getObjectValue:(out id _Nullable *_Nullable)obj
+             forString:(nonnull NSString *)string
+      errorDescription:(out NSString *_Nullable *_Nullable)error;
    + +
    +
    +

    Swift

    + 
    func getObjectValue(_ obj: AutoreleasingUnsafeMutablePointer
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLFillStyleLayer.html b/macos/0.3.0-rc.1/Classes/MGLFillStyleLayer.html new file mode 100644 index 0000000000..d79bcea179 --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLFillStyleLayer.html @@ -0,0 +1,879 @@ + + + + MGLFillStyleLayer Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLFillStyleLayer Class Reference +
+
+ +
+ +
+ +
+
+

MGLFillStyleLayer

 +
+
+ 
@interface MGLFillStyleLayer : MGLVectorStyleLayer
+ +
+
+

An MGLFillStyleLayer is a style layer that renders one or more filled (and +optionally stroked) polygons on the map.

+ +

Use a fill style layer to configure the visual appearance of polygon or +multipolygon features in vector tiles loaded by an MGLVectorSource object or +MGLPolygon, MGLPolygonFeature, MGLMultiPolygon, or +MGLMultiPolygonFeature instances in an MGLShapeSource object.

+ +

You can access an existing fill style layer using the +-[MGLStyle layerWithIdentifier:] method if you know its identifier; +otherwise, find it using the MGLStyle.layers property. You can also create a +new fill style layer and add it to the style using a method such as +-[MGLStyle addLayer:].

+ +

Example

+
let layer = MGLFillStyleLayer(identifier: parks, source: parks)
+layer.sourceLayerIdentifier = parks
+layer.fillColor = MGLStyleValue(rawValue: .green)
+layer.predicate = NSPredicate(format: type == %@, national-park)
+mapView.style?.addLayer(layer)
+

+ +
+
+ +
+
+
+
+ + + +

Accessing the Paint Attributes

+ +
+
    +
  • +
    + + + + fillAntialiased + +
    +
    +
    +
    +

    Whether or not the fill should be antialiased.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing YES. Set this property to nil to reset it to +the default value.

    + +

    This attribute corresponds to the fill-antialias +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (getter=isFillAntialiased, assign, readwrite, nonatomic,
+          null_resettable) MGLStyleValue<NSNumber *> *fillAntialiased;
    + +
    +
    +

    Swift

    + 
    var fillAntialiased: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + fillColor + +
    +
    +
    +
    +

    The color of the filled part of this layer.

    + +

    The default value of this property is an MGLStyleValue object containing +NSColor.blackColor. Set this property to nil to reset it to the default +value.

    + +

    This property is only applied to the style if fillPattern is set to nil. +Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSColor *> *fillColor;
    + +
    +
    +

    Swift

    + 
    var fillColor: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + fillOpacity + +
    +
    +
    +
    +

    The opacity of the entire fill layer. In contrast to the fillColor, this +value will also affect the 1pt stroke around the fill, if the stroke is used.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 1. Set this property to nil to reset +it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *fillOpacity;
    + +
    +
    +

    Swift

    + 
    var fillOpacity: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + fillOutlineColor + +
    +
    +
    +
    +

    The outline color of the fill. Matches the value of fillColor if unspecified.

    + +

    This property is only applied to the style if fillPattern is set to nil, +and fillAntialiased is set to an MGLStyleValue object containing an +NSNumber object containing YES. Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSColor *> *fillOutlineColor;
    + +
    +
    +

    Swift

    + 
    var fillOutlineColor: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + fillPattern + +
    +
    +
    +
    +

    Name of image in sprite to use for drawing image fills. For seamless patterns, +image width and height must be a factor of two (2, 4, 8, …, 512).

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSString *> *fillPattern;
    + +
    +
    +

    Swift

    + 
    var fillPattern: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + fillTranslation + +
    +
    +
    +
    +

    The geometry’s offset.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing a CGVector struct set to 0 points rightward and 0 +points upward. Set this property to nil to reset it to the default value.

    + +

    This attribute corresponds to the fill-translate +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *fillTranslation;
    + +
    +
    +

    Swift

    + 
    var fillTranslation: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + fillTranslationAnchor + +
    +
    +
    +
    +

    Controls the translation reference point.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing MGLFillTranslationAnchorMap. Set this property to +nil to reset it to the default value.

    + +

    This property is only applied to the style if fillTranslation is non-nil. +Otherwise, it is ignored.

    + +

    This attribute corresponds to the fill-translate-anchor +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *fillTranslationAnchor;
    + +
    +
    +

    Swift

    + 
    var fillTranslationAnchor: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLForegroundStyleLayer.html b/macos/0.3.0-rc.1/Classes/MGLForegroundStyleLayer.html new file mode 100644 index 0000000000..a95af1f437 --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLForegroundStyleLayer.html @@ -0,0 +1,687 @@ + + + + MGLForegroundStyleLayer Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLForegroundStyleLayer Class Reference +
+
+ +
+ +
+ +
+
+

MGLForegroundStyleLayer

 +
+
+ 
@interface MGLForegroundStyleLayer : MGLStyleLayer
+ +
+
+

MGLForegroundStyleLayer is an abstract superclass for style layers whose +content is defined by an MGLSource object.

+ +

Do not create instances of this class directly, and do not create your own +subclasses of this class. Instead, create instances of MGLRasterStyleLayer +and the concrete subclasses of MGLVectorStyleLayer.

+ +
+
+ +
+
+
+
+ + + +

Initializing a Style Layer

+ +
+
    +
  • + +
    +
    +
    +

    Returns a foreground style layer initialized with an identifier and source.

    + +

    After initializing and configuring the style layer, add it to a map view’s +style using the -[MGLStyle addLayer:] or +-[MGLStyle insertLayer:belowLayer:] method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithIdentifier:(nonnull NSString *)identifier
+                                    source:(nonnull MGLSource *)source;
    + +
    +
    +

    Swift

    + 
    init(identifier: String, source: MGLSource)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + identifier + + +
    +

    A string that uniquely identifies the source in the style to + which it is added.

    + +
    +
    + + source + + +
    +

    The source from which to obtain the data to style. If the source + has not yet been added to the current style, the behavior is undefined.

    + +
    +
    +
    +
    +

    Return Value

    +

    An initialized foreground style layer.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Specifying a Style Layer’s Content

+ +
+
    +
  • +
    + + + + sourceIdentifier + +
    +
    +
    +
    +

    Identifier of the source from which the receiver obtains the data to style.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic, nullable) NSString *sourceIdentifier;
    + +
    +
    +

    Swift

    + 
    var sourceIdentifier: String? { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLLineStyleLayer.html b/macos/0.3.0-rc.1/Classes/MGLLineStyleLayer.html new file mode 100644 index 0000000000..80a1504917 --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLLineStyleLayer.html @@ -0,0 +1,1204 @@ + + + + MGLLineStyleLayer Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLLineStyleLayer Class Reference +
+
+ +
+ +
+ +
+
+

MGLLineStyleLayer

 +
+
+ 
@interface MGLLineStyleLayer : MGLVectorStyleLayer
+ +
+
+

An MGLLineStyleLayer is a style layer that renders one or more stroked +polylines on the map.

+ +

Use a line style layer to configure the visual appearance of polyline or +multipolyline features in vector tiles loaded by an MGLVectorSource object or +MGLPolyline, MGLPolylineFeature, MGLMultiPolyline, or +MGLMultiPolylineFeature instances in an MGLShapeSource object.

+ +

You can access an existing line style layer using the +-[MGLStyle layerWithIdentifier:] method if you know its identifier; +otherwise, find it using the MGLStyle.layers property. You can also create a +new line style layer and add it to the style using a method such as +-[MGLStyle addLayer:].

+ +

Example

+
let layer = MGLLineStyleLayer(identifier: trails-path, source: trails)
+layer.sourceLayerIdentifier = trails
+layer.lineWidth = MGLStyleValue(interpolationBase: 1.5, stops: [
+    14: MGLStyleValue(rawValue: 2),
+    18: MGLStyleValue(rawValue: 20),
+])
+layer.lineColor = MGLStyleValue(rawValue: .brown)
+layer.lineCap = MGLStyleValue(rawValue: NSValue(mglLineCap: .round))
+layer.predicate = NSPredicate(format: %K == %@, trail-type, mountain-biking)
+mapView.style?.addLayer(layer)
+

+ +
+
+ +
+
+
+
+ + + +

Accessing the Layout Attributes

+ +
+
    +
  • +
    + + + + lineCap + +
    +
    +
    +
    +

    The display of line endings.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing MGLLineCapButt. Set this property to nil to +reset it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *lineCap;
    + +
    +
    +

    Swift

    + 
    var lineCap: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + lineJoin + +
    +
    +
    +
    +

    The display of lines when joining.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing MGLLineJoinMiter. Set this property to nil to +reset it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *lineJoin;
    + +
    +
    +

    Swift

    + 
    var lineJoin: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + lineMiterLimit + +
    +
    +
    +
    +

    Used to automatically convert miter joins to bevel joins for sharp angles.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 2. Set this property to nil to reset +it to the default value.

    + +

    This property is only applied to the style if lineJoin is set to an +MGLStyleValue object containing an NSValue object containing +MGLLineJoinMiter. Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *lineMiterLimit;
    + +
    +
    +

    Swift

    + 
    var lineMiterLimit: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + lineRoundLimit + +
    +
    +
    +
    +

    Used to automatically convert round joins to miter joins for shallow angles.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 1.05. Set this property to nil to +reset it to the default value.

    + +

    This property is only applied to the style if lineJoin is set to an +MGLStyleValue object containing an NSValue object containing +MGLLineJoinRound. Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *lineRoundLimit;
    + +
    +
    +

    Swift

    + 
    var lineRoundLimit: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Accessing the Paint Attributes

+ +
+
    +
  • +
    + + + + lineBlur + +
    +
    +
    +
    +

    Blur applied to the line, in points.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 0. Set this property to nil to reset +it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *lineBlur;
    + +
    +
    +

    Swift

    + 
    var lineBlur: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + lineColor + +
    +
    +
    +
    +

    The color with which the line will be drawn.

    + +

    The default value of this property is an MGLStyleValue object containing +NSColor.blackColor. Set this property to nil to reset it to the default +value.

    + +

    This property is only applied to the style if linePattern is set to nil. +Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSColor *> *lineColor;
    + +
    +
    +

    Swift

    + 
    var lineColor: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + lineDashPattern + +
    +
    +
    +
    +

    Specifies the lengths of the alternating dashes and gaps that form the dash +pattern. The lengths are later scaled by the line width. To convert a dash +length to points, multiply the length by the current line width.

    + +

    This property is measured in line widths.

    + +

    This property is only applied to the style if linePattern is set to nil. +Otherwise, it is ignored.

    + +

    This attribute corresponds to the line-dasharray +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSArray<NSNumber *> *> *lineDashPattern;
    + +
    +
    +

    Swift

    + 
    var lineDashPattern: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + lineGapWidth + +
    +
    +
    +
    +

    Draws a line casing outside of a line’s actual path. Value indicates the width +of the inner gap.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 0. Set this property to nil to reset +it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *lineGapWidth;
    + +
    +
    +

    Swift

    + 
    var lineGapWidth: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + lineOffset + +
    +
    +
    +
    +

    The line’s offset. For linear features, a positive value offsets the line to +the right, relative to the direction of the line, and a negative value to the +left. For polygon features, a positive value results in an inset, and a +negative value results in an outset.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 0. Set this property to nil to reset +it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *lineOffset;
    + +
    +
    +

    Swift

    + 
    var lineOffset: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + lineOpacity + +
    +
    +
    +
    +

    The opacity at which the line will be drawn.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 1. Set this property to nil to reset +it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *lineOpacity;
    + +
    +
    +

    Swift

    + 
    var lineOpacity: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + linePattern + +
    +
    +
    +
    +

    Name of image in style images to use for drawing image lines. For seamless +patterns, image width must be a factor of two (2, 4, 8, …, 512).

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSString *> *linePattern;
    + +
    +
    +

    Swift

    + 
    var linePattern: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + lineTranslation + +
    +
    +
    +
    +

    The geometry’s offset.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing a CGVector struct set to 0 points rightward and 0 +points upward. Set this property to nil to reset it to the default value.

    + +

    This attribute corresponds to the line-translate +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *lineTranslation;
    + +
    +
    +

    Swift

    + 
    var lineTranslation: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + lineTranslationAnchor + +
    +
    +
    +
    +

    Controls the translation reference point.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing MGLLineTranslationAnchorMap. Set this property to +nil to reset it to the default value.

    + +

    This property is only applied to the style if lineTranslation is non-nil. +Otherwise, it is ignored.

    + +

    This attribute corresponds to the line-translate-anchor +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *lineTranslationAnchor;
    + +
    +
    +

    Swift

    + 
    var lineTranslationAnchor: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + lineWidth + +
    +
    +
    +
    +

    Stroke thickness.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 1. Set this property to nil to reset +it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *lineWidth;
    + +
    +
    +

    Swift

    + 
    var lineWidth: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLMapCamera.html b/macos/0.3.0-rc.1/Classes/MGLMapCamera.html new file mode 100644 index 0000000000..13bef73542 --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLMapCamera.html @@ -0,0 +1,920 @@ + + + + MGLMapCamera Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLMapCamera Class Reference +
+
+ +
+ +
+ +
+
+

MGLMapCamera

 +
+
+ 
@interface MGLMapCamera : NSObject <NSSecureCoding, NSCopying>
+ +
+
+

An MGLMapCamera object represents a viewpoint from which the user observes +some point on an MGLMapView.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + centerCoordinate + +
    +
    +
    +
    +

    Coordinate at the center of the map view.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) CLLocationCoordinate2D centerCoordinate;
    + +
    +
    +

    Swift

    + 
    var centerCoordinate: CLLocationCoordinate2D { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + heading + +
    +
    +
    +
    +

    Heading measured in degrees clockwise from true north.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) CLLocationDirection heading;
    + +
    +
    +

    Swift

    + 
    var heading: CLLocationDirection { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + pitch + +
    +
    +
    +
    +

    Pitch toward the horizon measured in degrees, with 0 degrees resulting in a +two-dimensional map.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) CGFloat pitch;
    + +
    +
    +

    Swift

    + 
    var pitch: CGFloat { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + altitude + +
    +
    +
    +
    +

    Meters above ground level.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) CLLocationDistance altitude;
    + +
    +
    +

    Swift

    + 
    var altitude: CLLocationDistance { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + +camera + +
    +
    +
    +
    +

    Returns a new camera with all properties set to 0.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)camera;
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns a new camera using based on information about the camera’s viewpoint +and focus point.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)
+cameraLookingAtCenterCoordinate:(CLLocationCoordinate2D)centerCoordinate
+              fromEyeCoordinate:(CLLocationCoordinate2D)eyeCoordinate
+                    eyeAltitude:(CLLocationDistance)eyeAltitude;
    + +
    +
    +

    Swift

    + 
    convenience init(lookingAtCenter centerCoordinate: CLLocationCoordinate2D, fromEyeCoordinate eyeCoordinate: CLLocationCoordinate2D, eyeAltitude: CLLocationDistance)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + centerCoordinate + + +
    +

    The geographic coordinate on which the map should be + centered.

    + +
    +
    + + eyeCoordinate + + +
    +

    The geometric coordinate at which the camera should be + situated.

    + +
    +
    + + eyeAltitude + + +
    +

    The altitude (measured in meters) above the map at which the + camera should be situated. The altitude may be less than the distance from + the camera’s viewpoint to the camera’s focus point.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns a new camera with the given distance, pitch, and heading.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)
+cameraLookingAtCenterCoordinate:(CLLocationCoordinate2D)centerCoordinate
+                   fromDistance:(CLLocationDistance)distance
+                          pitch:(CGFloat)pitch
+                        heading:(CLLocationDirection)heading;
    + +
    +
    +

    Swift

    + 
    convenience init(lookingAtCenter centerCoordinate: CLLocationCoordinate2D, fromDistance distance: CLLocationDistance, pitch: CGFloat, heading: CLLocationDirection)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + centerCoordinate + + +
    +

    The geographic coordinate on which the map should be + centered.

    + +
    +
    + + distance + + +
    +

    The straight-line distance from the viewpoint to the + centerCoordinate.

    + +
    +
    + + pitch + + +
    +

    The viewing angle of the camera, measured in degrees. A value of + 0 results in a camera pointed straight down at the map. Angles greater + than 0 result in a camera angled toward the horizon.

    + +
    +
    + + heading + + +
    +

    The camera’s heading, measured in degrees clockwise from true + north. A value of 0 means that the top edge of the map view corresponds to + true north. The value 90 means the top of the map is pointing due east. + The value 180 means the top of the map points due south, and so on.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLMapView.html b/macos/0.3.0-rc.1/Classes/MGLMapView.html new file mode 100644 index 0000000000..2802ff663b --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLMapView.html @@ -0,0 +1,4792 @@ + + + + MGLMapView Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLMapView Class Reference +
+
+ +
+ +
+ +
+
+

MGLMapView

 +
+
+ 
@interface MGLMapView : NSView
+ +
+
+

An interactive, customizable map view with an interface similar to the one +provided by Apple’s MapKit.

+ +

Using MGLMapView, you can embed the map inside a view, allow users to +manipulate it with standard gestures, animate the map between different +viewpoints, and present information in the form of annotations and overlays.

+ +

The map view loads scalable vector tiles that conform to the +Mapbox Vector Tile Specification. +It styles them with a style that conforms to the +Mapbox Style Specification. +Such styles can be designed in +Mapbox Studio and hosted on +mapbox.com.

+ +

A collection of Mapbox-hosted styles is available through the MGLStyle class. +These basic styles use +Mapbox Streets +or Mapbox Satellite data +sources, but you can specify a custom style that makes use of your own data.

+ +

Mapbox-hosted vector tiles and styles require an API access token, which you +can obtain from the +Mapbox account page. +Access tokens associate requests to Mapbox’s vector tile and style APIs with +your Mapbox account. They also deter other developers from using your styles +without your permission.

+ +
+

Note

+ You are responsible for getting permission to use the map data and for +ensuring that your use adheres to the relevant terms of use. + +
+ +
+
+ +
+
+
+
+ + + +

Creating Instances

+ +
+
    +
  • +
    + + + + -initWithFrame: + +
    +
    +
    +
    +

    Initializes and returns a newly allocated map view with the specified frame and +the default style.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithFrame:(NSRect)frame;
    + +
    +
    +

    Swift

    + 
    init(frame: NSRect)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + frame + + +
    +

    The frame for the view, measured in points.

    + +
    +
    +
    +
    +

    Return Value

    +

    An initialized map view.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Initializes and returns a newly allocated map view with the specified frame and +style URL.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithFrame:(NSRect)frame
+                             styleURL:(nullable NSURL *)styleURL;
    + +
    +
    +

    Swift

    + 
    init(frame: NSRect, styleURL: URL?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + frame + + +
    +

    The frame for the view, measured in points.

    + +
    +
    + + styleURL + + +
    +

    URL of the map style to display. The URL may be a full HTTP or + HTTPS URL, a Mapbox URL indicating the style’s map ID + (`mapbox://styles/ +<user

    + +
    +

    / +<style +), or a path to a local file relative to + the application’s resource path. Specifynil` for the default style.

    +
    + +
    +
    +
    +
    +

    Return Value

    +

    An initialized map view.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Accessing the Delegate

+ +
+
    +
  • +
    + + + + delegate + +
    +
    +
    +
    +

    The receiver’s delegate.

    + +

    A map view sends messages to its delegate to notify it of changes to its +contents or the viewpoint. The delegate also provides information about +annotations displayed on the map, such as the styles to apply to individual +annotations.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readwrite, nonatomic, nullable) id<MGLMapViewDelegate> delegate;
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Configuring the Map’s Appearance

+ +
+
    +
  • +
    + + + + style + +
    +
    +
    +
    +

    The style currently displayed in the receiver.

    + +

    Unlike the styleURL property, this property is set to an object that allows +you to manipulate every aspect of the style locally.

    + +

    If the style is loading, this property is set to nil until the style finishes +loading. If the style has failed to load, this property is set to nil. +Because the style loads asynchronously, you should manipulate it in the +-[MGLMapViewDelegate mapView:didFinishLoadingStyle:] or +-[MGLMapViewDelegate mapViewDidFinishLoadingMap:] method. It is not possible +to manipulate the style before it has finished loading.

    + +
    +

    Note

    + The default styles provided by Mapbox contain sources and layers with +identifiers that will change over time. Applications that use APIs that +manipulate a style’s sources and layers must first set the style URL to an +explicitly versioned style using a convenience method like ++[MGLStyle outdoorsStyleURLWithVersion:], MGLMapView’s “Style URL” +inspectable in Interface Builder, or a manually constructed NSURL. + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic, nullable) MGLStyle *style;
    + +
    +
    +

    Swift

    + 
    var style: MGLStyle? { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + styleURL + +
    +
    +
    +
    +

    URL of the style currently displayed in the receiver.

    + +

    The URL may be a full HTTP or HTTPS URL, a Mapbox URL indicating the style’s +map ID (mapbox://styles/<user>/<style>), or a path to a local file relative +to the application’s resource path.

    + +

    If you set this property to nil, the receiver will use the default style and +this property will automatically be set to that style’s URL.

    + +

    If you want to modify the current style without replacing it outright, or if +you want to introspect individual style attributes, use the style property.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable) NSURL *styleURL;
    + +
    +
    +

    Swift

    + 
    var styleURL: URL! { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -reloadStyle: + +
    +
    +
    +
    +

    Reloads the style.

    + +

    You do not normally need to call this method. The map view automatically +responds to changes in network connectivity by reloading the style. You may +need to call this method if you change the access token after a style has +loaded but before loading a style associated with a different Mapbox account.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)reloadStyle:(nonnull id)sender;
    + +
    +
    +

    Swift

    + 
    @IBAction func reloadStyle(_ sender: Any)
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + zoomControls + +
    +
    +
    +
    +

    A control for zooming in and out, positioned in the lower-right corner.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) NSSegmentedControl *_Nonnull zoomControls;
    + +
    +
    +

    Swift

    + 
    var zoomControls: NSSegmentedControl { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + compass + +
    +
    +
    +
    +

    A control indicating the map’s direction and allowing the user to manipulate +the direction, positioned above the zoom controls in the lower-right corner.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) NSSlider *_Nonnull compass;
    + +
    +
    +

    Swift

    + 
    var compass: NSSlider { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + logoView + +
    +
    +
    +
    +

    The Mapbox logo, positioned in the lower-left corner.

    + +
    +

    Note

    + The Mapbox terms of service, which governs the use of Mapbox-hosted +vector tiles and styles, +requires most Mapbox +customers to display the Mapbox logo. If this applies to you, do not hide +this view or change its contents. + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) NSImageView *_Nonnull logoView;
    + +
    +
    +

    Swift

    + 
    var logoView: NSImageView { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + attributionView + +
    +
    +
    +
    +

    A view showing legally required copyright notices, positioned along the bottom +of the map view, to the left of the Mapbox logo.

    + +
    +

    Note

    + The Mapbox terms of service, which governs the use of Mapbox-hosted +vector tiles and styles, +requires these +copyright notices to accompany any map that features Mapbox-designed styles, +OpenStreetMap data, or other Mapbox data such as satellite or terrain data. +If that applies to this map view, do not hide this view or remove any +notices from it. + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) NSView *_Nonnull attributionView;
    + +
    +
    +

    Swift

    + 
    var attributionView: NSView { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Manipulating the Viewpoint

+ +
+
    +
  • +
    + + + + centerCoordinate + +
    +
    +
    +
    +

    The geographic coordinate at the center of the map view.

    + +

    Changing the value of this property centers the map on the new coordinate +without changing the current zoom level.

    + +

    Changing the value of this property updates the map view immediately. If you +want to animate the change, use the -setCenterCoordinate:animated: method +instead.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) CLLocationCoordinate2D centerCoordinate;
    + +
    +
    +

    Swift

    + 
    var centerCoordinate: CLLocationCoordinate2D { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Changes the center coordinate of the map and optionally animates the change.

    + +

    Changing the center coordinate centers the map on the new coordinate without +changing the current zoom level.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)setCenterCoordinate:(CLLocationCoordinate2D)coordinate
+                   animated:(BOOL)animated;
    + +
    +
    +

    Swift

    + 
    func setCenter(_ coordinate: CLLocationCoordinate2D, animated: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + coordinate + + +
    +

    The new center coordinate for the map.

    + +
    +
    + + animated + + +
    +

    Specify YES if you want the map view to scroll to the new + location or NO if you want the map to display the new location + immediately.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + zoomLevel + +
    +
    +
    +
    +

    The zoom level of the receiver.

    + +

    In addition to affecting the visual size and detail of features on the map, the +zoom level affects the size of the vector tiles that are loaded. At zoom level +0, each tile covers the entire world map; at zoom level 1, it covers ¼ of the +world; at zoom level 2, 1⁄16 of the world, and so on.

    + +

    Changing the value of this property updates the map view immediately. If you +want to animate the change, use the -setZoomLevel:animated: method instead.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) double zoomLevel;
    + +
    +
    +

    Swift

    + 
    var zoomLevel: Double { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + minimumZoomLevel + +
    +
    +
    +
    +

    The minimum zoom level at which the map can be shown.

    + +

    Depending on the map view’s aspect ratio, the map view may be prevented from +reaching the minimum zoom level, in order to keep the map from repeating within +the current viewport.

    + +

    If the value of this property is greater than that of the maximumZoomLevel +property, the behavior is undefined.

    + +

    The default value of this property is 0.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) double minimumZoomLevel;
    + +
    +
    +

    Swift

    + 
    var minimumZoomLevel: Double { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + maximumZoomLevel + +
    +
    +
    +
    +

    The maximum zoom level the map can be shown at.

    + +

    If the value of this property is smaller than that of the minimumZoomLevel +property, the behavior is undefined.

    + +

    The default value of this property is 20.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) double maximumZoomLevel;
    + +
    +
    +

    Swift

    + 
    var maximumZoomLevel: Double { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Changes the zoom level of the map and optionally animates the change.

    + +

    Changing the zoom level scales the map without changing the current center +coordinate.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)setZoomLevel:(double)zoomLevel animated:(BOOL)animated;
    + +
    +
    +

    Swift

    + 
    func setZoomLevel(_ zoomLevel: Double, animated: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + zoomLevel + + +
    +

    The new zoom level for the map.

    + +
    +
    + + animated + + +
    +

    Specify YES if you want the map view to animate the change + to the new zoom level or NO if you want the map to display the new zoom + level immediately.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + direction + +
    +
    +
    +
    +

    The heading of the map, measured in degrees clockwise from true north.

    + +

    The value 0 means that the top edge of the map view corresponds to true +north. The value 90 means the top of the map is pointing due east. The value +180 means the top of the map points due south, and so on.

    + +

    Changing the value of this property updates the map view immediately. If you +want to animate the change, use the -setDirection:animated: method instead.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) CLLocationDirection direction;
    + +
    +
    +

    Swift

    + 
    var direction: CLLocationDirection { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Changes the heading of the map and optionally animates the change.

    + +

    Changing the heading rotates the map without changing the current center +coordinate or zoom level.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)setDirection:(CLLocationDirection)direction animated:(BOOL)animated;
    + +
    +
    +

    Swift

    + 
    func setDirection(_ direction: CLLocationDirection, animated: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + direction + + +
    +

    The heading of the map, measured in degrees clockwise from + true north.

    + +
    +
    + + animated + + +
    +

    Specify YES if you want the map view to animate the change + to the new heading or NO if you want the map to display the new heading + immediately.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + camera + +
    +
    +
    +
    +

    A camera representing the current viewpoint of the map.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readwrite, copy, nonatomic) MGLMapCamera *_Nonnull camera;
    + +
    +
    +

    Swift

    + 
    @NSCopying var camera: MGLMapCamera { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -setCamera:animated: + +
    +
    +
    +
    +

    Moves the viewpoint to a different location with respect to the map with an +optional transition animation.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)setCamera:(nonnull MGLMapCamera *)camera animated:(BOOL)animated;
    + +
    +
    +

    Swift

    + 
    func setCamera(_ camera: MGLMapCamera, animated: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + camera + + +
    +

    The new viewpoint.

    + +
    +
    + + animated + + +
    +

    Specify YES if you want the map view to animate the change to + the new viewpoint or NO if you want the map to display the new viewpoint + immediately.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Moves the viewpoint to a different location with respect to the map with an +optional transition duration and timing function.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)setCamera:(nonnull MGLMapCamera *)camera
+               withDuration:(NSTimeInterval)duration
+    animationTimingFunction:(nullable CAMediaTimingFunction *)function
+          completionHandler:(nullable void (^)(void))completion;
    + +
    +
    +

    Swift

    + 
    func setCamera(_ camera: MGLMapCamera, withDuration duration: TimeInterval, animationTimingFunction function: CAMediaTimingFunction?, completionHandler completion: (() -> Void)? = nil)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + camera + + +
    +

    The new viewpoint.

    + +
    +
    + + duration + + +
    +

    The amount of time, measured in seconds, that the transition + animation should take. Specify 0 to jump to the new viewpoint + instantaneously.

    + +
    +
    + + function + + +
    +

    A timing function used for the animation. Set this parameter to + nil for a transition that matches most system animations. If the duration + is 0, this parameter is ignored.

    + +
    +
    + + completion + + +
    +

    The block to execute after the animation finishes.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Moves the viewpoint to a different location using a transition animation that +evokes powered flight and a default duration based on the length of the flight +path.

    + +

    The transition animation seamlessly incorporates zooming and panning to help +the user find his or her bearings even after traversing a great distance.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)flyToCamera:(nonnull MGLMapCamera *)camera
+    completionHandler:(nullable void (^)(void))completion;
    + +
    +
    +

    Swift

    + 
    func fly(to camera: MGLMapCamera, completionHandler completion: (() -> Void)? = nil)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + camera + + +
    +

    The new viewpoint.

    + +
    +
    + + completion + + +
    +

    The block to execute after the animation finishes.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Moves the viewpoint to a different location using a transition animation that +evokes powered flight and an optional transition duration.

    + +

    The transition animation seamlessly incorporates zooming and panning to help +the user find his or her bearings even after traversing a great distance.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)flyToCamera:(nonnull MGLMapCamera *)camera
+         withDuration:(NSTimeInterval)duration
+    completionHandler:(nullable void (^)(void))completion;
    + +
    +
    +

    Swift

    + 
    func fly(to camera: MGLMapCamera, withDuration duration: TimeInterval, completionHandler completion: (() -> Void)? = nil)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + camera + + +
    +

    The new viewpoint.

    + +
    +
    + + duration + + +
    +

    The amount of time, measured in seconds, that the transition + animation should take. Specify 0 to jump to the new viewpoint + instantaneously. Specify a negative value to use the default duration, which + is based on the length of the flight path.

    + +
    +
    + + completion + + +
    +

    The block to execute after the animation finishes.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Moves the viewpoint to a different location using a transition animation that +evokes powered flight and an optional transition duration and peak altitude.

    + +

    The transition animation seamlessly incorporates zooming and panning to help +the user find his or her bearings even after traversing a great distance.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)flyToCamera:(nonnull MGLMapCamera *)camera
+         withDuration:(NSTimeInterval)duration
+         peakAltitude:(CLLocationDistance)peakAltitude
+    completionHandler:(nullable void (^)(void))completion;
    + +
    +
    +

    Swift

    + 
    func fly(to camera: MGLMapCamera, withDuration duration: TimeInterval, peakAltitude: CLLocationDistance, completionHandler completion: (() -> Void)? = nil)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + camera + + +
    +

    The new viewpoint.

    + +
    +
    + + duration + + +
    +

    The amount of time, measured in seconds, that the transition + animation should take. Specify 0 to jump to the new viewpoint + instantaneously. Specify a negative value to use the default duration, which + is based on the length of the flight path.

    + +
    +
    + + peakAltitude + + +
    +

    The altitude, measured in meters, at the midpoint of the + animation. The value of this parameter is ignored if it is negative or if + the animation transition resulting from a similar call to + -setCamera:animated: would have a midpoint at a higher altitude.

    + +
    +
    + + completion + + +
    +

    The block to execute after the animation finishes.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    The geographic coordinate bounds visible in the receiver’s viewport.

    + +

    Changing the value of this property updates the receiver immediately. If you +want to animate the change, use the -setVisibleCoordinateBounds:animated: +method instead.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic)
+    MGLCoordinateBounds visibleCoordinateBounds;
    + +
    +
    +

    Swift

    + 
    var visibleCoordinateBounds: Int32 { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Changes the receiver’s viewport to fit the given coordinate bounds, optionally +animating the change.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)setVisibleCoordinateBounds:(MGLCoordinateBounds)bounds
+                          animated:(BOOL)animated;
    + +
    +
    +

    Swift

    + 
    func setVisibleCoordinateBounds(_ bounds: Any!, animated: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + bounds + + +
    +

    The bounds that the viewport will show in its entirety.

    + +
    +
    + + animated + + +
    +

    Specify YES to animate the change by smoothly scrolling and + zooming or NO to immediately display the given bounds.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Changes the receiver’s viewport to fit the given coordinate bounds and +optionally some additional padding on each side.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)setVisibleCoordinateBounds:(MGLCoordinateBounds)bounds
+                       edgePadding:(NSEdgeInsets)insets
+                          animated:(BOOL)animated;
    + +
    +
    +

    Swift

    + 
    func setVisibleCoordinateBounds(_ bounds: Any!, edgePadding insets: EdgeInsets, animated: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + bounds + + +
    +

    The bounds that the viewport will show in its entirety.

    + +
    +
    + + insets + + +
    +

    The minimum padding (in screen points) that will be visible + around the given coordinate bounds.

    + +
    +
    + + animated + + +
    +

    Specify YES to animate the change by smoothly scrolling and + zooming or NO to immediately display the given bounds.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Sets the visible region so that the map displays the specified annotations.

    + +

    Calling this method updates the value in the visibleCoordinateBounds property +and potentially other properties to reflect the new map region. A small amount +of padding is reserved around the edges of the map view. To specify a different +amount of padding, use the -showAnnotations:edgePadding:animated: method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)showAnnotations:(nonnull NSArray<id<MGLAnnotation>> *)annotations
+               animated:(BOOL)animated;
    + +
    +
    +

    Swift

    + 
    func showAnnotations(_ annotations: Any!, animated: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + annotations + + +
    +

    The annotations that you want to be visible in the map.

    + +
    +
    + + animated + + +
    +

    YES if you want the map region change to be animated, or NO +if you want the map to display the new region immediately without animations.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Sets the visible region so that the map displays the specified annotations with +the specified amount of padding on each side.

    + +

    Calling this method updates the value in the visibleCoordinateBounds property +and potentially other properties to reflect the new map region.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)showAnnotations:(nonnull NSArray<id<MGLAnnotation>> *)annotations
+            edgePadding:(NSEdgeInsets)insets
+               animated:(BOOL)animated;
    + +
    +
    +

    Swift

    + 
    func showAnnotations(_ annotations: Any!, edgePadding insets: EdgeInsets, animated: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + annotations + + +
    +

    The annotations that you want to be visible in the map.

    + +
    +
    + + insets + + +
    +

    The minimum padding (in screen points) around the edges of the +map view to keep clear of annotations.

    + +
    +
    + + animated + + +
    +

    YES if you want the map region change to be animated, or NO +if you want the map to display the new region immediately without animations.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns the camera that best fits the given coordinate bounds.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull MGLMapCamera *)cameraThatFitsCoordinateBounds:
+    (MGLCoordinateBounds)bounds;
    + +
    +
    +

    Swift

    + 
    func cameraThatFitsCoordinateBounds(_ bounds: Any!) -> MGLMapCamera
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + bounds + + +
    +

    The coordinate bounds to fit to the receiver’s viewport.

    + +
    +
    +
    +
    +

    Return Value

    +

    A camera object centered on the same location as the coordinate bounds + with zoom level as high (close to the ground) as possible while still + including the entire coordinate bounds. The camera object uses the current + direction and pitch.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns the camera that best fits the given coordinate bounds, optionally with +some additional padding on each side.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull MGLMapCamera *)cameraThatFitsCoordinateBounds:
+                              (MGLCoordinateBounds)bounds
+                                             edgePadding:(NSEdgeInsets)insets;
    + +
    +
    +

    Swift

    + 
    func cameraThatFitsCoordinateBounds(_ bounds: Any!, edgePadding insets: EdgeInsets) -> MGLMapCamera
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + bounds + + +
    +

    The coordinate bounds to fit to the receiver’s viewport.

    + +
    +
    + + insets + + +
    +

    The minimum padding (in screen points) that would be visible + around the returned camera object if it were set as the receiver’s camera.

    + +
    +
    +
    +
    +

    Return Value

    +

    A camera object centered on the same location as the coordinate bounds + with zoom level as high (close to the ground) as possible while still + including the entire coordinate bounds. The camera object uses the current + direction and pitch.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    A Boolean value indicating whether the receiver automatically adjusts its +content insets.

    + +

    When the value of this property is YES, the map view automatically updates +its contentInsets property to account for any overlapping title bar or +toolbar. To overlap with the title bar or toolbar, the containing window’s +style mask must have NSFullSizeContentViewWindowMask set, and the title bar +must not be transparent.

    + +

    The default value of this property is YES.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) BOOL automaticallyAdjustsContentInsets;
    + +
    +
    +

    Swift

    + 
    var automaticallyAdjustsContentInsets: Bool { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + contentInsets + +
    +
    +
    +
    +

    The distance from the edges of the map view’s frame to the edges of the map +view’s logical viewport.

    + +

    When the value of this property is equal to NSEdgeInsetsZero, viewport +properties such as centerCoordinate assume a viewport that matches the map +view’s frame. Otherwise, those properties are inset, excluding part of the +frame from the viewport. For instance, if the only the top edge is inset, the +map center is effectively shifted downward.

    + +

    When the value of the automaticallyAdjustsContentInsets property is YES, +the value of this property may be overridden at any time.

    + +

    Changing the value of this property updates the map view immediately. If you +want to animate the change, use the -setContentInsets:animated: method +instead.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) NSEdgeInsets contentInsets;
    + +
    +
    +

    Swift

    + 
    var contentInsets: EdgeInsets { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Sets the distance from the edges of the map view’s frame to the edges of the +map view’s logical viewport, with an optional transition animation.

    + +

    When the value of this property is equal to NSEdgeInsetsZero, viewport +properties such as centerCoordinate assume a viewport that matches the map +view’s frame. Otherwise, those properties are inset, excluding part of the +frame from the viewport. For instance, if the only the top edge is inset, the +map center is effectively shifted downward.

    + +

    When the value of the automaticallyAdjustsContentInsets property is YES, +the value of this property may be overridden at any time.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)setContentInsets:(NSEdgeInsets)contentInsets animated:(BOOL)animated;
    + +
    +
    +

    Swift

    + 
    func setContentInsets(_ contentInsets: EdgeInsets, animated: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + contentInsets + + +
    +

    The new values to inset the content by.

    + +
    +
    + + animated + + +
    +

    Specify YES if you want the map view to animate the change to + the content insets or NO if you want the map to inset the content + immediately.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Configuring How the User Interacts with the Map

+ +
+
    +
  • +
    + + + + zoomEnabled + +
    +
    +
    +
    +

    A Boolean value that determines whether the user may zoom the map in and out, +changing the zoom level.

    + +

    When this property is set to YES, the default, the user may zoom the map in +and out by pinching two fingers, by using a scroll wheel on a traditional +mouse, or by dragging the mouse cursor up and down while holding down the Shift +key. When the receiver has focus, the user may also zoom by pressing the up and +down arrow keys while holding down the Option key.

    + +

    This property controls only user interactions with the map. If you set the +value of this property to NO, you may still change the map zoom +programmatically.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (getter=isZoomEnabled, assign, readwrite, nonatomic) BOOL zoomEnabled;
    + +
    +
    +

    Swift

    + 
    var isZoomEnabled: Bool { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + scrollEnabled + +
    +
    +
    +
    +

    A Boolean value that determines whether the user may scroll around the map, +changing the center coordinate.

    + +

    When this property is set to YES, the default, the user may scroll the map by +swiping with two fingers or dragging the mouse cursor. When the receiver has +focus, the user may also scroll around the map by pressing the arrow keys.

    + +

    This property controls only user interactions with the map. If you set the +value of this property to NO, you may still change the map location +programmatically.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (getter=isScrollEnabled, assign, readwrite, nonatomic)
+    BOOL scrollEnabled;
    + +
    +
    +

    Swift

    + 
    var isScrollEnabled: Bool { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + rotateEnabled + +
    +
    +
    +
    +

    A Boolean value that determines whether the user may rotate the map, changing +the direction.

    + +

    When this property is set to YES, the default, the user may rotate the map by +moving two fingers in a circular motion or by dragging the mouse cursor left +and right while holding down the Option key. When the receiver has focus, the +user may also zoom by pressing the left and right arrow keys while holding down +the Option key.

    + +

    This property controls only user interactions with the map. If you set the +value of this property to NO, you may still rotate the map programmatically.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (getter=isRotateEnabled, assign, readwrite, nonatomic)
+    BOOL rotateEnabled;
    + +
    +
    +

    Swift

    + 
    var isRotateEnabled: Bool { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + pitchEnabled + +
    +
    +
    +
    +

    A Boolean value that determines whether the user may tilt of the map, changing +the pitch.

    + +

    When this property is set to YES, the default, the user may rotate the map by +dragging the mouse cursor up and down while holding down the Option key.

    + +

    This property controls only user interactions with the map. If you set the +value of this property to NO, you may still change the pitch of the map +programmatically.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (getter=isPitchEnabled, assign, readwrite, nonatomic)
+    BOOL pitchEnabled;
    + +
    +
    +

    Swift

    + 
    var isPitchEnabled: Bool { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Annotating the Map

+ +
+
    +
  • +
    + + + + annotations + +
    +
    +
    +
    +

    The complete list of annotations associated with the receiver. (read-only)

    + +

    The objects in this array must adopt the MGLAnnotation protocol. If no +annotations are associated with the map view, the value of this property is +nil.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic, nullable)
+    NSArray<id<MGLAnnotation>> *annotations;
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -addAnnotation: + +
    +
    +
    +
    +

    Adds an annotation to the map view.

    + +
    +

    Note

    +

    MGLMultiPolyline, MGLMultiPolygon, and MGLShapeCollection objects +cannot be added to the map view at this time. Nor can MGLMultiPoint +objects that are not instances of MGLPolyline or MGLPolygon. Any +multipoint, multipolyline, multipolygon, or shape collection object that is +specified is silently ignored.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)addAnnotation:(nonnull id<MGLAnnotation>)annotation;
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + annotation + + +
    +

    The annotation object to add to the receiver. This object + must conform to the MGLAnnotation protocol. The map view retains the + annotation object.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -addAnnotations: + +
    +
    +
    +
    +

    Adds an array of annotations to the map view.

    + +
    +

    Note

    +

    MGLMultiPolyline, MGLMultiPolygon, and MGLShapeCollection objects +cannot be added to the map view at this time. Nor can MGLMultiPoint +objects that are not instances of MGLPolyline or MGLPolygon. Any +multipoint, multipolyline, multipolygon, or shape collection objects that +are specified are silently ignored.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)addAnnotations:(nonnull NSArray<id<MGLAnnotation>> *)annotations;
    + +
    +
    +

    Swift

    + 
    func addAnnotations(_ annotations: Any!)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + annotations + + +
    +

    An array of annotation objects. Each object in the array + must conform to the MGLAnnotation protocol. The map view retains each + individual annotation object.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + visibleAnnotations + +
    +
    +
    +
    +

    The complete list of annotations associated with the receiver that are +currently visible.

    + +

    The objects in this array must adopt the MGLAnnotation protocol. If no +annotations are associated with the map view or if no annotations associated +with the map view are currently visible, the value of this property is nil.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic, nullable)
+    NSArray<id<MGLAnnotation>> *visibleAnnotations;
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -removeAnnotation: + +
    +
    +
    +
    +

    Removes an annotation from the map view, deselecting it if it is selected.

    + +

    Removing an annotation object dissociates it from the map view entirely, +preventing it from being displayed on the map. Thus you would typically call +this method only when you want to hide or delete a given annotation.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)removeAnnotation:(nonnull id<MGLAnnotation>)annotation;
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + annotation + + +
    +

    The annotation object to remove. This object must conform to + the MGLAnnotation protocol.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -removeAnnotations: + +
    +
    +
    +
    +

    Removes an array of annotations from the map view, deselecting any selected +annotations in the array.

    + +

    Removing annotation objects dissociates them from the map view entirely, +preventing them from being displayed on the map. Thus you would typically call +this method only when you want to hide or delete the given annotations.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)removeAnnotations:(nonnull NSArray<id<MGLAnnotation>> *)annotations;
    + +
    +
    +

    Swift

    + 
    func removeAnnotations(_ annotations: Any!)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + annotations + + +
    +

    The array of annotation objects to remove. Objects in the + array must conform to the MGLAnnotation protocol.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns a reusable annotation image object associated with its identifier.

    + +

    For performance reasons, you should generally reuse MGLAnnotationImage +objects for identical-looking annotations in your map views. Dequeueing saves +time and memory during performance-critical operations such as scrolling.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nullable MGLAnnotationImage *)dequeueReusableAnnotationImageWithIdentifier:
+    (nonnull NSString *)identifier;
    + +
    +
    +

    Swift

    + 
    func dequeueReusableAnnotationImage(withIdentifier identifier: String) -> MGLAnnotationImage?
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + identifier + + +
    +

    A string identifying the annotation image to be reused. This + string is the same one you specify when initially returning the annotation + image object using the -mapView:imageForAnnotation: method.

    + +
    +
    +
    +
    +

    Return Value

    +

    An annotation image object with the given identifier, or nil if no + such object exists in the reuse queue.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns the list of annotations associated with the receiver that intersect with +the given rectangle.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nullable NSArray<id<MGLAnnotation>> *)visibleAnnotationsInRect:(CGRect)rect;
    + +
    +
    +

    Swift

    + 
    func visibleAnnotations(in rect: CGRect) -> Any!
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + rect + + +
    +

    A rectangle expressed in the map view’s coordinate system.

    + +
    +
    +
    +
    +

    Return Value

    +

    An array of objects that adopt the MGLAnnotation protocol or nil if +no annotations associated with the map view are currently visible in the +rectangle.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Managing Annotation Selections

+ +
+
    +
  • +
    + + + + selectedAnnotations + +
    +
    +
    +
    +

    The currently selected annotations.

    + +

    Assigning a new array to this property selects only the first annotation in the +array.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readwrite, copy, nonatomic)
+    NSArray<id<MGLAnnotation>> *_Nonnull selectedAnnotations;
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -selectAnnotation: + +
    +
    +
    +
    +

    Selects an annotation and displays a callout popover for it.

    + +

    If the given annotation is not visible within the current viewport, this method +has no effect.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)selectAnnotation:(nonnull id<MGLAnnotation>)annotation;
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + annotation + + +
    +

    The annotation object to select.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -deselectAnnotation: + +
    +
    +
    +
    +

    Deselects an annotation and hides its callout popover.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)deselectAnnotation:(nullable id<MGLAnnotation>)annotation;
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + annotation + + +
    +

    The annotation object to deselect.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + calloutViewController + +
    +
    +
    +
    +

    A common view controller for managing a callout popover’s content view.

    + +

    Like any instance of NSPopover, an annotation callout manages its contents +with a view controller. The annotation object is the view controller’s +represented object. This means that you can bind controls in the view +controller’s content view to KVO-compliant properties of the annotation object, +such as title and subtitle.

    + +

    This property defines a common view controller that is used for every +annotation’s callout view. If you set this property to nil, a default view +controller will be used that manages a simple title label and subtitle label. +If you need distinct view controllers for different annotations, the map view’s +delegate should implement -mapView:calloutViewControllerForAnnotation: +instead.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readwrite, strong, nonatomic, null_resettable)
+    NSViewController *calloutViewController;
    + +
    +
    +

    Swift

    + 
    @IBOutlet var calloutViewController: NSViewController! { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Finding Annotations

+ +
+
    +
  • +
    + + + + -annotationAtPoint: + +
    +
    +
    +
    +

    Returns a point annotation located at the given point.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull id<MGLAnnotation>)annotationAtPoint:(NSPoint)point;
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + point + + +
    +

    A point in the view’s coordinate system.

    + +
    +
    +
    +
    +

    Return Value

    +

    A point annotation whose annotation image coincides with the point. If + multiple point annotations coincide with the point, the return value is the + annotation that would be selected if the user clicks at this point.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Overlaying the Map

+ +
+
    +
  • +
    + + + + -addOverlay: + +
    +
    +
    +
    +

    Adds a single overlay to the map.

    + +

    To remove an overlay from a map, use the -removeOverlay: method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)addOverlay:(nonnull id<MGLOverlay>)overlay;
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + overlay + + +
    +

    The overlay object to add. This object must conform to the + MGLOverlay protocol.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -addOverlays: + +
    +
    +
    +
    +

    Adds an array of overlays to the map.

    + +

    To remove multiple overlays from a map, use the -removeOverlays: method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)addOverlays:(nonnull NSArray<id<MGLOverlay>> *)overlays;
    + +
    +
    +

    Swift

    + 
    func addOverlays(_ overlays: Any!)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + overlays + + +
    +

    An array of objects, each of which must conform to the + MGLOverlay protocol.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -removeOverlay: + +
    +
    +
    +
    +

    Removes a single overlay from the map.

    + +

    If the specified overlay is not currently associated with the map view, this +method does nothing.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)removeOverlay:(nonnull id<MGLOverlay>)overlay;
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + overlay + + +
    +

    The overlay object to remove.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -removeOverlays: + +
    +
    +
    +
    +

    Removes an array of overlays from the map.

    + +

    If a given overlay object is not associated with the map view, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)removeOverlays:(nonnull NSArray<id<MGLOverlay>> *)overlays;
    + +
    +
    +

    Swift

    + 
    func removeOverlays(_ overlays: Any!)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + overlays + + +
    +

    An array of objects, each of which conforms to the MGLOverlay + protocol.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Accessing the Underlying Map Data

+ +
+
    +
  • + +
    +
    +
    +

    Returns an array of rendered map features that intersect with a given point.

    + +

    This method may return features from any of the map’s style layers. To restrict +the search to a particular layer or layers, use the +-visibleFeaturesAtPoint:inStyleLayersWithIdentifiers: method. For more +information about searching for map features, see that method’s documentation.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull NSArray<id<MGLFeature>> *)visibleFeaturesAtPoint:(NSPoint)point;
    + +
    +
    +

    Swift

    + 
    func visibleFeatures(_ point: NSPoint) -> Any!
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + point + + +
    +

    A point expressed in the map view’s coordinate system.

    + +
    +
    +
    +
    +

    Return Value

    +

    An array of objects conforming to the MGLFeature protocol that + represent features in the sources used by the current style.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns an array of rendered map features that intersect with a given point, +restricted to the given style layers.

    + +

    Each object in the returned array represents a feature rendered by the +current style and provides access to attributes specified by the relevant +tile sources. +The returned array includes features specified in vector and GeoJSON tile +sources but does not include anything from raster, image, or video sources.

    + +

    Only visible features are returned. For example, suppose the current style uses +the +Mapbox Streets source, +but none of the specified style layers includes features that have the maki +property set to bus. If you pass a point corresponding to the location of a +bus stop into this method, the bus stop feature does not appear in the +resulting array. On the other hand, if the style does include bus stops, an +MGLFeature object representing that bus stop is returned and its +attributes dictionary has the maki key set to bus (along with other +attributes). The dictionary contains only the attributes provided by the +tile source; it does not include computed attribute values or rules about how +the feature is rendered by the current style.

    + +

    The returned array is sorted by z-order, starting with the topmost rendered +feature and ending with the bottommost rendered feature. A feature that is +rendered multiple times due to wrapping across the antimeridian at low zoom +levels is included only once, subject to the caveat that follows.

    + +

    Features come from tiled vector data or GeoJSON data that is converted to tiles +internally, so feature geometries are clipped at tile boundaries and features +may appear duplicated across tiles. For example, suppose the specified point +lies along a road that spans the screen. The resulting array includes those +parts of the road that lie within the map tile that contain the specified +point, even if the road extends into other tiles.

    + +

    To find out the layer names in a particular style, view the style in +Mapbox Studio.

    + +
    +

    Note

    +

    Layer identifiers are not guaranteed to exist across styles or different +versions of the same style. Applications that use this API must first set the +style URL to an explicitly versioned style using a convenience method like ++[MGLStyle outdoorsStyleURLWithVersion:], MGLMapView’s “Style URL” +inspectable in Interface Builder, or a manually constructed NSURL. This +approach also avoids layer identifer name changes that will occur in the default +style’s layers over time.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull NSArray<id<MGLFeature>> *)visibleFeaturesAtPoint:(NSPoint)point
+                               inStyleLayersWithIdentifiers:
+                                   (nullable NSSet<NSString *> *)
+                                       styleLayerIdentifiers;
    + +
    +
    +

    Swift

    + 
    func visibleFeatures(_ point: NSPoint, styleLayerIdentifiers: Any!) -> Any!
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + point + + +
    +

    A point expressed in the map view’s coordinate system.

    + +
    +
    + + styleLayerIdentifiers + + +
    +

    A set of strings that correspond to the names of + layers defined in the current style. Only the features contained in these + layers are included in the returned array.

    + +
    +
    +
    +
    +

    Return Value

    +

    An array of objects conforming to the MGLFeature protocol that + represent features in the sources used by the current style.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns an array of rendered map features that intersect with the given +rectangle.

    + +

    This method may return features from any of the map’s style layers. To restrict +the search to a particular layer or layers, use the +-visibleFeaturesAtPoint:inStyleLayersWithIdentifiers: method. For more +information about searching for map features, see that method’s documentation.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull NSArray<id<MGLFeature>> *)visibleFeaturesInRect:(NSRect)rect;
    + +
    +
    +

    Swift

    + 
    func visibleFeatures(_ rect: NSRect) -> Any!
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + rect + + +
    +

    A rectangle expressed in the map view’s coordinate system.

    + +
    +
    +
    +
    +

    Return Value

    +

    An array of objects conforming to the MGLFeature protocol that + represent features in the sources used by the current style.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns an array of rendered map features that intersect with the given +rectangle, restricted to the given style layers.

    + +

    Each object in the returned array represents a feature rendered by the +current style and provides access to attributes specified by the relevant +tile sources. +The returned array includes features specified in vector and GeoJSON tile +sources but does not include anything from raster, image, or video sources.

    + +

    Only visible features are returned. For example, suppose the current style uses +the +Mapbox Streets source, +but none of the specified style layers includes features that have the maki +property set to bus. If you pass a rectangle containing the location of a bus +stop into this method, the bus stop feature does not appear in the resulting +array. On the other hand, if the style does include bus stops, an MGLFeature +object representing that bus stop is returned and its attributes dictionary +has the maki key set to bus (along with other attributes). The dictionary +contains only the attributes provided by the tile source; it does not include +computed attribute values or rules about how the feature is rendered by the +current style.

    + +

    The returned array is sorted by z-order, starting with the topmost rendered +feature and ending with the bottommost rendered feature. A feature that is +rendered multiple times due to wrapping across the antimeridian at low zoom +levels is included only once, subject to the caveat that follows.

    + +

    Features come from tiled vector data or GeoJSON data that is converted to tiles +internally, so feature geometries are clipped at tile boundaries and features +may appear duplicated across tiles. For example, suppose the specified +rectangle intersects with a road that spans the screen. The resulting array +includes those parts of the road that lie within the map tiles covering the +specified rectangle, even if the road extends into other tiles. The portion of +the road within each map tile is included individually.

    + +

    To find out the layer names in a particular style, view the style in +Mapbox Studio.

    + +
    +

    Note

    +

    Layer identifiers are not guaranteed to exist across styles or different +versions of the same style. Applications that use this API must first set the +style URL to an explicitly versioned style using a convenience method like ++[MGLStyle outdoorsStyleURLWithVersion:], MGLMapView’s “Style URL” +inspectable in Interface Builder, or a manually constructed NSURL. This +approach also avoids layer identifer name changes that will occur in the default +style’s layers over time.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull NSArray<id<MGLFeature>> *)visibleFeaturesInRect:(NSRect)rect
+                              inStyleLayersWithIdentifiers:
+                                  (nullable NSSet<NSString *> *)
+                                      styleLayerIdentifiers;
    + +
    +
    +

    Swift

    + 
    func visibleFeatures(_ rect: NSRect, styleLayerIdentifiers: Any!) -> Any!
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + rect + + +
    +

    A rectangle expressed in the map view’s coordinate system.

    + +
    +
    + + styleLayerIdentifiers + + +
    +

    A set of strings that correspond to the names of + layers defined in the current style. Only the features contained in these + layers are included in the returned array.

    + +
    +
    +
    +
    +

    Return Value

    +

    An array of objects conforming to the MGLFeature protocol that + represent features in the sources used by the current style.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Converting Geographic Coordinates

+ +
+
    +
  • + +
    +
    +
    +

    Converts a geographic coordinate to a point in the given view’s coordinate +system.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (NSPoint)convertCoordinate:(CLLocationCoordinate2D)coordinate
+               toPointToView:(nullable NSView *)view;
    + +
    +
    +

    Swift

    + 
    func convert(_ coordinate: CLLocationCoordinate2D, toPointTo view: NSView?) -> NSPoint
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + coordinate + + +
    +

    The geographic coordinate to convert.

    + +
    +
    + + view + + +
    +

    The view in whose coordinate system the returned point should be + expressed. If this parameter is nil, the returned point is expressed in + the window’s coordinate system. If view is not nil, it must belong to + the same window as the map view.

    + +
    +
    +
    +
    +

    Return Value

    +

    The point (in the appropriate view or window coordinate system) + corresponding to the given geographic coordinate.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Converts a point in the given view’s coordinate system to a geographic +coordinate.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (CLLocationCoordinate2D)convertPoint:(NSPoint)point
+                  toCoordinateFromView:(nullable NSView *)view;
    + +
    +
    +

    Swift

    + 
    func convert(_ point: NSPoint, toCoordinateFrom view: NSView?) -> CLLocationCoordinate2D
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + point + + +
    +

    The point to convert.

    + +
    +
    + + view + + +
    +

    The view in whose coordinate system the point is expressed.

    + +
    +
    +
    +
    +

    Return Value

    +

    The geographic coordinate at the given point.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Converts a geographic bounding box to a rectangle in the given view’s +coordinate system.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (NSRect)convertCoordinateBounds:(MGLCoordinateBounds)bounds
+                     toRectToView:(nullable NSView *)view;
    + +
    +
    +

    Swift

    + 
    func convertCoordinateBounds(_ bounds: Any!, toRectTo view: NSView?) -> NSRect
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + bounds + + +
    +

    The geographic bounding box to convert.

    + +
    +
    + + view + + +
    +

    The view in whose coordinate system the returned rectangle should + be expressed. If this parameter is nil, the returned rectangle is + expressed in the window’s coordinate system. If view is not nil, it must + belong to the same window as the map view.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Converts a rectangle in the given view’s coordinate system to a geographic +bounding box.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (MGLCoordinateBounds)convertRect:(NSRect)rect
+        toCoordinateBoundsFromView:(nullable NSView *)view;
    + +
    +
    +

    Swift

    + 
    func convert(_ rect: NSRect, toCoordinateBoundsFrom view: NSView?) -> Any!
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + rect + + +
    +

    The rectangle to convert.

    + +
    +
    + + view + + +
    +

    The view in whose coordinate system the rectangle is expressed.

    + +
    +
    +
    +
    +

    Return Value

    +

    The geographic bounding box coextensive with the given rectangle.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns the distance spanned by one point in the map view’s coordinate system +at the given latitude and current zoom level.

    + +

    The distance between points decreases as the latitude approaches the poles. +This relationship parallels the relationship between longitudinal coordinates +at different latitudes.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (CLLocationDistance)metersPerPointAtLatitude:(CLLocationDegrees)latitude;
    + +
    +
    +

    Swift

    + 
    func metersPerPoint(atLatitude latitude: CLLocationDegrees) -> CLLocationDistance
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + latitude + + +
    +

    The latitude of the geographic coordinate represented by the + point.

    + +
    +
    +
    +
    +

    Return Value

    +

    The distance in meters spanned by a single point.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Giving Feedback to Improve the Map

+ +
+
    +
  • +
    + + + + -giveFeedback: + +
    +
    +
    +
    +

    Opens one or more webpages in the default Web browser in which the user can +provide feedback about the map data.

    + +

    You should add a menu item to the Help menu of your application that invokes +this method. Title it “Improve This Map” or similar. Set its target to the +first responder and its action to giveFeedback:.

    + +

    This map view searches the current style’s sources for webpages to open. +Specifically, each source’s tile set has an attribution property containing +HTML code; if an <a> tag (link) within that code has an +class attribute set to mapbox-improve-map, its +href attribute defines the URL to open. Such links are omitted +from the attribution view.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)giveFeedback:(nonnull id)sender;
    + +
    +
    +

    Swift

    + 
    @IBAction func giveFeedback(_ sender: Any)
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Debugging the Map

+ +
+
    +
  • +
    + + + + debugMask + +
    +
    +
    +
    +

    The options that determine which debugging aids are shown on the map.

    + +

    These options are all disabled by default and should remain disabled in +released software for performance and aesthetic reasons.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) MGLMapDebugMaskOptions debugMask;
    + +
    +
    +

    Swift

    + 
    var debugMask: Int32 { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLMultiPoint.html b/macos/0.3.0-rc.1/Classes/MGLMultiPoint.html new file mode 100644 index 0000000000..2fdc0ff480 --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLMultiPoint.html @@ -0,0 +1,1188 @@ + + + + MGLMultiPoint Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLMultiPoint Class Reference +
+
+ +
+ +
+ +
+
+

MGLMultiPoint

 +
+
+ 
@interface MGLMultiPoint : MGLShape
+ +
+
+

The MGLMultiPoint class is an abstract superclass used to define shapes +composed of multiple vertices.

+ +

You do not create instances of this class directly. Instead, you create +instances of the MGLPolyline or MGLPolygon classes. However, you can use +the method and properties of this class to access information about the +vertices of the line or polygon.

+ +

Do not confuse MGLMultiPoint with MGLPointCollection, which represents a +collection of related but disconnected points.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + coordinates + +
    +
    +
    +
    +

    The array of vertices associated with the shape.

    + +

    This C array is a pointer to a structure inside the multipoint object, which +may have a lifetime shorter than the multipoint object and will certainly not +have a longer lifetime. Therefore, you should copy the C array if it needs to +be stored outside of the memory context in which you use this property.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) CLLocationCoordinate2D *_Nonnull coordinates;
    + +
    +
    +

    Swift

    + 
    var coordinates: UnsafeMutablePointer
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + pointCount + +
    +
    +
    +
    +

    The number of vertices in the shape.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) NSUInteger pointCount;
    + +
    +
    +

    Swift

    + 
    var pointCount: UInt { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Retrieves the vertices of part of the shape.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)getCoordinates:(nonnull CLLocationCoordinate2D *)coords
+                 range:(NSRange)range;
    + +
    +
    +

    Swift

    + 
    func getCoordinates(_ coords: UnsafeMutablePointer
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + coords + + +
    +

    On input, you must provide a C array of CLLocationCoordinate2D + structures large enough to hold the desired number of coordinates. On + output, this structure contains the requested coordinate data.

    + +
    +
    + + range + + +
    +

    The range of vertices you want. The location field indicates + the first vertex you are requesting, with 0 being the first vertex, 1 + being the second vertex, and so on. The length field indicates the number + of vertices you want. The array in coords must be large enough to + accommodate the number of requested coordinates.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Sets the shape’s vertices to the given C array of vertices.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)setCoordinates:(nonnull CLLocationCoordinate2D *)coords
+                 count:(NSUInteger)count;
    + +
    +
    +

    Swift

    + 
    func setCoordinates(_ coords: UnsafeMutablePointer
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + coords + + +
    +

    The array of coordinates defining the shape. The data in this + array is copied to the shape’s coordinates property.

    + +
    +
    + + count + + +
    +

    The number of coordinates from the coords array.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Inserts the given vertices into the shape. If the shape is currently visible on +the map, it is redrawn immediately.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)insertCoordinates:(nonnull const CLLocationCoordinate2D *)coords
+                    count:(NSUInteger)count
+                  atIndex:(NSUInteger)index;
    + +
    +
    +

    Swift

    + 
    func insertCoordinates(_ coords: UnsafePointer
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + coords + + +
    +

    The array of coordinates to insert into the shape. The data in + this array is copied to the shape’s coordinates property.

    + +
    +
    + + count + + +
    +

    The number of items in the coords array.

    + +
    +
    + + index + + +
    +

    The zero-based index at which the first coordinate in coords + will appear in the coordinates property.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Appends the given vertices to the shape. If the shape is currently visible on +the map, it is redrawn immediately.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)appendCoordinates:(nonnull const CLLocationCoordinate2D *)coords
+                    count:(NSUInteger)count;
    + +
    +
    +

    Swift

    + 
    func appendCoordinates(_ coords: UnsafePointer
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + coords + + +
    +

    The array of coordinates to add to the shape. The data in this + array is copied to the shape’s coordinates property.

    + +
    +
    + + count + + +
    +

    The number of items in the coords array.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Replaces the vertices at the given range in the shape with the same number of +vertices from a given C array. If the shape is currently visible on the map, it +is redrawn immediately.

    + +

    The number of coordinates in coords must be equal to the length of range. +If you want to insert or delete one or more vertices, use the +-replaceCoordinatesInRange:withCoordinates:count: method.

    + +

    If range extends beyond the shape’s coordinates property, an +NSRangeException is raised. If you want to append new vertices to the shape, +use the -appendCoordinates:count: method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)replaceCoordinatesInRange:(NSRange)range
+                  withCoordinates:
+                      (nonnull const CLLocationCoordinate2D *)coords;
    + +
    +
    +

    Swift

    + 
    func replaceCoordinates(in range: NSRange, withCoordinates coords: UnsafePointer
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + range + + +
    +

    The range of vertices to replace. The location field indicates + the first vertex you are replacing, with 0 being the first vertex, 1 + being the second vertex, and so on. The length field indicates the number + of vertices to replace.

    + +
    +
    + + coords + + +
    +

    The array of coordinates defining part of the shape. The data in + this array is copied to the shape’s coordinates property.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Replaces the vertices at the given range in the shape with the specified number +of vertices from a given C array. If the shape is currently visible on the map, +it is redrawn immediately.

    + +

    If count is greater than the length field of range, some vertices will +effectively be inserted into the shape. On the other hand, if count is less +than the length field of range, some vertices will effectively be removed.

    + +

    If range extends beyond the shape’s coordinates property, an +NSRangeException is raised. If you want to append new vertices to the shape, +use the -appendCoordinates:count: method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)replaceCoordinatesInRange:(NSRange)range
+                  withCoordinates:(nonnull const CLLocationCoordinate2D *)coords
+                            count:(NSUInteger)count;
    + +
    +
    +

    Swift

    + 
    func replaceCoordinates(in range: NSRange, withCoordinates coords: UnsafePointer
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + range + + +
    +

    The range of vertices to replace. The location field indicates + the first vertex you are replacing, with 0 being the first vertex, 1 + being the second vertex, and so on. The length field indicates the number + of vertices to replace.

    + +
    +
    + + coords + + +
    +

    The array of coordinates defining part of the shape. The data in + this array is copied to the shape’s coordinates property.

    + +
    +
    + + count + + +
    +

    The number of coordinates from the coords array to insert in + place of the coordinates in range. The sum of range’s length and this + count must not exceed the number of items currently in the coordinates + property.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Removes the vertices at the given range from the shape. If the shape is +currently visible on the map, it is redrawn immediately.

    + +

    If range extends beyond the shape’s coordinates property, an +NSRangeException is raised.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)removeCoordinatesInRange:(NSRange)range;
    + +
    +
    +

    Swift

    + 
    func removeCoordinates(in range: NSRange)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + range + + +
    +

    The range of vertices to remove. The location field indicates + the first vertex you are removing, with 0 being the first vertex, 1 + being the second vertex, and so on. The length field indicates the number + of vertices to remove.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLMultiPolygon.html b/macos/0.3.0-rc.1/Classes/MGLMultiPolygon.html new file mode 100644 index 0000000000..7614414caa --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLMultiPolygon.html @@ -0,0 +1,659 @@ + + + + MGLMultiPolygon Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLMultiPolygon Class Reference +
+
+ +
+ +
+ +
+
+

MGLMultiPolygon

 +
+
+ 
@interface MGLMultiPolygon : MGLShape <MGLOverlay>
+ +
+
+

An MGLMultiPolygon object represents a shape consisting of one or more +polygons that do not overlap. For example, you could use a multipolygon shape +to represent the body of land that consists of an island surrounded by an +atoll: the inner island would be one MGLPolygon object, while the surrounding +atoll would be another. You could also use a multipolygon shape to represent a +group of disconnected but related buildings.

+ +

You can add multipolygon shapes to the map by adding them to an +MGLShapeSource object. Configure the appearance of an MGLShapeSource’s or +MGLVectorSource’s multipolygons collectively using an MGLFillStyleLayer or +MGLSymbolStyleLayer object.

+ +

You cannot add an MGLMultiPolygon object directly to a map view using +-[MGLMapView addAnnotation:] or -[MGLMapView addOverlay:]. However, you can +add the polygons array’s items as overlays individually.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + polygons + +
    +
    +
    +
    +

    An array of polygons forming the multipolygon.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, copy, nonatomic) NSArray<MGLPolygon *> *_Nonnull polygons;
    + +
    +
    +

    Swift

    + 
    var polygons: [MGLPolygon] { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Creates and returns a multipolygon object consisting of the given polygons.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)multiPolygonWithPolygons:
+    (nonnull NSArray<MGLPolygon *> *)polygons;
    + +
    +
    +

    Swift

    + 
    convenience init(polygons: [MGLPolygon])
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + polygons + + +
    +

    The array of polygons defining the shape.

    + +
    +
    +
    +
    +

    Return Value

    +

    A new multipolygon object.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLMultiPolyline.html b/macos/0.3.0-rc.1/Classes/MGLMultiPolyline.html new file mode 100644 index 0000000000..5cef0e12c7 --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLMultiPolyline.html @@ -0,0 +1,661 @@ + + + + MGLMultiPolyline Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLMultiPolyline Class Reference +
+
+ +
+ +
+ +
+
+

MGLMultiPolyline

 +
+
+ 
@interface MGLMultiPolyline : MGLShape <MGLOverlay>
+ +
+
+

An MGLMultiPolyline object represents a shape consisting of one or more +polylines. For example, you could use a multipolyline shape to represent both +sides of a divided highway (dual carriageway), excluding the median (central +reservation): each carriageway would be a distinct MGLPolyline object.

+ +

You can add multipolyline shapes to the map by adding them to an +MGLShapeSource object. Configure the appearance of an MGLShapeSource’s or +MGLVectorSource’s multipolylines collectively using an MGLLineStyleLayer or +MGLSymbolStyleLayer object.

+ +

You cannot add an MGLMultiPolyline object directly to a map view using +-[MGLMapView addAnnotation:] or -[MGLMapView addOverlay:]. However, you can +add the polylines array’s items as overlays individually.

+ +

A multipolyline is known as a +MultiLineString +geometry in GeoJSON.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + polylines + +
    +
    +
    +
    +

    An array of polygons forming the multipolyline.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, copy, nonatomic) NSArray<MGLPolyline *> *_Nonnull polylines;
    + +
    +
    +

    Swift

    + 
    var polylines: [MGLPolyline] { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Creates and returns a multipolyline object consisting of the given polylines.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)multiPolylineWithPolylines:
+    (nonnull NSArray<MGLPolyline *> *)polylines;
    + +
    +
    +

    Swift

    + 
    convenience init(polylines: [MGLPolyline])
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + polylines + + +
    +

    The array of polylines defining the shape.

    + +
    +
    +
    +
    +

    Return Value

    +

    A new multipolyline object.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLOfflinePack.html b/macos/0.3.0-rc.1/Classes/MGLOfflinePack.html new file mode 100644 index 0000000000..3741cf8872 --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLOfflinePack.html @@ -0,0 +1,846 @@ + + + + MGLOfflinePack Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLOfflinePack Class Reference +
+
+ +
+ +
+ +
+
+

MGLOfflinePack

 +
+
+ 
@interface MGLOfflinePack : NSObject
+ +
+
+

An MGLOfflinePack represents a collection of resources necessary for viewing +a region offline to a local database.

+ +

To create an instance of MGLOfflinePack, use the ++[MGLOfflineStorage addPackForRegion:withContext:completionHandler:] method. +A pack created using -[MGLOfflinePack init] is immediately invalid.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + region + +
    +
    +
    +
    +

    The region for which the pack manages resources.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) id<MGLOfflineRegion> _Nonnull region;
    + +
    +
    +

    Swift

    + 
    var region: MGLOfflineRegion { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + context + +
    +
    +
    +
    +

    Arbitrary data stored alongside the downloaded resources.

    + +

    The context typically holds application-specific information for identifying +the pack, such as a user-selected name.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) NSData *_Nonnull context;
    + +
    +
    +

    Swift

    + 
    var context: Data { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + state + +
    +
    +
    +
    +

    The pack’s current state.

    + +

    The state of an inactive or completed pack is computed lazily and is set to +MGLOfflinePackStateUnknown by default. To request the pack’s status, use the +-requestProgress method. To get notified when the state becomes known and +when it changes, observe KVO change notifications on this pack’s state key +path. Alternatively, you can add an observer for +MGLOfflinePackProgressChangedNotifications about this pack that come from the +default notification center.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) MGLOfflinePackState state;
    + +
    +
    +

    Swift

    + 
    var state: MGLOfflinePackState { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + progress + +
    +
    +
    +
    +

    The pack’s current progress.

    + +

    The progress of an inactive or completed pack is computed lazily, and all its +fields are set to 0 by default. To request the pack’s progress, use the +-requestProgress method. To get notified when the progress becomes +known and when it changes, observe KVO change notifications on this pack’s +state key path. Alternatively, you can add an observer for +MGLOfflinePackProgressChangedNotifications about this pack that come from the +default notification center.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) MGLOfflinePackProgress progress;
    + +
    +
    +

    Swift

    + 
    var progress: MGLOfflinePackProgress { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -resume + +
    +
    +
    +
    +

    Resumes downloading if the pack is inactive.

    + +

    When a pack resumes after being suspended, it may begin by iterating over the +already downloaded resources. As a result, the progress structure’s +countOfResourcesCompleted field may revert to 0 before rapidly returning to +the level of progress at the time the pack was suspended.

    + +

    To temporarily suspend downloading, call the -suspend method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)resume;
    + +
    +
    +

    Swift

    + 
    func resume()
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -suspend + +
    +
    +
    +
    +

    Temporarily stops downloading if the pack is active.

    + +

    A pack suspends asynchronously, so some network requests may be sent after this +method is called. Regardless, the progress property will not be updated until +-resume is called.

    + +

    If the pack previously reached a higher level of progress before being +suspended, it may wait to suspend until it returns to that level.

    + +

    To resume downloading, call the -resume method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)suspend;
    + +
    +
    +

    Swift

    + 
    func suspend()
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -requestProgress + +
    +
    +
    +
    +

    Request an asynchronous update to the pack’s state and progress properties.

    + +

    The state and progress of an inactive or completed pack are computed lazily. If +you need the state or progress of a pack whose state property is currently +set to MGLOfflinePackStateUnknown, observe KVO change notifications on this +pack’s state key path, then call this method. Alternatively, you can add an +observer for MGLOfflinePackProgressChangedNotification about this pack that +come from the default notification center.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)requestProgress;
    + +
    +
    +

    Swift

    + 
    func requestProgress()
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLOfflineStorage.html b/macos/0.3.0-rc.1/Classes/MGLOfflineStorage.html new file mode 100644 index 0000000000..f0bce63c4d --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLOfflineStorage.html @@ -0,0 +1,952 @@ + + + + MGLOfflineStorage Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLOfflineStorage Class Reference +
+
+ +
+ +
+ +
+
+

MGLOfflineStorage

 +
+
+ 
@interface MGLOfflineStorage : NSObject
+ +
+
+

MGLOfflineStorage implements a singleton (shared object) that manages offline +packs. All of this class’s instance methods are asynchronous, reflecting the +fact that offline resources are stored in a database. The shared object +maintains a canonical collection of offline packs in its packs property.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + +sharedOfflineStorage + +
    +
    +
    +
    +

    Returns the shared offline storage object.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)sharedOfflineStorage;
    + +
    +
    +

    Swift

    + 
    class func shared() -> Self
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + packs + +
    +
    +
    +
    +

    An array of all known offline packs, in the order in which they were created.

    + +

    This property is set to nil, indicating that the receiver does not yet know +the existing packs, for an undefined amount of time starting from the moment +the shared offline storage object is initialized until the packs are fetched +from the database. After that point, this property is always non-nil, but it +may be empty to indicate that no packs are present.

    + +

    To detect when the shared offline storage object has finished loading its +packs property, observe KVO change notifications on the packs key path. +The initial load results in an NSKeyValueChangeSetting change.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, strong, nonatomic, nullable)
+    NSArray<MGLOfflinePack *> *packs;
    + +
    +
    +

    Swift

    + 
    var packs: [MGLOfflinePack]? { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Creates and registers an offline pack that downloads the resources needed to +use the given region offline.

    + +

    The resulting pack is added to the shared offline storage object’s packs +property, then the completion block is executed with that pack passed in.

    + +

    The pack has an initial state of MGLOfflinePackStateInactive. To begin +downloading resources, call -[MGLOfflinePack resume] on the pack from within +the completion handler. To monitor download progress, add an observer for +MGLOfflinePackProgressChangedNotifications about that pack.

    + +

    To detect when any call to this method results in a new pack, observe KVO +change notifications on the shared offline storage object’s packs key path. +Additions to that array result in an NSKeyValueChangeInsertion change.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)addPackForRegion:(nonnull id<MGLOfflineRegion>)region
+             withContext:(nonnull NSData *)context
+       completionHandler:
+           (nullable MGLOfflinePackAdditionCompletionHandler)completion;
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + region + + +
    +

    A region to download.

    + +
    +
    + + context + + +
    +

    Arbitrary data to store alongside the downloaded resources.

    + +
    +
    + + completion + + +
    +

    The completion handler to call once the pack has been added. + This handler is executed asynchronously on the main queue.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Unregisters the given offline pack and allows resources that are no longer +required by any remaining packs to be potentially freed.

    + +

    As soon as this method is called on a pack, the pack becomes invalid; any +attempt to send it a message will result in an exception being thrown. If an +error occurs and the pack cannot be removed, do not attempt to reuse the pack +object. Instead, if you need continued access to the pack, suspend all packs +and use the -reloadPacks method to obtain valid pointers to all the packs.

    + +

    To detect when any call to this method results in a pack being removed, observe +KVO change notifications on the shared offline storage object’s packs key +path. Removals from that array result in an NSKeyValueChangeRemoval change.

    + +

    When you remove an offline pack, any resources that are required by that pack, +but not other packs, become eligible for deletion from offline storage. Because +the backing store used for offline storage is also used as a general purpose +cache for map resources, such resources may not be immediately removed if the +implementation determines that they remain useful for general performance of +the map.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)removePack:(nonnull MGLOfflinePack *)pack
+    withCompletionHandler:
+        (nullable MGLOfflinePackRemovalCompletionHandler)completion;
    + +
    +
    +

    Swift

    + 
    func removePack(_ pack: MGLOfflinePack, withCompletionHandler completion: MGLOfflinePackRemovalCompletionHandler? = nil)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + pack + + +
    +

    The offline pack to remove.

    + +
    +
    + + completion + + +
    +

    The completion handler to call once the pack has been + removed. This handler is executed asynchronously on the main queue.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -reloadPacks + +
    +
    +
    +
    +

    Forcibly, asynchronously reloads the packs property. At some point after this +method is called, the pointer values of the MGLOfflinePack objects in the +packs property change, even if the underlying data for these packs has not +changed. If this method is called while a pack is actively downloading, the +behavior is undefined.

    + +

    You typically do not need to call this method.

    + +

    To detect when the shared offline storage object has finished reloading its +packs property, observe KVO change notifications on the packs key path. +A reload results in an NSKeyValueChangeSetting change.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)reloadPacks;
    + +
    +
    +

    Swift

    + 
    func reloadPacks()
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Sets the maximum number of Mapbox-hosted tiles that may be downloaded and +stored on the current device.

    + +

    Once this limit is reached, an +MGLOfflinePackMaximumMapboxTilesReachedNotification is posted for every +attempt to download additional tiles until already downloaded tiles are removed +by calling the -removePack:withCompletionHandler: method.

    + +
    +

    Note

    + The Mapbox Terms of Service +prohibits changing or bypassing this limit without permission from Mapbox. +Contact your Mapbox sales representative to have the limit raised. + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)setMaximumAllowedMapboxTiles:(uint64_t)maximumCount;
    + +
    +
    +

    Swift

    + 
    func setMaximumAllowedMapboxTiles(_ maximumCount: UInt64)
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + countOfBytesCompleted + +
    +
    +
    +
    +

    The cumulative size, measured in bytes, of all downloaded resources on disk.

    + +

    The returned value includes all resources, including tiles, whether downloaded +as part of an offline pack or due to caching during normal use of MGLMapView.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) unsigned long long countOfBytesCompleted;
    + +
    +
    +

    Swift

    + 
    var countOfBytesCompleted: UInt64 { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLPointAnnotation.html b/macos/0.3.0-rc.1/Classes/MGLPointAnnotation.html new file mode 100644 index 0000000000..90bd89a587 --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLPointAnnotation.html @@ -0,0 +1,608 @@ + + + + MGLPointAnnotation Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLPointAnnotation Class Reference +
+
+ +
+ +
+ +
+
+

MGLPointAnnotation

 +
+
+ 
@interface MGLPointAnnotation : MGLShape
+ +
+
+

An MGLPointAnnotation object represents a one-dimensional shape located at a +single geographical coordinate. Depending on how it is used, an +MGLPointAnnotation object is known as a point annotation or point shape. For +example, you could use a point shape to represent a city at low zoom levels, an +address at high zoom levels, or the location of a long press gesture.

+ +

You can add point shapes to the map by adding them to an MGLShapeSource +object. Configure the appearance of an MGLShapeSource’s or +MGLVectorSource’s point shapes collectively using an MGLCircleStyleLayer or +MGLSymbolStyleLayer object.

+ +

For more interactivity, add a selectable point annotation to a map view using +the -[MGLMapView addAnnotation:] method. Alternatively, define your own model +class that conforms to the MGLAnnotation protocol. Configure a point +annotation’s appearance using +-[MGLMapViewDelegate mapView:imageForAnnotation:] or +-[MGLMapViewDelegate mapView:viewForAnnotation:] (iOS only). A point +annotation’s MGLShape.title and MGLShape.subtitle properties define the +default content of the annotation’s callout (on iOS) or popover (on macOS).

+ +

To group multiple related points together in one shape, use an +MGLPointCollection or MGLShapeCollection object.

+ +

A point shape is known as a +Point geometry +in GeoJSON.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + coordinate + +
    +
    +
    +
    +

    The coordinate point of the shape, specified as a latitude and longitude.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) CLLocationCoordinate2D coordinate;
    + +
    +
    +

    Swift

    + 
    var coordinate: CLLocationCoordinate2D { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLPointCollection.html b/macos/0.3.0-rc.1/Classes/MGLPointCollection.html new file mode 100644 index 0000000000..b0c7c35b87 --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLPointCollection.html @@ -0,0 +1,791 @@ + + + + MGLPointCollection Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLPointCollection Class Reference +
+
+ +
+ +
+ +
+
+

MGLPointCollection

 +
+
+ 
@interface MGLPointCollection : MGLShape <MGLOverlay>
+ +
+
+

An MGLPointCollection object represents a shape consisting of one or more +disconnected vertices, specified as CLLocationCoordinate2D instances. The +points in the collection may be related but are not connected spatially. For +example, you could use a point collection to represent all the trees in an +orchard.

+ +

You can add point collections to the map by adding them to an MGLShapeSource +object. Configure the appearance of an MGLShapeSource’s or +MGLVectorSource’s point collections collectively using an +MGLCircleStyleLayer or MGLSymbolStyleLayer object.

+ +

You cannot add an MGLPointCollection object directly to a map view as an +annotation. However, you can create individual MGLPointAnnotation objects +from the coordinates array and add those annotation objects to the map view +using the -[MGLMapView addAnnotations:] method.

+ +

A point collection is known as a +MultiPoint +geometry in GeoJSON. Do not confuse MGLPointCollection with MGLMultiPoint, +the abstract superclass of MGLPolyline and MGLPolygon.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +

    Creates and returns a MGLPointCollection object from the specified set of +coordinates.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (instancetype)pointCollectionWithCoordinates:
+                    (const CLLocationCoordinate2D *)coords
+                                         count:(NSUInteger)count;
    + +
    +
    +

    Swift

    + 
    convenience init!(coordinates coords: UnsafePointer
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + coords + + +
    +

    The array of coordinates defining the shape. The data in this +array is copied to the new object.

    + +
    +
    + + count + + +
    +

    The number of items in the coords array.

    + +
    +
    +
    +
    +

    Return Value

    +

    A new point collection object.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + coordinates + +
    +
    +
    +
    +

    The array of coordinates associated with the shape.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) CLLocationCoordinate2D *coordinates;
    + +
    +
    +

    Swift

    + 
    var coordinates: UnsafeMutablePointer
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + pointCount + +
    +
    +
    +
    +

    The number of coordinates associated with the shape.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) NSUInteger pointCount;
    + +
    +
    +

    Swift

    + 
    var pointCount: UInt { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Retrieves one or more coordinates associated with the shape.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)getCoordinates:(CLLocationCoordinate2D *)coords range:(NSRange)range;
    + +
    +
    +

    Swift

    + 
    func getCoordinates(_ coords: UnsafeMutablePointer
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + coords + + +
    +

    On input, you must provide a C array of structures large enough +to hold the desired number of coordinates. On output, this structure +contains the requested coordinate data.

    + +
    +
    + + range + + +
    +

    The range of points you want. The location field indicates the +first point you are requesting, with 0 being the first point, 1 being +the second point, and so on. The length field indicates the number of +points you want. The array in coords must be large enough to accommodate +the number of requested coordinates.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLPolygon.html b/macos/0.3.0-rc.1/Classes/MGLPolygon.html new file mode 100644 index 0000000000..277c19d5da --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLPolygon.html @@ -0,0 +1,794 @@ + + + + MGLPolygon Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLPolygon Class Reference +
+
+ +
+ +
+ +
+
+

MGLPolygon

 +
+
+ 
@interface MGLPolygon : MGLMultiPoint <MGLOverlay>
+ +
+
+

An MGLPolygon object represents a closed shape consisting of four or more +vertices, specified as CLLocationCoordinate2D instances, and the edges that +connect them. For example, you could use a polygon shape to represent a +building, a lake, or an area you want to highlight.

+ +

You can add polygon shapes to the map by adding them to an MGLShapeSource +object. Configure the appearance of an MGLShapeSource’s or +MGLVectorSource’s polygons collectively using an MGLFillStyleLayer or +MGLSymbolStyleLayer object.

+ +

Alternatively, you can add a polygon overlay directly to a map view using the +-[MGLMapView addAnnotation:] or -[MGLMapView addOverlay:] method. Configure +a polygon overlay’s appearance using +-[MGLMapViewDelegate mapView:strokeColorForShapeAnnotation:] and +-[MGLMapViewDelegate mapView:fillColorForPolygonAnnotation:].

+ +

The vertices are automatically connected in the order in which you provide +them. You should close the polygon by specifying the same +CLLocationCoordinate2D as the first and last vertices; otherwise, the +polygon’s fill may not cover the area you expect it to. To avoid filling the +space within the shape, give the polygon a transparent fill or use an +MGLPolyline object.

+ +

A polygon may have one or more interior polygons, or holes, that you specify as +MGLPolygon objects with the +polygonWithCoordinates:count:interiorPolygons: +method. For example, if a polygon represents a lake, it could exclude an island +within the lake using an interior polygon. Interior polygons may not themselves +have interior polygons. To represent a shape that includes a polygon within a +hole or, more generally, to group multiple polygons together in one shape, use +an MGLMultiPolygon or MGLShapeCollection object.

+ +

To make the polygon straddle the antimeridian, specify some longitudes less +than −180 degrees or greater than 180 degrees.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + interiorPolygons + +
    +
    +
    +
    +

    The array of polygons nested inside the receiver.

    + +

    The area occupied by any interior polygons is excluded from the overall shape. +Interior polygons should not overlap. An interior polygon should not have +interior polygons of its own.

    + +

    If there are no interior polygons, the value of this property is nil.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic, nullable)
+    NSArray<MGLPolygon *> *interiorPolygons;
    + +
    +
    +

    Swift

    + 
    var interiorPolygons: [MGLPolygon]? { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Creates and returns an MGLPolygon object from the specified set of +coordinates.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)polygonWithCoordinates:
+                            (nonnull const CLLocationCoordinate2D *)coords
+                                         count:(NSUInteger)count;
    + +
    +
    +

    Swift

    + 
    convenience init(coordinates coords: UnsafePointer
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + coords + + +
    +

    The array of coordinates defining the shape. The data in this + array is copied to the new object.

    + +
    +
    + + count + + +
    +

    The number of items in the coords array.

    + +
    +
    +
    +
    +

    Return Value

    +

    A new polygon object.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Creates and returns an MGLPolygon object from the specified set of +coordinates and interior polygons.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)
+polygonWithCoordinates:(nonnull const CLLocationCoordinate2D *)coords
+                 count:(NSUInteger)count
+      interiorPolygons:(nullable NSArray<MGLPolygon *> *)interiorPolygons;
    + +
    +
    +

    Swift

    + 
    convenience init(coordinates coords: UnsafePointer
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + coords + + +
    +

    The array of coordinates defining the shape. The data in this + array is copied to the new object.

    + +
    +
    + + count + + +
    +

    The number of items in the coords array.

    + +
    +
    + + interiorPolygons + + +
    +

    An array of MGLPolygon objects that define regions + excluded from the overall shape. If this array is nil or empty, the shape + is considered to have no interior polygons.

    + +
    +
    +
    +
    +

    Return Value

    +

    A new polygon object.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLPolyline.html b/macos/0.3.0-rc.1/Classes/MGLPolyline.html new file mode 100644 index 0000000000..9f29e64b76 --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLPolyline.html @@ -0,0 +1,653 @@ + + + + MGLPolyline Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLPolyline Class Reference +
+
+ +
+ +
+ +
+
+

MGLPolyline

 +
+
+ 
@interface MGLPolyline : MGLMultiPoint <MGLOverlay>
+ +
+
+

An MGLPolyline object represents a shape consisting of two or more vertices, +specified as CLLocationCoordinate2D instances, and the line segments that +connect them. For example, you could use an polyline to represent a road or the +path along which something moves.

+ +

You can add polyline shapes to the map by adding them to an MGLShapeSource +object. Configure the appearance of an MGLShapeSource’s or +MGLVectorSource’s polylines collectively using an MGLLineStyleLayer or +MGLSymbolStyleLayer object.

+ +

Alternatively, you can add a polyline overlay directly to a map view using the +-[MGLMapView addAnnotation:] or -[MGLMapView addOverlay:] method. Configure +a polyline overlay’s appearance using +-[MGLMapViewDelegate mapView:strokeColorForShapeAnnotation:] and +-[MGLMapViewDelegate mapView:lineWidthForPolylineAnnotation:].

+ +

The vertices are automatically connected in the order in which you provide +them. The first and last vertices are not connected to each other, but you can +specify the same CLLocationCoordinate2D as the first and last vertices in +order to close the polyline. To fill the space within the shape, use an +MGLPolygon object. To group multiple polylines together in one shape, use an +MGLMultiPolyline or MGLShapeCollection object.

+ +

To make the polyline straddle the antimeridian, specify some longitudes less +than −180 degrees or greater than 180 degrees.

+ +

A polyline is known as a +LineString +geometry in GeoJSON.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +

    Creates and returns an MGLPolyline object from the specified set of +coordinates.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)polylineWithCoordinates:
+                            (nonnull const CLLocationCoordinate2D *)coords
+                                          count:(NSUInteger)count;
    + +
    +
    +

    Swift

    + 
    convenience init(coordinates coords: UnsafePointer
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + coords + + +
    +

    The array of coordinates defining the shape. The data in this + array is copied to the new object.

    + +
    +
    + + count + + +
    +

    The number of items in the coords array.

    + +
    +
    +
    +
    +

    Return Value

    +

    A new polyline object.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLRasterSource.html b/macos/0.3.0-rc.1/Classes/MGLRasterSource.html new file mode 100644 index 0000000000..2a88afcc92 --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLRasterSource.html @@ -0,0 +1,772 @@ + + + + MGLRasterSource Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLRasterSource Class Reference +
+
+ +
+ +
+ +
+
+

MGLRasterSource

 +
+
+ 
@interface MGLRasterSource : MGLTileSource
+ +
+
+

MGLRasterSource is a map content source that supplies raster image tiles to +be shown on the map. The location of and metadata about the tiles are defined +either by an option dictionary or by an external file that conforms to the +TileJSON specification. +A raster source is added to an MGLStyle object along with one or more +MGLRasterStyleLayer objects. Use a raster style layer to control the +appearance of content supplied by the raster source.

+ +

Each +raster +source defined by the style JSON file is represented at runtime by an +MGLRasterSource object that you can use to initialize new style layers. You +can also add and remove sources dynamically using methods such as +-[MGLStyle addSource:] and -[MGLStyle sourceWithIdentifier:].

+ +

Example

+
let source = MGLRasterSource(identifier: clouds, tileURLTemplates: [https://example.com/raster-tiles/{z}/{x}/{y}.png], options: [
+    .minimumZoomLevel: 9,
+    .maximumZoomLevel: 16,
+    .tileSize: 512,
+    .attributionInfos: [
+        MGLAttributionInfo(title: NSAttributedString(string: © Mapbox), url: URL(string: http://mapbox.com))
+    ]
+])
+mapView.style?.addSource(source)
+

+ +
+
+ +
+
+
+
+ + + +

Initializing a Source

+ +
+
    +
  • + +
    +
    +
    +

    Returns a raster source initialized with an identifier and configuration URL.

    + +

    After initializing and configuring the source, add it to a map view’s style +using the -[MGLStyle addSource:] method.

    + +

    The URL may be a full HTTP or HTTPS URL or, for tile sets hosted by Mapbox, a +Mapbox URL indicating a map identifier (mapbox://<mapid>). The URL should +point to a JSON file that conforms to the +TileJSON specification.

    + +

    If a Mapbox URL is specified, this source uses a tile size of 256. For all +other tile sets, the default value is 512. (See the +MGLTileSourceOptionTileSize documentation for more information about tile +sizes.) If you need to use a tile size other than the default, use the +-initWithIdentifier:configurationURL:tileSize: method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithIdentifier:(nonnull NSString *)identifier
+                          configurationURL:(nonnull NSURL *)configurationURL;
    + +
    +
    +

    Swift

    + 
    convenience init(identifier: String, configurationURL: URL)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + identifier + + +
    +

    A string that uniquely identifies the source in the style to + which it is added.

    + +
    +
    + + configurationURL + + +
    +

    A URL to a TileJSON configuration file describing the + source’s contents and other metadata.

    + +
    +
    +
    +
    +

    Return Value

    +

    An initialized raster source.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns a raster source initialized with an identifier, configuration URL, and +tile size.

    + +

    After initializing and configuring the source, add it to a map view’s style +using the -[MGLStyle addSource:] method.

    + +

    The URL may be a full HTTP or HTTPS URL or, for tile sets hosted by Mapbox, a +Mapbox URL indicating a map identifier (mapbox://<mapid>). The URL should +point to a JSON file that conforms to the +TileJSON specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithIdentifier:(nonnull NSString *)identifier
+                          configurationURL:(nonnull NSURL *)configurationURL
+                                  tileSize:(CGFloat)tileSize;
    + +
    +
    +

    Swift

    + 
    init(identifier: String, configurationURL: URL, tileSize: CGFloat)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + identifier + + +
    +

    A string that uniquely identifies the source in the style to + which it is added.

    + +
    +
    + + configurationURL + + +
    +

    A URL to a TileJSON configuration file describing the +source’s contents and other metadata.

    + +
    +
    + + tileSize + + +
    +

    The width and height (measured in points) of each tiled image + in the raster source. See the MGLTileSourceOptionTileSize documentation + for details.

    + +
    +
    +
    +
    +

    Return Value

    +

    An initialized raster source.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLRasterStyleLayer.html b/macos/0.3.0-rc.1/Classes/MGLRasterStyleLayer.html new file mode 100644 index 0000000000..6db2f3a999 --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLRasterStyleLayer.html @@ -0,0 +1,880 @@ + + + + MGLRasterStyleLayer Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLRasterStyleLayer Class Reference +
+
+ +
+ +
+ +
+
+

MGLRasterStyleLayer

 +
+
+ 
@interface MGLRasterStyleLayer : MGLForegroundStyleLayer
+ +
+
+

An MGLRasterStyleLayer is a style layer that renders raster tiles on the map.

+ +

Use a raster style layer to configure the color parameters of raster tiles +loaded by an MGLRasterSource object. For example, you could use a raster +style layer to render Mapbox +Satellite imagery, a raster tile +set uploaded to Mapbox Studio, or a raster map authored in TileMill, the classic +Mapbox Editor, or Mapbox Studio Classic.

+ +

You can access an existing raster style layer using the +-[MGLStyle layerWithIdentifier:] method if you know its identifier; +otherwise, find it using the MGLStyle.layers property. You can also create a +new raster style layer and add it to the style using a method such as +-[MGLStyle addLayer:].

+ +

Example

+
let layer = MGLRasterStyleLayer(identifier: clouds, source: source)
+layer.rasterOpacity = MGLStyleValue(rawValue: 0.5)
+mapView.style?.addLayer(layer)
+

+ +
+
+ +
+
+
+
+ + + +

Accessing the Paint Attributes

+ +
+
    +
  • + +
    +
    +
    +

    Increase or reduce the brightness of the image. The value is the maximum +brightness.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 1. Set this property to nil to reset +it to the default value.

    + +

    This attribute corresponds to the raster-brightness-max +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *maximumRasterBrightness;
    + +
    +
    +

    Swift

    + 
    var maximumRasterBrightness: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Increase or reduce the brightness of the image. The value is the minimum +brightness.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 0. Set this property to nil to reset +it to the default value.

    + +

    This attribute corresponds to the raster-brightness-min +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *minimumRasterBrightness;
    + +
    +
    +

    Swift

    + 
    var minimumRasterBrightness: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + rasterContrast + +
    +
    +
    +
    +

    Increase or reduce the contrast of the image.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 0. Set this property to nil to reset +it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *rasterContrast;
    + +
    +
    +

    Swift

    + 
    var rasterContrast: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + rasterFadeDuration + +
    +
    +
    +
    +

    Fade duration when a new tile is added.

    + +

    This property is measured in milliseconds.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 300. Set this property to nil to +reset it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *rasterFadeDuration;
    + +
    +
    +

    Swift

    + 
    var rasterFadeDuration: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + rasterHueRotation + +
    +
    +
    +
    +

    Rotates hues around the color wheel.

    + +

    This property is measured in degrees.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 0. Set this property to nil to reset +it to the default value.

    + +

    This attribute corresponds to the raster-hue-rotate +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *rasterHueRotation;
    + +
    +
    +

    Swift

    + 
    var rasterHueRotation: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + rasterOpacity + +
    +
    +
    +
    +

    The opacity at which the image will be drawn.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 1. Set this property to nil to reset +it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *rasterOpacity;
    + +
    +
    +

    Swift

    + 
    var rasterOpacity: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + rasterSaturation + +
    +
    +
    +
    +

    Increase or reduce the saturation of the image.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 0. Set this property to nil to reset +it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *rasterSaturation;
    + +
    +
    +

    Swift

    + 
    var rasterSaturation: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLShape.html b/macos/0.3.0-rc.1/Classes/MGLShape.html new file mode 100644 index 0000000000..6bef940919 --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLShape.html @@ -0,0 +1,886 @@ + + + + MGLShape Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLShape Class Reference +
+
+ +
+ +
+ +
+
+

MGLShape

 +
+
+ 
@interface MGLShape : NSObject <MGLAnnotation, NSSecureCoding>
+ +
+
+

MGLShape is an abstract class that represents a shape or annotation. Shapes +constitute the content of a map – not only the overlays atop the map, but also +the content that forms the base map.

+ +

You do not create instances of this class directly or create subclasses of this +class. Instead, you create instances of MGLPointAnnotation, +MGLPointCollection, MGLPolyline, MGLMultiPolyline, MGLPolygon, +MGLMultiPolygon, or MGLShapeCollection. The shape classes correspond to the +Geometry object +types in the GeoJSON standard, but some have nonstandard names for backwards +compatibility.

+ +

Although you do not create instances of this class directly, you can use its ++[MGLShape shapeWithData:encoding:error:] factory method to create one of the +concrete subclasses of MGLShape noted above from GeoJSON data.

+ +

You can add shapes to the map by adding them to an MGLShapeSource object. +Configure the appearance of an MGLShapeSource’s or MGLVectorSource’s shapes +collectively using a concrete instance of MGLVectorStyleLayer. Alternatively, +you can add some kinds of shapes directly to a map view as annotations or +overlays.

+ +
+
+ +
+
+
+
+ + + +

Creating a Shape

+ +
+
    +
  • + +
    +
    +
    +

    Returns an MGLShape object initialized with the given data interpreted as a +string containing a GeoJSON object.

    + +

    If the GeoJSON object is a geometry, the returned value is a kind of +MGLShape. If it is a feature object, the returned value is a kind of +MGLShape that conforms to the MGLFeature protocol. If it is a feature +collection object, the returned value is an instance of +MGLShapeCollectionFeature.

    + +

    Example

    +
    let url = mainBundle.url(forResource: amsterdam, withExtension: geojson)!
+let data = try! Data(contentsOf: url)
+let feature = try! MGLShape(data: data, encoding: String.Encoding.utf8.rawValue) as! MGLShapeCollectionFeature
+

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nullable MGLShape *)shapeWithData:(nonnull NSData *)data
+                            encoding:(NSStringEncoding)encoding
+                               error:(NSError *_Nullable *_Nullable)outError;
    + +
    +
    +

    Swift

    + 
    /*not inherited*/ init(data: Data, encoding: UInt) throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + data + + +
    +

    String data containing GeoJSON source code.

    + +
    +
    + + encoding + + +
    +

    The encoding used by data.

    + +
    +
    + + outError + + +
    +

    Upon return, if an error has occurred, a pointer to an + NSError object describing the error. Pass in NULL to ignore any error.

    + +
    +
    +
    +
    +

    Return Value

    +

    An MGLShape object representation of data, or nil if data could + not be parsed as valid GeoJSON source code. If nil, outError contains an + NSError object describing the problem.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Accessing the Shape Attributes

+ +
+
    +
  • +
    + + + + title + +
    +
    +
    +
    +

    The title of the shape annotation.

    + +

    The default value of this property is nil.

    + +

    This property is ignored when the shape is used in an MGLShapeSource. To name +a shape used in a shape source, create an MGLFeature and add an attribute to +the MGLFeature.attributes property.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readwrite, copy, nonatomic, nullable) NSString *title;
    + +
    +
    +

    Swift

    + 
    var title: String? { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + subtitle + +
    +
    +
    +
    +

    The subtitle of the shape annotation. The default value of this property is +nil.

    + +

    This property is ignored when the shape is used in an MGLShapeSource. To +provide additional information about a shape used in a shape source, create an +MGLFeature and add an attribute to the MGLFeature.attributes property.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readwrite, copy, nonatomic, nullable) NSString *subtitle;
    + +
    +
    +

    Swift

    + 
    var subtitle: String? { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + toolTip + +
    +
    +
    +
    +

    The tooltip of the shape annotation.

    + +

    The default value of this property is nil.

    + +

    This property is ignored when the shape is used in an MGLShapeSource.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readwrite, copy, nonatomic, nullable) NSString *toolTip;
    + +
    +
    +

    Swift

    + 
    var toolTip: String? { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Creating GeoJSON Data

+ +
+
    +
  • + +
    +
    +
    +

    Returns the GeoJSON string representation of the shape encapsulated in a data +object.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull NSData *)geoJSONDataUsingEncoding:(NSStringEncoding)encoding;
    + +
    +
    +

    Swift

    + 
    func geoJSONData(usingEncoding encoding: UInt) -> Data
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + encoding + + +
    +

    The string encoding to use.

    + +
    +
    +
    +
    +

    Return Value

    +

    A data object containing the shape’s GeoJSON string representation.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLShapeCollection.html b/macos/0.3.0-rc.1/Classes/MGLShapeCollection.html new file mode 100644 index 0000000000..95fde63b43 --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLShapeCollection.html @@ -0,0 +1,669 @@ + + + + MGLShapeCollection Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLShapeCollection Class Reference +
+
+ +
+ +
+ +
+
+

MGLShapeCollection

 +
+
+ 
@interface MGLShapeCollection : MGLShape
+ +
+
+

An MGLShapeCollection object represents a shape consisting of zero or more +distinct but related shapes that are instances of MGLShape. The constituent +shapes can be a mixture of different kinds of shapes.

+ +

MGLShapeCollection is most commonly used to add multiple shapes to a single +MGLShapeSource. Configure the appearance of an MGLShapeSource’s or +MGLVectorSource’s shape collection collectively using an +MGLSymbolStyleLayer object, or use multiple instances of +MGLCircleStyleLayer, MGLFillStyleLayer, and MGLLineStyleLayer to +configure the appearance of each kind of shape inside the collection.

+ +

You cannot add an MGLShapeCollection object directly to a map view as an +annotation. However, you can create individual MGLPointAnnotation, +MGLPolyline, and MGLPolygon objects from the shapes array and add those +annotation objects to the map view using the -[MGLMapView addAnnotations:] +method.

+ +

To represent a collection of point, polyline, or polygon shapes, it may be more +convenient to use an MGLPointCollection, MGLMultiPolyline, or +MGLMultiPolygon object, respectively.

+ +

A multipolyline is known as a +GeometryCollection +geometry in GeoJSON.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + shapes + +
    +
    +
    +
    +

    An array of shapes forming the shape collection.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, copy, nonatomic) NSArray<MGLShape *> *_Nonnull shapes;
    + +
    +
    +

    Swift

    + 
    var shapes: [MGLShape] { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Creates and returns a shape collection consisting of the given shapes.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)shapeCollectionWithShapes:
+    (nonnull NSArray<MGLShape *> *)shapes;
    + +
    +
    +

    Swift

    + 
    convenience init(shapes: [MGLShape])
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + shapes + + +
    +

    The array of shapes defining the shape collection. The data in + this array is copied to the new object.

    + +
    +
    +
    +
    +

    Return Value

    +

    A new shape collection object.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLShapeSource.html b/macos/0.3.0-rc.1/Classes/MGLShapeSource.html new file mode 100644 index 0000000000..ae25cd285c --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLShapeSource.html @@ -0,0 +1,1066 @@ + + + + MGLShapeSource Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLShapeSource Class Reference +
+
+ +
+ +
+ +
+
+

MGLShapeSource

 +
+
+ 
@interface MGLShapeSource : MGLSource
+ +
+
+

MGLShapeSource is a map content source that supplies vector shapes to be +shown on the map. The shapes may be instances of MGLShape or MGLFeature, +or they may be defined by local or external +GeoJSON code. A shape source is added to an +MGLStyle object along with an MGLVectorStyleLayer object. The vector style +layer defines the appearance of any content supplied by the shape source.

+ +

Each +geojson +source defined by the style JSON file is represented at runtime by an +MGLShapeSource object that you can use to refine the map’s content and +initialize new style layers. You can also add and remove sources dynamically +using methods such as -[MGLStyle addSource:] and +-[MGLStyle sourceWithIdentifier:].

+ +

Any vector style layer initialized with a shape source should have a nil +value in its sourceLayerIdentifier property.

+ +

Example

+
var coordinates: [CLLocationCoordinate2D] = [
+    CLLocationCoordinate2D(latitude: 37.77, longitude: -122.42),
+    CLLocationCoordinate2D(latitude: 38.91, longitude: -77.04),
+]
+let polyline = MGLPolylineFeature(coordinates: &coordinates, count: UInt(coordinates.count))
+let source = MGLShapeSource(identifier: lines, features: [polyline], options: nil)
+mapView.style?.addSource(source)
+

+ +
+
+ +
+
+
+
+ + + +

Initializing a Source

+ +
+
    +
  • + +
    +
    +
    +

    Returns a shape source with an identifier, URL, and dictionary of options for +the source.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)
+initWithIdentifier:(nonnull NSString *)identifier
+               URL:(nonnull NSURL *)url
+           options:(nullable NSDictionary<MGLShapeSourceOption, id> *)options;
    + +
    +
    +

    Swift

    + 
    init(identifier: String, url: URL, options: [MGLShapeSourceOption : Any]? = nil)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + identifier + + +
    +

    A string that uniquely identifies the source.

    + +
    +
    + + URL + + +
    +

    An HTTP(S) URL, absolute file URL, or local file URL relative to the + current application’s resource bundle.

    + +
    +
    + + options + + +
    +

    An NSDictionary of options for this source.

    + +
    +
    +
    +
    +

    Return Value

    +

    An initialized shape source.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns a shape source with an identifier, a shape, and dictionary of options +for the source.

    + +

    To specify attributes about the shape, use an instance of an MGLShape +subclass that conforms to the MGLFeature protocol, such as MGLPointFeature. +To include multiple shapes in the source, use an MGLShapeCollection or +MGLShapeCollectionFeature object, or use the +-initWithIdentifier:features:options: or +-initWithIdentifier:shapes:options: methods.

    + +

    To create a shape from GeoJSON source code, use the ++[MGLShape shapeWithData:encoding:error:] method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)
+initWithIdentifier:(nonnull NSString *)identifier
+             shape:(nullable MGLShape *)shape
+           options:(nullable NSDictionary<MGLShapeSourceOption, id> *)options;
    + +
    +
    +

    Swift

    + 
    init(identifier: String, shape: MGLShape?, options: [MGLShapeSourceOption : Any]? = nil)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + identifier + + +
    +

    A string that uniquely identifies the source.

    + +
    +
    + + shape + + +
    +

    A concrete subclass of MGLShape

    + +
    +
    + + options + + +
    +

    An NSDictionary of options for this source.

    + +
    +
    +
    +
    +

    Return Value

    +

    An initialized shape source.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns a shape source with an identifier, an array of features, and a dictionary +of options for the source.

    + +

    Unlike -initWithIdentifier:shapes:options:, this method accepts MGLFeature +instances, such as MGLPointFeature objects, whose attributes you can use when +applying a predicate to MGLVectorStyleLayer or configuring a style layer’s +appearance.

    + +

    To create a shape from GeoJSON source code, use the ++[MGLShape shapeWithData:encoding:error:] method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)
+initWithIdentifier:(nonnull NSString *)identifier
+          features:(nonnull NSArray<MGLShape<MGLFeature> *> *)features
+           options:(nullable NSDictionary<MGLShapeSourceOption, id> *)options;
    + +
    +
    +

    Swift

    + 
    convenience init(identifier: String, features: [MGLShape], options: [MGLShapeSourceOption : Any]? = nil)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + identifier + + +
    +

    A string that uniquely identifies the source.

    + +
    +
    + + features + + +
    +

    An array of objects that conform to the MGLFeature protocol.

    + +
    +
    + + options + + +
    +

    An NSDictionary of options for this source.

    + +
    +
    +
    +
    +

    Return Value

    +

    An initialized shape source.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns a shape source with an identifier, an array of shapes, and a dictionary of +options for the source.

    + +

    Any MGLFeature instance passed into this initializer is treated as an ordinary +shape, causing any attributes to be inaccessible to an MGLVectorStyleLayer when +evaluating a predicate or configuring certain layout or paint attributes. To +preserve the attributes associated with each feature, use the +-initWithIdentifier:features:options: method instead.

    + +

    To create a shape from GeoJSON source code, use the ++[MGLShape shapeWithData:encoding:error:] method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)
+initWithIdentifier:(nonnull NSString *)identifier
+            shapes:(nonnull NSArray<MGLShape *> *)shapes
+           options:(nullable NSDictionary<MGLShapeSourceOption, id> *)options;
    + +
    +
    +

    Swift

    + 
    convenience init(identifier: String, shapes: [MGLShape], options: [MGLShapeSourceOption : Any]? = nil)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + identifier + + +
    +

    A string that uniquely identifies the source.

    + +
    +
    + + shapes + + +
    +

    An array of shapes; each shape is a member of a concrete subclass of MGLShape.

    + +
    +
    + + options + + +
    +

    An NSDictionary of options for this source.

    + +
    +
    +
    +
    +

    Return Value

    +

    An initialized shape source.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Accessing a Source’s Content

+ +
+
    +
  • +
    + + + + shape + +
    +
    +
    +
    +

    The contents of the source. A shape can represent a GeoJSON geometry, a +feature, or a collection of features.

    + +

    If the receiver was initialized using -initWithIdentifier:URL:options:, this +property is set to nil. This property is unavailable until the receiver is +passed into -[MGLStyle addSource:].

    + +

    You can get/set the shapes within a collection via this property. Actions must +be performed on the application’s main thread.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readwrite, copy, nonatomic, nullable) MGLShape *shape;
    + +
    +
    +

    Swift

    + 
    @NSCopying var shape: MGLShape? { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + URL + +
    +
    +
    +
    +

    The URL to the GeoJSON document that specifies the contents of the source.

    + +

    If the receiver was initialized using -initWithIdentifier:shape:options:, +this property is set to nil.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readwrite, copy, nonatomic, nullable) NSURL *URL;
    + +
    +
    +

    Swift

    + 
    var url: URL? { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLSource.html b/macos/0.3.0-rc.1/Classes/MGLSource.html new file mode 100644 index 0000000000..f24ade17dc --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLSource.html @@ -0,0 +1,679 @@ + + + + MGLSource Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLSource Class Reference +
+
+ +
+ +
+ +
+
+

MGLSource

 +
+
+ 
@interface MGLSource : NSObject
+ +
+
+

MGLSource is an abstract base class for map content sources. A map content +source supplies content to be shown on the map. A source is added to an +MGLStyle object along with an MGLForegroundStyleLayer object. The +foreground style layer defines the appearance of any content supplied by the +source.

+ +

Each source defined by the style JSON file is represented at runtime by an +MGLSource object that you can use to refine the map’s content. You can also +add and remove sources dynamically using methods such as +-[MGLStyle addSource:] and -[MGLStyle sourceWithIdentifier:].

+ +

Do not create instances of this class directly, and do not create your own +subclasses of this class. Instead, create instances of MGLShapeSource and the +concrete subclasses of MGLTileSource, MGLVectorSource and MGLRasterSource.

+ +
+
+ +
+
+
+
+ + + +

Initializing a Source

+ +
+
    +
  • +
    + + + + -initWithIdentifier: + +
    +
    +
    +
    +

    Returns a source initialized with an identifier.

    + +

    After initializing and configuring the source, add it to a map view’s style +using the -[MGLStyle addSource:] method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithIdentifier:(nonnull NSString *)identifier;
    + +
    +
    +

    Swift

    + 
    init(identifier: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + identifier + + +
    +

    A string that uniquely identifies the source in the style to + which it is added.

    + +
    +
    +
    +
    +

    Return Value

    +

    An initialized source.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Identifying a Source

+ +
+
    +
  • +
    + + + + identifier + +
    +
    +
    +
    +

    A string that uniquely identifies the source in the style to which it is added.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readwrite, copy, nonatomic) NSString *_Nonnull identifier;
    + +
    +
    +

    Swift

    + 
    var identifier: String { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLStyle.html b/macos/0.3.0-rc.1/Classes/MGLStyle.html new file mode 100644 index 0000000000..2e133e1c8b --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLStyle.html @@ -0,0 +1,2437 @@ + + + + MGLStyle Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLStyle Class Reference +
+
+ +
+ +
+ +
+
+

MGLStyle

 +
+
+ 
@interface MGLStyle : NSObject
+ +
+
+

The proxy object for the current map style.

+ +

MGLStyle provides a set of convenience methods for changing Mapbox +default styles using -[MGLMapView styleURL]. +Learn more about Mapbox default styles.

+ +

It is also possible to directly manipulate the current map style +via -[MGLMapView style] by updating the style’s data sources or layers.

+ +
+

Note

+ Wait until the map style has finished loading before modifying a map’s +style via any of the MGLStyle instance methods below. You can use the +-[MGLMapViewDelegate mapView:didFinishLoadingStyle:] or +-[MGLMapViewDelegate mapViewDidFinishLoadingMap:] methods as indicators +that it’s safe to modify the map’s style. + +
+ +
+
+ +
+
+
+
+ + + +

Accessing Default Styles

+ +
+
    +
  • +
    + + + + +streetsStyleURL + +
    +
    +
    +
    +

    Returns the URL to version 8 of the +Mapbox Streets style.

    + +

    Streets is a general-purpose style with detailed road and transit networks.

    + +

    MGLMapView and MGLTilePyramidOfflineRegion use Mapbox Streets when no style +is specified explicitly.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSURL *)streetsStyleURL;
    + +
    +
    +

    Swift

    + 
    class func streetsStyleURL() -> URL
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns the URL to the given version of the +Mapbox Streets style.

    + +

    Streets is a general-purpose style with detailed road and transit networks.

    + +

    MGLMapView and MGLTilePyramidOfflineRegion use Mapbox Streets when no style +is specified explicitly.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSURL *)streetsStyleURLWithVersion:(NSInteger)version;
    + +
    +
    +

    Swift

    + 
    class func streetsStyleURL(withVersion version: Int) -> URL
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + version + + +
    +

    The style’s latest released version. As of publication, the + current version is 9.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + +emeraldStyleURL + +
    +
    +
    +
    +

    Returns the URL to version 8 of the +Mapbox Emerald style.

    + +

    Emerald is a tactile style with subtle textures and dramatic hillshading.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSURL *)emeraldStyleURL;
    + +
    +
    +

    Swift

    + 
    class func emeraldStyleURL() -> URL
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns the URL to the given version of the +Mapbox Outdoors style.

    + +

    Outdoors is a general-purpose style tailored to outdoor activities.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSURL *)outdoorsStyleURLWithVersion:(NSInteger)version;
    + +
    +
    +

    Swift

    + 
    class func outdoorsStyleURL(withVersion version: Int) -> URL
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + version + + +
    +

    The style’s latest released version. As of publication, the + current version is 9.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + +lightStyleURL + +
    +
    +
    +
    +

    Returns the URL to version 8 of the +Mapbox Light style.

    + +

    Light is a subtle, light-colored backdrop for data visualizations.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSURL *)lightStyleURL;
    + +
    +
    +

    Swift

    + 
    class func lightStyleURL() -> URL
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns the URL to the given version of the +Mapbox Light style.

    + +

    Light is a subtle, light-colored backdrop for data visualizations.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSURL *)lightStyleURLWithVersion:(NSInteger)version;
    + +
    +
    +

    Swift

    + 
    class func lightStyleURL(withVersion version: Int) -> URL
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + version + + +
    +

    The style’s latest released version. As of publication, the + current version is 9.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + +darkStyleURL + +
    +
    +
    +
    +

    Returns the URL to version 8 of the +Mapbox Dark style.

    + +

    Dark is a subtle, dark-colored backdrop for data visualizations.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSURL *)darkStyleURL;
    + +
    +
    +

    Swift

    + 
    class func darkStyleURL() -> URL
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns the URL to the given version of the +Mapbox Dark style.

    + +

    Dark is a subtle, dark-colored backdrop for data visualizations.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSURL *)darkStyleURLWithVersion:(NSInteger)version;
    + +
    +
    +

    Swift

    + 
    class func darkStyleURL(withVersion version: Int) -> URL
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + version + + +
    +

    The style’s latest released version. As of publication, the + current version is 9.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + +satelliteStyleURL + +
    +
    +
    +
    +

    Returns the URL to version 8 of the +Mapbox Satellite style.

    + +

    Satellite is high-resolution satellite and aerial imagery.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSURL *)satelliteStyleURL;
    + +
    +
    +

    Swift

    + 
    class func satelliteStyleURL() -> URL
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns the URL to the given version of the +Mapbox Satellite style.

    + +

    Satellite is high-resolution satellite and aerial imagery.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSURL *)satelliteStyleURLWithVersion:(NSInteger)version;
    + +
    +
    +

    Swift

    + 
    class func satelliteStyleURL(withVersion version: Int) -> URL
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + version + + +
    +

    The style’s latest released version. As of publication, the + current version is 9.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + +hybridStyleURL + +
    +
    +
    +
    +

    Returns the URL to version 8 of the +Mapbox Satellite Streets +style.

    + +

    Satellite Streets combines the high-resolution satellite and aerial imagery of +Mapbox Satellite with unobtrusive labels and translucent roads from Mapbox +Streets.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSURL *)hybridStyleURL;
    + +
    +
    +

    Swift

    + 
    class func hybridStyleURL() -> URL
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns the URL to the given version of the +Mapbox Satellite Streets +style.

    + +

    Satellite Streets combines the high-resolution satellite and aerial imagery of +Mapbox Satellite with unobtrusive labels and translucent roads from Mapbox +Streets.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSURL *)satelliteStreetsStyleURLWithVersion:(NSInteger)version;
    + +
    +
    +

    Swift

    + 
    class func satelliteStreetsStyleURL(withVersion version: Int) -> URL
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + version + + +
    +

    The style’s latest released version. As of publication, the + current version is 9.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Accessing Metadata About the Style

+ +
+
    +
  • +
    + + + + name + +
    +
    +
    +
    +

    The name of the style.

    + +

    You can customize the style’s name in Mapbox Studio.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, copy, atomic, nullable) NSString *name;
    + +
    +
    +

    Swift

    + 
    var name: String? { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Managing Sources

+ +
+
    +
  • +
    + + + + sources + +
    +
    +
    +
    +

    A set containing the style’s sources.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readwrite, strong, nonatomic)
+    NSSet<__kindof MGLSource *> *_Nonnull sources;
    + +
    +
    +

    Swift

    + 
    var sources: Set
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns a source with the given identifier in the current style.

    + +
    +

    Note

    +

    Source identifiers are not guaranteed to exist across styles or different +versions of the same style. Applications that use this API must first set the +style URL to an explicitly versioned style using a convenience method like ++[MGLStyle outdoorsStyleURLWithVersion:], MGLMapView’s “Style URL” +inspectable in Interface Builder, or a manually constructed NSURL. This +approach also avoids source identifer name changes that will occur in the default +style’s sources over time.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nullable MGLSource *)sourceWithIdentifier:(nonnull NSString *)identifier;
    + +
    +
    +

    Swift

    + 
    func source(withIdentifier identifier: String) -> MGLSource?
    + +
    +
    +
    +

    Return Value

    +

    An instance of a concrete subclass of MGLSource associated with the + given identifier, or nil if the current style contains no such source.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -addSource: + +
    +
    +
    +
    +

    Adds a new source to the current style.

    + +
    +

    Note

    +

    Adding the same source instance more than once will result in a +MGLRedundantSourceException. Reusing the same source identifier, even with +different source instances, will result in a +MGLRedundantSourceIdentifierException.

    + +
    + +
    +

    Note

    +

    Sources should be added in +-[MGLMapViewDelegate mapView:didFinishLoadingStyle:] or +-[MGLMapViewDelegate mapViewDidFinishLoadingMap:] to ensure that the map +has loaded the style and is ready to accept a new source.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)addSource:(nonnull MGLSource *)source;
    + +
    +
    +

    Swift

    + 
    func addSource(_ source: MGLSource)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + source + + +
    +

    The source to add to the current style.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -removeSource: + +
    +
    +
    +
    +

    Removes a source from the current style.

    + +
    +

    Note

    +

    Source identifiers are not guaranteed to exist across styles or different +versions of the same style. Applications that use this API must first set the +style URL to an explicitly versioned style using a convenience method like ++[MGLStyle outdoorsStyleURLWithVersion:], MGLMapView’s “Style URL” +inspectable in Interface Builder, or a manually constructed NSURL. This +approach also avoids source identifer name changes that will occur in the default +style’s sources over time.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)removeSource:(nonnull MGLSource *)source;
    + +
    +
    +

    Swift

    + 
    func removeSource(_ source: MGLSource)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + source + + +
    +

    The source to remove from the current style.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Managing Style Layers

+ +
+
    +
  • +
    + + + + layers + +
    +
    +
    +
    +

    The layers included in the style, arranged according to their back-to-front +ordering on the screen.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readwrite, strong, nonatomic)
+    NSArray<__kindof MGLStyleLayer *> *_Nonnull layers;
    + +
    +
    +

    Swift

    + 
    var layers: [MGLStyleLayer] { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -layerWithIdentifier: + +
    +
    +
    +
    +

    Returns a style layer with the given identifier in the current style.

    + +
    +

    Note

    +

    Layer identifiers are not guaranteed to exist across styles or different +versions of the same style. Applications that use this API must first set +the style URL to an explicitly versioned style using a convenience method like ++[MGLStyle outdoorsStyleURLWithVersion:], MGLMapView’s “Style URL” +inspectable in Interface Builder, or a manually constructed NSURL. This +approach also avoids layer identifer name changes that will occur in the default +style’s layers over time.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nullable MGLStyleLayer *)layerWithIdentifier:(nonnull NSString *)identifier;
    + +
    +
    +

    Swift

    + 
    func layer(withIdentifier identifier: String) -> MGLStyleLayer?
    + +
    +
    +
    +

    Return Value

    +

    An instance of a concrete subclass of MGLStyleLayer associated with + the given identifier, or nil if the current style contains no such style + layer.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -addLayer: + +
    +
    +
    +
    +

    Adds a new layer on top of existing layers.

    + +
    +

    Note

    +

    Adding the same layer instance more than once will result in a +MGLRedundantLayerException. Reusing the same layer identifer, even with +different layer instances, will also result in an exception.

    + +
    + +
    +

    Note

    +

    Layers should be added in +-[MGLMapViewDelegate mapView:didFinishLoadingStyle:] or +-[MGLMapViewDelegate mapViewDidFinishLoadingMap:] to ensure that the map +has loaded the style and is ready to accept a new layer.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)addLayer:(nonnull MGLStyleLayer *)layer;
    + +
    +
    +

    Swift

    + 
    func addLayer(_ layer: MGLStyleLayer)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + layer + + +
    +

    The layer object to add to the map view. This object must be an + instance of a concrete subclass of MGLStyleLayer.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -insertLayer:atIndex: + +
    +
    +
    +
    +

    Inserts a new layer into the style at the given index.

    + +
    +

    Note

    +

    Adding the same layer instance more than once will result in a +MGLRedundantLayerException. Reusing the same layer identifer, even with +different layer instances, will also result in an exception.

    + +
    + +
    +

    Note

    +

    Layers should be added in +-[MGLMapViewDelegate mapView:didFinishLoadingStyle:] or +-[MGLMapViewDelegate mapViewDidFinishLoadingMap:] to ensure that the map +has loaded the style and is ready to accept a new layer.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)insertLayer:(nonnull MGLStyleLayer *)layer atIndex:(NSUInteger)index;
    + +
    +
    +

    Swift

    + 
    func insertLayer(_ layer: MGLStyleLayer, at index: UInt)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + layer + + +
    +

    The layer to insert.

    + +
    +
    + + index + + +
    +

    The index at which to insert the layer. An index of 0 would send + the layer to the back; an index equal to the number of objects in the + layers property would bring the layer to the front.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Inserts a new layer below another layer.

    + +
    +

    Note

    + Layer identifiers are not guaranteed to exist across styles or different +versions of the same style. Applications that use this API must first set +the style URL to an explicitly versioned style using a convenience method like ++[MGLStyle outdoorsStyleURLWithVersion:], MGLMapView’s “Style URL” +inspectable in Interface Builder, or a manually constructed NSURL. This +approach also avoids layer identifer name changes that will occur in the default +style’s layers over time. + +
    + +

    Inserting the same layer instance more than once will result in a + MGLRedundantLayerException. Reusing the same layer identifer, even with + different layer instances, will also result in an exception.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)insertLayer:(nonnull MGLStyleLayer *)layer
+         belowLayer:(nonnull MGLStyleLayer *)sibling;
    + +
    +
    +

    Swift

    + 
    func insertLayer(_ layer: MGLStyleLayer, below sibling: MGLStyleLayer)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + layer + + +
    +

    The layer to insert.

    + +
    +
    + + sibling + + +
    +

    An existing layer in the style.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Inserts a new layer above another layer.

    + +
    +

    Note

    + Layer identifiers are not guaranteed to exist across styles or different +versions of the same style. Applications that use this API must first set +the style URL to an explicitly versioned style using a convenience method like ++[MGLStyle outdoorsStyleURLWithVersion:], MGLMapView’s “Style URL” +inspectable in Interface Builder, or a manually constructed NSURL. This +approach also avoids layer identifer name changes that will occur in the default +style’s layers over time. + +
    + +

    Inserting the same layer instance more than once will result in a + MGLRedundantLayerException. Reusing the same layer identifer, even with + different layer instances, will also result in an exception.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)insertLayer:(nonnull MGLStyleLayer *)layer
+         aboveLayer:(nonnull MGLStyleLayer *)sibling;
    + +
    +
    +

    Swift

    + 
    func insertLayer(_ layer: MGLStyleLayer, above sibling: MGLStyleLayer)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + layer + + +
    +

    The layer to insert.

    + +
    +
    + + sibling + + +
    +

    An existing layer in the style.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -removeLayer: + +
    +
    +
    +
    +

    Removes a layer from the map view.

    + +
    +

    Note

    +

    Layer identifiers are not guaranteed to exist across styles or different +versions of the same style. Applications that use this API must first set +the style URL to an explicitly versioned style using a convenience method like ++[MGLStyle outdoorsStyleURLWithVersion:], MGLMapView’s “Style URL” +inspectable in Interface Builder, or a manually constructed NSURL. This +approach also avoids layer identifer name changes that will occur in the default +style’s layers over time.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)removeLayer:(nonnull MGLStyleLayer *)layer;
    + +
    +
    +

    Swift

    + 
    func removeLayer(_ layer: MGLStyleLayer)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + layer + + +
    +

    The layer object to remove from the map view. This object +must conform to the MGLStyleLayer protocol.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Managing Style Classes

+ +
+
    +
  • +
    + + + + styleClasses + +
    +
    +
    +
    +

    Currently active style classes, represented as an array of string identifiers.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic)
+    NSArray<NSString *> *_Nonnull styleClasses;
    + +
    +
    +

    Swift

    + 
    var styleClasses: [String] { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -hasStyleClass: + +
    +
    +
    +
    +

    Returns a Boolean value indicating whether the style class with the given +identifier is currently active.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (BOOL)hasStyleClass:(nonnull NSString *)styleClass;
    + +
    +
    +

    Swift

    + 
    func hasStyleClass(_ styleClass: String) -> Bool
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + styleClass + + +
    +

    The style class to query for.

    + +
    +
    +
    +
    +

    Return Value

    +

    Whether the style class is currently active.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -addStyleClass: + +
    +
    +
    +
    +

    Activates the style class with the given identifier.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)addStyleClass:(nonnull NSString *)styleClass;
    + +
    +
    +

    Swift

    + 
    func addClass(_ styleClass: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + styleClass + + +
    +

    The style class to activate.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -removeStyleClass: + +
    +
    +
    +
    +

    Deactivates the style class with the given identifier.

    + +
    +

    Note

    +

    Style class names are not guaranteed to exist across styles or different +versions of the same style. Applications that use this API must first set the +style URL to an explicitly versioned style using a convenience method like ++[MGLStyle outdoorsStyleURLWithVersion:], MGLMapView’s “Style URL” +inspectable in Interface Builder, or a manually constructed NSURL. This +approach also avoids style class name changes that will occur in the default +style over time.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)removeStyleClass:(nonnull NSString *)styleClass;
    + +
    +
    +

    Swift

    + 
    func removeStyleClass(_ styleClass: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + styleClass + + +
    +

    The style class to deactivate.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Managing a Style’s Images

+ +
+
    +
  • +
    + + + + -imageForName: + +
    +
    +
    +
    +

    Returns the image associated with the given name in the style.

    + +
    +

    Note

    +

    Names and their associated images are not guaranteed to exist across +styles or different versions of the same style. Applications that use this +API must first set the style URL to an explicitly versioned style using a +convenience method like +[MGLStyle outdoorsStyleURLWithVersion:], +MGLMapView’s “Style URL” inspectable in Interface Builder, or a manually +constructed NSURL. This approach also avoids image name changes that will +occur in the default style over time.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nullable NSImage *)imageForName:(nonnull NSString *)name;
    + +
    +
    +

    Swift

    + 
    func image(forName name: String) -> NSImage?
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + name + + +
    +

    The name associated with the image you want to obtain.

    + +
    +
    +
    +
    +

    Return Value

    +

    The image associated with the given name, or nil if no image is + associated with that name.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -setImage:forName: + +
    +
    +
    +
    +

    Adds or overrides an image used by the style’s layers.

    + +

    To use an image in a style layer, give it a unique name using this method, then +set the iconImageName property of an MGLSymbolStyleLayer object to that +name.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)setImage:(nonnull NSImage *)image forName:(nonnull NSString *)name;
    + +
    +
    +

    Swift

    + 
    func setImage(_ image: NSImage, forName name: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + image + + +
    +

    The image for the name.

    + +
    +
    + + name + + +
    +

    The name of the image to set to the style.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -removeImageForName: + +
    +
    +
    +
    +

    Removes a name and its associated image from the style.

    + +
    +

    Note

    +

    Names and their associated images are not guaranteed to exist across +styles or different versions of the same style. Applications that use this +API must first set the style URL to an explicitly versioned style using a +convenience method like +[MGLStyle outdoorsStyleURLWithVersion:], +MGLMapView’s “Style URL” inspectable in Interface Builder, or a manually +constructed NSURL. This approach also avoids image name changes that will +occur in the default style over time.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)removeImageForName:(nonnull NSString *)name;
    + +
    +
    +

    Swift

    + 
    func removeImage(forName name: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + name + + +
    +

    The name of the image to remove.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLStyleConstantValue.html b/macos/0.3.0-rc.1/Classes/MGLStyleConstantValue.html new file mode 100644 index 0000000000..90af5a9936 --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLStyleConstantValue.html @@ -0,0 +1,741 @@ + + + + MGLStyleConstantValue Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLStyleConstantValue Class Reference +
+
+ +
+ +
+ +
+
+

MGLStyleConstantValue

 +
+
+ 
@interface MGLStyleConstantValue <T> : MGLStyleValue<T>
+ +
+
+

An MGLStyleConstantValue object is a generic container for a style attribute +value that remains constant as the zoom level changes. The layout and paint +attribute properties of MGLStyleLayer objects can be set to +MGLStyleConstantValue objects.

+ +

The MGLStyleConstantValue class takes a generic parameter T that indicates +the Foundation class being wrapped by this class.

+ +
+
+ +
+
+
+
+ + + +

Creating a Style Constant Value

+ +
+
    +
  • +
    + + + + +valueWithRawValue: + +
    +
    +
    +
    +

    Creates and returns an MGLStyleConstantValue object containing a raw value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)valueWithRawValue:(nonnull T)rawValue;
    + +
    +
    +

    Swift

    + 
    convenience init(rawValue: T)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + rawValue + + +
    +

    The constant value contained by the object.

    + +
    +
    +
    +
    +

    Return Value

    +

    An MGLStyleConstantValue object containing rawValue, which is + treated as a constant value.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Initializing a Style Constant Value

+ +
+
    +
  • +
    + + + + -initWithRawValue: + +
    +
    +
    +
    +

    Returns an MGLStyleConstantValue object containing a raw value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithRawValue:(nonnull T)rawValue;
    + +
    +
    +

    Swift

    + 
    init(rawValue: T)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + rawValue + + +
    +

    The value contained by the receiver.

    + +
    +
    +
    +
    +

    Return Value

    +

    An MGLStyleConstantValue object containing rawValue.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Accessing the Underlying Value

+ +
+
    +
  • +
    + + + + rawValue + +
    +
    +
    +
    +

    The raw value contained by the receiver.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) T _Nonnull rawValue;
    + +
    +
    +

    Swift

    + 
    var rawValue: T { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLStyleFunction.html b/macos/0.3.0-rc.1/Classes/MGLStyleFunction.html new file mode 100644 index 0000000000..a74fccee00 --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLStyleFunction.html @@ -0,0 +1,888 @@ + + + + MGLStyleFunction Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLStyleFunction Class Reference +
+
+ +
+ +
+ +
+
+

MGLStyleFunction

 +
+
+ 
@interface MGLStyleFunction <T> : MGLStyleValue<T>
+ +
+
+

An MGLStyleFunction is a value function defining a style value that changes +as the zoom level changes. The layout and paint attribute properties of an +MGLStyleLayer object can be set to MGLStyleFunction objects. Use a zoom +level function to create the illusion of depth and control data density.

+ +

The MGLStyleFunction class takes a generic parameter T that indicates the +Foundation class being wrapped by this class.

+ +
+
+ +
+
+
+
+ + + +

Creating a Style Function

+ +
+
    +
  • +
    + + + + +functionWithStops: + +
    +
    +
    +
    +

    Creates and returns an MGLStyleFunction object representing a linear zoom +level function with any number of stops.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)functionWithStops:
+    (nonnull NSDictionary<NSNumber *, MGLStyleValue<T> *> *)stops;
    + +
    +
    +

    Swift

    + 
    convenience init(stops: [NSNumber : MGLStyleValue
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + stops + + +
    +

    A dictionary associating zoom levels with style values.

    + +
    +
    +
    +
    +

    Return Value

    +

    An MGLStyleFunction object with the given stops.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Creates and returns an MGLStyleFunction object representing a zoom level +function with an exponential interpolation base and any number of stops.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)
+functionWithInterpolationBase:(CGFloat)interpolationBase
+                        stops:(nonnull NSDictionary<NSNumber *,
+                                                    MGLStyleValue<T> *> *)stops;
    + +
    +
    +

    Swift

    + 
    convenience init(interpolationBase: CGFloat, stops: [NSNumber : MGLStyleValue
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + interpolationBase + + +
    +

    The exponential base of the interpolation curve.

    + +
    +
    + + stops + + +
    +

    A dictionary associating zoom levels with style values.

    + +
    +
    +
    +
    +

    Return Value

    +

    An MGLStyleFunction object with the given interpolation base and stops.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Initializing a Style Function

+ +
+
    +
  • + +
    +
    +
    +

    Returns an MGLStyleFunction object representing a zoom level function with an +exponential interpolation base and any number of stops.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)
+initWithInterpolationBase:(CGFloat)interpolationBase
+                    stops:
+                        (nonnull NSDictionary<NSNumber *, MGLStyleValue<T> *> *)
+                            stops;
    + +
    +
    +

    Swift

    + 
    init(interpolationBase: CGFloat, stops: [NSNumber : MGLStyleValue
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + interpolationBase + + +
    +

    The exponential base of the interpolation curve.

    + +
    +
    + + stops + + +
    +

    A dictionary associating zoom levels with style values.

    + +
    +
    +
    +
    +

    Return Value

    +

    An MGLStyleFunction object with the given interpolation base and stops.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Accessing the Parameters of a Function

+ +
+
    +
  • +
    + + + + interpolationBase + +
    +
    +
    +
    +

    The exponential interpolation base of the function’s interpolation curve.

    + +

    The exponential interpolation base controls the rate at which the function’s output values +increase. A value of 1 causes the function to increase linearly by zoom level. +A higher exponential interpolation base causes the function’s output values to vary +exponentially, increasing more rapidly towards the high end of the function’s +range. The default value of this property is 1, for a linear curve.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) CGFloat interpolationBase;
    + +
    +
    +

    Swift

    + 
    var interpolationBase: CGFloat { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + stops + +
    +
    +
    +
    +

    A dictionary associating zoom levels with style values.

    + +

    Each of the function’s stops is represented by one key-value pair in the +dictionary. Each key in the dictionary is an NSNumber object containing a +floating-point zoom level. Each value in the dictionary is an MGLStyleValue +object containing the value of the style attribute when the map is at the +associated zoom level. An MGLStyleFunction object may not be used recursively +as a stop value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readwrite, copy, nonatomic)
+    NSDictionary<NSNumber *, MGLStyleValue<T> *> *_Nonnull stops;
    + +
    +
    +

    Swift

    + 
    var stops: [NSNumber : MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLStyleLayer.html b/macos/0.3.0-rc.1/Classes/MGLStyleLayer.html new file mode 100644 index 0000000000..205bc1720b --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLStyleLayer.html @@ -0,0 +1,798 @@ + + + + MGLStyleLayer Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLStyleLayer Class Reference +
+
+ +
+ +
+ +
+
+

MGLStyleLayer

 +
+
+ 
@interface MGLStyleLayer : NSObject
+ +
+
+

MGLStyleLayer is an abstract base class for style layers. A style layer +manages the layout and appearance of content at a specific z-index in a style. +An MGLStyle object consists of one or more MGLStyleLayer objects.

+ +

Each style layer defined by the style JSON file is represented at runtime by an +MGLStyleLayer object, which you can use to refine the map’s appearance. You +can also add and remove style layers dynamically.

+ +

Do not create instances of this class directly, and do not create your own +subclasses of this class. Instead, create instances of +MGLBackgroundStyleLayer and the concrete subclasses of +MGLForegroundStyleLayer.

+ +
+
+ +
+
+
+
+ + + +

Initializing a Style Layer

+ +
+
    +
  • +
    + + + + -initWithIdentifier: + +
    +
    +
    +
    +

    Returns a style layer object initialized with the given identifier.

    + +

    After initializing and configuring the style layer, add it to a map view’s +style using the -[MGLStyle addLayer:] or +-[MGLStyle insertLayer:belowLayer:] method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithIdentifier:(nonnull NSString *)identifier;
    + +
    +
    +

    Swift

    + 
    init(identifier: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + identifier + + +
    +

    A string that uniquely identifies the layer in the style to + which it is added.

    + +
    +
    +
    +
    +

    Return Value

    +

    An initialized style layer.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Identifying a Style Layer

+ +
+
    +
  • +
    + + + + identifier + +
    +
    +
    +
    +

    A string that uniquely identifies the style layer in the style to which it is +added.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, copy, nonatomic) NSString *_Nonnull identifier;
    + +
    +
    +

    Swift

    + 
    var identifier: String { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Configuring a Style Layer’s Visibility

+ +
+
    +
  • +
    + + + + visible + +
    +
    +
    +
    +

    Whether this layer is displayed. A value of NO hides the layer.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (getter=isVisible, assign, readwrite, nonatomic) BOOL visible;
    + +
    +
    +

    Swift

    + 
    var isVisible: Bool { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + maximumZoomLevel + +
    +
    +
    +
    +

    The maximum zoom level at which the layer gets parsed and appears.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) float maximumZoomLevel;
    + +
    +
    +

    Swift

    + 
    var maximumZoomLevel: Float { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + minimumZoomLevel + +
    +
    +
    +
    +

    The minimum zoom level at which the layer gets parsed and appears.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) float minimumZoomLevel;
    + +
    +
    +

    Swift

    + 
    var minimumZoomLevel: Float { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLStyleValue.html b/macos/0.3.0-rc.1/Classes/MGLStyleValue.html new file mode 100644 index 0000000000..e856423778 --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLStyleValue.html @@ -0,0 +1,776 @@ + + + + MGLStyleValue Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLStyleValue Class Reference +
+
+ +
+ +
+ +
+
+

MGLStyleValue

 +
+
+ 
@interface MGLStyleValue <T> : NSObject
+ +
+
+

An MGLStyleValue object is a generic container for a style attribute value. +The layout and paint attribute properties of MGLStyleLayer can be set to +MGLStyleValue objects.

+ +

The MGLStyleValue class itself represents a class cluster. Under the hood, a +particular MGLStyleValue object may be either an MGLStyleConstantValue to +represent a constant value or an MGLStyleFunction to represent a value +function. Do not initialize an MGLStyleValue object directly; instead, use +one of the class factory methods to create an MGLStyleValue object.

+ +

The MGLStyleValue class takes a generic parameter T that indicates the +Foundation class being wrapped by this class. Common values for T include:

+ +
    +
  • NSNumber (for Boolean values and floating-point numbers)
    • +
  • NSValue (for CGVector, NSEdgeInsets, UIEdgeInsets, and enumerations)
    • +
  • NSString
    • +
  • NSColor or UIColor
    • +
  • NSArray
    • +
+ +
+
+ +
+
+
+
+ + + +

Creating a Style Value

+ +
+
    +
  • +
    + + + + +valueWithRawValue: + +
    +
    +
    +
    +

    Creates and returns an MGLStyleConstantValue object containing a raw value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)valueWithRawValue:(nonnull T)rawValue;
    + +
    +
    +

    Swift

    + 
    convenience init(rawValue: T)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + rawValue + + +
    +

    The constant value contained by the object.

    + +
    +
    +
    +
    +

    Return Value

    +

    An MGLStyleConstantValue object containing rawValue, which is + treated as a constant value.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + +valueWithStops: + +
    +
    +
    +
    +

    Creates and returns an MGLStyleFunction object representing a linear zoom +level function with any number of stops.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)valueWithStops:
+    (nonnull NSDictionary<NSNumber *, MGLStyleValue<T> *> *)stops;
    + +
    +
    +

    Swift

    + 
    convenience init(stops: [NSNumber : MGLStyleValue
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + stops + + +
    +

    A dictionary associating zoom levels with style values.

    + +
    +
    +
    +
    +

    Return Value

    +

    An MGLStyleFunction object with the given stops.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Creates and returns an MGLStyleFunction object representing a zoom level +function with an exponential interpolation base and any number of stops.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)
+valueWithInterpolationBase:(CGFloat)interpolationBase
+                     stops:(nonnull NSDictionary<NSNumber *, MGLStyleValue<T> *>
+                                *)stops;
    + +
    +
    +

    Swift

    + 
    convenience init(interpolationBase: CGFloat, stops: [NSNumber : MGLStyleValue
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + interpolationBase + + +
    +

    The exponential base of the interpolation curve.

    + +
    +
    + + stops + + +
    +

    A dictionary associating zoom levels with style values.

    + +
    +
    +
    +
    +

    Return Value

    +

    An MGLStyleFunction object with the given interpolation base and stops.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLSymbolStyleLayer.html b/macos/0.3.0-rc.1/Classes/MGLSymbolStyleLayer.html new file mode 100644 index 0000000000..7fee270a08 --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLSymbolStyleLayer.html @@ -0,0 +1,2840 @@ + + + + MGLSymbolStyleLayer Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLSymbolStyleLayer Class Reference +
+
+ +
+ +
+ +
+
+

MGLSymbolStyleLayer

 +
+
+ 
@interface MGLSymbolStyleLayer : MGLVectorStyleLayer
+ +
+
+

An MGLSymbolStyleLayer is a style layer that renders icon and text labels at +points or along lines on the map.

+ +

Use a symbol style layer to configure the visual appearance of labels for +features in vector tiles loaded by an MGLVectorSource object or MGLShape or +MGLFeature instances in an MGLShapeSource object.

+ +

You can access an existing symbol style layer using the +-[MGLStyle layerWithIdentifier:] method if you know its identifier; +otherwise, find it using the MGLStyle.layers property. You can also create a +new symbol style layer and add it to the style using a method such as +-[MGLStyle addLayer:].

+ +

Example

+
let layer = MGLSymbolStyleLayer(identifier: coffeeshops, source: pois)
+layer.sourceLayerIdentifier = pois
+layer.iconImageName = MGLStyleValue(rawValue: coffee)
+layer.iconScale = MGLStyleValue(rawValue: 0.5)
+layer.text = MGLStyleValue(rawValue: {name})
+layer.textTranslation = MGLStyleValue(rawValue: NSValue(cgVector: CGVector(dx: 10, dy: 0)))
+layer.textJustification = MGLStyleValue(rawValue: NSValue(mglTextJustification: .left))
+layer.textAnchor = MGLStyleValue(rawValue: NSValue(mglTextAnchor: .left))
+layer.predicate = NSPredicate(format: %K == %@, venue-type, coffee)
+mapView.style?.addLayer(layer)
+

+ +
+
+ +
+
+
+
+ + + +

Accessing the Layout Attributes

+ +
+
    +
  • +
    + + + + iconAllowsOverlap + +
    +
    +
    +
    +

    If true, the icon will be visible even if it collides with other previously +drawn symbols.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing NO. Set this property to nil to reset it to +the default value.

    + +

    This property is only applied to the style if iconImageName is non-nil. +Otherwise, it is ignored.

    + +

    This attribute corresponds to the icon-allow-overlap +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *iconAllowsOverlap;
    + +
    +
    +

    Swift

    + 
    var iconAllowsOverlap: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + iconIgnoresPlacement + +
    +
    +
    +
    +

    If true, other symbols can be visible even if they collide with the icon.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing NO. Set this property to nil to reset it to +the default value.

    + +

    This property is only applied to the style if iconImageName is non-nil. +Otherwise, it is ignored.

    + +

    This attribute corresponds to the icon-ignore-placement +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *iconIgnoresPlacement;
    + +
    +
    +

    Swift

    + 
    var iconIgnoresPlacement: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + iconImageName + +
    +
    +
    +
    +

    A string with {tokens} replaced, referencing the data property to pull from.

    + +

    This attribute corresponds to the icon-image +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSString *> *iconImageName;
    + +
    +
    +

    Swift

    + 
    var iconImageName: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + iconOffset + +
    +
    +
    +
    +

    Offset distance of icon from its anchor.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing a CGVector struct set to 0 rightward and 0 +upward. Set this property to nil to reset it to the default value.

    + +

    This property is only applied to the style if iconImageName is non-nil. +Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *iconOffset;
    + +
    +
    +

    Swift

    + 
    var iconOffset: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + iconOptional + +
    +
    +
    +
    +

    If true, text will display without their corresponding icons when the icon +collides with other symbols and the text does not.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing NO. Set this property to nil to reset it to +the default value.

    + +

    This property is only applied to the style if iconImageName is non-nil, and +text is non-nil. Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (getter=isIconOptional, assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *iconOptional;
    + +
    +
    +

    Swift

    + 
    var iconOptional: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + iconPadding + +
    +
    +
    +
    +

    Size of the additional area around the icon bounding box used for detecting +symbol collisions.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 2. Set this property to nil to reset +it to the default value.

    + +

    This property is only applied to the style if iconImageName is non-nil. +Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *iconPadding;
    + +
    +
    +

    Swift

    + 
    var iconPadding: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + iconRotation + +
    +
    +
    +
    +

    Rotates the icon clockwise.

    + +

    This property is measured in degrees.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 0. Set this property to nil to reset +it to the default value.

    + +

    This property is only applied to the style if iconImageName is non-nil. +Otherwise, it is ignored.

    + +

    This attribute corresponds to the icon-rotate +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *iconRotation;
    + +
    +
    +

    Swift

    + 
    var iconRotation: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + iconRotationAlignment + +
    +
    +
    +
    +

    In combination with symbolPlacement, determines the rotation behavior of +icons.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing MGLIconRotationAlignmentAuto. Set this property +to nil to reset it to the default value.

    + +

    This property is only applied to the style if iconImageName is non-nil. +Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *iconRotationAlignment;
    + +
    +
    +

    Swift

    + 
    var iconRotationAlignment: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + iconScale + +
    +
    +
    +
    +

    Scale factor for icon. 1 is original size, 3 triples the size.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 1. Set this property to nil to reset +it to the default value.

    + +

    This property is only applied to the style if iconImageName is non-nil. +Otherwise, it is ignored.

    + +

    This attribute corresponds to the icon-size +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *iconScale;
    + +
    +
    +

    Swift

    + 
    var iconScale: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + iconTextFit + +
    +
    +
    +
    +

    Scales the icon to fit around the associated text.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing MGLIconTextFitNone. Set this property to nil to +reset it to the default value.

    + +

    This property is only applied to the style if iconImageName is non-nil, and +text is non-nil. Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *iconTextFit;
    + +
    +
    +

    Swift

    + 
    var iconTextFit: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + iconTextFitPadding + +
    +
    +
    +
    +

    Size of the additional area added to dimensions determined by iconTextFit.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing NSEdgeInsetsZero. Set this property to nil to +reset it to the default value.

    + +

    This property is only applied to the style if iconImageName is non-nil, and +text is non-nil, and iconTextFit is set to an MGLStyleValue object +containing an NSValue object containing MGLIconTextFitBoth, +MGLIconTextFitWidth, or MGLIconTextFitHeight. Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *iconTextFitPadding;
    + +
    +
    +

    Swift

    + 
    var iconTextFitPadding: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + keepsIconUpright + +
    +
    +
    +
    +

    If true, the icon may be flipped to prevent it from being rendered upside-down.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing NO. Set this property to nil to reset it to +the default value.

    + +

    This property is only applied to the style if iconImageName is non-nil, and +iconRotationAlignment is set to an MGLStyleValue object containing an +NSValue object containing MGLIconRotationAlignmentMap, and +symbolPlacement is set to an MGLStyleValue object containing an NSValue +object containing MGLSymbolPlacementLine. Otherwise, it is ignored.

    + +

    This attribute corresponds to the icon-keep-upright +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *keepsIconUpright;
    + +
    +
    +

    Swift

    + 
    var keepsIconUpright: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + keepsTextUpright + +
    +
    +
    +
    +

    If true, the text may be flipped vertically to prevent it from being rendered +upside-down.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing YES. Set this property to nil to reset it to +the default value.

    + +

    This property is only applied to the style if text is non-nil, and +textRotationAlignment is set to an MGLStyleValue object containing an +NSValue object containing MGLTextRotationAlignmentMap, and +symbolPlacement is set to an MGLStyleValue object containing an NSValue +object containing MGLSymbolPlacementLine. Otherwise, it is ignored.

    + +

    This attribute corresponds to the text-keep-upright +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *keepsTextUpright;
    + +
    +
    +

    Swift

    + 
    var keepsTextUpright: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + maximumTextAngle + +
    +
    +
    +
    +

    Maximum angle change between adjacent characters.

    + +

    This property is measured in degrees.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 45. Set this property to nil to +reset it to the default value.

    + +

    This property is only applied to the style if text is non-nil, and +symbolPlacement is set to an MGLStyleValue object containing an NSValue +object containing MGLSymbolPlacementLine. Otherwise, it is ignored.

    + +

    This attribute corresponds to the text-max-angle +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *maximumTextAngle;
    + +
    +
    +

    Swift

    + 
    var maximumTextAngle: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + maximumTextWidth + +
    +
    +
    +
    +

    The maximum line width for text wrapping.

    + +

    This property is measured in ems.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 10. Set this property to nil to +reset it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +

    This attribute corresponds to the text-max-width +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *maximumTextWidth;
    + +
    +
    +

    Swift

    + 
    var maximumTextWidth: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + symbolAvoidsEdges + +
    +
    +
    +
    +

    If true, the symbols will not cross tile edges to avoid mutual collisions. +Recommended in layers that don’t have enough padding in the vector tile to +prevent collisions, or if it is a point symbol layer placed after a line symbol +layer.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing NO. Set this property to nil to reset it to +the default value.

    + +

    This attribute corresponds to the symbol-avoid-edges +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *symbolAvoidsEdges;
    + +
    +
    +

    Swift

    + 
    var symbolAvoidsEdges: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + symbolPlacement + +
    +
    +
    +
    +

    Label placement relative to its geometry.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing MGLSymbolPlacementPoint. Set this property to +nil to reset it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *symbolPlacement;
    + +
    +
    +

    Swift

    + 
    var symbolPlacement: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + symbolSpacing + +
    +
    +
    +
    +

    Distance between two symbol anchors.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 250. Set this property to nil to +reset it to the default value.

    + +

    This property is only applied to the style if symbolPlacement is set to an +MGLStyleValue object containing an NSValue object containing +MGLSymbolPlacementLine. Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *symbolSpacing;
    + +
    +
    +

    Swift

    + 
    var symbolSpacing: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + text + +
    +
    +
    +
    +

    Value to use for a text label. Feature properties are specified using tokens +like {field_name}.

    + +

    The default value of this property is an MGLStyleValue object containing the +empty string. Set this property to nil to reset it to the default value.

    + +

    This attribute corresponds to the text-field +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSString *> *text;
    + +
    +
    +

    Swift

    + 
    var text: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textAllowsOverlap + +
    +
    +
    +
    +

    If true, the text will be visible even if it collides with other previously +drawn symbols.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing NO. Set this property to nil to reset it to +the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +

    This attribute corresponds to the text-allow-overlap +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *textAllowsOverlap;
    + +
    +
    +

    Swift

    + 
    var textAllowsOverlap: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textAnchor + +
    +
    +
    +
    +

    Part of the text placed closest to the anchor.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing MGLTextAnchorCenter. Set this property to nil +to reset it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *textAnchor;
    + +
    +
    +

    Swift

    + 
    var textAnchor: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textFontNames + +
    +
    +
    +
    +

    An array of font face names used to display the text.

    + +

    Each font name must be included in the {fontstack} portion of the JSON +stylesheet’s glyphs +property. You can register a custom font when designing the style in Mapbox +Studio. Fonts installed on the system are not used.

    + +

    The first font named in the array is applied to the text. For each character in +the text, if the first font lacks a glyph for the character, the next font is +applied as a fallback, and so on.

    + +

    The default value of this property is an MGLStyleValue object containing the +array Open Sans Regular, Arial Unicode MS Regular. Set this property to +nil to reset it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +

    This attribute corresponds to the text-font +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSArray<NSString *> *> *textFontNames;
    + +
    +
    +

    Swift

    + 
    var textFontNames: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textFontSize + +
    +
    +
    +
    +

    Font size.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 16. Set this property to nil to +reset it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +

    This attribute corresponds to the text-size +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *textFontSize;
    + +
    +
    +

    Swift

    + 
    var textFontSize: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textIgnoresPlacement + +
    +
    +
    +
    +

    If true, other symbols can be visible even if they collide with the text.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing NO. Set this property to nil to reset it to +the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +

    This attribute corresponds to the text-ignore-placement +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *textIgnoresPlacement;
    + +
    +
    +

    Swift

    + 
    var textIgnoresPlacement: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textJustification + +
    +
    +
    +
    +

    Text justification options.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing MGLTextJustificationCenter. Set this property to +nil to reset it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +

    This attribute corresponds to the text-justify +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *textJustification;
    + +
    +
    +

    Swift

    + 
    var textJustification: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textLetterSpacing + +
    +
    +
    +
    +

    Text tracking amount.

    + +

    This property is measured in ems.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 0. Set this property to nil to reset +it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *textLetterSpacing;
    + +
    +
    +

    Swift

    + 
    var textLetterSpacing: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textLineHeight + +
    +
    +
    +
    +

    Text leading value for multi-line text.

    + +

    This property is measured in ems.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 1.2. Set this property to nil to +reset it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *textLineHeight;
    + +
    +
    +

    Swift

    + 
    var textLineHeight: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textOffset + +
    +
    +
    +
    +

    Offset distance of text from its anchor.

    + +

    This property is measured in ems.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing a CGVector struct set to 0 ems rightward and 0 +ems upward. Set this property to nil to reset it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *textOffset;
    + +
    +
    +

    Swift

    + 
    var textOffset: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textOptional + +
    +
    +
    +
    +

    If true, icons will display without their corresponding text when the text +collides with other symbols and the icon does not.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing NO. Set this property to nil to reset it to +the default value.

    + +

    This property is only applied to the style if text is non-nil, and +iconImageName is non-nil. Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (getter=isTextOptional, assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *textOptional;
    + +
    +
    +

    Swift

    + 
    var textOptional: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textPadding + +
    +
    +
    +
    +

    Size of the additional area around the text bounding box used for detecting +symbol collisions.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 2. Set this property to nil to reset +it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *textPadding;
    + +
    +
    +

    Swift

    + 
    var textPadding: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textPitchAlignment + +
    +
    +
    +
    +

    Orientation of text when map is pitched.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing MGLTextPitchAlignmentAuto. Set this property to +nil to reset it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *textPitchAlignment;
    + +
    +
    +

    Swift

    + 
    var textPitchAlignment: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textRotation + +
    +
    +
    +
    +

    Rotates the text clockwise.

    + +

    This property is measured in degrees.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 0. Set this property to nil to reset +it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +

    This attribute corresponds to the text-rotate +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *textRotation;
    + +
    +
    +

    Swift

    + 
    var textRotation: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textRotationAlignment + +
    +
    +
    +
    +

    In combination with symbolPlacement, determines the rotation behavior of the +individual glyphs forming the text.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing MGLTextRotationAlignmentAuto. Set this property +to nil to reset it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *textRotationAlignment;
    + +
    +
    +

    Swift

    + 
    var textRotationAlignment: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textTransform + +
    +
    +
    +
    +

    Specifies how to capitalize text.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing MGLTextTransformNone. Set this property to nil +to reset it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *textTransform;
    + +
    +
    +

    Swift

    + 
    var textTransform: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Accessing the Paint Attributes

+ +
+
    +
  • +
    + + + + iconColor + +
    +
    +
    +
    +

    The tint color to apply to the icon. The iconImageName property must be set +to a template image.

    + +

    The default value of this property is an MGLStyleValue object containing +NSColor.blackColor. Set this property to nil to reset it to the default +value.

    + +

    This property is only applied to the style if iconImageName is non-nil. +Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSColor *> *iconColor;
    + +
    +
    +

    Swift

    + 
    var iconColor: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + iconHaloBlur + +
    +
    +
    +
    +

    Fade out the halo towards the outside.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 0. Set this property to nil to reset +it to the default value.

    + +

    This property is only applied to the style if iconImageName is non-nil. +Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *iconHaloBlur;
    + +
    +
    +

    Swift

    + 
    var iconHaloBlur: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + iconHaloColor + +
    +
    +
    +
    +

    The color of the icon’s halo. The iconImageName property must be set to a +template image.

    + +

    The default value of this property is an MGLStyleValue object containing +NSColor.clearColor. Set this property to nil to reset it to the default +value.

    + +

    This property is only applied to the style if iconImageName is non-nil. +Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSColor *> *iconHaloColor;
    + +
    +
    +

    Swift

    + 
    var iconHaloColor: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + iconHaloWidth + +
    +
    +
    +
    +

    Distance of halo to the icon outline.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 0. Set this property to nil to reset +it to the default value.

    + +

    This property is only applied to the style if iconImageName is non-nil. +Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *iconHaloWidth;
    + +
    +
    +

    Swift

    + 
    var iconHaloWidth: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + iconOpacity + +
    +
    +
    +
    +

    The opacity at which the icon will be drawn.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 1. Set this property to nil to reset +it to the default value.

    + +

    This property is only applied to the style if iconImageName is non-nil. +Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *iconOpacity;
    + +
    +
    +

    Swift

    + 
    var iconOpacity: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + iconTranslation + +
    +
    +
    +
    +

    Distance that the icon’s anchor is moved from its original placement.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing a CGVector struct set to 0 points rightward and 0 +points upward. Set this property to nil to reset it to the default value.

    + +

    This property is only applied to the style if iconImageName is non-nil. +Otherwise, it is ignored.

    + +

    This attribute corresponds to the icon-translate +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *iconTranslation;
    + +
    +
    +

    Swift

    + 
    var iconTranslation: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + iconTranslationAnchor + +
    +
    +
    +
    +

    Controls the translation reference point.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing MGLIconTranslationAnchorMap. Set this property to +nil to reset it to the default value.

    + +

    This property is only applied to the style if iconImageName is non-nil, and +iconTranslation is non-nil. Otherwise, it is ignored.

    + +

    This attribute corresponds to the icon-translate-anchor +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *iconTranslationAnchor;
    + +
    +
    +

    Swift

    + 
    var iconTranslationAnchor: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textColor + +
    +
    +
    +
    +

    The color with which the text will be drawn.

    + +

    The default value of this property is an MGLStyleValue object containing +NSColor.blackColor. Set this property to nil to reset it to the default +value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSColor *> *textColor;
    + +
    +
    +

    Swift

    + 
    var textColor: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textHaloBlur + +
    +
    +
    +
    +

    The halo’s fadeout distance towards the outside.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 0. Set this property to nil to reset +it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *textHaloBlur;
    + +
    +
    +

    Swift

    + 
    var textHaloBlur: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textHaloColor + +
    +
    +
    +
    +

    The color of the text’s halo, which helps it stand out from backgrounds.

    + +

    The default value of this property is an MGLStyleValue object containing +NSColor.clearColor. Set this property to nil to reset it to the default +value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSColor *> *textHaloColor;
    + +
    +
    +

    Swift

    + 
    var textHaloColor: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textHaloWidth + +
    +
    +
    +
    +

    Distance of halo to the font outline. Max text halo width is ¼ of the +font-size.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 0. Set this property to nil to reset +it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *textHaloWidth;
    + +
    +
    +

    Swift

    + 
    var textHaloWidth: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textOpacity + +
    +
    +
    +
    +

    The opacity at which the text will be drawn.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 1. Set this property to nil to reset +it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *textOpacity;
    + +
    +
    +

    Swift

    + 
    var textOpacity: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textTranslation + +
    +
    +
    +
    +

    Distance that the text’s anchor is moved from its original placement.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing a CGVector struct set to 0 points rightward and 0 +points upward. Set this property to nil to reset it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +

    This attribute corresponds to the text-translate +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *textTranslation;
    + +
    +
    +

    Swift

    + 
    var textTranslation: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textTranslationAnchor + +
    +
    +
    +
    +

    Controls the translation reference point.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing MGLTextTranslationAnchorMap. Set this property to +nil to reset it to the default value.

    + +

    This property is only applied to the style if text is non-nil, and +textTranslation is non-nil. Otherwise, it is ignored.

    + +

    This attribute corresponds to the text-translate-anchor +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *textTranslationAnchor;
    + +
    +
    +

    Swift

    + 
    var textTranslationAnchor: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLTilePyramidOfflineRegion.html b/macos/0.3.0-rc.1/Classes/MGLTilePyramidOfflineRegion.html new file mode 100644 index 0000000000..6b272219c1 --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLTilePyramidOfflineRegion.html @@ -0,0 +1,821 @@ + + + + MGLTilePyramidOfflineRegion Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLTilePyramidOfflineRegion Class Reference +
+
+ +
+ +
+ +
+
+

MGLTilePyramidOfflineRegion

 +
+
+ 
@interface MGLTilePyramidOfflineRegion
+    : NSObject <MGLOfflineRegion, NSSecureCoding, NSCopying>
+ +
+
+

An offline region defined by a style URL, geographic coordinate bounds, and +range of zoom levels.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + styleURL + +
    +
    +
    +
    +

    URL of the style whose resources are required for offline viewing.

    + +

    In addition to the JSON stylesheet, different styles may require different font +glyphs, sprite sheets, and other resources.

    + +

    The URL may be a full HTTP or HTTPS URL or a Mapbox URL indicating the style’s +map ID (mapbox://styles/{user}/{style}).

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) NSURL *_Nonnull styleURL;
    + +
    +
    +

    Swift

    + 
    var styleURL: URL { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + bounds + +
    +
    +
    +
    +

    The coordinate bounds for the geographic region covered by the downloaded +tiles.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) MGLCoordinateBounds bounds;
    + +
    +
    +

    Swift

    + 
    var bounds: MGLCoordinateBounds { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + minimumZoomLevel + +
    +
    +
    +
    +

    The minimum zoom level for which to download tiles and other resources.

    + +

    For more information about zoom levels, -[MGLMapView zoomLevel].

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) double minimumZoomLevel;
    + +
    +
    +

    Swift

    + 
    var minimumZoomLevel: Double { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + maximumZoomLevel + +
    +
    +
    +
    +

    The maximum zoom level for which to download tiles and other resources.

    + +

    For more information about zoom levels, -[MGLMapView zoomLevel].

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) double maximumZoomLevel;
    + +
    +
    +

    Swift

    + 
    var maximumZoomLevel: Double { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Initializes a newly created offline region with the given style URL, geographic +coordinate bounds, and range of zoom levels.

    + +

    This is the designated initializer for MGLTilePyramidOfflineRegion.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithStyleURL:(nullable NSURL *)styleURL
+                                  bounds:(MGLCoordinateBounds)bounds
+                           fromZoomLevel:(double)minimumZoomLevel
+                             toZoomLevel:(double)maximumZoomLevel;
    + +
    +
    +

    Swift

    + 
    init(styleURL: URL?, bounds: MGLCoordinateBounds, fromZoomLevel minimumZoomLevel: Double, toZoomLevel maximumZoomLevel: Double)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + styleURL + + +
    +

    URL of the map style for which to download resources. The URL + may be a full HTTP or HTTPS URL or a Mapbox URL indicating the style’s map + ID (mapbox://styles/{user}/{style}). Specify nil for the default style. + Relative file URLs cannot be used as offline style URLs. To download the + online resources required by a local style, specify a URL to an online copy + of the style.

    + +
    +
    + + bounds + + +
    +

    The coordinate bounds for the geographic region to be covered by + the downloaded tiles.

    + +
    +
    + + minimumZoomLevel + + +
    +

    The minimum zoom level to be covered by the downloaded + tiles. This parameter should be set to at least 0 but no greater than the + value of the maximumZoomLevel parameter. For each required tile source, if + this parameter is set to a value less than the tile source’s minimum zoom + level, the download covers zoom levels down to the tile source’s minimum + zoom level.

    + +
    +
    + + maximumZoomLevel + + +
    +

    The maximum zoom level to be covered by the downloaded + tiles. This parameter should be set to at least the value of the + minimumZoomLevel parameter. For each required tile source, if this + parameter is set to a value greater than the tile source’s minimum zoom + level, the download covers zoom levels up to the tile source’s maximum zoom + level.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLTileSource.html b/macos/0.3.0-rc.1/Classes/MGLTileSource.html new file mode 100644 index 0000000000..b890612a03 --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLTileSource.html @@ -0,0 +1,938 @@ + + + + MGLTileSource Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLTileSource Class Reference +
+
+ +
+ +
+ +
+
+

MGLTileSource

 +
+
+ 
@interface MGLTileSource : MGLSource
+ +
+
+

MGLTileSource is a map content source that supplies map tiles to be shown on +the map. The location of and metadata about the tiles are defined either by an +option dictionary or by an external file that conforms to the +TileJSON specification. +A tile source is added to an MGLStyle object along with one or more +MGLRasterStyleLayer or MGLVectorStyleLayer objects. Use a style layer to +control the appearance of content supplied by the tile source.

+ +

Do not create instances of this class directly, and do not create your own +subclasses of this class. Instead, create instances of MGLRasterSource and +MGLVectorSource.

+ +
+
+ +
+
+
+
+ + + +

Initializing a Source

+ +
+
    +
  • + +
    +
    +
    +

    Returns a tile source initialized with an identifier and configuration URL.

    + +

    After initializing and configuring the source, add it to a map view’s style +using the -[MGLStyle addSource:] method.

    + +

    The URL may be a full HTTP or HTTPS URL or, for tile sets hosted by Mapbox, a +Mapbox URL indicating a map identifier (mapbox://<mapid>). The URL should +point to a JSON file that conforms to the +TileJSON specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithIdentifier:(nonnull NSString *)identifier
+                          configurationURL:(nonnull NSURL *)configurationURL;
    + +
    +
    +

    Swift

    + 
    init(identifier: String, configurationURL: URL)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + identifier + + +
    +

    A string that uniquely identifies the source in the style to + which it is added.

    + +
    +
    + + configurationURL + + +
    +

    A URL to a TileJSON configuration file describing the + source’s contents and other metadata.

    + +
    +
    +
    +
    +

    Return Value

    +

    An initialized tile source.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns a tile source initialized an identifier, tile URL templates, and +options.

    + +

    After initializing and configuring the source, add it to a map view’s style +using the -[MGLStyle addSource:] method.

    + +

    Tile URL templates

    + +

    Tile URL templates are strings that specify the URLs of the tile images to +load. Each template resembles an absolute URL, but with any number of +placeholder strings that the source evaluates based on the tile it needs to +load. For example:

    + +
      +
    • http://www.example.com/tiles/{z}/{x}/{y}.pbf could be + evaluated as http://www.example.com/tiles/14/6/9.pbf.
      • +
    • http://www.example.com/tiles/{z}/{x}/{y}{ratio}.png could be + evaluated as http://www.example.com/tiles/14/6/9@2x.png.
      • +
    + +

    Tile sources support the following placeholder strings in tile URL templates, +all of which are optional:

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Placeholder stringDescription
    {x}The index of the tile along the map’s x axis according to Spherical + Mercator projection. If the value is 0, the tile’s left edge corresponds + to the 180th meridian west. If the value is 2z−1, + the tile’s right edge corresponds to the 180th meridian east.
    {y}The index of the tile along the map’s y axis according to Spherical + Mercator projection. If the value is 0, the tile’s tile edge corresponds + to arctan(sinh(π)), or approximately 85.0511 degrees north. If the value + is 2z−1, the tile’s bottom edge corresponds to + −arctan(sinh(π)), or approximately 85.0511 degrees south. The y axis is + inverted if the options parameter contains + MGLTileSourceOptionTileCoordinateSystem with a value of + MGLTileCoordinateSystemTMS.
    {z}The tile’s zoom level. At zoom level 0, each tile covers the entire + world map; at zoom level 1, it covers ¼ of the world; at zoom level 2, + 1⁄16 of the world, and so on. For tiles loaded by + a MGLRasterSource object, whether the tile zoom level + matches the map’s current zoom level depends on the value of the + source’s tile size as specified in the + MGLTileSourceOptionTileSize key of the + options parameter.
    {bbox-epsg-3857}The tile’s bounding box, expressed as a comma-separated list of the + tile’s western, southern, eastern, and northern extents according to + Spherical Mercator (EPSG:3857) projection. The bounding box is typically + used with map services conforming to the + Web Map Service + protocol.
    {quadkey}A quadkey indicating both the tile’s location and its zoom level. The + quadkey is typically used with + Bing Maps. +
    {ratio}A suffix indicating the resolution of the tile image. The suffix is the + empty string for standard resolution displays and @2x for + Retina displays, including displays for which + NSScreen.backingScaleFactor or UIScreen.scale + is 3.
    {prefix}Two hexadecimal digits chosen such that each visible tile has a + different prefix. The prefix is typically used for domain sharding.
    + +

    For more information about the {x}, {y}, and {z} placeholder strings, +consult the +OpenStreetMap Wiki.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)
+initWithIdentifier:(nonnull NSString *)identifier
+  tileURLTemplates:(nonnull NSArray<NSString *> *)tileURLTemplates
+           options:(nullable NSDictionary<MGLTileSourceOption, id> *)options;
    + +
    +
    +

    Swift

    + 
    init(identifier: String, tileURLTemplates: [String], options: [MGLTileSourceOption : Any]? = nil)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + identifier + + +
    +

    A string that uniquely identifies the source in the style to + which it is added.

    + +
    +
    + + tileURLTemplates + + +
    +

    An array of tile URL template strings. Only the first + string is used; any additional strings are ignored.

    + +
    +
    + + options + + +
    +

    A dictionary containing configuration options. See + MGLTileSourceOption for available keys and values. Pass in nil to use + the default values.

    + +
    +
    +
    +
    +

    Return Value

    +

    An initialized tile source.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Accessing a Source’s Content

+ +
+
    +
  • +
    + + + + configurationURL + +
    +
    +
    +
    +

    The URL to the TileJSON configuration file that specifies the contents of the +source.

    + +

    If the receiver was initialized using +-initWithIdentifier:tileURLTemplates:options, this property is set to nil.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, copy, nonatomic, nullable) NSURL *configurationURL;
    + +
    +
    +

    Swift

    + 
    var configurationURL: URL? { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Accessing Attribution Strings

+ +
+
    +
  • +
    + + + + attributionInfos + +
    +
    +
    +
    +

    An array of MGLAttributionInfo objects that define the attribution +statements to be displayed when the map is shown to the user.

    + +

    By default, this array is empty. If the source is initialized with a +configuration URL, this array is also empty until the configuration JSON file +is loaded.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, copy, nonatomic)
+    NSArray<MGLAttributionInfo *> *_Nonnull attributionInfos;
    + +
    +
    +

    Swift

    + 
    var attributionInfos: [MGLAttributionInfo] { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Classes/MGLVectorStyleLayer.html b/macos/0.3.0-rc.1/Classes/MGLVectorStyleLayer.html new file mode 100644 index 0000000000..d966d714c6 --- /dev/null +++ b/macos/0.3.0-rc.1/Classes/MGLVectorStyleLayer.html @@ -0,0 +1,754 @@ + + + + MGLVectorStyleLayer Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLVectorStyleLayer Class Reference +
+
+ +
+ +
+ +
+
+

MGLVectorStyleLayer

 +
+
+ 
@interface MGLVectorStyleLayer : MGLForegroundStyleLayer
+ +
+
+

MGLVectorStyleLayer is an abstract superclass for style layers whose content +is defined by an MGLShapeSource or MGLVectorSource object.

+ +

Do not create instances of this class directly, and do not create your own +subclasses of this class. Instead, create instances of the following concrete +subclasses: MGLCircleStyleLayer, MGLFillStyleLayer, MGLLineStyleLayer, +and MGLSymbolStyleLayer.

+ +
+
+ +
+
+
+
+ + + +

Refining a Style Layer’s Content

+ +
+
    +
  • +
    + + + + sourceLayerIdentifier + +
    +
    +
    +
    +

    Identifier of the layer within the source identified by the sourceIdentifier +property from which the receiver obtains the data to style.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, nullable)
+    NSString *sourceLayerIdentifier;
    + +
    +
    +

    Swift

    + 
    var sourceLayerIdentifier: String? { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + predicate + +
    +
    +
    +
    +

    The style layer’s predicate.

    + +

    Use the style layer’s predicate to include only the features in the source +layer that satisfy a condition that you define. If the style layer initially +comes from the style, its predicate corresponds to the +filter +property in the style JSON.

    + +

    The following comparison operators are supported.

    + +
      +
    • NSEqualToPredicateOperatorType (=, ==)
      • +
    • NSGreaterThanOrEqualToPredicateOperatorType (>=, =>)
      • +
    • NSLessThanOrEqualToPredicateOperatorType (<=, =<)
      • +
    • NSGreaterThanPredicateOperatorType (>)
      • +
    • NSLessThanPredicateOperatorType (<)
      • +
    • NSNotEqualToPredicateOperatorType (!=, <>)
      • +
    • NSBetweenPredicateOperatorType (BETWEEN)
      • +
    + +

    The following compound operators are supported:

    + +
      +
    • NSAndPredicateType (AND, &&)
      • +
    • NSOrPredicateType (OR, ||)
      • +
    • NSNotPredicateType (NOT, !)
      • +
    + +

    The following aggregate operators are supported:

    + +
      +
    • NSInPredicateOperatorType (IN)
      • +
    • NSContainsPredicateOperatorType (CONTAINS)
      • +
    + +

    To test whether a feature has or lacks a specific attribute, compare the +attribute to NULL or NIL. Predicates created using the ++[NSPredicate predicateWithValue:] method are also supported. String +operators and custom operators are not supported.

    + +

    For details about the predicate format string syntax, consult the “Predicate +Format String Syntax” chapter of the +“Predicate Programming Guide” +in Apple developer documentation.

    + +

    The predicate’s left-hand expression must be a string that identifies a feature +attribute or, alternatively, one of the following special attributes:

    + + + + + + + + + + + + + + + + + + + +
    AttributeMeaning
    $id + A value that uniquely identifies the feature in the containing source. + For details on the types of values that may be associated with this key, + consult the documentation for the MGLFeature protocol’s + identifier property. +
    $type + The type of geometry represented by the feature. A feature’s type is + guaranteed to be one of the following strings: +
      +
    • + Point for point features, corresponding to the + MGLPointAnnotation class +
      • +
    • + LineString for polyline features, corresponding to + the MGLPolyline class +
      • +
    • + Polygon for polygon features, corresponding to the + MGLPolygon class +
      • +
    +
    point_countThe number of point features in a given cluster.
    + +

    The predicate’s right-hand expression must be an NSString (to match strings) +or NSNumber (to match numbers, including Boolean values) or an array of +NSStrings or NSNumbers, depending on the operator and the type of values +expected for the attribute being tested. For floating-point values, use +-[NSNumber numberWithDouble:] instead of -[NSNumber numberWithFloat:] +to avoid precision issues.

    + +

    Automatic type casting is not performed. Therefore, a feature only matches this +predicate if its value for the attribute in question is of the same type as the +value specified in the predicate. Also, operator modifiers such as c (for +case insensitivity), d (for diacritic insensitivity), and l (for locale +sensitivity) are unsupported for comparison and aggregate operators that are +used in the predicate.

    + +

    It is possible to create expressions that contain special characters in the +predicate format syntax. This includes the $ in the $id and $type special +style attributes and also hyphen-minus and tag:subtag. However, you must use +%K in the format string to represent these variables: +@"%K == 'LineString'", @"$type".

    + +

    Example

    + +

    To filter the layer to include only the features whose index attribute is 5 +or 10 and whose ele attribute is at least 1,500, you could create an +NSCompoundPredicate along these lines:

    + +
    let layer = MGLLineStyleLayer(identifier: "contour", source: terrain)
+layer.sourceLayerIdentifier = "contours"
+layer.predicate = NSPredicate(format: "(index == 5 || index == 10) && ele >= 1500.0")
+mapView.style?.addLayer(layer)
+
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, nullable) NSPredicate *predicate;
    + +
    +
    +

    Swift

    + 
    var predicate: NSPredicate? { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Content Primitives.html b/macos/0.3.0-rc.1/Content Primitives.html new file mode 100644 index 0000000000..2d564bd056 --- /dev/null +++ b/macos/0.3.0-rc.1/Content Primitives.html @@ -0,0 +1,867 @@ + + + + Content Primitives Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + Content Primitives Reference +
+
+ +
+ +
+ +
+
+

Content Primitives

 + +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Content Sources.html b/macos/0.3.0-rc.1/Content Sources.html new file mode 100644 index 0000000000..1fce7803c7 --- /dev/null +++ b/macos/0.3.0-rc.1/Content Sources.html @@ -0,0 +1,844 @@ + + + + Content Sources Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + Content Sources Reference +
+
+ +
+ +
+ +
+
+

Content Sources

 + +
+
+ +
+
+
+
    +
  • +
    + + + + MGLSource + +
    +
    +
    +
    +

    MGLSource is an abstract base class for map content sources. A map content +source supplies content to be shown on the map. A source is added to an +MGLStyle object along with an MGLForegroundStyleLayer object. The +foreground style layer defines the appearance of any content supplied by the +source.

    + +

    Each source defined by the style JSON file is represented at runtime by an +MGLSource object that you can use to refine the map’s content. You can also +add and remove sources dynamically using methods such as +-[MGLStyle addSource:] and -[MGLStyle sourceWithIdentifier:].

    + +

    Do not create instances of this class directly, and do not create your own +subclasses of this class. Instead, create instances of MGLShapeSource and the +concrete subclasses of MGLTileSource, MGLVectorSource and MGLRasterSource.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLSource : NSObject
    + +
    +
    +

    Swift

    + 
    class MGLSource : NSObject
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLTileSource + +
    +
    +
    +
    +

    MGLTileSource is a map content source that supplies map tiles to be shown on +the map. The location of and metadata about the tiles are defined either by an +option dictionary or by an external file that conforms to the +TileJSON specification. +A tile source is added to an MGLStyle object along with one or more +MGLRasterStyleLayer or MGLVectorStyleLayer objects. Use a style layer to +control the appearance of content supplied by the tile source.

    + +

    Do not create instances of this class directly, and do not create your own +subclasses of this class. Instead, create instances of MGLRasterSource and +MGLVectorSource.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLTileSource : MGLSource
    + +
    +
    +

    Swift

    + 
    class MGLTileSource : MGLSource
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLShapeSource + +
    +
    +
    +
    +

    MGLShapeSource is a map content source that supplies vector shapes to be +shown on the map. The shapes may be instances of MGLShape or MGLFeature, +or they may be defined by local or external +GeoJSON code. A shape source is added to an +MGLStyle object along with an MGLVectorStyleLayer object. The vector style +layer defines the appearance of any content supplied by the shape source.

    + +

    Each +geojson +source defined by the style JSON file is represented at runtime by an +MGLShapeSource object that you can use to refine the map’s content and +initialize new style layers. You can also add and remove sources dynamically +using methods such as -[MGLStyle addSource:] and +-[MGLStyle sourceWithIdentifier:].

    + +

    Any vector style layer initialized with a shape source should have a nil +value in its sourceLayerIdentifier property.

    + +

    Example

    +
    var coordinates: [CLLocationCoordinate2D] = [
+    CLLocationCoordinate2D(latitude: 37.77, longitude: -122.42),
+    CLLocationCoordinate2D(latitude: 38.91, longitude: -77.04),
+]
+let polyline = MGLPolylineFeature(coordinates: &coordinates, count: UInt(coordinates.count))
+let source = MGLShapeSource(identifier: lines, features: [polyline], options: nil)
+mapView.style?.addSource(source)
+

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLShapeSource : MGLSource
    + +
    +
    +

    Swift

    + 
    class MGLShapeSource : MGLSource
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLRasterSource + +
    +
    +
    +
    +

    MGLRasterSource is a map content source that supplies raster image tiles to +be shown on the map. The location of and metadata about the tiles are defined +either by an option dictionary or by an external file that conforms to the +TileJSON specification. +A raster source is added to an MGLStyle object along with one or more +MGLRasterStyleLayer objects. Use a raster style layer to control the +appearance of content supplied by the raster source.

    + +

    Each +raster +source defined by the style JSON file is represented at runtime by an +MGLRasterSource object that you can use to initialize new style layers. You +can also add and remove sources dynamically using methods such as +-[MGLStyle addSource:] and -[MGLStyle sourceWithIdentifier:].

    + +

    Example

    +
    let source = MGLRasterSource(identifier: clouds, tileURLTemplates: [https://example.com/raster-tiles/{z}/{x}/{y}.png], options: [
+    .minimumZoomLevel: 9,
+    .maximumZoomLevel: 16,
+    .tileSize: 512,
+    .attributionInfos: [
+        MGLAttributionInfo(title: NSAttributedString(string: © Mapbox), url: URL(string: http://mapbox.com))
+    ]
+])
+mapView.style?.addSource(source)
+

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLRasterSource : MGLTileSource
    + +
    +
    +

    Swift

    + 
    class MGLRasterSource : MGLTileSource
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLVectorSource + +
    +
    +
    +
    +

    MGLVectorSource is a map content source that supplies tiled vector data in +Mapbox Vector Tile format to +be shown on the map. The location of and metadata about the tiles are defined +either by an option dictionary or by an external file that conforms to the +TileJSON specification. +A vector source is added to an MGLStyle object along with one or more +MGLVectorStyleLayer objects. A vector style layer defines the appearance of +any content supplied by the vector source.

    + +

    Each +vector +source defined by the style JSON file is represented at runtime by an +MGLVectorSource object that you can use to initialize new style layers. You +can also add and remove sources dynamically using methods such as +-[MGLStyle addSource:] and -[MGLStyle sourceWithIdentifier:].

    + +

    Within each vector tile, each geometric coordinate must lie between +−1 × extent and +(extent × 2) − 1, inclusive. Any vector style +layer initialized with a vector source must have a non-nil value in its +sourceLayerIdentifier property.

    + +

    Example

    +
    let source = MGLVectorSource(identifier: pois, tileURLTemplates: [https://example.com/vector-tiles/{z}/{x}/{y}.mvt], options: [
+    .minimumZoomLevel: 9,
+    .maximumZoomLevel: 16,
+    .attributionInfos: [
+        MGLAttributionInfo(title: NSAttributedString(string: © Mapbox), url: URL(string: http://mapbox.com))
+    ]
+])
+mapView.style?.addSource(source)
+

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLVectorSource : MGLTileSource
    + +
    +
    +

    Swift

    + 
    class MGLVectorSource : MGLTileSource
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Enums/MGLCircleScaleAlignment.html b/macos/0.3.0-rc.1/Enums/MGLCircleScaleAlignment.html new file mode 100644 index 0000000000..42611e1173 --- /dev/null +++ b/macos/0.3.0-rc.1/Enums/MGLCircleScaleAlignment.html @@ -0,0 +1,622 @@ + + + + MGLCircleScaleAlignment Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLCircleScaleAlignment Enum Reference +
+
+ +
+ +
+ +
+
+

MGLCircleScaleAlignment

 +
+
+ 
enum MGLCircleScaleAlignment : NSUInteger {}
+ +
+
+

Controls the scaling behavior of the circle when the map is pitched.

+ +

Values of this type are used in the MGLCircleStyleLayer.circleScaleAlignment +property.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Enums/MGLCircleTranslationAnchor.html b/macos/0.3.0-rc.1/Enums/MGLCircleTranslationAnchor.html new file mode 100644 index 0000000000..fc3cd7e3df --- /dev/null +++ b/macos/0.3.0-rc.1/Enums/MGLCircleTranslationAnchor.html @@ -0,0 +1,622 @@ + + + + MGLCircleTranslationAnchor Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLCircleTranslationAnchor Enum Reference +
+
+ +
+ +
+ +
+
+

MGLCircleTranslationAnchor

 +
+
+ 
enum MGLCircleTranslationAnchor : NSUInteger {}
+ +
+
+

Controls the translation reference point.

+ +

Values of this type are used in the MGLCircleStyleLayer.circleTranslationAnchor +property.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Enums/MGLErrorCode.html b/macos/0.3.0-rc.1/Enums/MGLErrorCode.html new file mode 100644 index 0000000000..522d7d5341 --- /dev/null +++ b/macos/0.3.0-rc.1/Enums/MGLErrorCode.html @@ -0,0 +1,691 @@ + + + + MGLErrorCode Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLErrorCode Enum Reference +
+
+ +
+ +
+ +
+
+

MGLErrorCode

 +
+
+ 
enum MGLErrorCode : NSInteger {}
+ +
+
+

Error constants for the Mapbox SDK.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Enums/MGLFillTranslationAnchor.html b/macos/0.3.0-rc.1/Enums/MGLFillTranslationAnchor.html new file mode 100644 index 0000000000..1e4d6557f1 --- /dev/null +++ b/macos/0.3.0-rc.1/Enums/MGLFillTranslationAnchor.html @@ -0,0 +1,622 @@ + + + + MGLFillTranslationAnchor Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLFillTranslationAnchor Enum Reference +
+
+ +
+ +
+ +
+
+

MGLFillTranslationAnchor

 +
+
+ 
enum MGLFillTranslationAnchor : NSUInteger {}
+ +
+
+

Controls the translation reference point.

+ +

Values of this type are used in the MGLFillStyleLayer.fillTranslationAnchor +property.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Enums/MGLIconRotationAlignment.html b/macos/0.3.0-rc.1/Enums/MGLIconRotationAlignment.html new file mode 100644 index 0000000000..7d03e57716 --- /dev/null +++ b/macos/0.3.0-rc.1/Enums/MGLIconRotationAlignment.html @@ -0,0 +1,665 @@ + + + + MGLIconRotationAlignment Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLIconRotationAlignment Enum Reference +
+
+ +
+ +
+ +
+
+

MGLIconRotationAlignment

 +
+
+ 
enum MGLIconRotationAlignment : NSUInteger {}
+ +
+
+

In combination with symbolPlacement, determines the rotation behavior of +icons.

+ +

Values of this type are used in the MGLSymbolStyleLayer.iconRotationAlignment +property.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Enums/MGLIconTextFit.html b/macos/0.3.0-rc.1/Enums/MGLIconTextFit.html new file mode 100644 index 0000000000..b827b3756d --- /dev/null +++ b/macos/0.3.0-rc.1/Enums/MGLIconTextFit.html @@ -0,0 +1,694 @@ + + + + MGLIconTextFit Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLIconTextFit Enum Reference +
+
+ +
+ +
+ +
+
+

MGLIconTextFit

 +
+
+ 
enum MGLIconTextFit : NSUInteger {}
+ +
+
+

Scales the icon to fit around the associated text.

+ +

Values of this type are used in the MGLSymbolStyleLayer.iconTextFit +property.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Enums/MGLIconTranslationAnchor.html b/macos/0.3.0-rc.1/Enums/MGLIconTranslationAnchor.html new file mode 100644 index 0000000000..96c5a86ba3 --- /dev/null +++ b/macos/0.3.0-rc.1/Enums/MGLIconTranslationAnchor.html @@ -0,0 +1,622 @@ + + + + MGLIconTranslationAnchor Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLIconTranslationAnchor Enum Reference +
+
+ +
+ +
+ +
+
+

MGLIconTranslationAnchor

 +
+
+ 
enum MGLIconTranslationAnchor : NSUInteger {}
+ +
+
+

Controls the translation reference point.

+ +

Values of this type are used in the MGLSymbolStyleLayer.iconTranslationAnchor +property.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Enums/MGLLineCap.html b/macos/0.3.0-rc.1/Enums/MGLLineCap.html new file mode 100644 index 0000000000..8e101fef91 --- /dev/null +++ b/macos/0.3.0-rc.1/Enums/MGLLineCap.html @@ -0,0 +1,662 @@ + + + + MGLLineCap Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLLineCap Enum Reference +
+
+ +
+ +
+ +
+
+

MGLLineCap

 +
+
+ 
enum MGLLineCap : NSUInteger {}
+ +
+
+

The display of line endings.

+ +

Values of this type are used in the MGLLineStyleLayer.lineCap +property.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + MGLLineCapButt + +
    +
    +
    +
    +

    A cap with a squared-off end which is drawn to the exact endpoint of the +line.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLLineCapButt
    + +
    +
    +

    Swift

    + 
    case butt = 0
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + MGLLineCapRound + +
    +
    +
    +
    +

    A cap with a rounded end which is drawn beyond the endpoint of the line at +a radius of one-half of the line’s width and centered on the endpoint of +the line.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLLineCapRound
    + +
    +
    +

    Swift

    + 
    case round = 1
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + MGLLineCapSquare + +
    +
    +
    +
    +

    A cap with a squared-off end which is drawn beyond the endpoint of the line +at a distance of one-half of the line’s width.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLLineCapSquare
    + +
    +
    +

    Swift

    + 
    case square = 2
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Enums/MGLLineJoin.html b/macos/0.3.0-rc.1/Enums/MGLLineJoin.html new file mode 100644 index 0000000000..e82f83d12b --- /dev/null +++ b/macos/0.3.0-rc.1/Enums/MGLLineJoin.html @@ -0,0 +1,662 @@ + + + + MGLLineJoin Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLLineJoin Enum Reference +
+
+ +
+ +
+ +
+
+

MGLLineJoin

 +
+
+ 
enum MGLLineJoin : NSUInteger {}
+ +
+
+

The display of lines when joining.

+ +

Values of this type are used in the MGLLineStyleLayer.lineJoin +property.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + MGLLineJoinBevel + +
    +
    +
    +
    +

    A join with a squared-off end which is drawn beyond the endpoint of the +line at a distance of one-half of the line’s width.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLLineJoinBevel
    + +
    +
    +

    Swift

    + 
    case bevel = 0
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + MGLLineJoinRound + +
    +
    +
    +
    +

    A join with a rounded end which is drawn beyond the endpoint of the line at +a radius of one-half of the line’s width and centered on the endpoint of +the line.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLLineJoinRound
    + +
    +
    +

    Swift

    + 
    case round = 1
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + MGLLineJoinMiter + +
    +
    +
    +
    +

    A join with a sharp, angled corner which is drawn with the outer sides +beyond the endpoint of the path until they meet.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLLineJoinMiter
    + +
    +
    +

    Swift

    + 
    case miter = 2
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Enums/MGLLineTranslationAnchor.html b/macos/0.3.0-rc.1/Enums/MGLLineTranslationAnchor.html new file mode 100644 index 0000000000..b5bc8888e9 --- /dev/null +++ b/macos/0.3.0-rc.1/Enums/MGLLineTranslationAnchor.html @@ -0,0 +1,622 @@ + + + + MGLLineTranslationAnchor Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLLineTranslationAnchor Enum Reference +
+
+ +
+ +
+ +
+
+

MGLLineTranslationAnchor

 +
+
+ 
enum MGLLineTranslationAnchor : NSUInteger {}
+ +
+
+

Controls the translation reference point.

+ +

Values of this type are used in the MGLLineStyleLayer.lineTranslationAnchor +property.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Enums/MGLMapDebugMaskOptions.html b/macos/0.3.0-rc.1/Enums/MGLMapDebugMaskOptions.html new file mode 100644 index 0000000000..215cb9937a --- /dev/null +++ b/macos/0.3.0-rc.1/Enums/MGLMapDebugMaskOptions.html @@ -0,0 +1,805 @@ + + + + MGLMapDebugMaskOptions Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLMapDebugMaskOptions Enum Reference +
+
+ +
+ +
+ +
+
+

MGLMapDebugMaskOptions

 +
+
+ 
enum MGLMapDebugMaskOptions : NSUInteger {}
+ +
+
+

Options for enabling debugging features in an MGLMapView instance.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +

    Edges of tile boundaries are shown as thick, red lines to help diagnose + tile clipping issues.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLMapDebugTileBoundariesMask = 1 << 1
    + +
    +
    +

    Swift

    + 
    static var tileBoundariesMask: MGLMapDebugMaskOptions { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Each tile shows its tile coordinate (x/y/z) in the upper-left corner.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLMapDebugTileInfoMask = 1 << 2
    + +
    +
    +

    Swift

    + 
    static var tileInfoMask: MGLMapDebugMaskOptions { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Each tile shows a timestamp indicating when it was loaded.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLMapDebugTimestampsMask = 1 << 3
    + +
    +
    +

    Swift

    + 
    static var timestampsMask: MGLMapDebugMaskOptions { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Edges of glyphs and symbols are shown as faint, green lines to help + diagnose collision and label placement issues.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLMapDebugCollisionBoxesMask = 1 << 4
    + +
    +
    +

    Swift

    + 
    static var collisionBoxesMask: MGLMapDebugMaskOptions { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Each drawing operation is replaced by a translucent fill. Overlapping + drawing operations appear more prominent to help diagnose overdrawing. + - note: This option does nothing in Release builds of the SDK.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLMapDebugOverdrawVisualizationMask = 1 << 5
    + +
    +
    +

    Swift

    + 
    static var overdrawVisualizationMask: MGLMapDebugMaskOptions { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    The stencil buffer is shown instead of the color buffer. + - note: This option does nothing in Release builds of the SDK.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLMapDebugStencilBufferMask = 1 << 6
    + +
    +
    +

    Swift

    + 
    static var stencilBufferMask: MGLMapDebugMaskOptions { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    The depth buffer is shown instead of the color buffer. + - note: This option does nothing in Release builds of the SDK.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLMapDebugDepthBufferMask = 1 << 7
    + +
    +
    +

    Swift

    + 
    static var depthBufferMask: MGLMapDebugMaskOptions { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Enums/MGLOfflinePackState.html b/macos/0.3.0-rc.1/Enums/MGLOfflinePackState.html new file mode 100644 index 0000000000..2675fa9904 --- /dev/null +++ b/macos/0.3.0-rc.1/Enums/MGLOfflinePackState.html @@ -0,0 +1,746 @@ + + + + MGLOfflinePackState Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLOfflinePackState Enum Reference +
+
+ +
+ +
+ +
+
+

MGLOfflinePackState

 +
+
+ 
enum MGLOfflinePackState : NSInteger {}
+ +
+
+

The state an offline pack is currently in.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Enums/MGLSymbolPlacement.html b/macos/0.3.0-rc.1/Enums/MGLSymbolPlacement.html new file mode 100644 index 0000000000..ea0d1be17d --- /dev/null +++ b/macos/0.3.0-rc.1/Enums/MGLSymbolPlacement.html @@ -0,0 +1,623 @@ + + + + MGLSymbolPlacement Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLSymbolPlacement Enum Reference +
+
+ +
+ +
+ +
+
+

MGLSymbolPlacement

 +
+
+ 
enum MGLSymbolPlacement : NSUInteger {}
+ +
+
+

Label placement relative to its geometry.

+ +

Values of this type are used in the MGLSymbolStyleLayer.symbolPlacement +property.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +

    The label is placed at the point where the geometry is located.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLSymbolPlacementPoint
    + +
    +
    +

    Swift

    + 
    case point = 0
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    The label is placed along the line of the geometry. Can only be used on +LineString and Polygon geometries.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLSymbolPlacementLine
    + +
    +
    +

    Swift

    + 
    case line = 1
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Enums/MGLTextAnchor.html b/macos/0.3.0-rc.1/Enums/MGLTextAnchor.html new file mode 100644 index 0000000000..a32bf4158b --- /dev/null +++ b/macos/0.3.0-rc.1/Enums/MGLTextAnchor.html @@ -0,0 +1,874 @@ + + + + MGLTextAnchor Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLTextAnchor Enum Reference +
+
+ +
+ +
+ +
+
+

MGLTextAnchor

 +
+
+ 
enum MGLTextAnchor : NSUInteger {}
+ +
+
+

Part of the text placed closest to the anchor.

+ +

Values of this type are used in the MGLSymbolStyleLayer.textAnchor +property.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + MGLTextAnchorCenter + +
    +
    +
    +
    +

    The center of the text is placed closest to the anchor.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLTextAnchorCenter
    + +
    +
    +

    Swift

    + 
    case center = 0
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + MGLTextAnchorLeft + +
    +
    +
    +
    +

    The left side of the text is placed closest to the anchor.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLTextAnchorLeft
    + +
    +
    +

    Swift

    + 
    case left = 1
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + MGLTextAnchorRight + +
    +
    +
    +
    +

    The right side of the text is placed closest to the anchor.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLTextAnchorRight
    + +
    +
    +

    Swift

    + 
    case right = 2
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + MGLTextAnchorTop + +
    +
    +
    +
    +

    The top of the text is placed closest to the anchor.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLTextAnchorTop
    + +
    +
    +

    Swift

    + 
    case top = 3
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + MGLTextAnchorBottom + +
    +
    +
    +
    +

    The bottom of the text is placed closest to the anchor.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLTextAnchorBottom
    + +
    +
    +

    Swift

    + 
    case bottom = 4
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + MGLTextAnchorTopLeft + +
    +
    +
    +
    +

    The top left corner of the text is placed closest to the anchor.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLTextAnchorTopLeft
    + +
    +
    +

    Swift

    + 
    case topLeft = 5
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + MGLTextAnchorTopRight + +
    +
    +
    +
    +

    The top right corner of the text is placed closest to the anchor.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLTextAnchorTopRight
    + +
    +
    +

    Swift

    + 
    case topRight = 6
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    The bottom left corner of the text is placed closest to the anchor.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLTextAnchorBottomLeft
    + +
    +
    +

    Swift

    + 
    case bottomLeft = 7
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    The bottom right corner of the text is placed closest to the anchor.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLTextAnchorBottomRight
    + +
    +
    +

    Swift

    + 
    case bottomRight = 8
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Enums/MGLTextJustification.html b/macos/0.3.0-rc.1/Enums/MGLTextJustification.html new file mode 100644 index 0000000000..1ea3cf5a90 --- /dev/null +++ b/macos/0.3.0-rc.1/Enums/MGLTextJustification.html @@ -0,0 +1,658 @@ + + + + MGLTextJustification Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLTextJustification Enum Reference +
+
+ +
+ +
+ +
+
+

MGLTextJustification

 +
+
+ 
enum MGLTextJustification : NSUInteger {}
+ +
+
+

Text justification options.

+ +

Values of this type are used in the MGLSymbolStyleLayer.textJustification +property.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Enums/MGLTextPitchAlignment.html b/macos/0.3.0-rc.1/Enums/MGLTextPitchAlignment.html new file mode 100644 index 0000000000..265cf78b07 --- /dev/null +++ b/macos/0.3.0-rc.1/Enums/MGLTextPitchAlignment.html @@ -0,0 +1,658 @@ + + + + MGLTextPitchAlignment Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLTextPitchAlignment Enum Reference +
+
+ +
+ +
+ +
+
+

MGLTextPitchAlignment

 +
+
+ 
enum MGLTextPitchAlignment : NSUInteger {}
+ +
+
+

Orientation of text when map is pitched.

+ +

Values of this type are used in the MGLSymbolStyleLayer.textPitchAlignment +property.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Enums/MGLTextRotationAlignment.html b/macos/0.3.0-rc.1/Enums/MGLTextRotationAlignment.html new file mode 100644 index 0000000000..956eae8bb1 --- /dev/null +++ b/macos/0.3.0-rc.1/Enums/MGLTextRotationAlignment.html @@ -0,0 +1,665 @@ + + + + MGLTextRotationAlignment Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLTextRotationAlignment Enum Reference +
+
+ +
+ +
+ +
+
+

MGLTextRotationAlignment

 +
+
+ 
enum MGLTextRotationAlignment : NSUInteger {}
+ +
+
+

In combination with symbolPlacement, determines the rotation behavior of the +individual glyphs forming the text.

+ +

Values of this type are used in the MGLSymbolStyleLayer.textRotationAlignment +property.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Enums/MGLTextTransform.html b/macos/0.3.0-rc.1/Enums/MGLTextTransform.html new file mode 100644 index 0000000000..4c14611183 --- /dev/null +++ b/macos/0.3.0-rc.1/Enums/MGLTextTransform.html @@ -0,0 +1,658 @@ + + + + MGLTextTransform Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLTextTransform Enum Reference +
+
+ +
+ +
+ +
+
+

MGLTextTransform

 +
+
+ 
enum MGLTextTransform : NSUInteger {}
+ +
+
+

Specifies how to capitalize text.

+ +

Values of this type are used in the MGLSymbolStyleLayer.textTransform +property.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Enums/MGLTextTranslationAnchor.html b/macos/0.3.0-rc.1/Enums/MGLTextTranslationAnchor.html new file mode 100644 index 0000000000..ab9376c6b9 --- /dev/null +++ b/macos/0.3.0-rc.1/Enums/MGLTextTranslationAnchor.html @@ -0,0 +1,622 @@ + + + + MGLTextTranslationAnchor Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLTextTranslationAnchor Enum Reference +
+
+ +
+ +
+ +
+
+

MGLTextTranslationAnchor

 +
+
+ 
enum MGLTextTranslationAnchor : NSUInteger {}
+ +
+
+

Controls the translation reference point.

+ +

Values of this type are used in the MGLSymbolStyleLayer.textTranslationAnchor +property.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Enums/MGLTileCoordinateSystem.html b/macos/0.3.0-rc.1/Enums/MGLTileCoordinateSystem.html new file mode 100644 index 0000000000..b1afb9482f --- /dev/null +++ b/macos/0.3.0-rc.1/Enums/MGLTileCoordinateSystem.html @@ -0,0 +1,628 @@ + + + + MGLTileCoordinateSystem Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLTileCoordinateSystem Enum Reference +
+
+ +
+ +
+ +
+
+

MGLTileCoordinateSystem

 +
+
+ 
enum MGLTileCoordinateSystem : NSUInteger {}
+ +
+
+

Tile coordinate systems that determine how tile coordinates in tile URLs are +interpreted.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +

    The origin is at the top-left (northwest), and y values increase +southwards.

    + +

    This tile coordinate system is used by Mapbox and OpenStreetMap tile +servers.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLTileCoordinateSystemXYZ = 0
    + +
    +
    +

    Swift

    + 
    case XYZ = 0
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    The origin is at the bottom-left (southwest), and y values increase +northwards.

    + +

    This tile coordinate system is used by tile servers that conform to the +Tile Map Service Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLTileCoordinateSystemTMS
    + +
    +
    +

    Swift

    + 
    case TMS = 1
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Enums/MGLUserTrackingMode.html b/macos/0.3.0-rc.1/Enums/MGLUserTrackingMode.html new file mode 100644 index 0000000000..5d290383fc --- /dev/null +++ b/macos/0.3.0-rc.1/Enums/MGLUserTrackingMode.html @@ -0,0 +1,692 @@ + + + + MGLUserTrackingMode Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLUserTrackingMode Enum Reference +
+
+ +
+ +
+ +
+
+

MGLUserTrackingMode

 +
+
+ 
enum MGLUserTrackingMode : NSUInteger {}
+ +
+
+

The mode used to track the user location on the map. Used with +MGLMapView.userTrackingMode.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Formatters.html b/macos/0.3.0-rc.1/Formatters.html new file mode 100644 index 0000000000..9da04fbb68 --- /dev/null +++ b/macos/0.3.0-rc.1/Formatters.html @@ -0,0 +1,674 @@ + + + + Formatters Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + Formatters Reference +
+
+ +
+ +
+ +
+
+

Formatters

 + +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +

    The MGLClockDirectionFormatter class provides properly formatted descriptions +of headings relative to the user, known as clock positions. For +example, a value of 90 may be formatted as “3 o’clock”, depending on the +locale.

    + +

    Use this class to create localized heading strings when displaying directions +relative to the user’s current location and heading. To format a direction +irrespective of the user’s orientation, use MGLCompassDirectionFormatter +instead.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLClockDirectionFormatter : NSFormatter
    + +
    +
    +

    Swift

    + 
    class MGLClockDirectionFormatter : Formatter
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • + +
    +
    +
    +

    The MGLCompassDirectionFormatter class provides properly formatted +descriptions of absolute headings. For example, a value of 90 may be +formatted as “east”, depending on the locale.

    + +

    Use this class to create localized heading strings when displaying directions +irrespective of the user’s current location. To format a direction relative to +the user’s current location, use MGLClockDirectionFormatter instead.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLCompassDirectionFormatter : NSFormatter
    + +
    +
    +

    Swift

    + 
    class MGLCompassDirectionFormatter : Formatter
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • + +
    +
    +
    +

    The MGLCoordinateFormatter class provides properly formatted descriptions of +geographic coordinate pairs. Use this class to create localized coordinate +strings when displaying location information to users.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLCoordinateFormatter : NSFormatter
    + +
    +
    +

    Swift

    + 
    class MGLCoordinateFormatter : Formatter
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Geometry.html b/macos/0.3.0-rc.1/Geometry.html new file mode 100644 index 0000000000..1c6312db6b --- /dev/null +++ b/macos/0.3.0-rc.1/Geometry.html @@ -0,0 +1,1106 @@ + + + + Geometry Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + Geometry Reference +
+
+ +
+ +
+ +
+
+

Geometry

 + +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Guides.html b/macos/0.3.0-rc.1/Guides.html new file mode 100644 index 0000000000..dc56590ec2 --- /dev/null +++ b/macos/0.3.0-rc.1/Guides.html @@ -0,0 +1,535 @@ + + + + Guides Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + Guides Reference +
+
+ +
+ +
+ +
+
+

Guides

 + +
+
+ +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Maps.html b/macos/0.3.0-rc.1/Maps.html new file mode 100644 index 0000000000..6a21c6d7bd --- /dev/null +++ b/macos/0.3.0-rc.1/Maps.html @@ -0,0 +1,782 @@ + + + + Maps Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + Maps Reference +
+
+ +
+ +
+ +
+
+

Maps

 + +
+
+ +
+
+
+
    +
  • +
    + + + + MGLAccountManager + +
    +
    +
    +
    +

    The MGLAccountManager object provides a global way to set a Mapbox API access +token.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLAccountManager : NSObject
    + +
    +
    +

    Swift

    + 
    class MGLAccountManager : NSObject
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLMapCamera + +
    +
    +
    +
    +

    An MGLMapCamera object represents a viewpoint from which the user observes +some point on an MGLMapView.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLMapCamera : NSObject <NSSecureCoding, NSCopying>
    + +
    +
    +

    Swift

    + 
    class MGLMapCamera : NSObject, NSSecureCoding, NSCopying
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLMapView + +
    +
    +
    +
    +

    An interactive, customizable map view with an interface similar to the one +provided by Apple’s MapKit.

    + +

    Using MGLMapView, you can embed the map inside a view, allow users to +manipulate it with standard gestures, animate the map between different +viewpoints, and present information in the form of annotations and overlays.

    + +

    The map view loads scalable vector tiles that conform to the +Mapbox Vector Tile Specification. +It styles them with a style that conforms to the +Mapbox Style Specification. +Such styles can be designed in +Mapbox Studio and hosted on +mapbox.com.

    + +

    A collection of Mapbox-hosted styles is available through the MGLStyle class. +These basic styles use +Mapbox Streets +or Mapbox Satellite data +sources, but you can specify a custom style that makes use of your own data.

    + +

    Mapbox-hosted vector tiles and styles require an API access token, which you +can obtain from the +Mapbox account page. +Access tokens associate requests to Mapbox’s vector tile and style APIs with +your Mapbox account. They also deter other developers from using your styles +without your permission.

    + +
    +

    Note

    + You are responsible for getting permission to use the map data and for +ensuring that your use adheres to the relevant terms of use. + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLMapView : NSView
    + +
    +
    +

    Swift

    + 
    class MGLMapView : NSView
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLMapViewDelegate + +
    +
    +
    +
    +

    The MGLMapViewDelegate protocol defines a set of optional methods that you +can use to receive messages from an MGLMapView instance. Because many map +operations require the MGLMapView class to load data asynchronously, the map +view calls these methods to notify your application when specific operations +complete. The map view also uses these methods to request information about +annotations displayed on the map, such as the styles and interaction modes to +apply to individual annotations.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @protocol MGLMapViewDelegate <NSObject>
    + +
    +
    +

    Swift

    + 
    protocol MGLMapViewDelegate : NSObjectProtocol
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLUserTrackingMode + +
    +
    +
    +
    +

    The mode used to track the user location on the map. Used with +MGLMapView.userTrackingMode.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum MGLUserTrackingMode : NSUInteger {}
    + +
    +
    +

    Swift

    + 
    enum MGLUserTrackingMode : UInt
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Offline Maps.html b/macos/0.3.0-rc.1/Offline Maps.html new file mode 100644 index 0000000000..f142781bd4 --- /dev/null +++ b/macos/0.3.0-rc.1/Offline Maps.html @@ -0,0 +1,786 @@ + + + + Offline Maps Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + Offline Maps Reference +
+
+ +
+ +
+ +
+
+

Offline Maps

 + +
+
+ +
+
+
+
    +
  • +
    + + + + MGLOfflineRegion + +
    +
    +
    +
    +

    An object conforming to the MGLOfflineRegion protocol determines which +resources are required by an MGLOfflinePack object. At present, only +instances of MGLTilePyramidOfflineRegion may be used as MGLOfflinePack +regions, but additional conforming implementations may be added in the future.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @protocol MGLOfflineRegion <NSObject>
    + +
    +
    +

    Swift

    + 
    protocol MGLOfflineRegion : NSObjectProtocol
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLOfflineStorage + +
    +
    +
    +
    +

    MGLOfflineStorage implements a singleton (shared object) that manages offline +packs. All of this class’s instance methods are asynchronous, reflecting the +fact that offline resources are stored in a database. The shared object +maintains a canonical collection of offline packs in its packs property.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLOfflineStorage : NSObject
    + +
    +
    +

    Swift

    + 
    class MGLOfflineStorage : NSObject
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLOfflinePack + +
    +
    +
    +
    +

    An MGLOfflinePack represents a collection of resources necessary for viewing +a region offline to a local database.

    + +

    To create an instance of MGLOfflinePack, use the ++[MGLOfflineStorage addPackForRegion:withContext:completionHandler:] method. +A pack created using -[MGLOfflinePack init] is immediately invalid.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLOfflinePack : NSObject
    + +
    +
    +

    Swift

    + 
    class MGLOfflinePack : NSObject
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    A structure containing information about an offline pack’s current download +progress.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    struct MGLOfflinePackProgress {}
    + +
    +
    +

    Swift

    + 
    struct MGLOfflinePackProgress
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + MGLOfflinePackState + +
    +
    +
    +
    +

    The state an offline pack is currently in.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum MGLOfflinePackState : NSInteger {}
    + +
    +
    +

    Swift

    + 
    enum MGLOfflinePackState : Int
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Other Categories.html b/macos/0.3.0-rc.1/Other Categories.html new file mode 100644 index 0000000000..7e9d0795f5 --- /dev/null +++ b/macos/0.3.0-rc.1/Other Categories.html @@ -0,0 +1,720 @@ + + + + Other Categories Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + Other Categories Reference +
+
+ +
+ +
+ +
+
+

Other Categories

 +

The following categories are available globally.

+ +
+
+ +
+
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Other Classes.html b/macos/0.3.0-rc.1/Other Classes.html new file mode 100644 index 0000000000..88aec6310d --- /dev/null +++ b/macos/0.3.0-rc.1/Other Classes.html @@ -0,0 +1,668 @@ + + + + Other Classes Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + Other Classes Reference +
+
+ +
+ +
+ +
+
+

Other Classes

 +

The following classes are available globally.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + MGLAttributionInfo + +
    +
    +
    +
    +

    Information about an attribution statement, usually a copyright or trademark +statement, associated with a map content source.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLAttributionInfo : NSObject
    + +
    +
    +

    Swift

    + 
    class MGLAttributionInfo : NSObject
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLStyleConstantValue + +
    +
    +
    +
    +

    An MGLStyleConstantValue object is a generic container for a style attribute +value that remains constant as the zoom level changes. The layout and paint +attribute properties of MGLStyleLayer objects can be set to +MGLStyleConstantValue objects.

    + +

    The MGLStyleConstantValue class takes a generic parameter T that indicates +the Foundation class being wrapped by this class.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLStyleConstantValue <T> : MGLStyleValue<T>
    + +
    +
    +

    Swift

    + 
    class MGLStyleConstantValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + MGLStyleFunction + +
    +
    +
    +
    +

    An MGLStyleFunction is a value function defining a style value that changes +as the zoom level changes. The layout and paint attribute properties of an +MGLStyleLayer object can be set to MGLStyleFunction objects. Use a zoom +level function to create the illusion of depth and control data density.

    + +

    The MGLStyleFunction class takes a generic parameter T that indicates the +Foundation class being wrapped by this class.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLStyleFunction <T> : MGLStyleValue<T>
    + +
    +
    +

    Swift

    + 
    class MGLStyleFunction
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Other Constants.html b/macos/0.3.0-rc.1/Other Constants.html new file mode 100644 index 0000000000..a60ddb9a74 --- /dev/null +++ b/macos/0.3.0-rc.1/Other Constants.html @@ -0,0 +1,1539 @@ + + + + Other Constants Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + Other Constants Reference +
+
+ +
+ +
+ +
+
+

Other Constants

 +

The following constants are available globally.

+ +
+
+ +
+
+
+ +
+
+
    +
  • + +
    +
    +
    +

    An NSNumber object containing a floating-point number that specifies the +width and height (measured in points) at which the map displays each raster +image tile when the map’s zoom level is an integer. The raster source scales +its images up or down when the map’s zoom level falls between two integers.

    + +

    The default value for this option is 512. Version 4 of the +Mapbox Maps API +requires a value of 256, as do many third-party tile servers, so consult your +provider’s documentation for the correct value.

    + +

    This option is only applicable to MGLRasterSource objects; it is ignored when +initializing MGLVectorSource objects.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern const MGLTileSourceOption _Nonnull MGLTileSourceOptionTileSize
    + +
    +
    +

    Swift

    + 
    static let tileSize: MGLTileSourceOption
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • + +
    +
    +
    +

    An NSNumber object containing a Boolean enabling or disabling clustering. +If the shape property contains point shapes, setting this option to +YES clusters the points by radius into groups. The default value is NO.

    + +

    This attribute corresponds to the +cluster +source property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern const MGLShapeSourceOption _Nonnull MGLShapeSourceOptionClustered
    + +
    +
    +

    Swift

    + 
    static let clustered: MGLShapeSourceOption
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    An NSNumber object containing an integer; specifies the radius of each +cluster if clustering is enabled. A value of 512 produces a radius equal to +the width of a tile. The default value is 50.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern const MGLShapeSourceOption _Nonnull MGLShapeSourceOptionClusterRadius
    + +
    +
    +

    Swift

    + 
    static let clusterRadius: MGLShapeSourceOption
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    An NSNumber object containing an integer; specifies the maximum zoom level at +which to cluster points if clustering is enabled. Defaults to one zoom level +less than the value of MGLShapeSourceOptionMaximumZoomLevel so that, at the +maximum zoom level, the shapes are not clustered.

    + +

    This attribute corresponds to the +clusterMaxZoom +source property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern const MGLShapeSourceOption _Nonnull MGLShapeSourceOptionMaximumZoomLevelForClustering
    + +
    +
    +

    Swift

    + 
    static let maximumZoomLevelForClustering: MGLShapeSourceOption
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    An NSNumber object containing an integer; specifies the maximum zoom level at +which to create vector tiles. A greater value produces greater detail at high +zoom levels. The default value is 18.

    + +

    This attribute corresponds to the +maxzoom +source property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern const MGLShapeSourceOption _Nonnull MGLShapeSourceOptionMaximumZoomLevel
    + +
    +
    +

    Swift

    + 
    static let maximumZoomLevel: MGLShapeSourceOption
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    An NSNumber object containing an integer; specifies the size of the tile +buffer on each side. A value of 0 produces no buffer. A value of 512 produces a +buffer as wide as the tile itself. Larger values produce fewer rendering +artifacts near tile edges and slower performance. The default value is 128.

    + +

    This attribute corresponds to the +buffer +source property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern const MGLShapeSourceOption _Nonnull MGLShapeSourceOptionBuffer
    + +
    +
    +

    Swift

    + 
    static let buffer: MGLShapeSourceOption
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    An NSNumber object containing a double; specifies the Douglas-Peucker +simplification tolerance. A greater value produces simpler geometries and +improves performance. The default value is 0.375.

    + +

    This attribute corresponds to the +tolerance +source property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern const MGLShapeSourceOption _Nonnull MGLShapeSourceOptionSimplificationTolerance
    + +
    +
    +

    Swift

    + 
    static let simplificationTolerance: MGLShapeSourceOption
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • + +
    +
    +
    +

    A version number identifying the default version of the suite of default styles +provided by Mapbox. This version number may be passed into one of the +“StyleURLWithVersion” class methods of MGLStyle.

    + +

    The value of this constant generally corresponds to the latest released version +as of the date on which this SDK was published. You can use this constant to +ascertain the style used by MGLMapView and MGLTilePyramidOfflineRegion when +no style URL is specified. Consult the +Mapbox Styles API documentation +for the most up-to-date style versioning information.

    + +
    +

    Warning

    + The value of this constant may change in a future release of the SDK. +If you use any feature that depends on a specific aspect of a default style +– for instance, the minimum zoom level that includes roads – you may use the +current value of this constant or the underlying style URL, but do not use +the constant itself. Such details may change significantly from version to +version. + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    static const NSInteger MGLStyleDefaultVersion = 9
    + +
    +
    +

    Swift

    + 
    let MGLStyleDefaultVersion: Int
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+ +
+
+
    +
  • +
    + + + + MGLErrorDomain + +
    +
    +
    +
    +

    Indicates an error occurred in the Mapbox SDK.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern const NSErrorDomain _Nonnull MGLErrorDomain
    + +
    +
    +

    Swift

    + 
    let MGLErrorDomain: String
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Other Enums.html b/macos/0.3.0-rc.1/Other Enums.html new file mode 100644 index 0000000000..6d4dee1ac5 --- /dev/null +++ b/macos/0.3.0-rc.1/Other Enums.html @@ -0,0 +1,1314 @@ + + + + Other Enums Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + Other Enums Reference +
+
+ +
+ +
+ +
+
+

Other Enums

 +

The following enums are available globally.

+ +
+
+ +
+
+
+ +
+
+ +
+
+ +
+
+ +
+
+
    +
  • + +
    +
    +
    +

    Tile coordinate systems that determine how tile coordinates in tile URLs are +interpreted.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum MGLTileCoordinateSystem : NSUInteger {}
    + +
    +
    +

    Swift

    + 
    enum MGLTileCoordinateSystem : UInt
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Other Type Definitions.html b/macos/0.3.0-rc.1/Other Type Definitions.html new file mode 100644 index 0000000000..6ea33193ef --- /dev/null +++ b/macos/0.3.0-rc.1/Other Type Definitions.html @@ -0,0 +1,794 @@ + + + + Other Type Definitions Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + Other Type Definitions Reference +
+
+ +
+ +
+ +
+
+

Other Type Definitions

 +

The following type definitions are available globally.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +

    A key in the userInfo property of a notification posted by MGLOfflinePack.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef NSString *MGLOfflinePackUserInfoKey
    + +
    +
    +

    Swift

    + 
    struct MGLOfflinePackUserInfoKey : RawRepresentable, _SwiftNewtypeWrapper, Equatable, Hashable, Comparable, _ObjectiveCBridgeable
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    A block to be called once an offline pack has been completely created and +added.

    + +

    An application typically calls the -resume method on the pack inside this +completion handler to begin the download.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef void (^MGLOfflinePackAdditionCompletionHandler)(
+    MGLOfflinePack *_Nullable, NSError *_Nullable)
    + +
    +
    +

    Swift

    + 
    typealias MGLOfflinePackAdditionCompletionHandler = (MGLOfflinePack?, Error?) -> Void
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + pack + + +
    +

    Contains a pointer to the newly added pack, or nil if there was + an error creating or adding the pack.

    + +
    +
    + + error + + +
    +

    Contains a pointer to an error object (if any) indicating why the + pack could not be created or added.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    A block to be called once an offline pack has been completely invalidated and +removed.

    + +

    Avoid any references to the pack inside this completion handler: by the time +this completion handler is executed, the pack has become invalid, and any +messages passed to it will raise an exception.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef void (^MGLOfflinePackRemovalCompletionHandler)(NSError *_Nullable)
    + +
    +
    +

    Swift

    + 
    typealias MGLOfflinePackRemovalCompletionHandler = (Error?) -> Void
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + error + + +
    +

    Contains a pointer to an error object (if any) indicating why the + pack could not be invalidated or removed.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLShapeSourceOption + +
    +
    +
    +
    +

    Options for MGLShapeSource objects.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef NSString *MGLShapeSourceOption
    + +
    +
    +

    Swift

    + 
    struct MGLShapeSourceOption : RawRepresentable, _SwiftNewtypeWrapper, Equatable, Hashable, Comparable, _ObjectiveCBridgeable
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLTileSourceOption + +
    +
    +
    +
    +

    Options for MGLTileSource objects.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef NSString *MGLTileSourceOption
    + +
    +
    +

    Swift

    + 
    struct MGLTileSourceOption : RawRepresentable, _SwiftNewtypeWrapper, Equatable, Hashable, Comparable, _ObjectiveCBridgeable
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Protocols/MGLAnnotation.html b/macos/0.3.0-rc.1/Protocols/MGLAnnotation.html new file mode 100644 index 0000000000..a7b4eb094e --- /dev/null +++ b/macos/0.3.0-rc.1/Protocols/MGLAnnotation.html @@ -0,0 +1,729 @@ + + + + MGLAnnotation Protocol Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLAnnotation Protocol Reference +
+
+ +
+ +
+ +
+
+

MGLAnnotation

 +
+
+ 
@protocol MGLAnnotation <NSObject>
+ +
+
+

The MGLAnnotation protocol is used to provide annotation-related information +to a map view. To use this protocol, you adopt it in any custom objects that +store or represent annotation data. Each object then serves as the source of +information about a single map annotation and provides critical information, +such as the annotation’s location on the map. Annotation objects do not provide +the visual representation of the annotation but typically coordinate (in +conjunction with the map view’s delegate) the creation of an appropriate +objects to handle the display.

+ +

An object that adopts this protocol must implement the coordinate property. +The other methods of this protocol are optional.

+ +
+
+ +
+
+
+
+ + + +

Position Attributes

+ +
+
    +
  • +
    + + + + coordinate + +
    +
    +
    +
    +

    The center point (specified as a map coordinate) of the annotation. (required) +(read-only)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) CLLocationCoordinate2D coordinate;
    + +
    +
    +

    Swift

    + 
    var coordinate: CLLocationCoordinate2D { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Title Attributes

+ +
+
    +
  • +
    + + + + title + +
    +
    +
    +
    +

    The string containing the annotation’s title.

    + +

    Although this property is optional, if you support the selection of annotations +in your map view, you are expected to provide this property. This string is +displayed in the callout for the associated annotation.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @optional
+@property (readonly, copy, nonatomic, nullable) NSString *title;
    + +
    +
    +

    Swift

    + 
    optional var title: String? { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + subtitle + +
    +
    +
    +
    +

    The string containing the annotation’s subtitle.

    + +

    This string is displayed in the callout for the associated annotation.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @optional
+@property (readonly, copy, nonatomic, nullable) NSString *subtitle;
    + +
    +
    +

    Swift

    + 
    optional var subtitle: String? { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + toolTip + +
    +
    +
    +
    +

    The string containing the annotation’s tooltip.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @optional
+@property (readonly, copy, nonatomic, nullable) NSString *toolTip;
    + +
    +
    +

    Swift

    + 
    optional var toolTip: String? { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Protocols/MGLFeature.html b/macos/0.3.0-rc.1/Protocols/MGLFeature.html new file mode 100644 index 0000000000..75cecb78bf --- /dev/null +++ b/macos/0.3.0-rc.1/Protocols/MGLFeature.html @@ -0,0 +1,801 @@ + + + + MGLFeature Protocol Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLFeature Protocol Reference +
+
+ +
+ +
+ +
+
+

MGLFeature

 +
+
+ 
@protocol MGLFeature <MGLAnnotation>
+ +
+
+

The MGLFeature protocol is used to provide details about geographic features +contained in an MGLShapeSource or MGLVectorSource object. Each concrete +subclass of MGLShape in turn has a subclass that conforms to this protocol. A +feature object associates a shape with an optional identifier and attributes.

+ +

You can add custom data to display on the map by creating feature objects and +adding them to an MGLShapeSource using the +-[MGLShapeSource initWithIdentifier:shape:options:] method or +MGLShapeSource.shape property. Similarly, you can add MGLPointFeature, +MGLPolylineFeature, and MGLPolygonFeature objects to the map as annotations +using -[MGLMapView addAnnotations:] and related methods.

+ +

In addition to adding data to the map, you can also extract data from the map: +-[MGLMapView visibleFeaturesAtPoint:] and related methods return feature +objects that correspond to features in the source. This enables you to inspect +the properties of features in vector tiles loaded by MGLVectorSource objects. +You also reuse these feature objects as overlay annotations.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + identifier + +
    +
    +
    +
    +

    An object that uniquely identifies the feature in its containing content +source.

    + +

    You can configure an MGLVectorStyleLayer object to include or exclude a +specific feature in an MGLShapeSource or MGLVectorSource. In the +MGLVectorStyleLayer.predicate property, compare the special $id attribute +to the feature’s identifier.

    + +

    In vector tiles loaded by MGLVectorSource objects, the identifier corresponds +to the +feature identifier +(id). If the source does not specify the feature’s identifier, the value of +this property is nil. If specified, the identifier may be an integer, +floating-point number, or string. These data types are mapped to instances of +the following Foundation classes:

    + + + + + + + + + + +
    In the tile sourceThis property
    Integer NSNumber (use the unsignedLongLongValue or longLongValue property)
    Floating-point number NSNumber (use the doubleValue property)
    String NSString
    + +

    For details about the identifiers used in most Mapbox-provided styles, consult +the +Mapbox Streets +layer reference.

    + +

    The identifier should be set before adding the feature to an MGLShapeSource +object; setting it afterwards has no effect on the map’s contents. While it is +possible to change this value on feature instances obtained from +-[MGLMapView visibleFeaturesAtPoint:] and related methods, doing so likewise +has no effect on the map’s contents.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readwrite, copy, nonatomic, nullable) id identifier;
    + +
    +
    +

    Swift

    + 
    var identifier: Any? { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + attributes + +
    +
    +
    +
    +

    A dictionary of attributes for this feature.

    + +

    You can configure an MGLVectorStyleLayer object to include or exclude a +specific feature in an MGLShapeSource or MGLVectorSource. In the +MGLVectorStyleLayer.predicate property, compare a key of the attribute +dictionary to the value you want to include. For example, if you want an +MGLLineStyleLayer object to display only important features, you might assign +a value above 50 to the important features’ importance attribute, then set +MGLVectorStyleLayer.predicate to an NSPredicate with the format +importance > 50.

    + +

    You can also configure some attributes of an MGLSymbolStyleLayer object to +include the value of an attribute in this dictionary whenever it renders this +feature. For example, to label features in an MGLShapeSource object by their +names, you can assign a name attribute to each of the source’s features, then +set MGLSymbolStyleLayer.textField to an MGLStyleValue object containing the +string {name}.

    + +

    In vector tiles loaded by MGLVectorSource objects, the keys and values of +each feature’s attribute dictionary are determined by the source. Each +attribute name is a string, while each attribute value may be a null value, +Boolean value, integer, floating-point number, or string. These data types are +mapped to instances of the following Foundation classes:

    + + + + + + + + + + + + +
    In the tile sourceIn this dictionary
    Null NSNull
    Boolean NSNumber (use the boolValue property)
    Integer NSNumber (use the unsignedLongLongValue or longLongValue property)
    Floating-point number NSNumber (use the doubleValue property)
    String NSString
    + +

    For details about the attribute names and values found in Mapbox-provided +vector tile sources, consult the +Mapbox Streets +and +Mapbox Terrain +layer references.

    + +

    Note that while it is possible to change this value on feature +instances obtained from -[MGLMapView visibleFeaturesAtPoint:] and related +methods, there will be no effect on the map. Setting this value can be useful +when the feature instance is used to initialize an MGLShapeSource and that +source is added to the map and styled.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readwrite, copy, nonatomic)
+    NSDictionary<NSString *, id> *_Nonnull attributes;
    + +
    +
    +

    Swift

    + 
    var attributes: [String : Any] { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -attributeForKey: + +
    +
    +
    +
    +

    Returns the feature attribute for the given attribute name.

    + +

    See the attributes property’s documentation for details on keys and values +associated with this method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nullable id)attributeForKey:(nonnull NSString *)key;
    + +
    +
    +

    Swift

    + 
    func attribute(forKey key: String) -> Any?
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -geoJSONDictionary + +
    +
    +
    +
    +

    Returns a dictionary that can be serialized as a GeoJSON Feature representation +of an instance of an MGLFeature subclass.

    + +

    The dictionary includes a geometry key corresponding to the receiver’s +underlying geometry data, a properties key corresponding to the receiver’s +attributes property, and an id key corresponding to the receiver’s +identifier property.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull NSDictionary<NSString *, id> *)geoJSONDictionary;
    + +
    +
    +

    Swift

    + 
    func geoJSONDictionary() -> [String : Any]
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Protocols/MGLMapViewDelegate.html b/macos/0.3.0-rc.1/Protocols/MGLMapViewDelegate.html new file mode 100644 index 0000000000..dcbff6458a --- /dev/null +++ b/macos/0.3.0-rc.1/Protocols/MGLMapViewDelegate.html @@ -0,0 +1,1930 @@ + + + + MGLMapViewDelegate Protocol Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLMapViewDelegate Protocol Reference +
+
+ +
+ +
+ +
+
+

MGLMapViewDelegate

 +
+
+ 
@protocol MGLMapViewDelegate <NSObject>
+ +
+
+

The MGLMapViewDelegate protocol defines a set of optional methods that you +can use to receive messages from an MGLMapView instance. Because many map +operations require the MGLMapView class to load data asynchronously, the map +view calls these methods to notify your application when specific operations +complete. The map view also uses these methods to request information about +annotations displayed on the map, such as the styles and interaction modes to +apply to individual annotations.

+ +
+
+ +
+
+
+
+ + + +

Responding to Map Viewpoint Changes

+ +
+
    +
  • + +
    +
    +
    +

    Tells the delegate that the viewpoint depicted by the map view is about to +change.

    + +

    This method is called whenever the currently displayed map camera will start +changing for any reason.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)mapView:(nonnull MGLMapView *)mapView
+    cameraWillChangeAnimated:(BOOL)animated;
    + +
    +
    +

    Swift

    + 
    optional func mapView(_ mapView: MGLMapView, cameraWillChangeAnimated animated: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + mapView + + +
    +

    The map view whose viewpoint will change.

    + +
    +
    + + animated + + +
    +

    Whether the change will cause an animated effect on the map.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Tells the delegate that the viewpoint depicted by the map view is changing.

    + +

    This method is called as the currently displayed map camera changes as part of +an animation, whether due to a user gesture or due to a call to a method such +as -[MGLMapView setCamera:animated:]. During the animation, this method may +be called many times to report updates to the viewpoint. Therefore, your +implementation of this method should be as lightweight as possible to avoid +affecting performance.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)mapViewCameraIsChanging:(nonnull MGLMapView *)mapView;
    + +
    +
    +

    Swift

    + 
    optional func mapViewCameraIsChanging(_ mapView: MGLMapView)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + mapView + + +
    +

    The map view whose viewpoint is changing.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Tells the delegate that the viewpoint depicted by the map view has finished +changing.

    + +

    This method is called whenever the currently displayed map camera has finished +changing, after any calls to -mapViewRegionIsChanging: due to animation.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)mapView:(nonnull MGLMapView *)mapView
+    cameraDidChangeAnimated:(BOOL)animated;
    + +
    +
    +

    Swift

    + 
    optional func mapView(_ mapView: MGLMapView, cameraDidChangeAnimated animated: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + mapView + + +
    +

    The map view whose viewpoint has changed.

    + +
    +
    + + animated + + +
    +

    Whether the change caused an animated effect on the map.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Loading the Map

+ +
+
    +
  • + +
    +
    +
    +

    Tells the delegate that the map view will begin to load.

    + +

    This method is called whenever the map view starts loading, including when a +new style has been set and the map must reload.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)mapViewWillStartLoadingMap:(nonnull MGLMapView *)mapView;
    + +
    +
    +

    Swift

    + 
    optional func mapViewWillStartLoadingMap(_ mapView: MGLMapView)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + mapView + + +
    +

    The map view that is starting to load.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Tells the delegate that the map view has finished loading.

    + +

    This method is called whenever the map view finishes loading, either after the +initial load or after a style change has forced a reload.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)mapViewDidFinishLoadingMap:(nonnull MGLMapView *)mapView;
    + +
    +
    +

    Swift

    + 
    optional func mapViewDidFinishLoadingMap(_ mapView: MGLMapView)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + mapView + + +
    +

    The map view that has finished loading.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Tells the delegate that the map view was unable to load data needed for +displaying the map.

    + +

    This method may be called for a variety of reasons, including a network +connection failure or a failure to fetch the style from the server. You can use +the given error message to notify the user that map data is unavailable.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)mapViewDidFailLoadingMap:(nonnull MGLMapView *)mapView
+                       withError:(nonnull NSError *)error;
    + +
    +
    +

    Swift

    + 
    optional func mapViewDidFailLoadingMap(_ mapView: MGLMapView, withError error: Error)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + mapView + + +
    +

    The map view that is unable to load the data.

    + +
    +
    + + error + + +
    +

    The reason the data could not be loaded.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Tells the delegate that the map view is about to redraw.

    + +

    This method is called any time the map view needs to redraw due to a change in +the viewpoint or style property transition. This method may be called very +frequently, even moreso than -mapViewRegionIsChanging:. Therefore, your +implementation of this method should be as lightweight as possible to avoid +affecting performance.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)mapViewWillStartRenderingFrame:(nonnull MGLMapView *)mapView;
    + +
    +
    +

    Swift

    + 
    optional func mapViewWillStartRenderingFrame(_ mapView: MGLMapView)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + mapView + + +
    +

    The map view that is about to redraw.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Tells the delegate that the map view has just redrawn.

    + +

    This method is called any time the map view needs to redraw due to a change in +the viewpoint or style property transition. This method may be called very +frequently, even moreso than -mapViewRegionIsChanging:. Therefore, your +implementation of this method should be as lightweight as possible to avoid +affecting performance.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)mapViewDidFinishRenderingFrame:(nonnull MGLMapView *)mapView
+                         fullyRendered:(BOOL)fullyRendered;
    + +
    +
    +

    Swift

    + 
    optional func mapViewDidFinishRenderingFrame(_ mapView: MGLMapView, fullyRendered: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + mapView + + +
    +

    The map view that has just redrawn.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Tells the delegate that the map has just finished loading a style.

    + +

    This method is called during the initialization of the map view and after any +subsequent loading of a new style. This method is called between the +-mapViewWillStartRenderingMap: and -mapViewDidFinishRenderingMap: delegate +methods. Changes to sources or layers of the current style do not cause this +method to be called.

    + +

    This method is the earliest opportunity to modify the layout or appearance of +the current style before the map view is displayed to the user.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)mapView:(nonnull MGLMapView *)mapView
+    didFinishLoadingStyle:(nonnull MGLStyle *)style;
    + +
    +
    +

    Swift

    + 
    optional func mapView(_ mapView: MGLMapView, didFinishLoadingStyle style: Any!)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + mapView + + +
    +

    The map view that has just loaded a style.

    + +
    +
    + + style + + +
    +

    The style that was loaded.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Managing the Appearance of Annotations

+ +
+
    +
  • + +
    +
    +
    +

    Returns an annotation image object to mark the given point annotation object on +the map.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nullable MGLAnnotationImage *)mapView:(nonnull MGLMapView *)mapView
+                      imageForAnnotation:(nonnull id<MGLAnnotation>)annotation;
    + +
    +
    +

    Swift

    + 
    optional func mapView(_ mapView: MGLMapView, imageForAnnotation annotation: Any) -> MGLAnnotationImage?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + mapView + + +
    +

    The map view that requested the annotation image.

    + +
    +
    + + annotation + + +
    +

    The object representing the annotation that is about to be + displayed.

    + +
    +
    +
    +
    +

    Return Value

    +

    The image object to display for the given annotation or nil if you + want to display the default marker image.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns the alpha value to use when rendering a shape annotation.

    + +

    A value of 0.0 results in a completely transparent shape. A value of 1.0, the +default, results in a completely opaque shape.

    + +

    This method sets the opacity of an entire shape, inclusive of its stroke and +fill. To independently set the values for stroke or fill, specify an alpha +component in the color returned by -mapView:strokeColorForShapeAnnotation: or +-mapView:fillColorForPolygonAnnotation:.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (CGFloat)mapView:(nonnull MGLMapView *)mapView
+    alphaForShapeAnnotation:(nonnull MGLShape *)annotation;
    + +
    +
    +

    Swift

    + 
    optional func mapView(_ mapView: MGLMapView, alphaForShapeAnnotation annotation: MGLShape) -> CGFloat
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + mapView + + +
    +

    The map view rendering the shape annotation.

    + +
    +
    + + annotation + + +
    +

    The annotation being rendered.

    + +
    +
    +
    +
    +

    Return Value

    +

    An alpha value between 0 and 1.0.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns the color to use when rendering the outline of a shape annotation.

    + +

    The default stroke color is the selected menu item color. If a pattern color is +specified, the result is undefined.

    + +

    Opacity may be set by specifying an alpha component. The default alpha value is +1.0 and results in a completely opaque stroke.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull NSColor *)mapView:(nonnull MGLMapView *)mapView
+    strokeColorForShapeAnnotation:(nonnull MGLShape *)annotation;
    + +
    +
    +

    Swift

    + 
    optional func mapView(_ mapView: MGLMapView, strokeColorForShapeAnnotation annotation: MGLShape) -> Any!
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + mapView + + +
    +

    The map view rendering the shape annotation.

    + +
    +
    + + annotation + + +
    +

    The annotation being rendered.

    + +
    +
    +
    +
    +

    Return Value

    +

    A color to use for the shape outline.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns the color to use when rendering the fill of a polygon annotation.

    + +

    The default fill color is the selected menu item color. If a pattern color is +specified, the result is undefined.

    + +

    Opacity may be set by specifying an alpha component. The default alpha value is +1.0 and results in a completely opaque shape.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull NSColor *)mapView:(nonnull MGLMapView *)mapView
+    fillColorForPolygonAnnotation:(nonnull MGLPolygon *)annotation;
    + +
    +
    +

    Swift

    + 
    optional func mapView(_ mapView: MGLMapView, fillColorForPolygonAnnotation annotation: MGLPolygon) -> Any!
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + mapView + + +
    +

    The map view rendering the polygon annotation.

    + +
    +
    + + annotation + + +
    +

    The annotation being rendered.

    + +
    +
    +
    +
    +

    Return Value

    +

    The polygon’s interior fill color.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns the line width in points to use when rendering the outline of a +polyline annotation.

    + +

    By default, the polyline is outlined with a line 3.0 points wide.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (CGFloat)mapView:(nonnull MGLMapView *)mapView
+    lineWidthForPolylineAnnotation:(nonnull MGLPolyline *)annotation;
    + +
    +
    +

    Swift

    + 
    optional func mapView(_ mapView: MGLMapView, lineWidthForPolylineAnnotation annotation: MGLPolyline) -> CGFloat
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + mapView + + +
    +

    The map view rendering the polygon annotation.

    + +
    +
    + + annotation + + +
    +

    The annotation being rendered.

    + +
    +
    +
    +
    +

    Return Value

    +

    A line width for the polyline, measured in points.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Selecting Annotations

+ +
+
    +
  • + +
    +
    +
    +

    Tells the delegate that one of its annotations has been selected.

    + +

    You can use this method to track changes to the selection state of annotations.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)mapView:(nonnull MGLMapView *)mapView
+    didSelectAnnotation:(nonnull id<MGLAnnotation>)annotation;
    + +
    +
    +

    Swift

    + 
    optional func mapView(_ mapView: MGLMapView, didSelectAnnotation annotation: Any)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + mapView + + +
    +

    The map view containing the annotation.

    + +
    +
    + + annotation + + +
    +

    The annotation that was selected.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Tells the delegate that one of its annotations has been deselected.

    + +

    You can use this method to track changes in the selection state of annotations.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)mapView:(nonnull MGLMapView *)mapView
+    didDeselectAnnotation:(nonnull id<MGLAnnotation>)annotation;
    + +
    +
    +

    Swift

    + 
    optional func mapView(_ mapView: MGLMapView, didDeselectAnnotation annotation: Any)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + mapView + + +
    +

    The map view containing the annotation.

    + +
    +
    + + annotation + + +
    +

    The annotation that was deselected.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Managing Callout Popovers

+ +
+
    +
  • + +
    +
    +
    +

    Returns a Boolean value indicating whether the annotation is able to display +extra information in a callout popover.

    + +

    This method is called after an annotation is selected, before any callout is +displayed for the annotation.

    + +

    If the return value is YES, a callout popover is shown when the user clicks +on an annotation, selecting it. The default callout displays the annotation’s +title and subtitle. You can customize the popover’s contents by implementing +the -mapView:calloutViewControllerForAnnotation: method.

    + +

    If the return value is NO, or if this method is absent from the delegate, or +if the annotation lacks a title, the annotation will not show a callout even +when selected.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (BOOL)mapView:(nonnull MGLMapView *)mapView
+    annotationCanShowCallout:(nonnull id<MGLAnnotation>)annotation;
    + +
    +
    +

    Swift

    + 
    optional func mapView(_ mapView: MGLMapView, annotationCanShowCallout annotation: Any) -> Bool
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + mapView + + +
    +

    The map view that has selected the annotation.

    + +
    +
    + + annotation + + +
    +

    The object representing the annotation.

    + +
    +
    +
    +
    +

    Return Value

    +

    A Boolean value indicating whether the annotation should show a + callout.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns a view controller to manage the callout popover’s content view.

    + +

    Like any instance of NSPopover, an annotation callout manages its contents +with a view controller. The annotation object is the view controller’s +represented object. This means that you can bind controls in the view +controller’s content view to KVO-compliant properties of the annotation object, +such as title and subtitle.

    + +

    If each annotation should have an identical callout, you can set the +MGLMapView.calloutViewController property instead.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nullable NSViewController *)mapView:(nonnull MGLMapView *)mapView
+    calloutViewControllerForAnnotation:(nonnull id<MGLAnnotation>)annotation;
    + +
    +
    +

    Swift

    + 
    optional func mapView(_ mapView: MGLMapView, calloutViewControllerForAnnotation annotation: Any) -> Any!
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + mapView + + +
    +

    The map view that is requesting a callout view controller.

    + +
    +
    + + annotation + + +
    +

    The object representing the annotation.

    + +
    +
    +
    +
    +

    Return Value

    +

    A view controller for the given annotation.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Protocols/MGLOverlay.html b/macos/0.3.0-rc.1/Protocols/MGLOverlay.html new file mode 100644 index 0000000000..f5233c2462 --- /dev/null +++ b/macos/0.3.0-rc.1/Protocols/MGLOverlay.html @@ -0,0 +1,698 @@ + + + + MGLOverlay Protocol Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLOverlay Protocol Reference +
+
+ +
+ +
+ +
+
+

MGLOverlay

 +
+
+ 
@protocol MGLOverlay <MGLAnnotation>
+ +
+
+

The MGLOverlay protocol defines a specific type of annotation that represents +both a point and an area on a map. Overlay objects are essentially data objects +that contain the geographic data needed to represent the map area. Overlays can +take the form of a polyline or polygon.

+ +

You use overlays to layer more sophisticated content on top of a map view. For +example, you could use an overlay to show the boundaries of a national park or +trace a bus route along city streets. This SDK defines several concrete classes +that conform to this protocol and define standard shapes.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + coordinate + +
    +
    +
    +
    +

    A coordinate representing the overlay. (required) (read-only)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) CLLocationCoordinate2D coordinate;
    + +
    +
    +

    Swift

    + 
    var coordinate: CLLocationCoordinate2D { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + overlayBounds + +
    +
    +
    +
    +

    The cooordinate rectangle that encompasses the overlay. (required) (read-only)

    + +

    This property contains the smallest rectangle that completely encompasses the +overlay. Implementers of this protocol must set this area when implementing +their overlay class, and after setting it, you must not change it.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) MGLCoordinateBounds overlayBounds;
    + +
    +
    +

    Swift

    + 
    var overlayBounds: MGLCoordinateBounds { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns a Boolean indicating whether the specified rectangle intersects the +receiver’s shape.

    + +

    You can implement this method to provide more specific bounds checking for an +overlay. If you do not implement it, the bounding rectangle is used to detect +intersections.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (BOOL)intersectsOverlayBounds:(MGLCoordinateBounds)overlayBounds;
    + +
    +
    +

    Swift

    + 
    func intersects(_ overlayBounds: MGLCoordinateBounds) -> Bool
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + overlayBounds + + +
    +

    The rectangle to intersect with the receiver’s area.

    + +
    +
    +
    +
    +

    Return Value

    +

    YES if any part of the map rectangle intersects the receiver’s shape + or NO if it does not.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Shapes and Annotations.html b/macos/0.3.0-rc.1/Shapes and Annotations.html new file mode 100644 index 0000000000..9c5b6b58ff --- /dev/null +++ b/macos/0.3.0-rc.1/Shapes and Annotations.html @@ -0,0 +1,1226 @@ + + + + Shapes and Annotations Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + Shapes and Annotations Reference +
+
+ +
+ +
+ +
+
+

Shapes and Annotations

 + +
+
+ +
+
+
+
    +
  • +
    + + + + MGLAnnotation + +
    +
    +
    +
    +

    The MGLAnnotation protocol is used to provide annotation-related information +to a map view. To use this protocol, you adopt it in any custom objects that +store or represent annotation data. Each object then serves as the source of +information about a single map annotation and provides critical information, +such as the annotation’s location on the map. Annotation objects do not provide +the visual representation of the annotation but typically coordinate (in +conjunction with the map view’s delegate) the creation of an appropriate +objects to handle the display.

    + +

    An object that adopts this protocol must implement the coordinate property. +The other methods of this protocol are optional.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @protocol MGLAnnotation <NSObject>
    + +
    +
    +

    Swift

    + 
    protocol MGLAnnotation : NSObjectProtocol
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLAnnotationImage + +
    +
    +
    +
    +

    The MGLAnnotationImage class is responsible for presenting point-based +annotations visually on an MGLMapView instance. Annotation image objects pair +NSImage objects with annotation-related metadata. They may be recycled later +and put into a reuse queue that is maintained by the map view.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLAnnotationImage : NSObject <NSSecureCoding>
    + +
    +
    +

    Swift

    + 
    class MGLAnnotationImage : NSObject, NSSecureCoding
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLOverlay + +
    +
    +
    +
    +

    The MGLOverlay protocol defines a specific type of annotation that represents +both a point and an area on a map. Overlay objects are essentially data objects +that contain the geographic data needed to represent the map area. Overlays can +take the form of a polyline or polygon.

    + +

    You use overlays to layer more sophisticated content on top of a map view. For +example, you could use an overlay to show the boundaries of a national park or +trace a bus route along city streets. This SDK defines several concrete classes +that conform to this protocol and define standard shapes.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @protocol MGLOverlay <MGLAnnotation>
    + +
    +
    +

    Swift

    + 
    protocol MGLOverlay : MGLAnnotation
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+ +
+
+
    +
  • +
    + + + + MGLMultiPoint + +
    +
    +
    +
    +

    The MGLMultiPoint class is an abstract superclass used to define shapes +composed of multiple vertices.

    + +

    You do not create instances of this class directly. Instead, you create +instances of the MGLPolyline or MGLPolygon classes. However, you can use +the method and properties of this class to access information about the +vertices of the line or polygon.

    + +

    Do not confuse MGLMultiPoint with MGLPointCollection, which represents a +collection of related but disconnected points.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLMultiPoint : MGLShape
    + +
    +
    +

    Swift

    + 
    class MGLMultiPoint : MGLShape
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Structs/MGLCoordinateBounds.html b/macos/0.3.0-rc.1/Structs/MGLCoordinateBounds.html new file mode 100644 index 0000000000..348f5bbf05 --- /dev/null +++ b/macos/0.3.0-rc.1/Structs/MGLCoordinateBounds.html @@ -0,0 +1,619 @@ + + + + MGLCoordinateBounds Struct Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLCoordinateBounds Struct Reference +
+
+ +
+ +
+ +
+
+

MGLCoordinateBounds

 +
+
+ 
struct MGLCoordinateBounds {}
+ +
+
+

A rectangular area as measured on a two-dimensional map projection.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + sw + +
    +
    +
    +
    +

    Coordinate at the southwest corner.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    CLLocationCoordinate2D sw
    + +
    +
    +

    Swift

    + 
    var sw: CLLocationCoordinate2D
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + ne + +
    +
    +
    +
    +

    Coordinate at the northeast corner.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    CLLocationCoordinate2D ne
    + +
    +
    +

    Swift

    + 
    var ne: CLLocationCoordinate2D
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Structs/MGLCoordinateSpan.html b/macos/0.3.0-rc.1/Structs/MGLCoordinateSpan.html new file mode 100644 index 0000000000..ae98e40872 --- /dev/null +++ b/macos/0.3.0-rc.1/Structs/MGLCoordinateSpan.html @@ -0,0 +1,619 @@ + + + + MGLCoordinateSpan Struct Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLCoordinateSpan Struct Reference +
+
+ +
+ +
+ +
+
+

MGLCoordinateSpan

 +
+
+ 
struct MGLCoordinateSpan {}
+ +
+
+

Defines the area spanned by an MGLCoordinateBounds.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Structs/MGLOfflinePackProgress.html b/macos/0.3.0-rc.1/Structs/MGLOfflinePackProgress.html new file mode 100644 index 0000000000..1c85a02f87 --- /dev/null +++ b/macos/0.3.0-rc.1/Structs/MGLOfflinePackProgress.html @@ -0,0 +1,776 @@ + + + + MGLOfflinePackProgress Struct Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLOfflinePackProgress Struct Reference +
+
+ +
+ +
+ +
+
+

MGLOfflinePackProgress

 +
+
+ 
struct MGLOfflinePackProgress {}
+ +
+
+

A structure containing information about an offline pack’s current download +progress.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +

    The number of resources, including tiles, that have been completely +downloaded and are ready to use offline.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    uint64_t countOfResourcesCompleted
    + +
    +
    +

    Swift

    + 
    var countOfResourcesCompleted: UInt64
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + countOfBytesCompleted + +
    +
    +
    +
    +

    The cumulative size of the downloaded resources on disk, including tiles, +measured in bytes.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    uint64_t countOfBytesCompleted
    + +
    +
    +

    Swift

    + 
    var countOfBytesCompleted: UInt64
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + countOfTilesCompleted + +
    +
    +
    +
    +

    The number of tiles that have been completely downloaded and are ready +to use offline.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    uint64_t countOfTilesCompleted
    + +
    +
    +

    Swift

    + 
    var countOfTilesCompleted: UInt64
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    The cumulative size of the downloaded tiles on disk, measured in bytes.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    uint64_t countOfTileBytesCompleted
    + +
    +
    +

    Swift

    + 
    var countOfTileBytesCompleted: UInt64
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    The minimum number of resources that must be downloaded in order to view +the pack’s full region without any omissions.

    + +

    At the beginning of a download, this count is a lower bound; the number of +expected resources may increase as the download progresses.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    uint64_t countOfResourcesExpected
    + +
    +
    +

    Swift

    + 
    var countOfResourcesExpected: UInt64
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    The maximum number of resources that must be downloaded in order to view +the pack’s full region without any omissions.

    + +

    At the beginning of a download, when the exact number of required resources +is unknown, this field is set to UINT64_MAX. Thus this count is always an +upper bound.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    uint64_t maximumResourcesExpected
    + +
    +
    +

    Swift

    + 
    var maximumResourcesExpected: UInt64
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Style Layers.html b/macos/0.3.0-rc.1/Style Layers.html new file mode 100644 index 0000000000..0ab8bf8416 --- /dev/null +++ b/macos/0.3.0-rc.1/Style Layers.html @@ -0,0 +1,1057 @@ + + + + Style Layers Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + Style Layers Reference +
+
+ +
+ +
+ +
+
+

Style Layers

 + +
+
+ +
+
+
+
    +
  • +
    + + + + MGLStyleLayer + +
    +
    +
    +
    +

    MGLStyleLayer is an abstract base class for style layers. A style layer +manages the layout and appearance of content at a specific z-index in a style. +An MGLStyle object consists of one or more MGLStyleLayer objects.

    + +

    Each style layer defined by the style JSON file is represented at runtime by an +MGLStyleLayer object, which you can use to refine the map’s appearance. You +can also add and remove style layers dynamically.

    + +

    Do not create instances of this class directly, and do not create your own +subclasses of this class. Instead, create instances of +MGLBackgroundStyleLayer and the concrete subclasses of +MGLForegroundStyleLayer.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLStyleLayer : NSObject
    + +
    +
    +

    Swift

    + 
    class MGLStyleLayer : NSObject
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
    +
    +

    An MGLBackgroundStyleLayer is a style layer that covers the entire map. Use a +background style layer to configure a color or pattern to show below all other +map content. If the style’s other layers use the Mapbox Streets source, the +background style layer is responsible for drawing land, whereas the oceans and +other bodies of water are drawn by MGLFillStyleLayer objects.

    + +

    A background style layer is typically the bottommost layer in a style, because +it covers the entire map and can occlude any layers below it. You can therefore +access it by getting the last item in the MGLStyle.layers array.

    + +

    If the background style layer is transparent or omitted from the style, any +portion of the map view that does not show another style layer is transparent.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLBackgroundStyleLayer : MGLStyleLayer
    + +
    +
    +

    Swift

    + 
    class MGLBackgroundStyleLayer : MGLStyleLayer
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLRasterStyleLayer + +
    +
    +
    +
    +

    An MGLRasterStyleLayer is a style layer that renders raster tiles on the map.

    + +

    Use a raster style layer to configure the color parameters of raster tiles +loaded by an MGLRasterSource object. For example, you could use a raster +style layer to render Mapbox +Satellite imagery, a raster tile +set uploaded to Mapbox Studio, or a raster map authored in TileMill, the classic +Mapbox Editor, or Mapbox Studio Classic.

    + +

    You can access an existing raster style layer using the +-[MGLStyle layerWithIdentifier:] method if you know its identifier; +otherwise, find it using the MGLStyle.layers property. You can also create a +new raster style layer and add it to the style using a method such as +-[MGLStyle addLayer:].

    + +

    Example

    +
    let layer = MGLRasterStyleLayer(identifier: clouds, source: source)
+layer.rasterOpacity = MGLStyleValue(rawValue: 0.5)
+mapView.style?.addLayer(layer)
+

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLRasterStyleLayer : MGLForegroundStyleLayer
    + +
    +
    +

    Swift

    + 
    class MGLRasterStyleLayer : MGLForegroundStyleLayer
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+ +
+
+
    +
  • +
    + + + + MGLCircleStyleLayer + +
    +
    +
    +
    +

    An MGLCircleStyleLayer is a style layer that renders one or more filled +circles on the map.

    + +

    Use a circle style layer to configure the visual appearance of point or point +collection features in vector tiles loaded by an MGLVectorSource object or +MGLPointAnnotation, MGLPointFeature, MGLPointCollection, or +MGLPointCollectionFeature instances in an MGLShapeSource object.

    + +

    A circle style layer renders circles whose radii are measured in screen units. +To display circles on the map whose radii correspond to real-world distances, +use many-sided regular polygons and configure their appearance using an +MGLFillStyleLayer object.

    + +

    You can access an existing circle style layer using the +-[MGLStyle layerWithIdentifier:] method if you know its identifier; +otherwise, find it using the MGLStyle.layers property. You can also create a +new circle style layer and add it to the style using a method such as +-[MGLStyle addLayer:].

    + +

    Example

    +
    let layer = MGLCircleStyleLayer(identifier: circles, source: population)
+layer.sourceLayerIdentifier = population
+layer.circleColor = MGLStyleValue(rawValue: .green)
+layer.circleRadius = MGLStyleValue(interpolationBase: 1.75, stops: [
+    12: MGLStyleValue(rawValue: 2),
+    22: MGLStyleValue(rawValue: 180)
+])
+layer.circleOpacity = MGLStyleValue(rawValue: 0.7)
+layer.predicate = NSPredicate(format: %K == %@, marital-status, married)
+mapView.style?.addLayer(layer)
+

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLCircleStyleLayer : MGLVectorStyleLayer
    + +
    +
    +

    Swift

    + 
    class MGLCircleStyleLayer : MGLVectorStyleLayer
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+ +
+
+
    +
  • +
    + + + + MGLLineStyleLayer + +
    +
    +
    +
    +

    An MGLLineStyleLayer is a style layer that renders one or more stroked +polylines on the map.

    + +

    Use a line style layer to configure the visual appearance of polyline or +multipolyline features in vector tiles loaded by an MGLVectorSource object or +MGLPolyline, MGLPolylineFeature, MGLMultiPolyline, or +MGLMultiPolylineFeature instances in an MGLShapeSource object.

    + +

    You can access an existing line style layer using the +-[MGLStyle layerWithIdentifier:] method if you know its identifier; +otherwise, find it using the MGLStyle.layers property. You can also create a +new line style layer and add it to the style using a method such as +-[MGLStyle addLayer:].

    + +

    Example

    +
    let layer = MGLLineStyleLayer(identifier: trails-path, source: trails)
+layer.sourceLayerIdentifier = trails
+layer.lineWidth = MGLStyleValue(interpolationBase: 1.5, stops: [
+    14: MGLStyleValue(rawValue: 2),
+    18: MGLStyleValue(rawValue: 20),
+])
+layer.lineColor = MGLStyleValue(rawValue: .brown)
+layer.lineCap = MGLStyleValue(rawValue: NSValue(mglLineCap: .round))
+layer.predicate = NSPredicate(format: %K == %@, trail-type, mountain-biking)
+mapView.style?.addLayer(layer)
+

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLLineStyleLayer : MGLVectorStyleLayer
    + +
    +
    +

    Swift

    + 
    class MGLLineStyleLayer : MGLVectorStyleLayer
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLSymbolStyleLayer + +
    +
    +
    +
    +

    An MGLSymbolStyleLayer is a style layer that renders icon and text labels at +points or along lines on the map.

    + +

    Use a symbol style layer to configure the visual appearance of labels for +features in vector tiles loaded by an MGLVectorSource object or MGLShape or +MGLFeature instances in an MGLShapeSource object.

    + +

    You can access an existing symbol style layer using the +-[MGLStyle layerWithIdentifier:] method if you know its identifier; +otherwise, find it using the MGLStyle.layers property. You can also create a +new symbol style layer and add it to the style using a method such as +-[MGLStyle addLayer:].

    + +

    Example

    +
    let layer = MGLSymbolStyleLayer(identifier: coffeeshops, source: pois)
+layer.sourceLayerIdentifier = pois
+layer.iconImageName = MGLStyleValue(rawValue: coffee)
+layer.iconScale = MGLStyleValue(rawValue: 0.5)
+layer.text = MGLStyleValue(rawValue: {name})
+layer.textTranslation = MGLStyleValue(rawValue: NSValue(cgVector: CGVector(dx: 10, dy: 0)))
+layer.textJustification = MGLStyleValue(rawValue: NSValue(mglTextJustification: .left))
+layer.textAnchor = MGLStyleValue(rawValue: NSValue(mglTextAnchor: .left))
+layer.predicate = NSPredicate(format: %K == %@, venue-type, coffee)
+mapView.style?.addLayer(layer)
+

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLSymbolStyleLayer : MGLVectorStyleLayer
    + +
    +
    +

    Swift

    + 
    class MGLSymbolStyleLayer : MGLVectorStyleLayer
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/Styling the Map.html b/macos/0.3.0-rc.1/Styling the Map.html new file mode 100644 index 0000000000..063376ae31 --- /dev/null +++ b/macos/0.3.0-rc.1/Styling the Map.html @@ -0,0 +1,653 @@ + + + + Styling the Map Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + Styling the Map Reference +
+
+ +
+ +
+ +
+
+

Styling the Map

 + +
+
+ +
+
+
+ +
+
+
    +
  • +
    + + + + MGLStyleValue + +
    +
    +
    +
    +

    An MGLStyleValue object is a generic container for a style attribute value. +The layout and paint attribute properties of MGLStyleLayer can be set to +MGLStyleValue objects.

    + +

    The MGLStyleValue class itself represents a class cluster. Under the hood, a +particular MGLStyleValue object may be either an MGLStyleConstantValue to +represent a constant value or an MGLStyleFunction to represent a value +function. Do not initialize an MGLStyleValue object directly; instead, use +one of the class factory methods to create an MGLStyleValue object.

    + +

    The MGLStyleValue class takes a generic parameter T that indicates the +Foundation class being wrapped by this class. Common values for T include:

    + +
      +
    • NSNumber (for Boolean values and floating-point numbers)
      • +
    • NSValue (for CGVector, NSEdgeInsets, UIEdgeInsets, and enumerations)
      • +
    • NSString
      • +
    • NSColor or UIColor
      • +
    • NSArray
      • +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLStyleValue <T> : NSObject
    + +
    +
    +

    Swift

    + 
    class MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/css/highlight.css b/macos/0.3.0-rc.1/css/highlight.css new file mode 100644 index 0000000000..8db1704115 --- /dev/null +++ b/macos/0.3.0-rc.1/css/highlight.css @@ -0,0 +1,187 @@ +/* Rouge Syntax Highlighting, Mapbox Base style +------------------------------------------------------- */ +.highlight .hll { + background-color: #ffffcc; } + +/* No Styling, Just Default: + .highlight .nx, Normal Text + .highlight .ni Name.Entity + .highlight .nf Name.Entity + .highlight .no Name.Constant +*/ +/* Comments */ +.highlight .o, +.highlight .c, +.highlight .c1, +.highlight .cp, +.highlight .cm { + color: #999; + font-style: italic; } + +.highlight .err { + color: #F00000; + background-color: #F0A0A0; } + +/* Error */ +.highlight .k { + color: #404040; + font-weight: bold; } + +/* Keyword */ +.highlight .css .k { + font-weight: normal; } + +.highlight .cs { + color: #404040; + font-style: italic; } + +/* Comment.Special */ +.highlight .gd { + color: #A00000; } + +/* Generic.Deleted */ +.highlight .ge { + font-style: italic; } + +/* Generic.Emph */ +.highlight .gs { + font-weight: bold; } + +/* Generic.Strong */ +.highlight .gr { + color: #FF0000; } + +/* Generic.Error */ +.highlight .gh { + color: #000080; } + +/* Generic.Heading */ +.highlight .gi { + color: #00A000; } + +/* Generic.Inserted */ +.highlight .go { + color: #808080; } + +/* Generic.Output */ +.highlight .gp { + color: #c65d09; } + +/* Generic.Prompt */ +.highlight .gu { + color: #800080; } + +/* Generic.Subheading */ +.highlight .gt { + color: #0040D0; } + +/* Generic.Traceback */ +.highlight .kc { + color: #D24400; } + +/* Keyword.Constant */ +/* Keyword.Declaration + * Keyword.Namespace + * Keyword.Reserved */ +.highlight .kd, +.highlight .kn, +.highlight .kr, +.highlight .nt { + color: #0B5A91; } + +/* Name.Tag */ +/* Literal.Number */ +.highlight .mh, +.highlight .mo, +.highlight .il, +.highlight .mi, +.highlight .kt, +.highlight .mf, +.highlight .nl, +.highlight .na, +.highlight .m { + color: #0C9DC2; } + +/* Keyword.Type */ +.highlight .kp { + color: #0080f0; } + +/* Keyword.Pseudo */ +.highlight .nc { + color: #DF6637; } + +/* Name.Class */ +.highlight .css .nc { + color: #75A21C; } + +.highlight .nd { + color: #505050; } + +/* Name.Decorator */ +.highlight .ne { + color: #F00000; } + +/* Name.Exception */ +.highlight .nn { + color: #0e84b5; } + +/* Name.Namespace */ +.highlight .nf, +.highlight .nv { + color: #003060; } + +/* Name.Variable */ +.highlight .ow { + color: #404040; } + +/* Operator.Word */ +.highlight .w { + color: #bbbbbb; } + +/* Text.Whitespace */ +.highlight .sc { + color: #8080F0; } + +/* Literal.String.Char */ +.highlight .sd { + color: #D04020; } + +/* Literal.String.Doc */ +/* Name.Builtin / Name.Builtin.Pseudo */ +.highlight .bp, +.highlight .nb { + color: #007020; } + +/* Literal.String */ +.highlight .s, +.highlight .sh, +.highlight .sb, +.highlight .s1, +.highlight .sr, +.highlight .se { + color: #75A21C; } + +.highlight .si { + background-color: #eee; } + +/* Literal.String.Interpol */ +.highlight .p { + color: #444444; } + +/* Normal Text */ +.highlight .ss { + color: #f0c080; } + +/* Literal.String.Symbol */ +.highlight .vc { + color: #c0c0f0; } + +/* Name.Variable.Class */ +.highlight .vg { + color: #f08040; } + +/* Name.Variable.Global */ +.highlight .vi { + color: #a0a0f0; } + +/* Name.Variable.Instance */ diff --git a/macos/0.3.0-rc.1/css/jazzy.css b/macos/0.3.0-rc.1/css/jazzy.css new file mode 100644 index 0000000000..de35538af3 --- /dev/null +++ b/macos/0.3.0-rc.1/css/jazzy.css @@ -0,0 +1,493 @@ +*, *:before, *:after { + box-sizing: inherit; } + +body { + margin: 0; + background: #fff; + color: #0B293A; + font: 14px/25px "Open Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; + -webkit-font-smoothing: antialiased; + box-sizing: border-box; } + +h1 { + font-family: "Open Sans Bold", "Helvetica Neue", Helvetica, Arial, sans-serif; + font-size: 1.7rem; + font-weight: normal; + color: #0B293A; + margin: 0.5em 0 0.6em; } + +h1 a { + color: #0B293A; } + +h2 { + font-family: "Open Sans Bold", "Helvetica Neue", Helvetica, Arial, sans-serif; + font-size: 1.5rem; + font-weight: normal; + color: #0B293A; + margin: 1em 0 0.6em; } + +h3 { + font-family: "Open Sans Bold", "Helvetica Neue", Helvetica, Arial, sans-serif; + font-size: 14px; + font-weight: normal; + color: #0B293A; + margin: 1em 0 0.3em; } + +h4 { + font-family: "Open Sans Bold", "Helvetica Neue", Helvetica, Arial, sans-serif; + font-size: 1rem; + font-weight: normal; + color: #0B293A; + margin: 1.275em 0 0.85em; } + +h5, h6 { + font-family: "Open Sans Bold", "Helvetica Neue", Helvetica, Arial, sans-serif; + font-size: 1rem; + font-weight: normal; + color: #0B293A; + margin: 1.275em 0 0.85em; } + +p { + margin: 0 0 1em; } + +ul, ol { + padding: 0 0 0 1.5em; + margin: 0 0 0.85em; } + +ul.item-container { + padding: 0px; } + +ul:first-of-type, +ol:first-of-type { + margin: 0px; } + +blockquote { + margin: 0 0 0.85em; + padding: 0 15px; + color: #858585; + border-left: 4px solid #e5e5e5; } + +img { + max-width: 100%; } + +a { + color: #3887BE; + text-decoration: none; } + a > *:hover, a:hover, a:focus { + opacity: 0.7; } + a:focus { + box-shadow: inset 0 0 0 1px rgba(0, 0, 0, 0.05); } + +table { + background: #fff; + width: 100%; + font-size: 13px; + line-height: 23px; + border-collapse: collapse; + border-spacing: 0; + overflow: auto; + margin: 0 0 0.85em; } + +th, td { + padding: 6px 13px; + border: 1px solid rgba(12, 40, 73, 0.08); } + +pre { + margin: 0 0 1.275em; + padding: .85em 1em; + overflow: auto; + background: #F5F8FC; + font-family: Menlo, Bitstream Vera Sans Mono, Monaco, Consolas, monospacee; + border-radius: 4px; } + +code { + font-family: Menlo, Bitstream Vera Sans Mono, Monaco, Consolas, monospacee; + font-size: 13px; + line-height: .85em; } + +p > code, li > code { + background: #F5F8FC; + padding: 0.1em 0.2em; + font-weight: bold; + border: 1px solid #D5D5D5; + border-radius: 4px; } + +td > code, +.graybox code { + font-weight: bold; + font-size: 12px; } + +pre code { + padding: 0; + white-space: pre; } + +.content-wrapper { + display: flex; + flex-direction: column; } + @media (min-width: 768px) { + .content-wrapper { + flex-direction: row; } } + +.limiter { + max-width: 1360px; + margin: auto; + padding: 0px 30px; } + +.space-right2 { + margin-right: 20px; } + +.header-container { + background: #3A68D8; } + +.header { + display: flex; + padding: 12px 0px; + font-size: 12px; + color: #999; } + @media (max-width: 768px) { + .header { + display: block; } } + +.header-tag { + vertical-align: text-top; + line-height: 10px; + background: rgba(255, 255, 255, 0.1); + border-radius: 4px; + padding: 2px 5px; + margin-left: 5px; + opacity: 0.9; } + +.header-col { + margin: 5px 0 0 0; + padding: 0; } + +.header-col--primary { + flex: 1; } + +.header-link { + font-family: "Open Sans Bold", "Helvetica Neue", Helvetica, Arial, sans-serif; + color: #fff; } + +.header-image, .header-icon { + padding-right: 2px; + vertical-align: -4px; + height: 16px; } + +.breadcrumbs { + font-size: 13px; + padding: 8px 0px; + margin: 0; + background: #F5F8FC; + border-bottom: 1px solid rgba(12, 40, 73, 0.08); } + +.carat { + height: 10px; + margin: 0 5px; } + +.navigation { + order: 2; + font-size: 13px; + padding-top: 20px; } + @media (min-width: 768px) { + .navigation { + order: 1; + width: 25%; + min-width: 175px; + max-width: 300px; + padding-bottom: 64px; + line-height: 20px; + overflow: hidden; + border-right: 1px solid rgba(12, 40, 73, 0.08); } } + +.nav-groups { + list-style-type: none; + padding-left: 0; } + +.nav-group-name { + padding: 8px 0 8px 0px; } + +.small-heading, h4 { + font-size: 13px; + font-family: "Open Sans Bold", "Helvetica Neue", Helvetica, Arial, sans-serif; + text-transform: uppercase; + color: #0B293A; + letter-spacing: 1px; } + +.nav-group-tasks { + margin: 8px 0; + padding: 0 0 0 0; } + +.nav-group-task { + font-size: 1em; + list-style-type: none; + white-space: nowrap; + overflow: hidden; + text-overflow: ellipsis; + color: #3887BE; } + +.nav-group-task[data-url^="Protocols/"] > .nav-group-task-link::after, .nav-group-task[data-name="MGLForegroundStyleLayer"] .nav-group-task-link::after, +.nav-group-task[data-name="MGLMultiPoint"] .nav-group-task-link::after, +.nav-group-task[data-name="MGLShape"] .nav-group-task-link::after, +.nav-group-task[data-name="MGLSource"] .nav-group-task-link::after, +.nav-group-task[data-name="MGLStyleLayer"] .nav-group-task-link::after, +.nav-group-task[data-name="MGLTileSource"] .nav-group-task-link::after, +.nav-group-task[data-name="MGLVectorStyleLayer"] .nav-group-task-link::after { + color: #999; + font-size: 90%; + margin-left: 0.5em; } + +.nav-group-task[data-url^="Protocols/"] > .nav-group-task-link::after { + content: "(Protocol)"; } + +.nav-group-task[data-name="MGLForegroundStyleLayer"] .nav-group-task-link::after, +.nav-group-task[data-name="MGLMultiPoint"] .nav-group-task-link::after, +.nav-group-task[data-name="MGLShape"] .nav-group-task-link::after, +.nav-group-task[data-name="MGLSource"] .nav-group-task-link::after, +.nav-group-task[data-name="MGLStyleLayer"] .nav-group-task-link::after, +.nav-group-task[data-name="MGLTileSource"] .nav-group-task-link::after, +.nav-group-task[data-name="MGLVectorStyleLayer"] .nav-group-task-link::after { + content: "(Abstract Class)"; } + +.nav-group-name > .small-heading, +.nav-group-task-link { + display: block; } + +.nav-group-task-link { + color: rgba(11, 41, 58, 0.75); } + +.main-content { + order: 1; } + @media (min-width: 768px) { + .main-content { + order: 2; + flex: 1; + padding-bottom: 60px; + max-width: 80%; } } + +.section { + padding: 0px 20px; } + @media (max-width: 768px) { + .section { + padding: inherit; } } + +.section-content { + margin: 0 auto; + padding: 16px 0; + border-bottom: 1px solid rgba(12, 40, 73, 0.08); } + +.section-content img { + margin: 0 auto; } + +.section-name { + color: #0B293A; + display: block; } + +.anchor-icon { + margin-left: 4px; + opacity: 0.7; + display: inline-block; + background: url("../img/link.svg"); + background-repeat: no-repeat; + width: 10px; + height: 10px; } + +h1 > .anchor-icon { + margin-bottom: 2px; } + +.declaration .highlight { + font-size: 15px; + overflow-x: initial; + padding: 8px 0; + line-height: 20px; + margin: 0; + background-color: transparent; + border: none; } + +.highlight a { + text-decoration: underline; } + +.task-group-section { + border-top: 1px solid #ddd; } + +.task-group { + padding-top: 0px; } + +.task-name-container a[name]:before { + content: ""; + display: block; } + +.item { + width: 100%; + list-style-type: none; } + .item a[name]:before { + content: ""; + display: block; } + .item .token { + margin-left: 0px; + font-size: 13px; + display: flex; + padding: 5px 0px; + line-height: 14px; } + .item .token-name { + display: inline-block; + white-space: nowrap; + overflow: hidden; + text-overflow: ellipsis; } + .item .token-icon { + background: url("../img/plus.svg"); + width: 17px; + display: inline-block; + vertical-align: middle; + height: 13px; + opacity: 1; + margin-left: 5px; + background-repeat: no-repeat; } + .item .token-icon-minus { + background: url("../img/minus.svg"); + background-repeat: no-repeat; } + .item .declaration-note { + font-size: 13px; + color: #808080; + font-style: italic; } + +.pointer-container { + border-bottom: 1px solid #ddd; + left: -23px; + padding-bottom: 13px; + position: relative; + width: 110%; } + +.pointer { + left: 21px; + top: 7px; + display: block; + position: absolute; + width: 12px; + height: 12px; + border-left: 1px solid #ddd; + border-top: 1px solid #ddd; + background: #fdfeff; + transform: rotate(45deg); } + +.height-container { + display: none; + position: relative; + width: 100%; + overflow: hidden; } + .height-container .section { + background: #fdfeff; + border: 1px solid rgba(12, 40, 73, 0.08); + padding: 15px 20px; + border-radius: 4px; + margin: 10px 0px 30px; } + +.aside, .language { + padding: 6px 12px; + margin: 12px 0; + border-left: 4px solid #dddddd; + overflow-y: hidden; } + .aside .aside-title, .language .aside-title { + font-size: 10px; + font-family: "Open Sans Bold", "Helvetica Neue", Helvetica, Arial, sans-serif; + letter-spacing: 2px; + text-transform: uppercase; + padding: 2px 8px; + display: inline; + border-radius: 4px; + margin: 0; + -webkit-user-select: none; } + .aside p:last-child, .language p:last-child { + margin-bottom: 0; } + +.language { + background: #F5F8FC; + border-radius: 4px; + border-left: 4px solid #3A68D8; } + +.aside.aside-see, .aside.aside-note { + background: #F5F8FC; + border-radius: 4px; } + .aside.aside-see .aside-title, .aside.aside-note .aside-title { + padding-left: 0px; } + +.aside-warning { + border-left: 4px solid #ff6666; } + .aside-warning .aside-title { + color: #ff0000; } + +.graybox { + width: 100%; + border-collapse: separate; + border: solid rgba(12, 40, 73, 0.08) 1px; + border-radius: 6px; + -moz-border-radius: 6px; } + .graybox p { + margin: 0; + word-break: break-word; + min-width: 50px; } + .graybox td { + padding: 5px 25px 5px 10px; + vertical-align: middle; } + .graybox tr td:first-of-type { + text-align: right; + padding: 7px; + vertical-align: top; + word-break: normal; + width: 40px; + border-left: none; + border-top: none; } + .graybox th, .graybox td { + border-right: none; + border-top: none; } + .graybox td:first-child, .graybox th:first-child { + border-left: none; } + .graybox tr:last-of-type td { + border-bottom: none; } + +.show-on-github-icon { + width: 16px; + display: inline-block !important; + vertical-align: -3px; + padding-left: 2px; } + +.show-on-github a { + margin: 10px 0 10px; + display: inline-block; + font-size: 13px; } + +.footer { + border-top: 1px rgba(12, 40, 73, 0.08) solid; + padding: 8px 16px; + color: #888; } + .footer p { + display: inline; } + .footer a { + color: #555; } + +html.dash .header, html.dash .breadcrumbs, html.dash .navigation { + display: none; } +html.dash .height-container { + display: block; } + +@font-face { + font-family: 'Open Sans'; + src: url("../fonts/opensans-regular.eot"); + src: url("../fonts/opensans-regular.eot#iefix") format("embedded-opentype"), url("../fonts/opensans-regular.woff") format("woff"); } +@font-face { + font-family: 'Open Sans Bold'; + src: url("../fonts/opensans-bold.eot"); + src: url("../fonts/opensans-bold.eot#iefix") format("embedded-opentype"), url("../fonts/opensans-bold.woff") format("woff"); } +.strong { + font-family: "Open Sans Bold", "Helvetica Neue", Helvetica, Arial, sans-serif; } + +.text-purple { + color: #9595D1; } + +.text-blue { + color: #4092C5; } + +.keyline-purple { + border-color: #9595D1; } + +.keyline-blue { + border-color: #4092C5; } diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Info.plist b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Info.plist new file mode 100644 index 0000000000..820824f653 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Info.plist @@ -0,0 +1,20 @@ + + + + + CFBundleIdentifier + com.jazzy.mapbox + CFBundleName + Mapbox + DocSetPlatformFamily + mapbox + isDashDocset + + dashIndexFilePath + index.html + isJavaScriptEnabled + + DashDocSetFamily + dashtoc + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Categories/NSValue(MGLAdditions).html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Categories/NSValue(MGLAdditions).html new file mode 100644 index 0000000000..d0b03bb860 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Categories/NSValue(MGLAdditions).html @@ -0,0 +1,960 @@ + + + + NSValue(MGLAdditions) Category Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + NSValue(MGLAdditions) Category Reference +
+
+ +
+ +
+ +
+
+

NSValue(MGLAdditions)

 +
+
+ 
@interface NSValue (MGLAdditions)
+ +
+
+

Methods for round-tripping values for Mapbox-defined types.

+ +
+
+ +
+
+
+
+ + + +

Working with Geographic Coordinate Values

+ +
+
    +
  • + +
    +
    +
    +

    Creates a new value object containing the specified Core Location geographic +coordinate structure.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)valueWithMGLCoordinate:
+    (CLLocationCoordinate2D)coordinate;
    + +
    +
    +

    Swift

    + 
    convenience init(mglCoordinate coordinate: CLLocationCoordinate2D)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + coordinate + + +
    +

    The value for the new object.

    + +
    +
    +
    +
    +

    Return Value

    +

    A new value object that contains the geographic coordinate information.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + MGLCoordinateValue + +
    +
    +
    +
    +

    The Core Location geographic coordinate structure representation of the value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, atomic) CLLocationCoordinate2D MGLCoordinateValue;
    + +
    +
    +

    Swift

    + 
    var mglCoordinateValue: CLLocationCoordinate2D { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Creates a new value object containing the specified Mapbox coordinate span +structure.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)valueWithMGLCoordinateSpan:(MGLCoordinateSpan)span;
    + +
    +
    +

    Swift

    + 
    convenience init(mglCoordinateSpan span: MGLCoordinateSpan)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + span + + +
    +

    The value for the new object.

    + +
    +
    +
    +
    +

    Return Value

    +

    A new value object that contains the coordinate span information.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    The Mapbox coordinate span structure representation of the value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, atomic) MGLCoordinateSpan MGLCoordinateSpanValue;
    + +
    +
    +

    Swift

    + 
    var mglCoordinateSpanValue: MGLCoordinateSpan { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Creates a new value object containing the specified Mapbox coordinate bounds +structure.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)valueWithMGLCoordinateBounds:
+    (MGLCoordinateBounds)bounds;
    + +
    +
    +

    Swift

    + 
    convenience init(mglCoordinateBounds bounds: MGLCoordinateBounds)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + bounds + + +
    +

    The value for the new object.

    + +
    +
    +
    +
    +

    Return Value

    +

    A new value object that contains the coordinate bounds information.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    The Mapbox coordinate bounds structure representation of the value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, atomic) MGLCoordinateBounds MGLCoordinateBoundsValue;
    + +
    +
    +

    Swift

    + 
    var mglCoordinateBoundsValue: MGLCoordinateBounds { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Working with Offline Map Values

+ +
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Categories/NSValue(MGLCircleStyleLayerAdditions).html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Categories/NSValue(MGLCircleStyleLayerAdditions).html new file mode 100644 index 0000000000..faebff911e --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Categories/NSValue(MGLCircleStyleLayerAdditions).html @@ -0,0 +1,753 @@ + + + + NSValue(MGLCircleStyleLayerAdditions) Category Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + NSValue(MGLCircleStyleLayerAdditions) Category Reference +
+
+ +
+ +
+ +
+
+

NSValue(MGLCircleStyleLayerAdditions)

 +
+
+ 
@interface NSValue (MGLCircleStyleLayerAdditions)
+ +
+
+

Methods for wrapping an enumeration value for a style layer attribute in an +MGLCircleStyleLayer object and unwrapping its raw value.

+ +
+
+ +
+
+
+
+ + + +

Working with Circle Style Layer Attribute Values

+ +
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Categories/NSValue(MGLFillStyleLayerAdditions).html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Categories/NSValue(MGLFillStyleLayerAdditions).html new file mode 100644 index 0000000000..c00a760be1 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Categories/NSValue(MGLFillStyleLayerAdditions).html @@ -0,0 +1,654 @@ + + + + NSValue(MGLFillStyleLayerAdditions) Category Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + NSValue(MGLFillStyleLayerAdditions) Category Reference +
+
+ +
+ +
+ +
+
+

NSValue(MGLFillStyleLayerAdditions)

 +
+
+ 
@interface NSValue (MGLFillStyleLayerAdditions)
+ +
+
+

Methods for wrapping an enumeration value for a style layer attribute in an +MGLFillStyleLayer object and unwrapping its raw value.

+ +
+
+ +
+
+
+
+ + + +

Working with Fill Style Layer Attribute Values

+ +
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Categories/NSValue(MGLLineStyleLayerAdditions).html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Categories/NSValue(MGLLineStyleLayerAdditions).html new file mode 100644 index 0000000000..911fa25c13 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Categories/NSValue(MGLLineStyleLayerAdditions).html @@ -0,0 +1,848 @@ + + + + NSValue(MGLLineStyleLayerAdditions) Category Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + NSValue(MGLLineStyleLayerAdditions) Category Reference +
+
+ +
+ +
+ +
+
+

NSValue(MGLLineStyleLayerAdditions)

 +
+
+ 
@interface NSValue (MGLLineStyleLayerAdditions)
+ +
+
+

Methods for wrapping an enumeration value for a style layer attribute in an +MGLLineStyleLayer object and unwrapping its raw value.

+ +
+
+ +
+
+
+
+ + + +

Working with Line Style Layer Attribute Values

+ +
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Categories/NSValue(MGLSymbolStyleLayerAdditions).html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Categories/NSValue(MGLSymbolStyleLayerAdditions).html new file mode 100644 index 0000000000..d069915899 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Categories/NSValue(MGLSymbolStyleLayerAdditions).html @@ -0,0 +1,1537 @@ + + + + NSValue(MGLSymbolStyleLayerAdditions) Category Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + NSValue(MGLSymbolStyleLayerAdditions) Category Reference +
+
+ +
+ +
+ +
+
+

NSValue(MGLSymbolStyleLayerAdditions)

 +
+
+ 
@interface NSValue (MGLSymbolStyleLayerAdditions)
+ +
+
+

Methods for wrapping an enumeration value for a style layer attribute in an +MGLSymbolStyleLayer object and unwrapping its raw value.

+ +
+
+ +
+
+
+
+ + + +

Working with Symbol Style Layer Attribute Values

+ +
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLAccountManager.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLAccountManager.html new file mode 100644 index 0000000000..e5451cb3e9 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLAccountManager.html @@ -0,0 +1,670 @@ + + + + MGLAccountManager Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLAccountManager Class Reference +
+
+ +
+ +
+ +
+
+

MGLAccountManager

 +
+
+ 
@interface MGLAccountManager : NSObject
+ +
+
+

The MGLAccountManager object provides a global way to set a Mapbox API access +token.

+ +
+
+ +
+
+
+
+ + + +

Authorizing Access

+ +
+
    +
  • +
    + + + + +setAccessToken: + +
    +
    +
    +
    +

    Set the +Mapbox access token +to be used by all instances of MGLMapView in the current application.

    + +

    Mapbox-hosted vector tiles and styles require an API access token, which you +can obtain from the +Mapbox account page. +Access tokens associate requests to Mapbox’s vector tile and style APIs with +your Mapbox account. They also deter other developers from using your styles +without your permission.

    + +
    +

    Note

    +

    You must set the access token before attempting to load any Mapbox-hosted +style. Therefore, you should generally set it before creating an instance of +MGLMapView. The recommended way to set an access token is to add an entry to +your application’s Info.plist file with the key MGLMapboxAccessToken and +the type String. Alternatively, you may call this method from your +application delegate’s -applicationDidFinishLaunching: method.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (void)setAccessToken:(nullable NSString *)accessToken;
    + +
    +
    +

    Swift

    + 
    class func setAccessToken(_ accessToken: String?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + accessToken + + +
    +

    A Mapbox access token. Calling this method with a value of + nil has no effect.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + +accessToken + +
    +
    +
    +
    +

    Returns the +Mapbox access token +in use by instances of MGLMapView in the current application.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nullable NSString *)accessToken;
    + +
    +
    +

    Swift

    + 
    class func accessToken() -> String?
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLAnnotationImage.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLAnnotationImage.html new file mode 100644 index 0000000000..0ef68ba869 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLAnnotationImage.html @@ -0,0 +1,804 @@ + + + + MGLAnnotationImage Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLAnnotationImage Class Reference +
+
+ +
+ +
+ +
+
+

MGLAnnotationImage

 +
+
+ 
@interface MGLAnnotationImage : NSObject <NSSecureCoding>
+ +
+
+

The MGLAnnotationImage class is responsible for presenting point-based +annotations visually on an MGLMapView instance. Annotation image objects pair +NSImage objects with annotation-related metadata. They may be recycled later +and put into a reuse queue that is maintained by the map view.

+ +
+
+ +
+
+
+
+ + + +

Initializing and Preparing the Image Object

+ +
+
    +
  • + +
    +
    +
    +

    Initializes and returns a new annotation image object.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)annotationImageWithImage:(nonnull NSImage *)image
+                                 reuseIdentifier:
+                                     (nonnull NSString *)reuseIdentifier;
    + +
    +
    +

    Swift

    + 
    convenience init(image: NSImage, reuseIdentifier: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + image + + +
    +

    The image to display for the annotation.

    + +
    +
    + + reuseIdentifier + + +
    +

    The string that identifies this annotation image in the + reuse queue.

    + +
    +
    +
    +
    +

    Return Value

    +

    The initialized annotation image object or nil if there was a problem + initializing the object.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Getting and Setting Attributes

+ +
+
    +
  • +
    + + + + image + +
    +
    +
    +
    +

    The image to display for the annotation.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) NSImage *_Nonnull image;
    + +
    +
    +

    Swift

    + 
    var image: NSImage { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + reuseIdentifier + +
    +
    +
    +
    +

    The string that identifies this annotation image in the reuse queue. +(read-only)

    + +

    You specify the reuse identifier when you create the image object. You use this +type later to retrieve an annotation image object that was created previously +but which is currently unused because its annotation is not on-screen.

    + +

    If you define distinctly different types of annotations (with distinctly +different annotation images to go with them), you can differentiate between the +annotation types by specifying different reuse identifiers for each one.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) NSString *_Nonnull reuseIdentifier;
    + +
    +
    +

    Swift

    + 
    var reuseIdentifier: String { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + selectable + +
    +
    +
    +
    +

    A Boolean value indicating whether the annotation is selectable.

    + +

    The default value of this property is YES. If the value of this property is +NO, the annotation image ignores click events and cannot be selected.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (getter=isSelectable, assign, readwrite, nonatomic) BOOL selectable;
    + +
    +
    +

    Swift

    + 
    var isSelectable: Bool { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + cursor + +
    +
    +
    +
    +

    The cursor that appears above any annotation using this annotation image.

    + +

    By default, this property is set to nil, representing the current cursor.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, nullable) NSCursor *cursor;
    + +
    +
    +

    Swift

    + 
    var cursor: NSCursor? { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLAttributionInfo.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLAttributionInfo.html new file mode 100644 index 0000000000..49b2b0d575 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLAttributionInfo.html @@ -0,0 +1,820 @@ + + + + MGLAttributionInfo Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLAttributionInfo Class Reference +
+
+ +
+ +
+ +
+
+

MGLAttributionInfo

 +
+
+ 
@interface MGLAttributionInfo : NSObject
+ +
+
+

Information about an attribution statement, usually a copyright or trademark +statement, associated with a map content source.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + -initWithTitle:URL: + +
    +
    +
    +
    +

    Returns an initialized attribution info object with the given title and URL.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithTitle:(nonnull NSAttributedString *)title
+                                  URL:(nullable NSURL *)URL;
    + +
    +
    +

    Swift

    + 
    init(title: NSAttributedString, url URL: URL?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + title + + +
    +

    The attribution statement’s title.

    + +
    +
    + + URL + + +
    +

    A URL to more information about the entity named in the attribution.

    + +
    +
    +
    +
    +

    Return Value

    +

    An initialized attribution info object.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + title + +
    +
    +
    +
    +

    The attribution statement’s attributed title text.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) NSAttributedString *_Nonnull title;
    + +
    +
    +

    Swift

    + 
    var title: NSAttributedString { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + URL + +
    +
    +
    +
    +

    The URL to more information about the entity named in the attribution.

    + +

    If this property is set, the attribution statement should be displayed as a +hyperlink or action button. Otherwise, if it is nil, the attribution +statement should be displayed as plain text.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, nullable) NSURL *URL;
    + +
    +
    +

    Swift

    + 
    var url: URL? { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + feedbackLink + +
    +
    +
    +
    +

    A Boolean value indicating whether the attribution statement is a shortcut to a +feedback tool.

    + +

    If this property is set, the statement should be treated as a way for the user +to provide feedback rather than an attribution statement.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (getter=isFeedbackLink, assign, readwrite, nonatomic)
+    BOOL feedbackLink;
    + +
    +
    +

    Swift

    + 
    var isFeedbackLink: Bool { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns a copy of the URL property modified to account for the given center +coordinate and zoom level.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nullable NSURL *)feedbackURLAtCenterCoordinate:
+                        (CLLocationCoordinate2D)centerCoordinate
+                                        zoomLevel:(double)zoomLevel;
    + +
    +
    +

    Swift

    + 
    func feedbackURL(atCenter centerCoordinate: CLLocationCoordinate2D, zoomLevel: Double) -> URL?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + centerCoordinate + + +
    +

    The map’s center coordinate.

    + +
    +
    + + zoomLevel + + +
    +

    The map’s zoom level. See the MGLMapView.zoomLevel property + for more information.

    + +
    +
    +
    +
    +

    Return Value

    +

    A modified URL containing a fragment that points to the specified + viewport. If the feedbackLink property is set to NO, this method returns + nil.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLBackgroundStyleLayer.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLBackgroundStyleLayer.html new file mode 100644 index 0000000000..29bfeecfb4 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLBackgroundStyleLayer.html @@ -0,0 +1,689 @@ + + + + MGLBackgroundStyleLayer Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLBackgroundStyleLayer Class Reference +
+
+ +
+ +
+ +
+
+

MGLBackgroundStyleLayer

 +
+
+ 
@interface MGLBackgroundStyleLayer : MGLStyleLayer
+ +
+
+

An MGLBackgroundStyleLayer is a style layer that covers the entire map. Use a +background style layer to configure a color or pattern to show below all other +map content. If the style’s other layers use the Mapbox Streets source, the +background style layer is responsible for drawing land, whereas the oceans and +other bodies of water are drawn by MGLFillStyleLayer objects.

+ +

A background style layer is typically the bottommost layer in a style, because +it covers the entire map and can occlude any layers below it. You can therefore +access it by getting the last item in the MGLStyle.layers array.

+ +

If the background style layer is transparent or omitted from the style, any +portion of the map view that does not show another style layer is transparent.

+ +
+
+ +
+
+
+
+ + + +

Accessing the Paint Attributes

+ +
+
    +
  • +
    + + + + backgroundColor + +
    +
    +
    +
    +

    The color with which the background will be drawn.

    + +

    The default value of this property is an MGLStyleValue object containing +NSColor.blackColor. Set this property to nil to reset it to the default +value.

    + +

    This property is only applied to the style if backgroundPattern is set to +nil. Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSColor *> *backgroundColor;
    + +
    +
    +

    Swift

    + 
    var backgroundColor: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + backgroundOpacity + +
    +
    +
    +
    +

    The opacity at which the background will be drawn.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 1. Set this property to nil to reset +it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *backgroundOpacity;
    + +
    +
    +

    Swift

    + 
    var backgroundOpacity: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + backgroundPattern + +
    +
    +
    +
    +

    Name of image in style images to use for drawing an image background. For +seamless patterns, image width and height must be a factor of two (2, 4, 8, +…, 512).

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSString *> *backgroundPattern;
    + +
    +
    +

    Swift

    + 
    var backgroundPattern: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLCircleStyleLayer.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLCircleStyleLayer.html new file mode 100644 index 0000000000..5040bfcaed --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLCircleStyleLayer.html @@ -0,0 +1,891 @@ + + + + MGLCircleStyleLayer Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLCircleStyleLayer Class Reference +
+
+ +
+ +
+ +
+
+

MGLCircleStyleLayer

 +
+
+ 
@interface MGLCircleStyleLayer : MGLVectorStyleLayer
+ +
+
+

An MGLCircleStyleLayer is a style layer that renders one or more filled +circles on the map.

+ +

Use a circle style layer to configure the visual appearance of point or point +collection features in vector tiles loaded by an MGLVectorSource object or +MGLPointAnnotation, MGLPointFeature, MGLPointCollection, or +MGLPointCollectionFeature instances in an MGLShapeSource object.

+ +

A circle style layer renders circles whose radii are measured in screen units. +To display circles on the map whose radii correspond to real-world distances, +use many-sided regular polygons and configure their appearance using an +MGLFillStyleLayer object.

+ +

You can access an existing circle style layer using the +-[MGLStyle layerWithIdentifier:] method if you know its identifier; +otherwise, find it using the MGLStyle.layers property. You can also create a +new circle style layer and add it to the style using a method such as +-[MGLStyle addLayer:].

+ +

Example

+
let layer = MGLCircleStyleLayer(identifier: circles, source: population)
+layer.sourceLayerIdentifier = population
+layer.circleColor = MGLStyleValue(rawValue: .green)
+layer.circleRadius = MGLStyleValue(interpolationBase: 1.75, stops: [
+    12: MGLStyleValue(rawValue: 2),
+    22: MGLStyleValue(rawValue: 180)
+])
+layer.circleOpacity = MGLStyleValue(rawValue: 0.7)
+layer.predicate = NSPredicate(format: %K == %@, marital-status, married)
+mapView.style?.addLayer(layer)
+

+ +
+
+ +
+
+
+
+ + + +

Accessing the Paint Attributes

+ +
+
    +
  • +
    + + + + circleBlur + +
    +
    +
    +
    +

    Amount to blur the circle. 1 blurs the circle such that only the centerpoint is +full opacity.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 0. Set this property to nil to reset +it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *circleBlur;
    + +
    +
    +

    Swift

    + 
    var circleBlur: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + circleColor + +
    +
    +
    +
    +

    The fill color of the circle.

    + +

    The default value of this property is an MGLStyleValue object containing +NSColor.blackColor. Set this property to nil to reset it to the default +value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSColor *> *circleColor;
    + +
    +
    +

    Swift

    + 
    var circleColor: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + circleOpacity + +
    +
    +
    +
    +

    The opacity at which the circle will be drawn.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 1. Set this property to nil to reset +it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *circleOpacity;
    + +
    +
    +

    Swift

    + 
    var circleOpacity: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + circleRadius + +
    +
    +
    +
    +

    Circle radius.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 5. Set this property to nil to reset +it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *circleRadius;
    + +
    +
    +

    Swift

    + 
    var circleRadius: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + circleScaleAlignment + +
    +
    +
    +
    +

    Controls the scaling behavior of the circle when the map is pitched.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing MGLCircleScaleAlignmentMap. Set this property to +nil to reset it to the default value.

    + +

    This attribute corresponds to the circle-pitch-scale +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *circleScaleAlignment;
    + +
    +
    +

    Swift

    + 
    var circleScaleAlignment: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + circleTranslation + +
    +
    +
    +
    +

    The geometry’s offset.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing a CGVector struct set to 0 points rightward and 0 +points upward. Set this property to nil to reset it to the default value.

    + +

    This attribute corresponds to the circle-translate +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *circleTranslation;
    + +
    +
    +

    Swift

    + 
    var circleTranslation: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Controls the translation reference point.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing MGLCircleTranslationAnchorMap. Set this property +to nil to reset it to the default value.

    + +

    This property is only applied to the style if circleTranslation is non-nil. +Otherwise, it is ignored.

    + +

    This attribute corresponds to the circle-translate-anchor +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *circleTranslationAnchor;
    + +
    +
    +

    Swift

    + 
    var circleTranslationAnchor: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLClockDirectionFormatter.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLClockDirectionFormatter.html new file mode 100644 index 0000000000..0603db191a --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLClockDirectionFormatter.html @@ -0,0 +1,694 @@ + + + + MGLClockDirectionFormatter Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLClockDirectionFormatter Class Reference +
+
+ +
+ +
+ +
+
+

MGLClockDirectionFormatter

 +
+
+ 
@interface MGLClockDirectionFormatter : NSFormatter
+ +
+
+

The MGLClockDirectionFormatter class provides properly formatted descriptions +of headings relative to the user, known as clock positions. For +example, a value of 90 may be formatted as “3 o’clock”, depending on the +locale.

+ +

Use this class to create localized heading strings when displaying directions +relative to the user’s current location and heading. To format a direction +irrespective of the user’s orientation, use MGLCompassDirectionFormatter +instead.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + unitStyle + +
    +
    +
    +
    +

    The unit style used by this formatter.

    + +

    This property defaults to NSFormattingUnitStyleMedium.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) NSFormattingUnitStyle unitStyle;
    + +
    +
    +

    Swift

    + 
    var unitStyle: Formatter.UnitStyle { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -stringFromDirection: + +
    +
    +
    +
    +

    Returns a clock position string for the provided value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull NSString *)stringFromDirection:(CLLocationDirection)direction;
    + +
    +
    +

    Swift

    + 
    func string(fromDirection direction: CLLocationDirection) -> String
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + direction + + +
    +

    The heading, measured in degrees, where 0° means “straight + ahead” and 90° means “directly to your right”.

    + +
    +
    +
    +
    +

    Return Value

    +

    The clock position string appropriately formatted for the receiver’s + locale.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    This method is not supported for the MGLDirectionFormatter class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (BOOL)getObjectValue:(out id _Nullable *_Nullable)obj
+             forString:(nonnull NSString *)string
+      errorDescription:(out NSString *_Nullable *_Nullable)error;
    + +
    +
    +

    Swift

    + 
    func getObjectValue(_ obj: AutoreleasingUnsafeMutablePointer
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLCompassDirectionFormatter.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLCompassDirectionFormatter.html new file mode 100644 index 0000000000..2ec4d23d8d --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLCompassDirectionFormatter.html @@ -0,0 +1,691 @@ + + + + MGLCompassDirectionFormatter Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLCompassDirectionFormatter Class Reference +
+
+ +
+ +
+ +
+
+

MGLCompassDirectionFormatter

 +
+
+ 
@interface MGLCompassDirectionFormatter : NSFormatter
+ +
+
+

The MGLCompassDirectionFormatter class provides properly formatted +descriptions of absolute headings. For example, a value of 90 may be +formatted as “east”, depending on the locale.

+ +

Use this class to create localized heading strings when displaying directions +irrespective of the user’s current location. To format a direction relative to +the user’s current location, use MGLClockDirectionFormatter instead.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + unitStyle + +
    +
    +
    +
    +

    The unit style used by this formatter.

    + +

    This property defaults to NSFormattingUnitStyleMedium.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) NSFormattingUnitStyle unitStyle;
    + +
    +
    +

    Swift

    + 
    var unitStyle: Formatter.UnitStyle { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -stringFromDirection: + +
    +
    +
    +
    +

    Returns a heading string for the provided value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull NSString *)stringFromDirection:(CLLocationDirection)direction;
    + +
    +
    +

    Swift

    + 
    func string(fromDirection direction: CLLocationDirection) -> String
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + direction + + +
    +

    The heading, measured in degrees, where 0° means “due north” + and 90° means “due east”.

    + +
    +
    +
    +
    +

    Return Value

    +

    The heading string appropriately formatted for the formatter’s locale.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    This method is not supported for the MGLDirectionFormatter class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (BOOL)getObjectValue:(out id _Nullable *_Nullable)obj
+             forString:(nonnull NSString *)string
+      errorDescription:(out NSString *_Nullable *_Nullable)error;
    + +
    +
    +

    Swift

    + 
    func getObjectValue(_ obj: AutoreleasingUnsafeMutablePointer
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLCoordinateFormatter.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLCoordinateFormatter.html new file mode 100644 index 0000000000..c23315b220 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLCoordinateFormatter.html @@ -0,0 +1,766 @@ + + + + MGLCoordinateFormatter Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLCoordinateFormatter Class Reference +
+
+ +
+ +
+ +
+
+

MGLCoordinateFormatter

 +
+
+ 
@interface MGLCoordinateFormatter : NSFormatter
+ +
+
+

The MGLCoordinateFormatter class provides properly formatted descriptions of +geographic coordinate pairs. Use this class to create localized coordinate +strings when displaying location information to users.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + allowsMinutes + +
    +
    +
    +
    +

    Determines whether the output may contain minutes of arc when nonzero.

    + +

    The default value of this property is YES, causing the receiver to include +minutes of arc in its output. If allowsSeconds is YES, this property is +ignored and the output always includes minutes of arc.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) BOOL allowsMinutes;
    + +
    +
    +

    Swift

    + 
    var allowsMinutes: Bool { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + allowsSeconds + +
    +
    +
    +
    +

    Determines whether the output may contain seconds of arc when nonzero.

    + +

    The default value of this property is YES, causing the receiver to include +seconds of arc in its output.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) BOOL allowsSeconds;
    + +
    +
    +

    Swift

    + 
    var allowsSeconds: Bool { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + unitStyle + +
    +
    +
    +
    +

    The unit style used by this formatter.

    + +

    The default value of this property is NSFormattingUnitStyleMedium.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) NSFormattingUnitStyle unitStyle;
    + +
    +
    +

    Swift

    + 
    var unitStyle: Formatter.UnitStyle { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns a coordinate string for the provided value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull NSString *)stringFromCoordinate:(CLLocationCoordinate2D)coordinate;
    + +
    +
    +

    Swift

    + 
    func string(from coordinate: CLLocationCoordinate2D) -> String
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + coordinate + + +
    +

    The coordinate’s value.

    + +
    +
    +
    +
    +

    Return Value

    +

    The coordinate string appropriately formatted for the formatter’s + locale.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    This method is not supported for the MGLCoordinateFormatter class.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (BOOL)getObjectValue:(out id _Nullable *_Nullable)obj
+             forString:(nonnull NSString *)string
+      errorDescription:(out NSString *_Nullable *_Nullable)error;
    + +
    +
    +

    Swift

    + 
    func getObjectValue(_ obj: AutoreleasingUnsafeMutablePointer
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLFillStyleLayer.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLFillStyleLayer.html new file mode 100644 index 0000000000..d79bcea179 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLFillStyleLayer.html @@ -0,0 +1,879 @@ + + + + MGLFillStyleLayer Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLFillStyleLayer Class Reference +
+
+ +
+ +
+ +
+
+

MGLFillStyleLayer

 +
+
+ 
@interface MGLFillStyleLayer : MGLVectorStyleLayer
+ +
+
+

An MGLFillStyleLayer is a style layer that renders one or more filled (and +optionally stroked) polygons on the map.

+ +

Use a fill style layer to configure the visual appearance of polygon or +multipolygon features in vector tiles loaded by an MGLVectorSource object or +MGLPolygon, MGLPolygonFeature, MGLMultiPolygon, or +MGLMultiPolygonFeature instances in an MGLShapeSource object.

+ +

You can access an existing fill style layer using the +-[MGLStyle layerWithIdentifier:] method if you know its identifier; +otherwise, find it using the MGLStyle.layers property. You can also create a +new fill style layer and add it to the style using a method such as +-[MGLStyle addLayer:].

+ +

Example

+
let layer = MGLFillStyleLayer(identifier: parks, source: parks)
+layer.sourceLayerIdentifier = parks
+layer.fillColor = MGLStyleValue(rawValue: .green)
+layer.predicate = NSPredicate(format: type == %@, national-park)
+mapView.style?.addLayer(layer)
+

+ +
+
+ +
+
+
+
+ + + +

Accessing the Paint Attributes

+ +
+
    +
  • +
    + + + + fillAntialiased + +
    +
    +
    +
    +

    Whether or not the fill should be antialiased.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing YES. Set this property to nil to reset it to +the default value.

    + +

    This attribute corresponds to the fill-antialias +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (getter=isFillAntialiased, assign, readwrite, nonatomic,
+          null_resettable) MGLStyleValue<NSNumber *> *fillAntialiased;
    + +
    +
    +

    Swift

    + 
    var fillAntialiased: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + fillColor + +
    +
    +
    +
    +

    The color of the filled part of this layer.

    + +

    The default value of this property is an MGLStyleValue object containing +NSColor.blackColor. Set this property to nil to reset it to the default +value.

    + +

    This property is only applied to the style if fillPattern is set to nil. +Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSColor *> *fillColor;
    + +
    +
    +

    Swift

    + 
    var fillColor: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + fillOpacity + +
    +
    +
    +
    +

    The opacity of the entire fill layer. In contrast to the fillColor, this +value will also affect the 1pt stroke around the fill, if the stroke is used.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 1. Set this property to nil to reset +it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *fillOpacity;
    + +
    +
    +

    Swift

    + 
    var fillOpacity: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + fillOutlineColor + +
    +
    +
    +
    +

    The outline color of the fill. Matches the value of fillColor if unspecified.

    + +

    This property is only applied to the style if fillPattern is set to nil, +and fillAntialiased is set to an MGLStyleValue object containing an +NSNumber object containing YES. Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSColor *> *fillOutlineColor;
    + +
    +
    +

    Swift

    + 
    var fillOutlineColor: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + fillPattern + +
    +
    +
    +
    +

    Name of image in sprite to use for drawing image fills. For seamless patterns, +image width and height must be a factor of two (2, 4, 8, …, 512).

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSString *> *fillPattern;
    + +
    +
    +

    Swift

    + 
    var fillPattern: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + fillTranslation + +
    +
    +
    +
    +

    The geometry’s offset.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing a CGVector struct set to 0 points rightward and 0 +points upward. Set this property to nil to reset it to the default value.

    + +

    This attribute corresponds to the fill-translate +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *fillTranslation;
    + +
    +
    +

    Swift

    + 
    var fillTranslation: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + fillTranslationAnchor + +
    +
    +
    +
    +

    Controls the translation reference point.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing MGLFillTranslationAnchorMap. Set this property to +nil to reset it to the default value.

    + +

    This property is only applied to the style if fillTranslation is non-nil. +Otherwise, it is ignored.

    + +

    This attribute corresponds to the fill-translate-anchor +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *fillTranslationAnchor;
    + +
    +
    +

    Swift

    + 
    var fillTranslationAnchor: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLForegroundStyleLayer.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLForegroundStyleLayer.html new file mode 100644 index 0000000000..a95af1f437 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLForegroundStyleLayer.html @@ -0,0 +1,687 @@ + + + + MGLForegroundStyleLayer Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLForegroundStyleLayer Class Reference +
+
+ +
+ +
+ +
+
+

MGLForegroundStyleLayer

 +
+
+ 
@interface MGLForegroundStyleLayer : MGLStyleLayer
+ +
+
+

MGLForegroundStyleLayer is an abstract superclass for style layers whose +content is defined by an MGLSource object.

+ +

Do not create instances of this class directly, and do not create your own +subclasses of this class. Instead, create instances of MGLRasterStyleLayer +and the concrete subclasses of MGLVectorStyleLayer.

+ +
+
+ +
+
+
+
+ + + +

Initializing a Style Layer

+ +
+
    +
  • + +
    +
    +
    +

    Returns a foreground style layer initialized with an identifier and source.

    + +

    After initializing and configuring the style layer, add it to a map view’s +style using the -[MGLStyle addLayer:] or +-[MGLStyle insertLayer:belowLayer:] method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithIdentifier:(nonnull NSString *)identifier
+                                    source:(nonnull MGLSource *)source;
    + +
    +
    +

    Swift

    + 
    init(identifier: String, source: MGLSource)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + identifier + + +
    +

    A string that uniquely identifies the source in the style to + which it is added.

    + +
    +
    + + source + + +
    +

    The source from which to obtain the data to style. If the source + has not yet been added to the current style, the behavior is undefined.

    + +
    +
    +
    +
    +

    Return Value

    +

    An initialized foreground style layer.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Specifying a Style Layer’s Content

+ +
+
    +
  • +
    + + + + sourceIdentifier + +
    +
    +
    +
    +

    Identifier of the source from which the receiver obtains the data to style.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic, nullable) NSString *sourceIdentifier;
    + +
    +
    +

    Swift

    + 
    var sourceIdentifier: String? { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLLineStyleLayer.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLLineStyleLayer.html new file mode 100644 index 0000000000..80a1504917 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLLineStyleLayer.html @@ -0,0 +1,1204 @@ + + + + MGLLineStyleLayer Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLLineStyleLayer Class Reference +
+
+ +
+ +
+ +
+
+

MGLLineStyleLayer

 +
+
+ 
@interface MGLLineStyleLayer : MGLVectorStyleLayer
+ +
+
+

An MGLLineStyleLayer is a style layer that renders one or more stroked +polylines on the map.

+ +

Use a line style layer to configure the visual appearance of polyline or +multipolyline features in vector tiles loaded by an MGLVectorSource object or +MGLPolyline, MGLPolylineFeature, MGLMultiPolyline, or +MGLMultiPolylineFeature instances in an MGLShapeSource object.

+ +

You can access an existing line style layer using the +-[MGLStyle layerWithIdentifier:] method if you know its identifier; +otherwise, find it using the MGLStyle.layers property. You can also create a +new line style layer and add it to the style using a method such as +-[MGLStyle addLayer:].

+ +

Example

+
let layer = MGLLineStyleLayer(identifier: trails-path, source: trails)
+layer.sourceLayerIdentifier = trails
+layer.lineWidth = MGLStyleValue(interpolationBase: 1.5, stops: [
+    14: MGLStyleValue(rawValue: 2),
+    18: MGLStyleValue(rawValue: 20),
+])
+layer.lineColor = MGLStyleValue(rawValue: .brown)
+layer.lineCap = MGLStyleValue(rawValue: NSValue(mglLineCap: .round))
+layer.predicate = NSPredicate(format: %K == %@, trail-type, mountain-biking)
+mapView.style?.addLayer(layer)
+

+ +
+
+ +
+
+
+
+ + + +

Accessing the Layout Attributes

+ +
+
    +
  • +
    + + + + lineCap + +
    +
    +
    +
    +

    The display of line endings.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing MGLLineCapButt. Set this property to nil to +reset it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *lineCap;
    + +
    +
    +

    Swift

    + 
    var lineCap: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + lineJoin + +
    +
    +
    +
    +

    The display of lines when joining.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing MGLLineJoinMiter. Set this property to nil to +reset it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *lineJoin;
    + +
    +
    +

    Swift

    + 
    var lineJoin: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + lineMiterLimit + +
    +
    +
    +
    +

    Used to automatically convert miter joins to bevel joins for sharp angles.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 2. Set this property to nil to reset +it to the default value.

    + +

    This property is only applied to the style if lineJoin is set to an +MGLStyleValue object containing an NSValue object containing +MGLLineJoinMiter. Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *lineMiterLimit;
    + +
    +
    +

    Swift

    + 
    var lineMiterLimit: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + lineRoundLimit + +
    +
    +
    +
    +

    Used to automatically convert round joins to miter joins for shallow angles.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 1.05. Set this property to nil to +reset it to the default value.

    + +

    This property is only applied to the style if lineJoin is set to an +MGLStyleValue object containing an NSValue object containing +MGLLineJoinRound. Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *lineRoundLimit;
    + +
    +
    +

    Swift

    + 
    var lineRoundLimit: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Accessing the Paint Attributes

+ +
+
    +
  • +
    + + + + lineBlur + +
    +
    +
    +
    +

    Blur applied to the line, in points.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 0. Set this property to nil to reset +it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *lineBlur;
    + +
    +
    +

    Swift

    + 
    var lineBlur: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + lineColor + +
    +
    +
    +
    +

    The color with which the line will be drawn.

    + +

    The default value of this property is an MGLStyleValue object containing +NSColor.blackColor. Set this property to nil to reset it to the default +value.

    + +

    This property is only applied to the style if linePattern is set to nil. +Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSColor *> *lineColor;
    + +
    +
    +

    Swift

    + 
    var lineColor: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + lineDashPattern + +
    +
    +
    +
    +

    Specifies the lengths of the alternating dashes and gaps that form the dash +pattern. The lengths are later scaled by the line width. To convert a dash +length to points, multiply the length by the current line width.

    + +

    This property is measured in line widths.

    + +

    This property is only applied to the style if linePattern is set to nil. +Otherwise, it is ignored.

    + +

    This attribute corresponds to the line-dasharray +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSArray<NSNumber *> *> *lineDashPattern;
    + +
    +
    +

    Swift

    + 
    var lineDashPattern: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + lineGapWidth + +
    +
    +
    +
    +

    Draws a line casing outside of a line’s actual path. Value indicates the width +of the inner gap.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 0. Set this property to nil to reset +it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *lineGapWidth;
    + +
    +
    +

    Swift

    + 
    var lineGapWidth: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + lineOffset + +
    +
    +
    +
    +

    The line’s offset. For linear features, a positive value offsets the line to +the right, relative to the direction of the line, and a negative value to the +left. For polygon features, a positive value results in an inset, and a +negative value results in an outset.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 0. Set this property to nil to reset +it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *lineOffset;
    + +
    +
    +

    Swift

    + 
    var lineOffset: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + lineOpacity + +
    +
    +
    +
    +

    The opacity at which the line will be drawn.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 1. Set this property to nil to reset +it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *lineOpacity;
    + +
    +
    +

    Swift

    + 
    var lineOpacity: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + linePattern + +
    +
    +
    +
    +

    Name of image in style images to use for drawing image lines. For seamless +patterns, image width must be a factor of two (2, 4, 8, …, 512).

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSString *> *linePattern;
    + +
    +
    +

    Swift

    + 
    var linePattern: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + lineTranslation + +
    +
    +
    +
    +

    The geometry’s offset.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing a CGVector struct set to 0 points rightward and 0 +points upward. Set this property to nil to reset it to the default value.

    + +

    This attribute corresponds to the line-translate +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *lineTranslation;
    + +
    +
    +

    Swift

    + 
    var lineTranslation: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + lineTranslationAnchor + +
    +
    +
    +
    +

    Controls the translation reference point.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing MGLLineTranslationAnchorMap. Set this property to +nil to reset it to the default value.

    + +

    This property is only applied to the style if lineTranslation is non-nil. +Otherwise, it is ignored.

    + +

    This attribute corresponds to the line-translate-anchor +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *lineTranslationAnchor;
    + +
    +
    +

    Swift

    + 
    var lineTranslationAnchor: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + lineWidth + +
    +
    +
    +
    +

    Stroke thickness.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 1. Set this property to nil to reset +it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *lineWidth;
    + +
    +
    +

    Swift

    + 
    var lineWidth: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLMapCamera.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLMapCamera.html new file mode 100644 index 0000000000..13bef73542 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLMapCamera.html @@ -0,0 +1,920 @@ + + + + MGLMapCamera Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLMapCamera Class Reference +
+
+ +
+ +
+ +
+
+

MGLMapCamera

 +
+
+ 
@interface MGLMapCamera : NSObject <NSSecureCoding, NSCopying>
+ +
+
+

An MGLMapCamera object represents a viewpoint from which the user observes +some point on an MGLMapView.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + centerCoordinate + +
    +
    +
    +
    +

    Coordinate at the center of the map view.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) CLLocationCoordinate2D centerCoordinate;
    + +
    +
    +

    Swift

    + 
    var centerCoordinate: CLLocationCoordinate2D { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + heading + +
    +
    +
    +
    +

    Heading measured in degrees clockwise from true north.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) CLLocationDirection heading;
    + +
    +
    +

    Swift

    + 
    var heading: CLLocationDirection { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + pitch + +
    +
    +
    +
    +

    Pitch toward the horizon measured in degrees, with 0 degrees resulting in a +two-dimensional map.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) CGFloat pitch;
    + +
    +
    +

    Swift

    + 
    var pitch: CGFloat { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + altitude + +
    +
    +
    +
    +

    Meters above ground level.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) CLLocationDistance altitude;
    + +
    +
    +

    Swift

    + 
    var altitude: CLLocationDistance { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + +camera + +
    +
    +
    +
    +

    Returns a new camera with all properties set to 0.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)camera;
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns a new camera using based on information about the camera’s viewpoint +and focus point.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)
+cameraLookingAtCenterCoordinate:(CLLocationCoordinate2D)centerCoordinate
+              fromEyeCoordinate:(CLLocationCoordinate2D)eyeCoordinate
+                    eyeAltitude:(CLLocationDistance)eyeAltitude;
    + +
    +
    +

    Swift

    + 
    convenience init(lookingAtCenter centerCoordinate: CLLocationCoordinate2D, fromEyeCoordinate eyeCoordinate: CLLocationCoordinate2D, eyeAltitude: CLLocationDistance)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + centerCoordinate + + +
    +

    The geographic coordinate on which the map should be + centered.

    + +
    +
    + + eyeCoordinate + + +
    +

    The geometric coordinate at which the camera should be + situated.

    + +
    +
    + + eyeAltitude + + +
    +

    The altitude (measured in meters) above the map at which the + camera should be situated. The altitude may be less than the distance from + the camera’s viewpoint to the camera’s focus point.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns a new camera with the given distance, pitch, and heading.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)
+cameraLookingAtCenterCoordinate:(CLLocationCoordinate2D)centerCoordinate
+                   fromDistance:(CLLocationDistance)distance
+                          pitch:(CGFloat)pitch
+                        heading:(CLLocationDirection)heading;
    + +
    +
    +

    Swift

    + 
    convenience init(lookingAtCenter centerCoordinate: CLLocationCoordinate2D, fromDistance distance: CLLocationDistance, pitch: CGFloat, heading: CLLocationDirection)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + centerCoordinate + + +
    +

    The geographic coordinate on which the map should be + centered.

    + +
    +
    + + distance + + +
    +

    The straight-line distance from the viewpoint to the + centerCoordinate.

    + +
    +
    + + pitch + + +
    +

    The viewing angle of the camera, measured in degrees. A value of + 0 results in a camera pointed straight down at the map. Angles greater + than 0 result in a camera angled toward the horizon.

    + +
    +
    + + heading + + +
    +

    The camera’s heading, measured in degrees clockwise from true + north. A value of 0 means that the top edge of the map view corresponds to + true north. The value 90 means the top of the map is pointing due east. + The value 180 means the top of the map points due south, and so on.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLMapView.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLMapView.html new file mode 100644 index 0000000000..2802ff663b --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLMapView.html @@ -0,0 +1,4792 @@ + + + + MGLMapView Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLMapView Class Reference +
+
+ +
+ +
+ +
+
+

MGLMapView

 +
+
+ 
@interface MGLMapView : NSView
+ +
+
+

An interactive, customizable map view with an interface similar to the one +provided by Apple’s MapKit.

+ +

Using MGLMapView, you can embed the map inside a view, allow users to +manipulate it with standard gestures, animate the map between different +viewpoints, and present information in the form of annotations and overlays.

+ +

The map view loads scalable vector tiles that conform to the +Mapbox Vector Tile Specification. +It styles them with a style that conforms to the +Mapbox Style Specification. +Such styles can be designed in +Mapbox Studio and hosted on +mapbox.com.

+ +

A collection of Mapbox-hosted styles is available through the MGLStyle class. +These basic styles use +Mapbox Streets +or Mapbox Satellite data +sources, but you can specify a custom style that makes use of your own data.

+ +

Mapbox-hosted vector tiles and styles require an API access token, which you +can obtain from the +Mapbox account page. +Access tokens associate requests to Mapbox’s vector tile and style APIs with +your Mapbox account. They also deter other developers from using your styles +without your permission.

+ +
+

Note

+ You are responsible for getting permission to use the map data and for +ensuring that your use adheres to the relevant terms of use. + +
+ +
+
+ +
+
+
+
+ + + +

Creating Instances

+ +
+
    +
  • +
    + + + + -initWithFrame: + +
    +
    +
    +
    +

    Initializes and returns a newly allocated map view with the specified frame and +the default style.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithFrame:(NSRect)frame;
    + +
    +
    +

    Swift

    + 
    init(frame: NSRect)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + frame + + +
    +

    The frame for the view, measured in points.

    + +
    +
    +
    +
    +

    Return Value

    +

    An initialized map view.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Initializes and returns a newly allocated map view with the specified frame and +style URL.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithFrame:(NSRect)frame
+                             styleURL:(nullable NSURL *)styleURL;
    + +
    +
    +

    Swift

    + 
    init(frame: NSRect, styleURL: URL?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + frame + + +
    +

    The frame for the view, measured in points.

    + +
    +
    + + styleURL + + +
    +

    URL of the map style to display. The URL may be a full HTTP or + HTTPS URL, a Mapbox URL indicating the style’s map ID + (`mapbox://styles/ +<user

    + +
    +

    / +<style +), or a path to a local file relative to + the application’s resource path. Specifynil` for the default style.

    +
    + +
    +
    +
    +
    +

    Return Value

    +

    An initialized map view.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Accessing the Delegate

+ +
+
    +
  • +
    + + + + delegate + +
    +
    +
    +
    +

    The receiver’s delegate.

    + +

    A map view sends messages to its delegate to notify it of changes to its +contents or the viewpoint. The delegate also provides information about +annotations displayed on the map, such as the styles to apply to individual +annotations.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readwrite, nonatomic, nullable) id<MGLMapViewDelegate> delegate;
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Configuring the Map’s Appearance

+ +
+
    +
  • +
    + + + + style + +
    +
    +
    +
    +

    The style currently displayed in the receiver.

    + +

    Unlike the styleURL property, this property is set to an object that allows +you to manipulate every aspect of the style locally.

    + +

    If the style is loading, this property is set to nil until the style finishes +loading. If the style has failed to load, this property is set to nil. +Because the style loads asynchronously, you should manipulate it in the +-[MGLMapViewDelegate mapView:didFinishLoadingStyle:] or +-[MGLMapViewDelegate mapViewDidFinishLoadingMap:] method. It is not possible +to manipulate the style before it has finished loading.

    + +
    +

    Note

    + The default styles provided by Mapbox contain sources and layers with +identifiers that will change over time. Applications that use APIs that +manipulate a style’s sources and layers must first set the style URL to an +explicitly versioned style using a convenience method like ++[MGLStyle outdoorsStyleURLWithVersion:], MGLMapView’s “Style URL” +inspectable in Interface Builder, or a manually constructed NSURL. + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic, nullable) MGLStyle *style;
    + +
    +
    +

    Swift

    + 
    var style: MGLStyle? { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + styleURL + +
    +
    +
    +
    +

    URL of the style currently displayed in the receiver.

    + +

    The URL may be a full HTTP or HTTPS URL, a Mapbox URL indicating the style’s +map ID (mapbox://styles/<user>/<style>), or a path to a local file relative +to the application’s resource path.

    + +

    If you set this property to nil, the receiver will use the default style and +this property will automatically be set to that style’s URL.

    + +

    If you want to modify the current style without replacing it outright, or if +you want to introspect individual style attributes, use the style property.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable) NSURL *styleURL;
    + +
    +
    +

    Swift

    + 
    var styleURL: URL! { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -reloadStyle: + +
    +
    +
    +
    +

    Reloads the style.

    + +

    You do not normally need to call this method. The map view automatically +responds to changes in network connectivity by reloading the style. You may +need to call this method if you change the access token after a style has +loaded but before loading a style associated with a different Mapbox account.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)reloadStyle:(nonnull id)sender;
    + +
    +
    +

    Swift

    + 
    @IBAction func reloadStyle(_ sender: Any)
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + zoomControls + +
    +
    +
    +
    +

    A control for zooming in and out, positioned in the lower-right corner.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) NSSegmentedControl *_Nonnull zoomControls;
    + +
    +
    +

    Swift

    + 
    var zoomControls: NSSegmentedControl { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + compass + +
    +
    +
    +
    +

    A control indicating the map’s direction and allowing the user to manipulate +the direction, positioned above the zoom controls in the lower-right corner.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) NSSlider *_Nonnull compass;
    + +
    +
    +

    Swift

    + 
    var compass: NSSlider { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + logoView + +
    +
    +
    +
    +

    The Mapbox logo, positioned in the lower-left corner.

    + +
    +

    Note

    + The Mapbox terms of service, which governs the use of Mapbox-hosted +vector tiles and styles, +requires most Mapbox +customers to display the Mapbox logo. If this applies to you, do not hide +this view or change its contents. + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) NSImageView *_Nonnull logoView;
    + +
    +
    +

    Swift

    + 
    var logoView: NSImageView { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + attributionView + +
    +
    +
    +
    +

    A view showing legally required copyright notices, positioned along the bottom +of the map view, to the left of the Mapbox logo.

    + +
    +

    Note

    + The Mapbox terms of service, which governs the use of Mapbox-hosted +vector tiles and styles, +requires these +copyright notices to accompany any map that features Mapbox-designed styles, +OpenStreetMap data, or other Mapbox data such as satellite or terrain data. +If that applies to this map view, do not hide this view or remove any +notices from it. + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) NSView *_Nonnull attributionView;
    + +
    +
    +

    Swift

    + 
    var attributionView: NSView { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Manipulating the Viewpoint

+ +
+
    +
  • +
    + + + + centerCoordinate + +
    +
    +
    +
    +

    The geographic coordinate at the center of the map view.

    + +

    Changing the value of this property centers the map on the new coordinate +without changing the current zoom level.

    + +

    Changing the value of this property updates the map view immediately. If you +want to animate the change, use the -setCenterCoordinate:animated: method +instead.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) CLLocationCoordinate2D centerCoordinate;
    + +
    +
    +

    Swift

    + 
    var centerCoordinate: CLLocationCoordinate2D { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Changes the center coordinate of the map and optionally animates the change.

    + +

    Changing the center coordinate centers the map on the new coordinate without +changing the current zoom level.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)setCenterCoordinate:(CLLocationCoordinate2D)coordinate
+                   animated:(BOOL)animated;
    + +
    +
    +

    Swift

    + 
    func setCenter(_ coordinate: CLLocationCoordinate2D, animated: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + coordinate + + +
    +

    The new center coordinate for the map.

    + +
    +
    + + animated + + +
    +

    Specify YES if you want the map view to scroll to the new + location or NO if you want the map to display the new location + immediately.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + zoomLevel + +
    +
    +
    +
    +

    The zoom level of the receiver.

    + +

    In addition to affecting the visual size and detail of features on the map, the +zoom level affects the size of the vector tiles that are loaded. At zoom level +0, each tile covers the entire world map; at zoom level 1, it covers ¼ of the +world; at zoom level 2, 1⁄16 of the world, and so on.

    + +

    Changing the value of this property updates the map view immediately. If you +want to animate the change, use the -setZoomLevel:animated: method instead.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) double zoomLevel;
    + +
    +
    +

    Swift

    + 
    var zoomLevel: Double { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + minimumZoomLevel + +
    +
    +
    +
    +

    The minimum zoom level at which the map can be shown.

    + +

    Depending on the map view’s aspect ratio, the map view may be prevented from +reaching the minimum zoom level, in order to keep the map from repeating within +the current viewport.

    + +

    If the value of this property is greater than that of the maximumZoomLevel +property, the behavior is undefined.

    + +

    The default value of this property is 0.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) double minimumZoomLevel;
    + +
    +
    +

    Swift

    + 
    var minimumZoomLevel: Double { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + maximumZoomLevel + +
    +
    +
    +
    +

    The maximum zoom level the map can be shown at.

    + +

    If the value of this property is smaller than that of the minimumZoomLevel +property, the behavior is undefined.

    + +

    The default value of this property is 20.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) double maximumZoomLevel;
    + +
    +
    +

    Swift

    + 
    var maximumZoomLevel: Double { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Changes the zoom level of the map and optionally animates the change.

    + +

    Changing the zoom level scales the map without changing the current center +coordinate.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)setZoomLevel:(double)zoomLevel animated:(BOOL)animated;
    + +
    +
    +

    Swift

    + 
    func setZoomLevel(_ zoomLevel: Double, animated: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + zoomLevel + + +
    +

    The new zoom level for the map.

    + +
    +
    + + animated + + +
    +

    Specify YES if you want the map view to animate the change + to the new zoom level or NO if you want the map to display the new zoom + level immediately.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + direction + +
    +
    +
    +
    +

    The heading of the map, measured in degrees clockwise from true north.

    + +

    The value 0 means that the top edge of the map view corresponds to true +north. The value 90 means the top of the map is pointing due east. The value +180 means the top of the map points due south, and so on.

    + +

    Changing the value of this property updates the map view immediately. If you +want to animate the change, use the -setDirection:animated: method instead.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) CLLocationDirection direction;
    + +
    +
    +

    Swift

    + 
    var direction: CLLocationDirection { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Changes the heading of the map and optionally animates the change.

    + +

    Changing the heading rotates the map without changing the current center +coordinate or zoom level.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)setDirection:(CLLocationDirection)direction animated:(BOOL)animated;
    + +
    +
    +

    Swift

    + 
    func setDirection(_ direction: CLLocationDirection, animated: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + direction + + +
    +

    The heading of the map, measured in degrees clockwise from + true north.

    + +
    +
    + + animated + + +
    +

    Specify YES if you want the map view to animate the change + to the new heading or NO if you want the map to display the new heading + immediately.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + camera + +
    +
    +
    +
    +

    A camera representing the current viewpoint of the map.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readwrite, copy, nonatomic) MGLMapCamera *_Nonnull camera;
    + +
    +
    +

    Swift

    + 
    @NSCopying var camera: MGLMapCamera { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -setCamera:animated: + +
    +
    +
    +
    +

    Moves the viewpoint to a different location with respect to the map with an +optional transition animation.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)setCamera:(nonnull MGLMapCamera *)camera animated:(BOOL)animated;
    + +
    +
    +

    Swift

    + 
    func setCamera(_ camera: MGLMapCamera, animated: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + camera + + +
    +

    The new viewpoint.

    + +
    +
    + + animated + + +
    +

    Specify YES if you want the map view to animate the change to + the new viewpoint or NO if you want the map to display the new viewpoint + immediately.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Moves the viewpoint to a different location with respect to the map with an +optional transition duration and timing function.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)setCamera:(nonnull MGLMapCamera *)camera
+               withDuration:(NSTimeInterval)duration
+    animationTimingFunction:(nullable CAMediaTimingFunction *)function
+          completionHandler:(nullable void (^)(void))completion;
    + +
    +
    +

    Swift

    + 
    func setCamera(_ camera: MGLMapCamera, withDuration duration: TimeInterval, animationTimingFunction function: CAMediaTimingFunction?, completionHandler completion: (() -> Void)? = nil)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + camera + + +
    +

    The new viewpoint.

    + +
    +
    + + duration + + +
    +

    The amount of time, measured in seconds, that the transition + animation should take. Specify 0 to jump to the new viewpoint + instantaneously.

    + +
    +
    + + function + + +
    +

    A timing function used for the animation. Set this parameter to + nil for a transition that matches most system animations. If the duration + is 0, this parameter is ignored.

    + +
    +
    + + completion + + +
    +

    The block to execute after the animation finishes.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Moves the viewpoint to a different location using a transition animation that +evokes powered flight and a default duration based on the length of the flight +path.

    + +

    The transition animation seamlessly incorporates zooming and panning to help +the user find his or her bearings even after traversing a great distance.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)flyToCamera:(nonnull MGLMapCamera *)camera
+    completionHandler:(nullable void (^)(void))completion;
    + +
    +
    +

    Swift

    + 
    func fly(to camera: MGLMapCamera, completionHandler completion: (() -> Void)? = nil)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + camera + + +
    +

    The new viewpoint.

    + +
    +
    + + completion + + +
    +

    The block to execute after the animation finishes.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Moves the viewpoint to a different location using a transition animation that +evokes powered flight and an optional transition duration.

    + +

    The transition animation seamlessly incorporates zooming and panning to help +the user find his or her bearings even after traversing a great distance.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)flyToCamera:(nonnull MGLMapCamera *)camera
+         withDuration:(NSTimeInterval)duration
+    completionHandler:(nullable void (^)(void))completion;
    + +
    +
    +

    Swift

    + 
    func fly(to camera: MGLMapCamera, withDuration duration: TimeInterval, completionHandler completion: (() -> Void)? = nil)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + camera + + +
    +

    The new viewpoint.

    + +
    +
    + + duration + + +
    +

    The amount of time, measured in seconds, that the transition + animation should take. Specify 0 to jump to the new viewpoint + instantaneously. Specify a negative value to use the default duration, which + is based on the length of the flight path.

    + +
    +
    + + completion + + +
    +

    The block to execute after the animation finishes.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Moves the viewpoint to a different location using a transition animation that +evokes powered flight and an optional transition duration and peak altitude.

    + +

    The transition animation seamlessly incorporates zooming and panning to help +the user find his or her bearings even after traversing a great distance.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)flyToCamera:(nonnull MGLMapCamera *)camera
+         withDuration:(NSTimeInterval)duration
+         peakAltitude:(CLLocationDistance)peakAltitude
+    completionHandler:(nullable void (^)(void))completion;
    + +
    +
    +

    Swift

    + 
    func fly(to camera: MGLMapCamera, withDuration duration: TimeInterval, peakAltitude: CLLocationDistance, completionHandler completion: (() -> Void)? = nil)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + camera + + +
    +

    The new viewpoint.

    + +
    +
    + + duration + + +
    +

    The amount of time, measured in seconds, that the transition + animation should take. Specify 0 to jump to the new viewpoint + instantaneously. Specify a negative value to use the default duration, which + is based on the length of the flight path.

    + +
    +
    + + peakAltitude + + +
    +

    The altitude, measured in meters, at the midpoint of the + animation. The value of this parameter is ignored if it is negative or if + the animation transition resulting from a similar call to + -setCamera:animated: would have a midpoint at a higher altitude.

    + +
    +
    + + completion + + +
    +

    The block to execute after the animation finishes.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    The geographic coordinate bounds visible in the receiver’s viewport.

    + +

    Changing the value of this property updates the receiver immediately. If you +want to animate the change, use the -setVisibleCoordinateBounds:animated: +method instead.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic)
+    MGLCoordinateBounds visibleCoordinateBounds;
    + +
    +
    +

    Swift

    + 
    var visibleCoordinateBounds: Int32 { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Changes the receiver’s viewport to fit the given coordinate bounds, optionally +animating the change.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)setVisibleCoordinateBounds:(MGLCoordinateBounds)bounds
+                          animated:(BOOL)animated;
    + +
    +
    +

    Swift

    + 
    func setVisibleCoordinateBounds(_ bounds: Any!, animated: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + bounds + + +
    +

    The bounds that the viewport will show in its entirety.

    + +
    +
    + + animated + + +
    +

    Specify YES to animate the change by smoothly scrolling and + zooming or NO to immediately display the given bounds.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Changes the receiver’s viewport to fit the given coordinate bounds and +optionally some additional padding on each side.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)setVisibleCoordinateBounds:(MGLCoordinateBounds)bounds
+                       edgePadding:(NSEdgeInsets)insets
+                          animated:(BOOL)animated;
    + +
    +
    +

    Swift

    + 
    func setVisibleCoordinateBounds(_ bounds: Any!, edgePadding insets: EdgeInsets, animated: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + bounds + + +
    +

    The bounds that the viewport will show in its entirety.

    + +
    +
    + + insets + + +
    +

    The minimum padding (in screen points) that will be visible + around the given coordinate bounds.

    + +
    +
    + + animated + + +
    +

    Specify YES to animate the change by smoothly scrolling and + zooming or NO to immediately display the given bounds.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Sets the visible region so that the map displays the specified annotations.

    + +

    Calling this method updates the value in the visibleCoordinateBounds property +and potentially other properties to reflect the new map region. A small amount +of padding is reserved around the edges of the map view. To specify a different +amount of padding, use the -showAnnotations:edgePadding:animated: method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)showAnnotations:(nonnull NSArray<id<MGLAnnotation>> *)annotations
+               animated:(BOOL)animated;
    + +
    +
    +

    Swift

    + 
    func showAnnotations(_ annotations: Any!, animated: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + annotations + + +
    +

    The annotations that you want to be visible in the map.

    + +
    +
    + + animated + + +
    +

    YES if you want the map region change to be animated, or NO +if you want the map to display the new region immediately without animations.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Sets the visible region so that the map displays the specified annotations with +the specified amount of padding on each side.

    + +

    Calling this method updates the value in the visibleCoordinateBounds property +and potentially other properties to reflect the new map region.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)showAnnotations:(nonnull NSArray<id<MGLAnnotation>> *)annotations
+            edgePadding:(NSEdgeInsets)insets
+               animated:(BOOL)animated;
    + +
    +
    +

    Swift

    + 
    func showAnnotations(_ annotations: Any!, edgePadding insets: EdgeInsets, animated: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + annotations + + +
    +

    The annotations that you want to be visible in the map.

    + +
    +
    + + insets + + +
    +

    The minimum padding (in screen points) around the edges of the +map view to keep clear of annotations.

    + +
    +
    + + animated + + +
    +

    YES if you want the map region change to be animated, or NO +if you want the map to display the new region immediately without animations.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns the camera that best fits the given coordinate bounds.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull MGLMapCamera *)cameraThatFitsCoordinateBounds:
+    (MGLCoordinateBounds)bounds;
    + +
    +
    +

    Swift

    + 
    func cameraThatFitsCoordinateBounds(_ bounds: Any!) -> MGLMapCamera
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + bounds + + +
    +

    The coordinate bounds to fit to the receiver’s viewport.

    + +
    +
    +
    +
    +

    Return Value

    +

    A camera object centered on the same location as the coordinate bounds + with zoom level as high (close to the ground) as possible while still + including the entire coordinate bounds. The camera object uses the current + direction and pitch.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns the camera that best fits the given coordinate bounds, optionally with +some additional padding on each side.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull MGLMapCamera *)cameraThatFitsCoordinateBounds:
+                              (MGLCoordinateBounds)bounds
+                                             edgePadding:(NSEdgeInsets)insets;
    + +
    +
    +

    Swift

    + 
    func cameraThatFitsCoordinateBounds(_ bounds: Any!, edgePadding insets: EdgeInsets) -> MGLMapCamera
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + bounds + + +
    +

    The coordinate bounds to fit to the receiver’s viewport.

    + +
    +
    + + insets + + +
    +

    The minimum padding (in screen points) that would be visible + around the returned camera object if it were set as the receiver’s camera.

    + +
    +
    +
    +
    +

    Return Value

    +

    A camera object centered on the same location as the coordinate bounds + with zoom level as high (close to the ground) as possible while still + including the entire coordinate bounds. The camera object uses the current + direction and pitch.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    A Boolean value indicating whether the receiver automatically adjusts its +content insets.

    + +

    When the value of this property is YES, the map view automatically updates +its contentInsets property to account for any overlapping title bar or +toolbar. To overlap with the title bar or toolbar, the containing window’s +style mask must have NSFullSizeContentViewWindowMask set, and the title bar +must not be transparent.

    + +

    The default value of this property is YES.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) BOOL automaticallyAdjustsContentInsets;
    + +
    +
    +

    Swift

    + 
    var automaticallyAdjustsContentInsets: Bool { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + contentInsets + +
    +
    +
    +
    +

    The distance from the edges of the map view’s frame to the edges of the map +view’s logical viewport.

    + +

    When the value of this property is equal to NSEdgeInsetsZero, viewport +properties such as centerCoordinate assume a viewport that matches the map +view’s frame. Otherwise, those properties are inset, excluding part of the +frame from the viewport. For instance, if the only the top edge is inset, the +map center is effectively shifted downward.

    + +

    When the value of the automaticallyAdjustsContentInsets property is YES, +the value of this property may be overridden at any time.

    + +

    Changing the value of this property updates the map view immediately. If you +want to animate the change, use the -setContentInsets:animated: method +instead.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) NSEdgeInsets contentInsets;
    + +
    +
    +

    Swift

    + 
    var contentInsets: EdgeInsets { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Sets the distance from the edges of the map view’s frame to the edges of the +map view’s logical viewport, with an optional transition animation.

    + +

    When the value of this property is equal to NSEdgeInsetsZero, viewport +properties such as centerCoordinate assume a viewport that matches the map +view’s frame. Otherwise, those properties are inset, excluding part of the +frame from the viewport. For instance, if the only the top edge is inset, the +map center is effectively shifted downward.

    + +

    When the value of the automaticallyAdjustsContentInsets property is YES, +the value of this property may be overridden at any time.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)setContentInsets:(NSEdgeInsets)contentInsets animated:(BOOL)animated;
    + +
    +
    +

    Swift

    + 
    func setContentInsets(_ contentInsets: EdgeInsets, animated: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + contentInsets + + +
    +

    The new values to inset the content by.

    + +
    +
    + + animated + + +
    +

    Specify YES if you want the map view to animate the change to + the content insets or NO if you want the map to inset the content + immediately.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Configuring How the User Interacts with the Map

+ +
+
    +
  • +
    + + + + zoomEnabled + +
    +
    +
    +
    +

    A Boolean value that determines whether the user may zoom the map in and out, +changing the zoom level.

    + +

    When this property is set to YES, the default, the user may zoom the map in +and out by pinching two fingers, by using a scroll wheel on a traditional +mouse, or by dragging the mouse cursor up and down while holding down the Shift +key. When the receiver has focus, the user may also zoom by pressing the up and +down arrow keys while holding down the Option key.

    + +

    This property controls only user interactions with the map. If you set the +value of this property to NO, you may still change the map zoom +programmatically.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (getter=isZoomEnabled, assign, readwrite, nonatomic) BOOL zoomEnabled;
    + +
    +
    +

    Swift

    + 
    var isZoomEnabled: Bool { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + scrollEnabled + +
    +
    +
    +
    +

    A Boolean value that determines whether the user may scroll around the map, +changing the center coordinate.

    + +

    When this property is set to YES, the default, the user may scroll the map by +swiping with two fingers or dragging the mouse cursor. When the receiver has +focus, the user may also scroll around the map by pressing the arrow keys.

    + +

    This property controls only user interactions with the map. If you set the +value of this property to NO, you may still change the map location +programmatically.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (getter=isScrollEnabled, assign, readwrite, nonatomic)
+    BOOL scrollEnabled;
    + +
    +
    +

    Swift

    + 
    var isScrollEnabled: Bool { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + rotateEnabled + +
    +
    +
    +
    +

    A Boolean value that determines whether the user may rotate the map, changing +the direction.

    + +

    When this property is set to YES, the default, the user may rotate the map by +moving two fingers in a circular motion or by dragging the mouse cursor left +and right while holding down the Option key. When the receiver has focus, the +user may also zoom by pressing the left and right arrow keys while holding down +the Option key.

    + +

    This property controls only user interactions with the map. If you set the +value of this property to NO, you may still rotate the map programmatically.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (getter=isRotateEnabled, assign, readwrite, nonatomic)
+    BOOL rotateEnabled;
    + +
    +
    +

    Swift

    + 
    var isRotateEnabled: Bool { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + pitchEnabled + +
    +
    +
    +
    +

    A Boolean value that determines whether the user may tilt of the map, changing +the pitch.

    + +

    When this property is set to YES, the default, the user may rotate the map by +dragging the mouse cursor up and down while holding down the Option key.

    + +

    This property controls only user interactions with the map. If you set the +value of this property to NO, you may still change the pitch of the map +programmatically.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (getter=isPitchEnabled, assign, readwrite, nonatomic)
+    BOOL pitchEnabled;
    + +
    +
    +

    Swift

    + 
    var isPitchEnabled: Bool { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Annotating the Map

+ +
+
    +
  • +
    + + + + annotations + +
    +
    +
    +
    +

    The complete list of annotations associated with the receiver. (read-only)

    + +

    The objects in this array must adopt the MGLAnnotation protocol. If no +annotations are associated with the map view, the value of this property is +nil.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic, nullable)
+    NSArray<id<MGLAnnotation>> *annotations;
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -addAnnotation: + +
    +
    +
    +
    +

    Adds an annotation to the map view.

    + +
    +

    Note

    +

    MGLMultiPolyline, MGLMultiPolygon, and MGLShapeCollection objects +cannot be added to the map view at this time. Nor can MGLMultiPoint +objects that are not instances of MGLPolyline or MGLPolygon. Any +multipoint, multipolyline, multipolygon, or shape collection object that is +specified is silently ignored.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)addAnnotation:(nonnull id<MGLAnnotation>)annotation;
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + annotation + + +
    +

    The annotation object to add to the receiver. This object + must conform to the MGLAnnotation protocol. The map view retains the + annotation object.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -addAnnotations: + +
    +
    +
    +
    +

    Adds an array of annotations to the map view.

    + +
    +

    Note

    +

    MGLMultiPolyline, MGLMultiPolygon, and MGLShapeCollection objects +cannot be added to the map view at this time. Nor can MGLMultiPoint +objects that are not instances of MGLPolyline or MGLPolygon. Any +multipoint, multipolyline, multipolygon, or shape collection objects that +are specified are silently ignored.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)addAnnotations:(nonnull NSArray<id<MGLAnnotation>> *)annotations;
    + +
    +
    +

    Swift

    + 
    func addAnnotations(_ annotations: Any!)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + annotations + + +
    +

    An array of annotation objects. Each object in the array + must conform to the MGLAnnotation protocol. The map view retains each + individual annotation object.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + visibleAnnotations + +
    +
    +
    +
    +

    The complete list of annotations associated with the receiver that are +currently visible.

    + +

    The objects in this array must adopt the MGLAnnotation protocol. If no +annotations are associated with the map view or if no annotations associated +with the map view are currently visible, the value of this property is nil.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic, nullable)
+    NSArray<id<MGLAnnotation>> *visibleAnnotations;
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -removeAnnotation: + +
    +
    +
    +
    +

    Removes an annotation from the map view, deselecting it if it is selected.

    + +

    Removing an annotation object dissociates it from the map view entirely, +preventing it from being displayed on the map. Thus you would typically call +this method only when you want to hide or delete a given annotation.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)removeAnnotation:(nonnull id<MGLAnnotation>)annotation;
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + annotation + + +
    +

    The annotation object to remove. This object must conform to + the MGLAnnotation protocol.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -removeAnnotations: + +
    +
    +
    +
    +

    Removes an array of annotations from the map view, deselecting any selected +annotations in the array.

    + +

    Removing annotation objects dissociates them from the map view entirely, +preventing them from being displayed on the map. Thus you would typically call +this method only when you want to hide or delete the given annotations.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)removeAnnotations:(nonnull NSArray<id<MGLAnnotation>> *)annotations;
    + +
    +
    +

    Swift

    + 
    func removeAnnotations(_ annotations: Any!)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + annotations + + +
    +

    The array of annotation objects to remove. Objects in the + array must conform to the MGLAnnotation protocol.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns a reusable annotation image object associated with its identifier.

    + +

    For performance reasons, you should generally reuse MGLAnnotationImage +objects for identical-looking annotations in your map views. Dequeueing saves +time and memory during performance-critical operations such as scrolling.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nullable MGLAnnotationImage *)dequeueReusableAnnotationImageWithIdentifier:
+    (nonnull NSString *)identifier;
    + +
    +
    +

    Swift

    + 
    func dequeueReusableAnnotationImage(withIdentifier identifier: String) -> MGLAnnotationImage?
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + identifier + + +
    +

    A string identifying the annotation image to be reused. This + string is the same one you specify when initially returning the annotation + image object using the -mapView:imageForAnnotation: method.

    + +
    +
    +
    +
    +

    Return Value

    +

    An annotation image object with the given identifier, or nil if no + such object exists in the reuse queue.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns the list of annotations associated with the receiver that intersect with +the given rectangle.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nullable NSArray<id<MGLAnnotation>> *)visibleAnnotationsInRect:(CGRect)rect;
    + +
    +
    +

    Swift

    + 
    func visibleAnnotations(in rect: CGRect) -> Any!
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + rect + + +
    +

    A rectangle expressed in the map view’s coordinate system.

    + +
    +
    +
    +
    +

    Return Value

    +

    An array of objects that adopt the MGLAnnotation protocol or nil if +no annotations associated with the map view are currently visible in the +rectangle.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Managing Annotation Selections

+ +
+
    +
  • +
    + + + + selectedAnnotations + +
    +
    +
    +
    +

    The currently selected annotations.

    + +

    Assigning a new array to this property selects only the first annotation in the +array.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readwrite, copy, nonatomic)
+    NSArray<id<MGLAnnotation>> *_Nonnull selectedAnnotations;
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -selectAnnotation: + +
    +
    +
    +
    +

    Selects an annotation and displays a callout popover for it.

    + +

    If the given annotation is not visible within the current viewport, this method +has no effect.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)selectAnnotation:(nonnull id<MGLAnnotation>)annotation;
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + annotation + + +
    +

    The annotation object to select.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -deselectAnnotation: + +
    +
    +
    +
    +

    Deselects an annotation and hides its callout popover.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)deselectAnnotation:(nullable id<MGLAnnotation>)annotation;
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + annotation + + +
    +

    The annotation object to deselect.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + calloutViewController + +
    +
    +
    +
    +

    A common view controller for managing a callout popover’s content view.

    + +

    Like any instance of NSPopover, an annotation callout manages its contents +with a view controller. The annotation object is the view controller’s +represented object. This means that you can bind controls in the view +controller’s content view to KVO-compliant properties of the annotation object, +such as title and subtitle.

    + +

    This property defines a common view controller that is used for every +annotation’s callout view. If you set this property to nil, a default view +controller will be used that manages a simple title label and subtitle label. +If you need distinct view controllers for different annotations, the map view’s +delegate should implement -mapView:calloutViewControllerForAnnotation: +instead.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readwrite, strong, nonatomic, null_resettable)
+    NSViewController *calloutViewController;
    + +
    +
    +

    Swift

    + 
    @IBOutlet var calloutViewController: NSViewController! { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Finding Annotations

+ +
+
    +
  • +
    + + + + -annotationAtPoint: + +
    +
    +
    +
    +

    Returns a point annotation located at the given point.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull id<MGLAnnotation>)annotationAtPoint:(NSPoint)point;
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + point + + +
    +

    A point in the view’s coordinate system.

    + +
    +
    +
    +
    +

    Return Value

    +

    A point annotation whose annotation image coincides with the point. If + multiple point annotations coincide with the point, the return value is the + annotation that would be selected if the user clicks at this point.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Overlaying the Map

+ +
+
    +
  • +
    + + + + -addOverlay: + +
    +
    +
    +
    +

    Adds a single overlay to the map.

    + +

    To remove an overlay from a map, use the -removeOverlay: method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)addOverlay:(nonnull id<MGLOverlay>)overlay;
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + overlay + + +
    +

    The overlay object to add. This object must conform to the + MGLOverlay protocol.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -addOverlays: + +
    +
    +
    +
    +

    Adds an array of overlays to the map.

    + +

    To remove multiple overlays from a map, use the -removeOverlays: method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)addOverlays:(nonnull NSArray<id<MGLOverlay>> *)overlays;
    + +
    +
    +

    Swift

    + 
    func addOverlays(_ overlays: Any!)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + overlays + + +
    +

    An array of objects, each of which must conform to the + MGLOverlay protocol.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -removeOverlay: + +
    +
    +
    +
    +

    Removes a single overlay from the map.

    + +

    If the specified overlay is not currently associated with the map view, this +method does nothing.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)removeOverlay:(nonnull id<MGLOverlay>)overlay;
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + overlay + + +
    +

    The overlay object to remove.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -removeOverlays: + +
    +
    +
    +
    +

    Removes an array of overlays from the map.

    + +

    If a given overlay object is not associated with the map view, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)removeOverlays:(nonnull NSArray<id<MGLOverlay>> *)overlays;
    + +
    +
    +

    Swift

    + 
    func removeOverlays(_ overlays: Any!)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + overlays + + +
    +

    An array of objects, each of which conforms to the MGLOverlay + protocol.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Accessing the Underlying Map Data

+ +
+
    +
  • + +
    +
    +
    +

    Returns an array of rendered map features that intersect with a given point.

    + +

    This method may return features from any of the map’s style layers. To restrict +the search to a particular layer or layers, use the +-visibleFeaturesAtPoint:inStyleLayersWithIdentifiers: method. For more +information about searching for map features, see that method’s documentation.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull NSArray<id<MGLFeature>> *)visibleFeaturesAtPoint:(NSPoint)point;
    + +
    +
    +

    Swift

    + 
    func visibleFeatures(_ point: NSPoint) -> Any!
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + point + + +
    +

    A point expressed in the map view’s coordinate system.

    + +
    +
    +
    +
    +

    Return Value

    +

    An array of objects conforming to the MGLFeature protocol that + represent features in the sources used by the current style.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns an array of rendered map features that intersect with a given point, +restricted to the given style layers.

    + +

    Each object in the returned array represents a feature rendered by the +current style and provides access to attributes specified by the relevant +tile sources. +The returned array includes features specified in vector and GeoJSON tile +sources but does not include anything from raster, image, or video sources.

    + +

    Only visible features are returned. For example, suppose the current style uses +the +Mapbox Streets source, +but none of the specified style layers includes features that have the maki +property set to bus. If you pass a point corresponding to the location of a +bus stop into this method, the bus stop feature does not appear in the +resulting array. On the other hand, if the style does include bus stops, an +MGLFeature object representing that bus stop is returned and its +attributes dictionary has the maki key set to bus (along with other +attributes). The dictionary contains only the attributes provided by the +tile source; it does not include computed attribute values or rules about how +the feature is rendered by the current style.

    + +

    The returned array is sorted by z-order, starting with the topmost rendered +feature and ending with the bottommost rendered feature. A feature that is +rendered multiple times due to wrapping across the antimeridian at low zoom +levels is included only once, subject to the caveat that follows.

    + +

    Features come from tiled vector data or GeoJSON data that is converted to tiles +internally, so feature geometries are clipped at tile boundaries and features +may appear duplicated across tiles. For example, suppose the specified point +lies along a road that spans the screen. The resulting array includes those +parts of the road that lie within the map tile that contain the specified +point, even if the road extends into other tiles.

    + +

    To find out the layer names in a particular style, view the style in +Mapbox Studio.

    + +
    +

    Note

    +

    Layer identifiers are not guaranteed to exist across styles or different +versions of the same style. Applications that use this API must first set the +style URL to an explicitly versioned style using a convenience method like ++[MGLStyle outdoorsStyleURLWithVersion:], MGLMapView’s “Style URL” +inspectable in Interface Builder, or a manually constructed NSURL. This +approach also avoids layer identifer name changes that will occur in the default +style’s layers over time.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull NSArray<id<MGLFeature>> *)visibleFeaturesAtPoint:(NSPoint)point
+                               inStyleLayersWithIdentifiers:
+                                   (nullable NSSet<NSString *> *)
+                                       styleLayerIdentifiers;
    + +
    +
    +

    Swift

    + 
    func visibleFeatures(_ point: NSPoint, styleLayerIdentifiers: Any!) -> Any!
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + point + + +
    +

    A point expressed in the map view’s coordinate system.

    + +
    +
    + + styleLayerIdentifiers + + +
    +

    A set of strings that correspond to the names of + layers defined in the current style. Only the features contained in these + layers are included in the returned array.

    + +
    +
    +
    +
    +

    Return Value

    +

    An array of objects conforming to the MGLFeature protocol that + represent features in the sources used by the current style.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns an array of rendered map features that intersect with the given +rectangle.

    + +

    This method may return features from any of the map’s style layers. To restrict +the search to a particular layer or layers, use the +-visibleFeaturesAtPoint:inStyleLayersWithIdentifiers: method. For more +information about searching for map features, see that method’s documentation.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull NSArray<id<MGLFeature>> *)visibleFeaturesInRect:(NSRect)rect;
    + +
    +
    +

    Swift

    + 
    func visibleFeatures(_ rect: NSRect) -> Any!
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + rect + + +
    +

    A rectangle expressed in the map view’s coordinate system.

    + +
    +
    +
    +
    +

    Return Value

    +

    An array of objects conforming to the MGLFeature protocol that + represent features in the sources used by the current style.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns an array of rendered map features that intersect with the given +rectangle, restricted to the given style layers.

    + +

    Each object in the returned array represents a feature rendered by the +current style and provides access to attributes specified by the relevant +tile sources. +The returned array includes features specified in vector and GeoJSON tile +sources but does not include anything from raster, image, or video sources.

    + +

    Only visible features are returned. For example, suppose the current style uses +the +Mapbox Streets source, +but none of the specified style layers includes features that have the maki +property set to bus. If you pass a rectangle containing the location of a bus +stop into this method, the bus stop feature does not appear in the resulting +array. On the other hand, if the style does include bus stops, an MGLFeature +object representing that bus stop is returned and its attributes dictionary +has the maki key set to bus (along with other attributes). The dictionary +contains only the attributes provided by the tile source; it does not include +computed attribute values or rules about how the feature is rendered by the +current style.

    + +

    The returned array is sorted by z-order, starting with the topmost rendered +feature and ending with the bottommost rendered feature. A feature that is +rendered multiple times due to wrapping across the antimeridian at low zoom +levels is included only once, subject to the caveat that follows.

    + +

    Features come from tiled vector data or GeoJSON data that is converted to tiles +internally, so feature geometries are clipped at tile boundaries and features +may appear duplicated across tiles. For example, suppose the specified +rectangle intersects with a road that spans the screen. The resulting array +includes those parts of the road that lie within the map tiles covering the +specified rectangle, even if the road extends into other tiles. The portion of +the road within each map tile is included individually.

    + +

    To find out the layer names in a particular style, view the style in +Mapbox Studio.

    + +
    +

    Note

    +

    Layer identifiers are not guaranteed to exist across styles or different +versions of the same style. Applications that use this API must first set the +style URL to an explicitly versioned style using a convenience method like ++[MGLStyle outdoorsStyleURLWithVersion:], MGLMapView’s “Style URL” +inspectable in Interface Builder, or a manually constructed NSURL. This +approach also avoids layer identifer name changes that will occur in the default +style’s layers over time.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull NSArray<id<MGLFeature>> *)visibleFeaturesInRect:(NSRect)rect
+                              inStyleLayersWithIdentifiers:
+                                  (nullable NSSet<NSString *> *)
+                                      styleLayerIdentifiers;
    + +
    +
    +

    Swift

    + 
    func visibleFeatures(_ rect: NSRect, styleLayerIdentifiers: Any!) -> Any!
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + rect + + +
    +

    A rectangle expressed in the map view’s coordinate system.

    + +
    +
    + + styleLayerIdentifiers + + +
    +

    A set of strings that correspond to the names of + layers defined in the current style. Only the features contained in these + layers are included in the returned array.

    + +
    +
    +
    +
    +

    Return Value

    +

    An array of objects conforming to the MGLFeature protocol that + represent features in the sources used by the current style.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Converting Geographic Coordinates

+ +
+
    +
  • + +
    +
    +
    +

    Converts a geographic coordinate to a point in the given view’s coordinate +system.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (NSPoint)convertCoordinate:(CLLocationCoordinate2D)coordinate
+               toPointToView:(nullable NSView *)view;
    + +
    +
    +

    Swift

    + 
    func convert(_ coordinate: CLLocationCoordinate2D, toPointTo view: NSView?) -> NSPoint
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + coordinate + + +
    +

    The geographic coordinate to convert.

    + +
    +
    + + view + + +
    +

    The view in whose coordinate system the returned point should be + expressed. If this parameter is nil, the returned point is expressed in + the window’s coordinate system. If view is not nil, it must belong to + the same window as the map view.

    + +
    +
    +
    +
    +

    Return Value

    +

    The point (in the appropriate view or window coordinate system) + corresponding to the given geographic coordinate.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Converts a point in the given view’s coordinate system to a geographic +coordinate.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (CLLocationCoordinate2D)convertPoint:(NSPoint)point
+                  toCoordinateFromView:(nullable NSView *)view;
    + +
    +
    +

    Swift

    + 
    func convert(_ point: NSPoint, toCoordinateFrom view: NSView?) -> CLLocationCoordinate2D
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + point + + +
    +

    The point to convert.

    + +
    +
    + + view + + +
    +

    The view in whose coordinate system the point is expressed.

    + +
    +
    +
    +
    +

    Return Value

    +

    The geographic coordinate at the given point.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Converts a geographic bounding box to a rectangle in the given view’s +coordinate system.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (NSRect)convertCoordinateBounds:(MGLCoordinateBounds)bounds
+                     toRectToView:(nullable NSView *)view;
    + +
    +
    +

    Swift

    + 
    func convertCoordinateBounds(_ bounds: Any!, toRectTo view: NSView?) -> NSRect
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + bounds + + +
    +

    The geographic bounding box to convert.

    + +
    +
    + + view + + +
    +

    The view in whose coordinate system the returned rectangle should + be expressed. If this parameter is nil, the returned rectangle is + expressed in the window’s coordinate system. If view is not nil, it must + belong to the same window as the map view.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Converts a rectangle in the given view’s coordinate system to a geographic +bounding box.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (MGLCoordinateBounds)convertRect:(NSRect)rect
+        toCoordinateBoundsFromView:(nullable NSView *)view;
    + +
    +
    +

    Swift

    + 
    func convert(_ rect: NSRect, toCoordinateBoundsFrom view: NSView?) -> Any!
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + rect + + +
    +

    The rectangle to convert.

    + +
    +
    + + view + + +
    +

    The view in whose coordinate system the rectangle is expressed.

    + +
    +
    +
    +
    +

    Return Value

    +

    The geographic bounding box coextensive with the given rectangle.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns the distance spanned by one point in the map view’s coordinate system +at the given latitude and current zoom level.

    + +

    The distance between points decreases as the latitude approaches the poles. +This relationship parallels the relationship between longitudinal coordinates +at different latitudes.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (CLLocationDistance)metersPerPointAtLatitude:(CLLocationDegrees)latitude;
    + +
    +
    +

    Swift

    + 
    func metersPerPoint(atLatitude latitude: CLLocationDegrees) -> CLLocationDistance
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + latitude + + +
    +

    The latitude of the geographic coordinate represented by the + point.

    + +
    +
    +
    +
    +

    Return Value

    +

    The distance in meters spanned by a single point.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Giving Feedback to Improve the Map

+ +
+
    +
  • +
    + + + + -giveFeedback: + +
    +
    +
    +
    +

    Opens one or more webpages in the default Web browser in which the user can +provide feedback about the map data.

    + +

    You should add a menu item to the Help menu of your application that invokes +this method. Title it “Improve This Map” or similar. Set its target to the +first responder and its action to giveFeedback:.

    + +

    This map view searches the current style’s sources for webpages to open. +Specifically, each source’s tile set has an attribution property containing +HTML code; if an <a> tag (link) within that code has an +class attribute set to mapbox-improve-map, its +href attribute defines the URL to open. Such links are omitted +from the attribution view.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)giveFeedback:(nonnull id)sender;
    + +
    +
    +

    Swift

    + 
    @IBAction func giveFeedback(_ sender: Any)
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Debugging the Map

+ +
+
    +
  • +
    + + + + debugMask + +
    +
    +
    +
    +

    The options that determine which debugging aids are shown on the map.

    + +

    These options are all disabled by default and should remain disabled in +released software for performance and aesthetic reasons.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) MGLMapDebugMaskOptions debugMask;
    + +
    +
    +

    Swift

    + 
    var debugMask: Int32 { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLMultiPoint.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLMultiPoint.html new file mode 100644 index 0000000000..2fdc0ff480 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLMultiPoint.html @@ -0,0 +1,1188 @@ + + + + MGLMultiPoint Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLMultiPoint Class Reference +
+
+ +
+ +
+ +
+
+

MGLMultiPoint

 +
+
+ 
@interface MGLMultiPoint : MGLShape
+ +
+
+

The MGLMultiPoint class is an abstract superclass used to define shapes +composed of multiple vertices.

+ +

You do not create instances of this class directly. Instead, you create +instances of the MGLPolyline or MGLPolygon classes. However, you can use +the method and properties of this class to access information about the +vertices of the line or polygon.

+ +

Do not confuse MGLMultiPoint with MGLPointCollection, which represents a +collection of related but disconnected points.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + coordinates + +
    +
    +
    +
    +

    The array of vertices associated with the shape.

    + +

    This C array is a pointer to a structure inside the multipoint object, which +may have a lifetime shorter than the multipoint object and will certainly not +have a longer lifetime. Therefore, you should copy the C array if it needs to +be stored outside of the memory context in which you use this property.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) CLLocationCoordinate2D *_Nonnull coordinates;
    + +
    +
    +

    Swift

    + 
    var coordinates: UnsafeMutablePointer
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + pointCount + +
    +
    +
    +
    +

    The number of vertices in the shape.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) NSUInteger pointCount;
    + +
    +
    +

    Swift

    + 
    var pointCount: UInt { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Retrieves the vertices of part of the shape.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)getCoordinates:(nonnull CLLocationCoordinate2D *)coords
+                 range:(NSRange)range;
    + +
    +
    +

    Swift

    + 
    func getCoordinates(_ coords: UnsafeMutablePointer
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + coords + + +
    +

    On input, you must provide a C array of CLLocationCoordinate2D + structures large enough to hold the desired number of coordinates. On + output, this structure contains the requested coordinate data.

    + +
    +
    + + range + + +
    +

    The range of vertices you want. The location field indicates + the first vertex you are requesting, with 0 being the first vertex, 1 + being the second vertex, and so on. The length field indicates the number + of vertices you want. The array in coords must be large enough to + accommodate the number of requested coordinates.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Sets the shape’s vertices to the given C array of vertices.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)setCoordinates:(nonnull CLLocationCoordinate2D *)coords
+                 count:(NSUInteger)count;
    + +
    +
    +

    Swift

    + 
    func setCoordinates(_ coords: UnsafeMutablePointer
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + coords + + +
    +

    The array of coordinates defining the shape. The data in this + array is copied to the shape’s coordinates property.

    + +
    +
    + + count + + +
    +

    The number of coordinates from the coords array.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Inserts the given vertices into the shape. If the shape is currently visible on +the map, it is redrawn immediately.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)insertCoordinates:(nonnull const CLLocationCoordinate2D *)coords
+                    count:(NSUInteger)count
+                  atIndex:(NSUInteger)index;
    + +
    +
    +

    Swift

    + 
    func insertCoordinates(_ coords: UnsafePointer
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + coords + + +
    +

    The array of coordinates to insert into the shape. The data in + this array is copied to the shape’s coordinates property.

    + +
    +
    + + count + + +
    +

    The number of items in the coords array.

    + +
    +
    + + index + + +
    +

    The zero-based index at which the first coordinate in coords + will appear in the coordinates property.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Appends the given vertices to the shape. If the shape is currently visible on +the map, it is redrawn immediately.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)appendCoordinates:(nonnull const CLLocationCoordinate2D *)coords
+                    count:(NSUInteger)count;
    + +
    +
    +

    Swift

    + 
    func appendCoordinates(_ coords: UnsafePointer
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + coords + + +
    +

    The array of coordinates to add to the shape. The data in this + array is copied to the shape’s coordinates property.

    + +
    +
    + + count + + +
    +

    The number of items in the coords array.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Replaces the vertices at the given range in the shape with the same number of +vertices from a given C array. If the shape is currently visible on the map, it +is redrawn immediately.

    + +

    The number of coordinates in coords must be equal to the length of range. +If you want to insert or delete one or more vertices, use the +-replaceCoordinatesInRange:withCoordinates:count: method.

    + +

    If range extends beyond the shape’s coordinates property, an +NSRangeException is raised. If you want to append new vertices to the shape, +use the -appendCoordinates:count: method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)replaceCoordinatesInRange:(NSRange)range
+                  withCoordinates:
+                      (nonnull const CLLocationCoordinate2D *)coords;
    + +
    +
    +

    Swift

    + 
    func replaceCoordinates(in range: NSRange, withCoordinates coords: UnsafePointer
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + range + + +
    +

    The range of vertices to replace. The location field indicates + the first vertex you are replacing, with 0 being the first vertex, 1 + being the second vertex, and so on. The length field indicates the number + of vertices to replace.

    + +
    +
    + + coords + + +
    +

    The array of coordinates defining part of the shape. The data in + this array is copied to the shape’s coordinates property.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Replaces the vertices at the given range in the shape with the specified number +of vertices from a given C array. If the shape is currently visible on the map, +it is redrawn immediately.

    + +

    If count is greater than the length field of range, some vertices will +effectively be inserted into the shape. On the other hand, if count is less +than the length field of range, some vertices will effectively be removed.

    + +

    If range extends beyond the shape’s coordinates property, an +NSRangeException is raised. If you want to append new vertices to the shape, +use the -appendCoordinates:count: method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)replaceCoordinatesInRange:(NSRange)range
+                  withCoordinates:(nonnull const CLLocationCoordinate2D *)coords
+                            count:(NSUInteger)count;
    + +
    +
    +

    Swift

    + 
    func replaceCoordinates(in range: NSRange, withCoordinates coords: UnsafePointer
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + range + + +
    +

    The range of vertices to replace. The location field indicates + the first vertex you are replacing, with 0 being the first vertex, 1 + being the second vertex, and so on. The length field indicates the number + of vertices to replace.

    + +
    +
    + + coords + + +
    +

    The array of coordinates defining part of the shape. The data in + this array is copied to the shape’s coordinates property.

    + +
    +
    + + count + + +
    +

    The number of coordinates from the coords array to insert in + place of the coordinates in range. The sum of range’s length and this + count must not exceed the number of items currently in the coordinates + property.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Removes the vertices at the given range from the shape. If the shape is +currently visible on the map, it is redrawn immediately.

    + +

    If range extends beyond the shape’s coordinates property, an +NSRangeException is raised.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)removeCoordinatesInRange:(NSRange)range;
    + +
    +
    +

    Swift

    + 
    func removeCoordinates(in range: NSRange)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + range + + +
    +

    The range of vertices to remove. The location field indicates + the first vertex you are removing, with 0 being the first vertex, 1 + being the second vertex, and so on. The length field indicates the number + of vertices to remove.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLMultiPolygon.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLMultiPolygon.html new file mode 100644 index 0000000000..7614414caa --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLMultiPolygon.html @@ -0,0 +1,659 @@ + + + + MGLMultiPolygon Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLMultiPolygon Class Reference +
+
+ +
+ +
+ +
+
+

MGLMultiPolygon

 +
+
+ 
@interface MGLMultiPolygon : MGLShape <MGLOverlay>
+ +
+
+

An MGLMultiPolygon object represents a shape consisting of one or more +polygons that do not overlap. For example, you could use a multipolygon shape +to represent the body of land that consists of an island surrounded by an +atoll: the inner island would be one MGLPolygon object, while the surrounding +atoll would be another. You could also use a multipolygon shape to represent a +group of disconnected but related buildings.

+ +

You can add multipolygon shapes to the map by adding them to an +MGLShapeSource object. Configure the appearance of an MGLShapeSource’s or +MGLVectorSource’s multipolygons collectively using an MGLFillStyleLayer or +MGLSymbolStyleLayer object.

+ +

You cannot add an MGLMultiPolygon object directly to a map view using +-[MGLMapView addAnnotation:] or -[MGLMapView addOverlay:]. However, you can +add the polygons array’s items as overlays individually.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + polygons + +
    +
    +
    +
    +

    An array of polygons forming the multipolygon.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, copy, nonatomic) NSArray<MGLPolygon *> *_Nonnull polygons;
    + +
    +
    +

    Swift

    + 
    var polygons: [MGLPolygon] { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Creates and returns a multipolygon object consisting of the given polygons.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)multiPolygonWithPolygons:
+    (nonnull NSArray<MGLPolygon *> *)polygons;
    + +
    +
    +

    Swift

    + 
    convenience init(polygons: [MGLPolygon])
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + polygons + + +
    +

    The array of polygons defining the shape.

    + +
    +
    +
    +
    +

    Return Value

    +

    A new multipolygon object.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLMultiPolyline.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLMultiPolyline.html new file mode 100644 index 0000000000..5cef0e12c7 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLMultiPolyline.html @@ -0,0 +1,661 @@ + + + + MGLMultiPolyline Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLMultiPolyline Class Reference +
+
+ +
+ +
+ +
+
+

MGLMultiPolyline

 +
+
+ 
@interface MGLMultiPolyline : MGLShape <MGLOverlay>
+ +
+
+

An MGLMultiPolyline object represents a shape consisting of one or more +polylines. For example, you could use a multipolyline shape to represent both +sides of a divided highway (dual carriageway), excluding the median (central +reservation): each carriageway would be a distinct MGLPolyline object.

+ +

You can add multipolyline shapes to the map by adding them to an +MGLShapeSource object. Configure the appearance of an MGLShapeSource’s or +MGLVectorSource’s multipolylines collectively using an MGLLineStyleLayer or +MGLSymbolStyleLayer object.

+ +

You cannot add an MGLMultiPolyline object directly to a map view using +-[MGLMapView addAnnotation:] or -[MGLMapView addOverlay:]. However, you can +add the polylines array’s items as overlays individually.

+ +

A multipolyline is known as a +MultiLineString +geometry in GeoJSON.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + polylines + +
    +
    +
    +
    +

    An array of polygons forming the multipolyline.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, copy, nonatomic) NSArray<MGLPolyline *> *_Nonnull polylines;
    + +
    +
    +

    Swift

    + 
    var polylines: [MGLPolyline] { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Creates and returns a multipolyline object consisting of the given polylines.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)multiPolylineWithPolylines:
+    (nonnull NSArray<MGLPolyline *> *)polylines;
    + +
    +
    +

    Swift

    + 
    convenience init(polylines: [MGLPolyline])
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + polylines + + +
    +

    The array of polylines defining the shape.

    + +
    +
    +
    +
    +

    Return Value

    +

    A new multipolyline object.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLOfflinePack.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLOfflinePack.html new file mode 100644 index 0000000000..3741cf8872 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLOfflinePack.html @@ -0,0 +1,846 @@ + + + + MGLOfflinePack Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLOfflinePack Class Reference +
+
+ +
+ +
+ +
+
+

MGLOfflinePack

 +
+
+ 
@interface MGLOfflinePack : NSObject
+ +
+
+

An MGLOfflinePack represents a collection of resources necessary for viewing +a region offline to a local database.

+ +

To create an instance of MGLOfflinePack, use the ++[MGLOfflineStorage addPackForRegion:withContext:completionHandler:] method. +A pack created using -[MGLOfflinePack init] is immediately invalid.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + region + +
    +
    +
    +
    +

    The region for which the pack manages resources.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) id<MGLOfflineRegion> _Nonnull region;
    + +
    +
    +

    Swift

    + 
    var region: MGLOfflineRegion { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + context + +
    +
    +
    +
    +

    Arbitrary data stored alongside the downloaded resources.

    + +

    The context typically holds application-specific information for identifying +the pack, such as a user-selected name.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) NSData *_Nonnull context;
    + +
    +
    +

    Swift

    + 
    var context: Data { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + state + +
    +
    +
    +
    +

    The pack’s current state.

    + +

    The state of an inactive or completed pack is computed lazily and is set to +MGLOfflinePackStateUnknown by default. To request the pack’s status, use the +-requestProgress method. To get notified when the state becomes known and +when it changes, observe KVO change notifications on this pack’s state key +path. Alternatively, you can add an observer for +MGLOfflinePackProgressChangedNotifications about this pack that come from the +default notification center.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) MGLOfflinePackState state;
    + +
    +
    +

    Swift

    + 
    var state: MGLOfflinePackState { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + progress + +
    +
    +
    +
    +

    The pack’s current progress.

    + +

    The progress of an inactive or completed pack is computed lazily, and all its +fields are set to 0 by default. To request the pack’s progress, use the +-requestProgress method. To get notified when the progress becomes +known and when it changes, observe KVO change notifications on this pack’s +state key path. Alternatively, you can add an observer for +MGLOfflinePackProgressChangedNotifications about this pack that come from the +default notification center.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) MGLOfflinePackProgress progress;
    + +
    +
    +

    Swift

    + 
    var progress: MGLOfflinePackProgress { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -resume + +
    +
    +
    +
    +

    Resumes downloading if the pack is inactive.

    + +

    When a pack resumes after being suspended, it may begin by iterating over the +already downloaded resources. As a result, the progress structure’s +countOfResourcesCompleted field may revert to 0 before rapidly returning to +the level of progress at the time the pack was suspended.

    + +

    To temporarily suspend downloading, call the -suspend method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)resume;
    + +
    +
    +

    Swift

    + 
    func resume()
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -suspend + +
    +
    +
    +
    +

    Temporarily stops downloading if the pack is active.

    + +

    A pack suspends asynchronously, so some network requests may be sent after this +method is called. Regardless, the progress property will not be updated until +-resume is called.

    + +

    If the pack previously reached a higher level of progress before being +suspended, it may wait to suspend until it returns to that level.

    + +

    To resume downloading, call the -resume method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)suspend;
    + +
    +
    +

    Swift

    + 
    func suspend()
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -requestProgress + +
    +
    +
    +
    +

    Request an asynchronous update to the pack’s state and progress properties.

    + +

    The state and progress of an inactive or completed pack are computed lazily. If +you need the state or progress of a pack whose state property is currently +set to MGLOfflinePackStateUnknown, observe KVO change notifications on this +pack’s state key path, then call this method. Alternatively, you can add an +observer for MGLOfflinePackProgressChangedNotification about this pack that +come from the default notification center.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)requestProgress;
    + +
    +
    +

    Swift

    + 
    func requestProgress()
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLOfflineStorage.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLOfflineStorage.html new file mode 100644 index 0000000000..f0bce63c4d --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLOfflineStorage.html @@ -0,0 +1,952 @@ + + + + MGLOfflineStorage Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLOfflineStorage Class Reference +
+
+ +
+ +
+ +
+
+

MGLOfflineStorage

 +
+
+ 
@interface MGLOfflineStorage : NSObject
+ +
+
+

MGLOfflineStorage implements a singleton (shared object) that manages offline +packs. All of this class’s instance methods are asynchronous, reflecting the +fact that offline resources are stored in a database. The shared object +maintains a canonical collection of offline packs in its packs property.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + +sharedOfflineStorage + +
    +
    +
    +
    +

    Returns the shared offline storage object.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)sharedOfflineStorage;
    + +
    +
    +

    Swift

    + 
    class func shared() -> Self
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + packs + +
    +
    +
    +
    +

    An array of all known offline packs, in the order in which they were created.

    + +

    This property is set to nil, indicating that the receiver does not yet know +the existing packs, for an undefined amount of time starting from the moment +the shared offline storage object is initialized until the packs are fetched +from the database. After that point, this property is always non-nil, but it +may be empty to indicate that no packs are present.

    + +

    To detect when the shared offline storage object has finished loading its +packs property, observe KVO change notifications on the packs key path. +The initial load results in an NSKeyValueChangeSetting change.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, strong, nonatomic, nullable)
+    NSArray<MGLOfflinePack *> *packs;
    + +
    +
    +

    Swift

    + 
    var packs: [MGLOfflinePack]? { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Creates and registers an offline pack that downloads the resources needed to +use the given region offline.

    + +

    The resulting pack is added to the shared offline storage object’s packs +property, then the completion block is executed with that pack passed in.

    + +

    The pack has an initial state of MGLOfflinePackStateInactive. To begin +downloading resources, call -[MGLOfflinePack resume] on the pack from within +the completion handler. To monitor download progress, add an observer for +MGLOfflinePackProgressChangedNotifications about that pack.

    + +

    To detect when any call to this method results in a new pack, observe KVO +change notifications on the shared offline storage object’s packs key path. +Additions to that array result in an NSKeyValueChangeInsertion change.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)addPackForRegion:(nonnull id<MGLOfflineRegion>)region
+             withContext:(nonnull NSData *)context
+       completionHandler:
+           (nullable MGLOfflinePackAdditionCompletionHandler)completion;
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + region + + +
    +

    A region to download.

    + +
    +
    + + context + + +
    +

    Arbitrary data to store alongside the downloaded resources.

    + +
    +
    + + completion + + +
    +

    The completion handler to call once the pack has been added. + This handler is executed asynchronously on the main queue.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Unregisters the given offline pack and allows resources that are no longer +required by any remaining packs to be potentially freed.

    + +

    As soon as this method is called on a pack, the pack becomes invalid; any +attempt to send it a message will result in an exception being thrown. If an +error occurs and the pack cannot be removed, do not attempt to reuse the pack +object. Instead, if you need continued access to the pack, suspend all packs +and use the -reloadPacks method to obtain valid pointers to all the packs.

    + +

    To detect when any call to this method results in a pack being removed, observe +KVO change notifications on the shared offline storage object’s packs key +path. Removals from that array result in an NSKeyValueChangeRemoval change.

    + +

    When you remove an offline pack, any resources that are required by that pack, +but not other packs, become eligible for deletion from offline storage. Because +the backing store used for offline storage is also used as a general purpose +cache for map resources, such resources may not be immediately removed if the +implementation determines that they remain useful for general performance of +the map.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)removePack:(nonnull MGLOfflinePack *)pack
+    withCompletionHandler:
+        (nullable MGLOfflinePackRemovalCompletionHandler)completion;
    + +
    +
    +

    Swift

    + 
    func removePack(_ pack: MGLOfflinePack, withCompletionHandler completion: MGLOfflinePackRemovalCompletionHandler? = nil)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + pack + + +
    +

    The offline pack to remove.

    + +
    +
    + + completion + + +
    +

    The completion handler to call once the pack has been + removed. This handler is executed asynchronously on the main queue.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -reloadPacks + +
    +
    +
    +
    +

    Forcibly, asynchronously reloads the packs property. At some point after this +method is called, the pointer values of the MGLOfflinePack objects in the +packs property change, even if the underlying data for these packs has not +changed. If this method is called while a pack is actively downloading, the +behavior is undefined.

    + +

    You typically do not need to call this method.

    + +

    To detect when the shared offline storage object has finished reloading its +packs property, observe KVO change notifications on the packs key path. +A reload results in an NSKeyValueChangeSetting change.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)reloadPacks;
    + +
    +
    +

    Swift

    + 
    func reloadPacks()
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Sets the maximum number of Mapbox-hosted tiles that may be downloaded and +stored on the current device.

    + +

    Once this limit is reached, an +MGLOfflinePackMaximumMapboxTilesReachedNotification is posted for every +attempt to download additional tiles until already downloaded tiles are removed +by calling the -removePack:withCompletionHandler: method.

    + +
    +

    Note

    + The Mapbox Terms of Service +prohibits changing or bypassing this limit without permission from Mapbox. +Contact your Mapbox sales representative to have the limit raised. + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)setMaximumAllowedMapboxTiles:(uint64_t)maximumCount;
    + +
    +
    +

    Swift

    + 
    func setMaximumAllowedMapboxTiles(_ maximumCount: UInt64)
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + countOfBytesCompleted + +
    +
    +
    +
    +

    The cumulative size, measured in bytes, of all downloaded resources on disk.

    + +

    The returned value includes all resources, including tiles, whether downloaded +as part of an offline pack or due to caching during normal use of MGLMapView.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) unsigned long long countOfBytesCompleted;
    + +
    +
    +

    Swift

    + 
    var countOfBytesCompleted: UInt64 { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLPointAnnotation.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLPointAnnotation.html new file mode 100644 index 0000000000..90bd89a587 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLPointAnnotation.html @@ -0,0 +1,608 @@ + + + + MGLPointAnnotation Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLPointAnnotation Class Reference +
+
+ +
+ +
+ +
+
+

MGLPointAnnotation

 +
+
+ 
@interface MGLPointAnnotation : MGLShape
+ +
+
+

An MGLPointAnnotation object represents a one-dimensional shape located at a +single geographical coordinate. Depending on how it is used, an +MGLPointAnnotation object is known as a point annotation or point shape. For +example, you could use a point shape to represent a city at low zoom levels, an +address at high zoom levels, or the location of a long press gesture.

+ +

You can add point shapes to the map by adding them to an MGLShapeSource +object. Configure the appearance of an MGLShapeSource’s or +MGLVectorSource’s point shapes collectively using an MGLCircleStyleLayer or +MGLSymbolStyleLayer object.

+ +

For more interactivity, add a selectable point annotation to a map view using +the -[MGLMapView addAnnotation:] method. Alternatively, define your own model +class that conforms to the MGLAnnotation protocol. Configure a point +annotation’s appearance using +-[MGLMapViewDelegate mapView:imageForAnnotation:] or +-[MGLMapViewDelegate mapView:viewForAnnotation:] (iOS only). A point +annotation’s MGLShape.title and MGLShape.subtitle properties define the +default content of the annotation’s callout (on iOS) or popover (on macOS).

+ +

To group multiple related points together in one shape, use an +MGLPointCollection or MGLShapeCollection object.

+ +

A point shape is known as a +Point geometry +in GeoJSON.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + coordinate + +
    +
    +
    +
    +

    The coordinate point of the shape, specified as a latitude and longitude.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) CLLocationCoordinate2D coordinate;
    + +
    +
    +

    Swift

    + 
    var coordinate: CLLocationCoordinate2D { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLPointCollection.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLPointCollection.html new file mode 100644 index 0000000000..b0c7c35b87 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLPointCollection.html @@ -0,0 +1,791 @@ + + + + MGLPointCollection Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLPointCollection Class Reference +
+
+ +
+ +
+ +
+
+

MGLPointCollection

 +
+
+ 
@interface MGLPointCollection : MGLShape <MGLOverlay>
+ +
+
+

An MGLPointCollection object represents a shape consisting of one or more +disconnected vertices, specified as CLLocationCoordinate2D instances. The +points in the collection may be related but are not connected spatially. For +example, you could use a point collection to represent all the trees in an +orchard.

+ +

You can add point collections to the map by adding them to an MGLShapeSource +object. Configure the appearance of an MGLShapeSource’s or +MGLVectorSource’s point collections collectively using an +MGLCircleStyleLayer or MGLSymbolStyleLayer object.

+ +

You cannot add an MGLPointCollection object directly to a map view as an +annotation. However, you can create individual MGLPointAnnotation objects +from the coordinates array and add those annotation objects to the map view +using the -[MGLMapView addAnnotations:] method.

+ +

A point collection is known as a +MultiPoint +geometry in GeoJSON. Do not confuse MGLPointCollection with MGLMultiPoint, +the abstract superclass of MGLPolyline and MGLPolygon.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +

    Creates and returns a MGLPointCollection object from the specified set of +coordinates.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (instancetype)pointCollectionWithCoordinates:
+                    (const CLLocationCoordinate2D *)coords
+                                         count:(NSUInteger)count;
    + +
    +
    +

    Swift

    + 
    convenience init!(coordinates coords: UnsafePointer
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + coords + + +
    +

    The array of coordinates defining the shape. The data in this +array is copied to the new object.

    + +
    +
    + + count + + +
    +

    The number of items in the coords array.

    + +
    +
    +
    +
    +

    Return Value

    +

    A new point collection object.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + coordinates + +
    +
    +
    +
    +

    The array of coordinates associated with the shape.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) CLLocationCoordinate2D *coordinates;
    + +
    +
    +

    Swift

    + 
    var coordinates: UnsafeMutablePointer
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + pointCount + +
    +
    +
    +
    +

    The number of coordinates associated with the shape.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) NSUInteger pointCount;
    + +
    +
    +

    Swift

    + 
    var pointCount: UInt { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Retrieves one or more coordinates associated with the shape.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)getCoordinates:(CLLocationCoordinate2D *)coords range:(NSRange)range;
    + +
    +
    +

    Swift

    + 
    func getCoordinates(_ coords: UnsafeMutablePointer
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + coords + + +
    +

    On input, you must provide a C array of structures large enough +to hold the desired number of coordinates. On output, this structure +contains the requested coordinate data.

    + +
    +
    + + range + + +
    +

    The range of points you want. The location field indicates the +first point you are requesting, with 0 being the first point, 1 being +the second point, and so on. The length field indicates the number of +points you want. The array in coords must be large enough to accommodate +the number of requested coordinates.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLPolygon.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLPolygon.html new file mode 100644 index 0000000000..277c19d5da --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLPolygon.html @@ -0,0 +1,794 @@ + + + + MGLPolygon Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLPolygon Class Reference +
+
+ +
+ +
+ +
+
+

MGLPolygon

 +
+
+ 
@interface MGLPolygon : MGLMultiPoint <MGLOverlay>
+ +
+
+

An MGLPolygon object represents a closed shape consisting of four or more +vertices, specified as CLLocationCoordinate2D instances, and the edges that +connect them. For example, you could use a polygon shape to represent a +building, a lake, or an area you want to highlight.

+ +

You can add polygon shapes to the map by adding them to an MGLShapeSource +object. Configure the appearance of an MGLShapeSource’s or +MGLVectorSource’s polygons collectively using an MGLFillStyleLayer or +MGLSymbolStyleLayer object.

+ +

Alternatively, you can add a polygon overlay directly to a map view using the +-[MGLMapView addAnnotation:] or -[MGLMapView addOverlay:] method. Configure +a polygon overlay’s appearance using +-[MGLMapViewDelegate mapView:strokeColorForShapeAnnotation:] and +-[MGLMapViewDelegate mapView:fillColorForPolygonAnnotation:].

+ +

The vertices are automatically connected in the order in which you provide +them. You should close the polygon by specifying the same +CLLocationCoordinate2D as the first and last vertices; otherwise, the +polygon’s fill may not cover the area you expect it to. To avoid filling the +space within the shape, give the polygon a transparent fill or use an +MGLPolyline object.

+ +

A polygon may have one or more interior polygons, or holes, that you specify as +MGLPolygon objects with the +polygonWithCoordinates:count:interiorPolygons: +method. For example, if a polygon represents a lake, it could exclude an island +within the lake using an interior polygon. Interior polygons may not themselves +have interior polygons. To represent a shape that includes a polygon within a +hole or, more generally, to group multiple polygons together in one shape, use +an MGLMultiPolygon or MGLShapeCollection object.

+ +

To make the polygon straddle the antimeridian, specify some longitudes less +than −180 degrees or greater than 180 degrees.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + interiorPolygons + +
    +
    +
    +
    +

    The array of polygons nested inside the receiver.

    + +

    The area occupied by any interior polygons is excluded from the overall shape. +Interior polygons should not overlap. An interior polygon should not have +interior polygons of its own.

    + +

    If there are no interior polygons, the value of this property is nil.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic, nullable)
+    NSArray<MGLPolygon *> *interiorPolygons;
    + +
    +
    +

    Swift

    + 
    var interiorPolygons: [MGLPolygon]? { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Creates and returns an MGLPolygon object from the specified set of +coordinates.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)polygonWithCoordinates:
+                            (nonnull const CLLocationCoordinate2D *)coords
+                                         count:(NSUInteger)count;
    + +
    +
    +

    Swift

    + 
    convenience init(coordinates coords: UnsafePointer
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + coords + + +
    +

    The array of coordinates defining the shape. The data in this + array is copied to the new object.

    + +
    +
    + + count + + +
    +

    The number of items in the coords array.

    + +
    +
    +
    +
    +

    Return Value

    +

    A new polygon object.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Creates and returns an MGLPolygon object from the specified set of +coordinates and interior polygons.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)
+polygonWithCoordinates:(nonnull const CLLocationCoordinate2D *)coords
+                 count:(NSUInteger)count
+      interiorPolygons:(nullable NSArray<MGLPolygon *> *)interiorPolygons;
    + +
    +
    +

    Swift

    + 
    convenience init(coordinates coords: UnsafePointer
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + coords + + +
    +

    The array of coordinates defining the shape. The data in this + array is copied to the new object.

    + +
    +
    + + count + + +
    +

    The number of items in the coords array.

    + +
    +
    + + interiorPolygons + + +
    +

    An array of MGLPolygon objects that define regions + excluded from the overall shape. If this array is nil or empty, the shape + is considered to have no interior polygons.

    + +
    +
    +
    +
    +

    Return Value

    +

    A new polygon object.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLPolyline.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLPolyline.html new file mode 100644 index 0000000000..9f29e64b76 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLPolyline.html @@ -0,0 +1,653 @@ + + + + MGLPolyline Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLPolyline Class Reference +
+
+ +
+ +
+ +
+
+

MGLPolyline

 +
+
+ 
@interface MGLPolyline : MGLMultiPoint <MGLOverlay>
+ +
+
+

An MGLPolyline object represents a shape consisting of two or more vertices, +specified as CLLocationCoordinate2D instances, and the line segments that +connect them. For example, you could use an polyline to represent a road or the +path along which something moves.

+ +

You can add polyline shapes to the map by adding them to an MGLShapeSource +object. Configure the appearance of an MGLShapeSource’s or +MGLVectorSource’s polylines collectively using an MGLLineStyleLayer or +MGLSymbolStyleLayer object.

+ +

Alternatively, you can add a polyline overlay directly to a map view using the +-[MGLMapView addAnnotation:] or -[MGLMapView addOverlay:] method. Configure +a polyline overlay’s appearance using +-[MGLMapViewDelegate mapView:strokeColorForShapeAnnotation:] and +-[MGLMapViewDelegate mapView:lineWidthForPolylineAnnotation:].

+ +

The vertices are automatically connected in the order in which you provide +them. The first and last vertices are not connected to each other, but you can +specify the same CLLocationCoordinate2D as the first and last vertices in +order to close the polyline. To fill the space within the shape, use an +MGLPolygon object. To group multiple polylines together in one shape, use an +MGLMultiPolyline or MGLShapeCollection object.

+ +

To make the polyline straddle the antimeridian, specify some longitudes less +than −180 degrees or greater than 180 degrees.

+ +

A polyline is known as a +LineString +geometry in GeoJSON.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +

    Creates and returns an MGLPolyline object from the specified set of +coordinates.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)polylineWithCoordinates:
+                            (nonnull const CLLocationCoordinate2D *)coords
+                                          count:(NSUInteger)count;
    + +
    +
    +

    Swift

    + 
    convenience init(coordinates coords: UnsafePointer
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + coords + + +
    +

    The array of coordinates defining the shape. The data in this + array is copied to the new object.

    + +
    +
    + + count + + +
    +

    The number of items in the coords array.

    + +
    +
    +
    +
    +

    Return Value

    +

    A new polyline object.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLRasterSource.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLRasterSource.html new file mode 100644 index 0000000000..2a88afcc92 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLRasterSource.html @@ -0,0 +1,772 @@ + + + + MGLRasterSource Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLRasterSource Class Reference +
+
+ +
+ +
+ +
+
+

MGLRasterSource

 +
+
+ 
@interface MGLRasterSource : MGLTileSource
+ +
+
+

MGLRasterSource is a map content source that supplies raster image tiles to +be shown on the map. The location of and metadata about the tiles are defined +either by an option dictionary or by an external file that conforms to the +TileJSON specification. +A raster source is added to an MGLStyle object along with one or more +MGLRasterStyleLayer objects. Use a raster style layer to control the +appearance of content supplied by the raster source.

+ +

Each +raster +source defined by the style JSON file is represented at runtime by an +MGLRasterSource object that you can use to initialize new style layers. You +can also add and remove sources dynamically using methods such as +-[MGLStyle addSource:] and -[MGLStyle sourceWithIdentifier:].

+ +

Example

+
let source = MGLRasterSource(identifier: clouds, tileURLTemplates: [https://example.com/raster-tiles/{z}/{x}/{y}.png], options: [
+    .minimumZoomLevel: 9,
+    .maximumZoomLevel: 16,
+    .tileSize: 512,
+    .attributionInfos: [
+        MGLAttributionInfo(title: NSAttributedString(string: © Mapbox), url: URL(string: http://mapbox.com))
+    ]
+])
+mapView.style?.addSource(source)
+

+ +
+
+ +
+
+
+
+ + + +

Initializing a Source

+ +
+
    +
  • + +
    +
    +
    +

    Returns a raster source initialized with an identifier and configuration URL.

    + +

    After initializing and configuring the source, add it to a map view’s style +using the -[MGLStyle addSource:] method.

    + +

    The URL may be a full HTTP or HTTPS URL or, for tile sets hosted by Mapbox, a +Mapbox URL indicating a map identifier (mapbox://<mapid>). The URL should +point to a JSON file that conforms to the +TileJSON specification.

    + +

    If a Mapbox URL is specified, this source uses a tile size of 256. For all +other tile sets, the default value is 512. (See the +MGLTileSourceOptionTileSize documentation for more information about tile +sizes.) If you need to use a tile size other than the default, use the +-initWithIdentifier:configurationURL:tileSize: method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithIdentifier:(nonnull NSString *)identifier
+                          configurationURL:(nonnull NSURL *)configurationURL;
    + +
    +
    +

    Swift

    + 
    convenience init(identifier: String, configurationURL: URL)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + identifier + + +
    +

    A string that uniquely identifies the source in the style to + which it is added.

    + +
    +
    + + configurationURL + + +
    +

    A URL to a TileJSON configuration file describing the + source’s contents and other metadata.

    + +
    +
    +
    +
    +

    Return Value

    +

    An initialized raster source.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns a raster source initialized with an identifier, configuration URL, and +tile size.

    + +

    After initializing and configuring the source, add it to a map view’s style +using the -[MGLStyle addSource:] method.

    + +

    The URL may be a full HTTP or HTTPS URL or, for tile sets hosted by Mapbox, a +Mapbox URL indicating a map identifier (mapbox://<mapid>). The URL should +point to a JSON file that conforms to the +TileJSON specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithIdentifier:(nonnull NSString *)identifier
+                          configurationURL:(nonnull NSURL *)configurationURL
+                                  tileSize:(CGFloat)tileSize;
    + +
    +
    +

    Swift

    + 
    init(identifier: String, configurationURL: URL, tileSize: CGFloat)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + identifier + + +
    +

    A string that uniquely identifies the source in the style to + which it is added.

    + +
    +
    + + configurationURL + + +
    +

    A URL to a TileJSON configuration file describing the +source’s contents and other metadata.

    + +
    +
    + + tileSize + + +
    +

    The width and height (measured in points) of each tiled image + in the raster source. See the MGLTileSourceOptionTileSize documentation + for details.

    + +
    +
    +
    +
    +

    Return Value

    +

    An initialized raster source.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLRasterStyleLayer.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLRasterStyleLayer.html new file mode 100644 index 0000000000..6db2f3a999 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLRasterStyleLayer.html @@ -0,0 +1,880 @@ + + + + MGLRasterStyleLayer Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLRasterStyleLayer Class Reference +
+
+ +
+ +
+ +
+
+

MGLRasterStyleLayer

 +
+
+ 
@interface MGLRasterStyleLayer : MGLForegroundStyleLayer
+ +
+
+

An MGLRasterStyleLayer is a style layer that renders raster tiles on the map.

+ +

Use a raster style layer to configure the color parameters of raster tiles +loaded by an MGLRasterSource object. For example, you could use a raster +style layer to render Mapbox +Satellite imagery, a raster tile +set uploaded to Mapbox Studio, or a raster map authored in TileMill, the classic +Mapbox Editor, or Mapbox Studio Classic.

+ +

You can access an existing raster style layer using the +-[MGLStyle layerWithIdentifier:] method if you know its identifier; +otherwise, find it using the MGLStyle.layers property. You can also create a +new raster style layer and add it to the style using a method such as +-[MGLStyle addLayer:].

+ +

Example

+
let layer = MGLRasterStyleLayer(identifier: clouds, source: source)
+layer.rasterOpacity = MGLStyleValue(rawValue: 0.5)
+mapView.style?.addLayer(layer)
+

+ +
+
+ +
+
+
+
+ + + +

Accessing the Paint Attributes

+ +
+
    +
  • + +
    +
    +
    +

    Increase or reduce the brightness of the image. The value is the maximum +brightness.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 1. Set this property to nil to reset +it to the default value.

    + +

    This attribute corresponds to the raster-brightness-max +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *maximumRasterBrightness;
    + +
    +
    +

    Swift

    + 
    var maximumRasterBrightness: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Increase or reduce the brightness of the image. The value is the minimum +brightness.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 0. Set this property to nil to reset +it to the default value.

    + +

    This attribute corresponds to the raster-brightness-min +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *minimumRasterBrightness;
    + +
    +
    +

    Swift

    + 
    var minimumRasterBrightness: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + rasterContrast + +
    +
    +
    +
    +

    Increase or reduce the contrast of the image.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 0. Set this property to nil to reset +it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *rasterContrast;
    + +
    +
    +

    Swift

    + 
    var rasterContrast: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + rasterFadeDuration + +
    +
    +
    +
    +

    Fade duration when a new tile is added.

    + +

    This property is measured in milliseconds.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 300. Set this property to nil to +reset it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *rasterFadeDuration;
    + +
    +
    +

    Swift

    + 
    var rasterFadeDuration: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + rasterHueRotation + +
    +
    +
    +
    +

    Rotates hues around the color wheel.

    + +

    This property is measured in degrees.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 0. Set this property to nil to reset +it to the default value.

    + +

    This attribute corresponds to the raster-hue-rotate +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *rasterHueRotation;
    + +
    +
    +

    Swift

    + 
    var rasterHueRotation: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + rasterOpacity + +
    +
    +
    +
    +

    The opacity at which the image will be drawn.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 1. Set this property to nil to reset +it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *rasterOpacity;
    + +
    +
    +

    Swift

    + 
    var rasterOpacity: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + rasterSaturation + +
    +
    +
    +
    +

    Increase or reduce the saturation of the image.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 0. Set this property to nil to reset +it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *rasterSaturation;
    + +
    +
    +

    Swift

    + 
    var rasterSaturation: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLShape.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLShape.html new file mode 100644 index 0000000000..6bef940919 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLShape.html @@ -0,0 +1,886 @@ + + + + MGLShape Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLShape Class Reference +
+
+ +
+ +
+ +
+
+

MGLShape

 +
+
+ 
@interface MGLShape : NSObject <MGLAnnotation, NSSecureCoding>
+ +
+
+

MGLShape is an abstract class that represents a shape or annotation. Shapes +constitute the content of a map – not only the overlays atop the map, but also +the content that forms the base map.

+ +

You do not create instances of this class directly or create subclasses of this +class. Instead, you create instances of MGLPointAnnotation, +MGLPointCollection, MGLPolyline, MGLMultiPolyline, MGLPolygon, +MGLMultiPolygon, or MGLShapeCollection. The shape classes correspond to the +Geometry object +types in the GeoJSON standard, but some have nonstandard names for backwards +compatibility.

+ +

Although you do not create instances of this class directly, you can use its ++[MGLShape shapeWithData:encoding:error:] factory method to create one of the +concrete subclasses of MGLShape noted above from GeoJSON data.

+ +

You can add shapes to the map by adding them to an MGLShapeSource object. +Configure the appearance of an MGLShapeSource’s or MGLVectorSource’s shapes +collectively using a concrete instance of MGLVectorStyleLayer. Alternatively, +you can add some kinds of shapes directly to a map view as annotations or +overlays.

+ +
+
+ +
+
+
+
+ + + +

Creating a Shape

+ +
+
    +
  • + +
    +
    +
    +

    Returns an MGLShape object initialized with the given data interpreted as a +string containing a GeoJSON object.

    + +

    If the GeoJSON object is a geometry, the returned value is a kind of +MGLShape. If it is a feature object, the returned value is a kind of +MGLShape that conforms to the MGLFeature protocol. If it is a feature +collection object, the returned value is an instance of +MGLShapeCollectionFeature.

    + +

    Example

    +
    let url = mainBundle.url(forResource: amsterdam, withExtension: geojson)!
+let data = try! Data(contentsOf: url)
+let feature = try! MGLShape(data: data, encoding: String.Encoding.utf8.rawValue) as! MGLShapeCollectionFeature
+

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nullable MGLShape *)shapeWithData:(nonnull NSData *)data
+                            encoding:(NSStringEncoding)encoding
+                               error:(NSError *_Nullable *_Nullable)outError;
    + +
    +
    +

    Swift

    + 
    /*not inherited*/ init(data: Data, encoding: UInt) throws
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + data + + +
    +

    String data containing GeoJSON source code.

    + +
    +
    + + encoding + + +
    +

    The encoding used by data.

    + +
    +
    + + outError + + +
    +

    Upon return, if an error has occurred, a pointer to an + NSError object describing the error. Pass in NULL to ignore any error.

    + +
    +
    +
    +
    +

    Return Value

    +

    An MGLShape object representation of data, or nil if data could + not be parsed as valid GeoJSON source code. If nil, outError contains an + NSError object describing the problem.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Accessing the Shape Attributes

+ +
+
    +
  • +
    + + + + title + +
    +
    +
    +
    +

    The title of the shape annotation.

    + +

    The default value of this property is nil.

    + +

    This property is ignored when the shape is used in an MGLShapeSource. To name +a shape used in a shape source, create an MGLFeature and add an attribute to +the MGLFeature.attributes property.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readwrite, copy, nonatomic, nullable) NSString *title;
    + +
    +
    +

    Swift

    + 
    var title: String? { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + subtitle + +
    +
    +
    +
    +

    The subtitle of the shape annotation. The default value of this property is +nil.

    + +

    This property is ignored when the shape is used in an MGLShapeSource. To +provide additional information about a shape used in a shape source, create an +MGLFeature and add an attribute to the MGLFeature.attributes property.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readwrite, copy, nonatomic, nullable) NSString *subtitle;
    + +
    +
    +

    Swift

    + 
    var subtitle: String? { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + toolTip + +
    +
    +
    +
    +

    The tooltip of the shape annotation.

    + +

    The default value of this property is nil.

    + +

    This property is ignored when the shape is used in an MGLShapeSource.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readwrite, copy, nonatomic, nullable) NSString *toolTip;
    + +
    +
    +

    Swift

    + 
    var toolTip: String? { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Creating GeoJSON Data

+ +
+
    +
  • + +
    +
    +
    +

    Returns the GeoJSON string representation of the shape encapsulated in a data +object.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull NSData *)geoJSONDataUsingEncoding:(NSStringEncoding)encoding;
    + +
    +
    +

    Swift

    + 
    func geoJSONData(usingEncoding encoding: UInt) -> Data
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + encoding + + +
    +

    The string encoding to use.

    + +
    +
    +
    +
    +

    Return Value

    +

    A data object containing the shape’s GeoJSON string representation.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLShapeCollection.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLShapeCollection.html new file mode 100644 index 0000000000..95fde63b43 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLShapeCollection.html @@ -0,0 +1,669 @@ + + + + MGLShapeCollection Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLShapeCollection Class Reference +
+
+ +
+ +
+ +
+
+

MGLShapeCollection

 +
+
+ 
@interface MGLShapeCollection : MGLShape
+ +
+
+

An MGLShapeCollection object represents a shape consisting of zero or more +distinct but related shapes that are instances of MGLShape. The constituent +shapes can be a mixture of different kinds of shapes.

+ +

MGLShapeCollection is most commonly used to add multiple shapes to a single +MGLShapeSource. Configure the appearance of an MGLShapeSource’s or +MGLVectorSource’s shape collection collectively using an +MGLSymbolStyleLayer object, or use multiple instances of +MGLCircleStyleLayer, MGLFillStyleLayer, and MGLLineStyleLayer to +configure the appearance of each kind of shape inside the collection.

+ +

You cannot add an MGLShapeCollection object directly to a map view as an +annotation. However, you can create individual MGLPointAnnotation, +MGLPolyline, and MGLPolygon objects from the shapes array and add those +annotation objects to the map view using the -[MGLMapView addAnnotations:] +method.

+ +

To represent a collection of point, polyline, or polygon shapes, it may be more +convenient to use an MGLPointCollection, MGLMultiPolyline, or +MGLMultiPolygon object, respectively.

+ +

A multipolyline is known as a +GeometryCollection +geometry in GeoJSON.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + shapes + +
    +
    +
    +
    +

    An array of shapes forming the shape collection.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, copy, nonatomic) NSArray<MGLShape *> *_Nonnull shapes;
    + +
    +
    +

    Swift

    + 
    var shapes: [MGLShape] { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Creates and returns a shape collection consisting of the given shapes.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)shapeCollectionWithShapes:
+    (nonnull NSArray<MGLShape *> *)shapes;
    + +
    +
    +

    Swift

    + 
    convenience init(shapes: [MGLShape])
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + shapes + + +
    +

    The array of shapes defining the shape collection. The data in + this array is copied to the new object.

    + +
    +
    +
    +
    +

    Return Value

    +

    A new shape collection object.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLShapeSource.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLShapeSource.html new file mode 100644 index 0000000000..ae25cd285c --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLShapeSource.html @@ -0,0 +1,1066 @@ + + + + MGLShapeSource Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLShapeSource Class Reference +
+
+ +
+ +
+ +
+
+

MGLShapeSource

 +
+
+ 
@interface MGLShapeSource : MGLSource
+ +
+
+

MGLShapeSource is a map content source that supplies vector shapes to be +shown on the map. The shapes may be instances of MGLShape or MGLFeature, +or they may be defined by local or external +GeoJSON code. A shape source is added to an +MGLStyle object along with an MGLVectorStyleLayer object. The vector style +layer defines the appearance of any content supplied by the shape source.

+ +

Each +geojson +source defined by the style JSON file is represented at runtime by an +MGLShapeSource object that you can use to refine the map’s content and +initialize new style layers. You can also add and remove sources dynamically +using methods such as -[MGLStyle addSource:] and +-[MGLStyle sourceWithIdentifier:].

+ +

Any vector style layer initialized with a shape source should have a nil +value in its sourceLayerIdentifier property.

+ +

Example

+
var coordinates: [CLLocationCoordinate2D] = [
+    CLLocationCoordinate2D(latitude: 37.77, longitude: -122.42),
+    CLLocationCoordinate2D(latitude: 38.91, longitude: -77.04),
+]
+let polyline = MGLPolylineFeature(coordinates: &coordinates, count: UInt(coordinates.count))
+let source = MGLShapeSource(identifier: lines, features: [polyline], options: nil)
+mapView.style?.addSource(source)
+

+ +
+
+ +
+
+
+
+ + + +

Initializing a Source

+ +
+
    +
  • + +
    +
    +
    +

    Returns a shape source with an identifier, URL, and dictionary of options for +the source.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)
+initWithIdentifier:(nonnull NSString *)identifier
+               URL:(nonnull NSURL *)url
+           options:(nullable NSDictionary<MGLShapeSourceOption, id> *)options;
    + +
    +
    +

    Swift

    + 
    init(identifier: String, url: URL, options: [MGLShapeSourceOption : Any]? = nil)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + identifier + + +
    +

    A string that uniquely identifies the source.

    + +
    +
    + + URL + + +
    +

    An HTTP(S) URL, absolute file URL, or local file URL relative to the + current application’s resource bundle.

    + +
    +
    + + options + + +
    +

    An NSDictionary of options for this source.

    + +
    +
    +
    +
    +

    Return Value

    +

    An initialized shape source.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns a shape source with an identifier, a shape, and dictionary of options +for the source.

    + +

    To specify attributes about the shape, use an instance of an MGLShape +subclass that conforms to the MGLFeature protocol, such as MGLPointFeature. +To include multiple shapes in the source, use an MGLShapeCollection or +MGLShapeCollectionFeature object, or use the +-initWithIdentifier:features:options: or +-initWithIdentifier:shapes:options: methods.

    + +

    To create a shape from GeoJSON source code, use the ++[MGLShape shapeWithData:encoding:error:] method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)
+initWithIdentifier:(nonnull NSString *)identifier
+             shape:(nullable MGLShape *)shape
+           options:(nullable NSDictionary<MGLShapeSourceOption, id> *)options;
    + +
    +
    +

    Swift

    + 
    init(identifier: String, shape: MGLShape?, options: [MGLShapeSourceOption : Any]? = nil)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + identifier + + +
    +

    A string that uniquely identifies the source.

    + +
    +
    + + shape + + +
    +

    A concrete subclass of MGLShape

    + +
    +
    + + options + + +
    +

    An NSDictionary of options for this source.

    + +
    +
    +
    +
    +

    Return Value

    +

    An initialized shape source.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns a shape source with an identifier, an array of features, and a dictionary +of options for the source.

    + +

    Unlike -initWithIdentifier:shapes:options:, this method accepts MGLFeature +instances, such as MGLPointFeature objects, whose attributes you can use when +applying a predicate to MGLVectorStyleLayer or configuring a style layer’s +appearance.

    + +

    To create a shape from GeoJSON source code, use the ++[MGLShape shapeWithData:encoding:error:] method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)
+initWithIdentifier:(nonnull NSString *)identifier
+          features:(nonnull NSArray<MGLShape<MGLFeature> *> *)features
+           options:(nullable NSDictionary<MGLShapeSourceOption, id> *)options;
    + +
    +
    +

    Swift

    + 
    convenience init(identifier: String, features: [MGLShape], options: [MGLShapeSourceOption : Any]? = nil)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + identifier + + +
    +

    A string that uniquely identifies the source.

    + +
    +
    + + features + + +
    +

    An array of objects that conform to the MGLFeature protocol.

    + +
    +
    + + options + + +
    +

    An NSDictionary of options for this source.

    + +
    +
    +
    +
    +

    Return Value

    +

    An initialized shape source.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns a shape source with an identifier, an array of shapes, and a dictionary of +options for the source.

    + +

    Any MGLFeature instance passed into this initializer is treated as an ordinary +shape, causing any attributes to be inaccessible to an MGLVectorStyleLayer when +evaluating a predicate or configuring certain layout or paint attributes. To +preserve the attributes associated with each feature, use the +-initWithIdentifier:features:options: method instead.

    + +

    To create a shape from GeoJSON source code, use the ++[MGLShape shapeWithData:encoding:error:] method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)
+initWithIdentifier:(nonnull NSString *)identifier
+            shapes:(nonnull NSArray<MGLShape *> *)shapes
+           options:(nullable NSDictionary<MGLShapeSourceOption, id> *)options;
    + +
    +
    +

    Swift

    + 
    convenience init(identifier: String, shapes: [MGLShape], options: [MGLShapeSourceOption : Any]? = nil)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + identifier + + +
    +

    A string that uniquely identifies the source.

    + +
    +
    + + shapes + + +
    +

    An array of shapes; each shape is a member of a concrete subclass of MGLShape.

    + +
    +
    + + options + + +
    +

    An NSDictionary of options for this source.

    + +
    +
    +
    +
    +

    Return Value

    +

    An initialized shape source.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Accessing a Source’s Content

+ +
+
    +
  • +
    + + + + shape + +
    +
    +
    +
    +

    The contents of the source. A shape can represent a GeoJSON geometry, a +feature, or a collection of features.

    + +

    If the receiver was initialized using -initWithIdentifier:URL:options:, this +property is set to nil. This property is unavailable until the receiver is +passed into -[MGLStyle addSource:].

    + +

    You can get/set the shapes within a collection via this property. Actions must +be performed on the application’s main thread.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readwrite, copy, nonatomic, nullable) MGLShape *shape;
    + +
    +
    +

    Swift

    + 
    @NSCopying var shape: MGLShape? { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + URL + +
    +
    +
    +
    +

    The URL to the GeoJSON document that specifies the contents of the source.

    + +

    If the receiver was initialized using -initWithIdentifier:shape:options:, +this property is set to nil.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readwrite, copy, nonatomic, nullable) NSURL *URL;
    + +
    +
    +

    Swift

    + 
    var url: URL? { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLSource.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLSource.html new file mode 100644 index 0000000000..f24ade17dc --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLSource.html @@ -0,0 +1,679 @@ + + + + MGLSource Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLSource Class Reference +
+
+ +
+ +
+ +
+
+

MGLSource

 +
+
+ 
@interface MGLSource : NSObject
+ +
+
+

MGLSource is an abstract base class for map content sources. A map content +source supplies content to be shown on the map. A source is added to an +MGLStyle object along with an MGLForegroundStyleLayer object. The +foreground style layer defines the appearance of any content supplied by the +source.

+ +

Each source defined by the style JSON file is represented at runtime by an +MGLSource object that you can use to refine the map’s content. You can also +add and remove sources dynamically using methods such as +-[MGLStyle addSource:] and -[MGLStyle sourceWithIdentifier:].

+ +

Do not create instances of this class directly, and do not create your own +subclasses of this class. Instead, create instances of MGLShapeSource and the +concrete subclasses of MGLTileSource, MGLVectorSource and MGLRasterSource.

+ +
+
+ +
+
+
+
+ + + +

Initializing a Source

+ +
+
    +
  • +
    + + + + -initWithIdentifier: + +
    +
    +
    +
    +

    Returns a source initialized with an identifier.

    + +

    After initializing and configuring the source, add it to a map view’s style +using the -[MGLStyle addSource:] method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithIdentifier:(nonnull NSString *)identifier;
    + +
    +
    +

    Swift

    + 
    init(identifier: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + identifier + + +
    +

    A string that uniquely identifies the source in the style to + which it is added.

    + +
    +
    +
    +
    +

    Return Value

    +

    An initialized source.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Identifying a Source

+ +
+
    +
  • +
    + + + + identifier + +
    +
    +
    +
    +

    A string that uniquely identifies the source in the style to which it is added.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readwrite, copy, nonatomic) NSString *_Nonnull identifier;
    + +
    +
    +

    Swift

    + 
    var identifier: String { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLStyle.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLStyle.html new file mode 100644 index 0000000000..2e133e1c8b --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLStyle.html @@ -0,0 +1,2437 @@ + + + + MGLStyle Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLStyle Class Reference +
+
+ +
+ +
+ +
+
+

MGLStyle

 +
+
+ 
@interface MGLStyle : NSObject
+ +
+
+

The proxy object for the current map style.

+ +

MGLStyle provides a set of convenience methods for changing Mapbox +default styles using -[MGLMapView styleURL]. +Learn more about Mapbox default styles.

+ +

It is also possible to directly manipulate the current map style +via -[MGLMapView style] by updating the style’s data sources or layers.

+ +
+

Note

+ Wait until the map style has finished loading before modifying a map’s +style via any of the MGLStyle instance methods below. You can use the +-[MGLMapViewDelegate mapView:didFinishLoadingStyle:] or +-[MGLMapViewDelegate mapViewDidFinishLoadingMap:] methods as indicators +that it’s safe to modify the map’s style. + +
+ +
+
+ +
+
+
+
+ + + +

Accessing Default Styles

+ +
+
    +
  • +
    + + + + +streetsStyleURL + +
    +
    +
    +
    +

    Returns the URL to version 8 of the +Mapbox Streets style.

    + +

    Streets is a general-purpose style with detailed road and transit networks.

    + +

    MGLMapView and MGLTilePyramidOfflineRegion use Mapbox Streets when no style +is specified explicitly.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSURL *)streetsStyleURL;
    + +
    +
    +

    Swift

    + 
    class func streetsStyleURL() -> URL
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns the URL to the given version of the +Mapbox Streets style.

    + +

    Streets is a general-purpose style with detailed road and transit networks.

    + +

    MGLMapView and MGLTilePyramidOfflineRegion use Mapbox Streets when no style +is specified explicitly.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSURL *)streetsStyleURLWithVersion:(NSInteger)version;
    + +
    +
    +

    Swift

    + 
    class func streetsStyleURL(withVersion version: Int) -> URL
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + version + + +
    +

    The style’s latest released version. As of publication, the + current version is 9.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + +emeraldStyleURL + +
    +
    +
    +
    +

    Returns the URL to version 8 of the +Mapbox Emerald style.

    + +

    Emerald is a tactile style with subtle textures and dramatic hillshading.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSURL *)emeraldStyleURL;
    + +
    +
    +

    Swift

    + 
    class func emeraldStyleURL() -> URL
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns the URL to the given version of the +Mapbox Outdoors style.

    + +

    Outdoors is a general-purpose style tailored to outdoor activities.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSURL *)outdoorsStyleURLWithVersion:(NSInteger)version;
    + +
    +
    +

    Swift

    + 
    class func outdoorsStyleURL(withVersion version: Int) -> URL
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + version + + +
    +

    The style’s latest released version. As of publication, the + current version is 9.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + +lightStyleURL + +
    +
    +
    +
    +

    Returns the URL to version 8 of the +Mapbox Light style.

    + +

    Light is a subtle, light-colored backdrop for data visualizations.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSURL *)lightStyleURL;
    + +
    +
    +

    Swift

    + 
    class func lightStyleURL() -> URL
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns the URL to the given version of the +Mapbox Light style.

    + +

    Light is a subtle, light-colored backdrop for data visualizations.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSURL *)lightStyleURLWithVersion:(NSInteger)version;
    + +
    +
    +

    Swift

    + 
    class func lightStyleURL(withVersion version: Int) -> URL
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + version + + +
    +

    The style’s latest released version. As of publication, the + current version is 9.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + +darkStyleURL + +
    +
    +
    +
    +

    Returns the URL to version 8 of the +Mapbox Dark style.

    + +

    Dark is a subtle, dark-colored backdrop for data visualizations.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSURL *)darkStyleURL;
    + +
    +
    +

    Swift

    + 
    class func darkStyleURL() -> URL
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns the URL to the given version of the +Mapbox Dark style.

    + +

    Dark is a subtle, dark-colored backdrop for data visualizations.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSURL *)darkStyleURLWithVersion:(NSInteger)version;
    + +
    +
    +

    Swift

    + 
    class func darkStyleURL(withVersion version: Int) -> URL
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + version + + +
    +

    The style’s latest released version. As of publication, the + current version is 9.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + +satelliteStyleURL + +
    +
    +
    +
    +

    Returns the URL to version 8 of the +Mapbox Satellite style.

    + +

    Satellite is high-resolution satellite and aerial imagery.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSURL *)satelliteStyleURL;
    + +
    +
    +

    Swift

    + 
    class func satelliteStyleURL() -> URL
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns the URL to the given version of the +Mapbox Satellite style.

    + +

    Satellite is high-resolution satellite and aerial imagery.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSURL *)satelliteStyleURLWithVersion:(NSInteger)version;
    + +
    +
    +

    Swift

    + 
    class func satelliteStyleURL(withVersion version: Int) -> URL
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + version + + +
    +

    The style’s latest released version. As of publication, the + current version is 9.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + +hybridStyleURL + +
    +
    +
    +
    +

    Returns the URL to version 8 of the +Mapbox Satellite Streets +style.

    + +

    Satellite Streets combines the high-resolution satellite and aerial imagery of +Mapbox Satellite with unobtrusive labels and translucent roads from Mapbox +Streets.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSURL *)hybridStyleURL;
    + +
    +
    +

    Swift

    + 
    class func hybridStyleURL() -> URL
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns the URL to the given version of the +Mapbox Satellite Streets +style.

    + +

    Satellite Streets combines the high-resolution satellite and aerial imagery of +Mapbox Satellite with unobtrusive labels and translucent roads from Mapbox +Streets.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull NSURL *)satelliteStreetsStyleURLWithVersion:(NSInteger)version;
    + +
    +
    +

    Swift

    + 
    class func satelliteStreetsStyleURL(withVersion version: Int) -> URL
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + version + + +
    +

    The style’s latest released version. As of publication, the + current version is 9.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Accessing Metadata About the Style

+ +
+
    +
  • +
    + + + + name + +
    +
    +
    +
    +

    The name of the style.

    + +

    You can customize the style’s name in Mapbox Studio.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, copy, atomic, nullable) NSString *name;
    + +
    +
    +

    Swift

    + 
    var name: String? { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Managing Sources

+ +
+
    +
  • +
    + + + + sources + +
    +
    +
    +
    +

    A set containing the style’s sources.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readwrite, strong, nonatomic)
+    NSSet<__kindof MGLSource *> *_Nonnull sources;
    + +
    +
    +

    Swift

    + 
    var sources: Set
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns a source with the given identifier in the current style.

    + +
    +

    Note

    +

    Source identifiers are not guaranteed to exist across styles or different +versions of the same style. Applications that use this API must first set the +style URL to an explicitly versioned style using a convenience method like ++[MGLStyle outdoorsStyleURLWithVersion:], MGLMapView’s “Style URL” +inspectable in Interface Builder, or a manually constructed NSURL. This +approach also avoids source identifer name changes that will occur in the default +style’s sources over time.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nullable MGLSource *)sourceWithIdentifier:(nonnull NSString *)identifier;
    + +
    +
    +

    Swift

    + 
    func source(withIdentifier identifier: String) -> MGLSource?
    + +
    +
    +
    +

    Return Value

    +

    An instance of a concrete subclass of MGLSource associated with the + given identifier, or nil if the current style contains no such source.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -addSource: + +
    +
    +
    +
    +

    Adds a new source to the current style.

    + +
    +

    Note

    +

    Adding the same source instance more than once will result in a +MGLRedundantSourceException. Reusing the same source identifier, even with +different source instances, will result in a +MGLRedundantSourceIdentifierException.

    + +
    + +
    +

    Note

    +

    Sources should be added in +-[MGLMapViewDelegate mapView:didFinishLoadingStyle:] or +-[MGLMapViewDelegate mapViewDidFinishLoadingMap:] to ensure that the map +has loaded the style and is ready to accept a new source.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)addSource:(nonnull MGLSource *)source;
    + +
    +
    +

    Swift

    + 
    func addSource(_ source: MGLSource)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + source + + +
    +

    The source to add to the current style.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -removeSource: + +
    +
    +
    +
    +

    Removes a source from the current style.

    + +
    +

    Note

    +

    Source identifiers are not guaranteed to exist across styles or different +versions of the same style. Applications that use this API must first set the +style URL to an explicitly versioned style using a convenience method like ++[MGLStyle outdoorsStyleURLWithVersion:], MGLMapView’s “Style URL” +inspectable in Interface Builder, or a manually constructed NSURL. This +approach also avoids source identifer name changes that will occur in the default +style’s sources over time.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)removeSource:(nonnull MGLSource *)source;
    + +
    +
    +

    Swift

    + 
    func removeSource(_ source: MGLSource)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + source + + +
    +

    The source to remove from the current style.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Managing Style Layers

+ +
+
    +
  • +
    + + + + layers + +
    +
    +
    +
    +

    The layers included in the style, arranged according to their back-to-front +ordering on the screen.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readwrite, strong, nonatomic)
+    NSArray<__kindof MGLStyleLayer *> *_Nonnull layers;
    + +
    +
    +

    Swift

    + 
    var layers: [MGLStyleLayer] { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -layerWithIdentifier: + +
    +
    +
    +
    +

    Returns a style layer with the given identifier in the current style.

    + +
    +

    Note

    +

    Layer identifiers are not guaranteed to exist across styles or different +versions of the same style. Applications that use this API must first set +the style URL to an explicitly versioned style using a convenience method like ++[MGLStyle outdoorsStyleURLWithVersion:], MGLMapView’s “Style URL” +inspectable in Interface Builder, or a manually constructed NSURL. This +approach also avoids layer identifer name changes that will occur in the default +style’s layers over time.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nullable MGLStyleLayer *)layerWithIdentifier:(nonnull NSString *)identifier;
    + +
    +
    +

    Swift

    + 
    func layer(withIdentifier identifier: String) -> MGLStyleLayer?
    + +
    +
    +
    +

    Return Value

    +

    An instance of a concrete subclass of MGLStyleLayer associated with + the given identifier, or nil if the current style contains no such style + layer.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -addLayer: + +
    +
    +
    +
    +

    Adds a new layer on top of existing layers.

    + +
    +

    Note

    +

    Adding the same layer instance more than once will result in a +MGLRedundantLayerException. Reusing the same layer identifer, even with +different layer instances, will also result in an exception.

    + +
    + +
    +

    Note

    +

    Layers should be added in +-[MGLMapViewDelegate mapView:didFinishLoadingStyle:] or +-[MGLMapViewDelegate mapViewDidFinishLoadingMap:] to ensure that the map +has loaded the style and is ready to accept a new layer.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)addLayer:(nonnull MGLStyleLayer *)layer;
    + +
    +
    +

    Swift

    + 
    func addLayer(_ layer: MGLStyleLayer)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + layer + + +
    +

    The layer object to add to the map view. This object must be an + instance of a concrete subclass of MGLStyleLayer.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -insertLayer:atIndex: + +
    +
    +
    +
    +

    Inserts a new layer into the style at the given index.

    + +
    +

    Note

    +

    Adding the same layer instance more than once will result in a +MGLRedundantLayerException. Reusing the same layer identifer, even with +different layer instances, will also result in an exception.

    + +
    + +
    +

    Note

    +

    Layers should be added in +-[MGLMapViewDelegate mapView:didFinishLoadingStyle:] or +-[MGLMapViewDelegate mapViewDidFinishLoadingMap:] to ensure that the map +has loaded the style and is ready to accept a new layer.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)insertLayer:(nonnull MGLStyleLayer *)layer atIndex:(NSUInteger)index;
    + +
    +
    +

    Swift

    + 
    func insertLayer(_ layer: MGLStyleLayer, at index: UInt)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + layer + + +
    +

    The layer to insert.

    + +
    +
    + + index + + +
    +

    The index at which to insert the layer. An index of 0 would send + the layer to the back; an index equal to the number of objects in the + layers property would bring the layer to the front.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Inserts a new layer below another layer.

    + +
    +

    Note

    + Layer identifiers are not guaranteed to exist across styles or different +versions of the same style. Applications that use this API must first set +the style URL to an explicitly versioned style using a convenience method like ++[MGLStyle outdoorsStyleURLWithVersion:], MGLMapView’s “Style URL” +inspectable in Interface Builder, or a manually constructed NSURL. This +approach also avoids layer identifer name changes that will occur in the default +style’s layers over time. + +
    + +

    Inserting the same layer instance more than once will result in a + MGLRedundantLayerException. Reusing the same layer identifer, even with + different layer instances, will also result in an exception.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)insertLayer:(nonnull MGLStyleLayer *)layer
+         belowLayer:(nonnull MGLStyleLayer *)sibling;
    + +
    +
    +

    Swift

    + 
    func insertLayer(_ layer: MGLStyleLayer, below sibling: MGLStyleLayer)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + layer + + +
    +

    The layer to insert.

    + +
    +
    + + sibling + + +
    +

    An existing layer in the style.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Inserts a new layer above another layer.

    + +
    +

    Note

    + Layer identifiers are not guaranteed to exist across styles or different +versions of the same style. Applications that use this API must first set +the style URL to an explicitly versioned style using a convenience method like ++[MGLStyle outdoorsStyleURLWithVersion:], MGLMapView’s “Style URL” +inspectable in Interface Builder, or a manually constructed NSURL. This +approach also avoids layer identifer name changes that will occur in the default +style’s layers over time. + +
    + +

    Inserting the same layer instance more than once will result in a + MGLRedundantLayerException. Reusing the same layer identifer, even with + different layer instances, will also result in an exception.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)insertLayer:(nonnull MGLStyleLayer *)layer
+         aboveLayer:(nonnull MGLStyleLayer *)sibling;
    + +
    +
    +

    Swift

    + 
    func insertLayer(_ layer: MGLStyleLayer, above sibling: MGLStyleLayer)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + layer + + +
    +

    The layer to insert.

    + +
    +
    + + sibling + + +
    +

    An existing layer in the style.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -removeLayer: + +
    +
    +
    +
    +

    Removes a layer from the map view.

    + +
    +

    Note

    +

    Layer identifiers are not guaranteed to exist across styles or different +versions of the same style. Applications that use this API must first set +the style URL to an explicitly versioned style using a convenience method like ++[MGLStyle outdoorsStyleURLWithVersion:], MGLMapView’s “Style URL” +inspectable in Interface Builder, or a manually constructed NSURL. This +approach also avoids layer identifer name changes that will occur in the default +style’s layers over time.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)removeLayer:(nonnull MGLStyleLayer *)layer;
    + +
    +
    +

    Swift

    + 
    func removeLayer(_ layer: MGLStyleLayer)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + layer + + +
    +

    The layer object to remove from the map view. This object +must conform to the MGLStyleLayer protocol.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Managing Style Classes

+ +
+
    +
  • +
    + + + + styleClasses + +
    +
    +
    +
    +

    Currently active style classes, represented as an array of string identifiers.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic)
+    NSArray<NSString *> *_Nonnull styleClasses;
    + +
    +
    +

    Swift

    + 
    var styleClasses: [String] { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -hasStyleClass: + +
    +
    +
    +
    +

    Returns a Boolean value indicating whether the style class with the given +identifier is currently active.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (BOOL)hasStyleClass:(nonnull NSString *)styleClass;
    + +
    +
    +

    Swift

    + 
    func hasStyleClass(_ styleClass: String) -> Bool
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + styleClass + + +
    +

    The style class to query for.

    + +
    +
    +
    +
    +

    Return Value

    +

    Whether the style class is currently active.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -addStyleClass: + +
    +
    +
    +
    +

    Activates the style class with the given identifier.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)addStyleClass:(nonnull NSString *)styleClass;
    + +
    +
    +

    Swift

    + 
    func addClass(_ styleClass: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + styleClass + + +
    +

    The style class to activate.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -removeStyleClass: + +
    +
    +
    +
    +

    Deactivates the style class with the given identifier.

    + +
    +

    Note

    +

    Style class names are not guaranteed to exist across styles or different +versions of the same style. Applications that use this API must first set the +style URL to an explicitly versioned style using a convenience method like ++[MGLStyle outdoorsStyleURLWithVersion:], MGLMapView’s “Style URL” +inspectable in Interface Builder, or a manually constructed NSURL. This +approach also avoids style class name changes that will occur in the default +style over time.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)removeStyleClass:(nonnull NSString *)styleClass;
    + +
    +
    +

    Swift

    + 
    func removeStyleClass(_ styleClass: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + styleClass + + +
    +

    The style class to deactivate.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Managing a Style’s Images

+ +
+
    +
  • +
    + + + + -imageForName: + +
    +
    +
    +
    +

    Returns the image associated with the given name in the style.

    + +
    +

    Note

    +

    Names and their associated images are not guaranteed to exist across +styles or different versions of the same style. Applications that use this +API must first set the style URL to an explicitly versioned style using a +convenience method like +[MGLStyle outdoorsStyleURLWithVersion:], +MGLMapView’s “Style URL” inspectable in Interface Builder, or a manually +constructed NSURL. This approach also avoids image name changes that will +occur in the default style over time.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nullable NSImage *)imageForName:(nonnull NSString *)name;
    + +
    +
    +

    Swift

    + 
    func image(forName name: String) -> NSImage?
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + name + + +
    +

    The name associated with the image you want to obtain.

    + +
    +
    +
    +
    +

    Return Value

    +

    The image associated with the given name, or nil if no image is + associated with that name.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -setImage:forName: + +
    +
    +
    +
    +

    Adds or overrides an image used by the style’s layers.

    + +

    To use an image in a style layer, give it a unique name using this method, then +set the iconImageName property of an MGLSymbolStyleLayer object to that +name.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)setImage:(nonnull NSImage *)image forName:(nonnull NSString *)name;
    + +
    +
    +

    Swift

    + 
    func setImage(_ image: NSImage, forName name: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + image + + +
    +

    The image for the name.

    + +
    +
    + + name + + +
    +

    The name of the image to set to the style.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -removeImageForName: + +
    +
    +
    +
    +

    Removes a name and its associated image from the style.

    + +
    +

    Note

    +

    Names and their associated images are not guaranteed to exist across +styles or different versions of the same style. Applications that use this +API must first set the style URL to an explicitly versioned style using a +convenience method like +[MGLStyle outdoorsStyleURLWithVersion:], +MGLMapView’s “Style URL” inspectable in Interface Builder, or a manually +constructed NSURL. This approach also avoids image name changes that will +occur in the default style over time.

    + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)removeImageForName:(nonnull NSString *)name;
    + +
    +
    +

    Swift

    + 
    func removeImage(forName name: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + name + + +
    +

    The name of the image to remove.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLStyleConstantValue.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLStyleConstantValue.html new file mode 100644 index 0000000000..90af5a9936 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLStyleConstantValue.html @@ -0,0 +1,741 @@ + + + + MGLStyleConstantValue Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLStyleConstantValue Class Reference +
+
+ +
+ +
+ +
+
+

MGLStyleConstantValue

 +
+
+ 
@interface MGLStyleConstantValue <T> : MGLStyleValue<T>
+ +
+
+

An MGLStyleConstantValue object is a generic container for a style attribute +value that remains constant as the zoom level changes. The layout and paint +attribute properties of MGLStyleLayer objects can be set to +MGLStyleConstantValue objects.

+ +

The MGLStyleConstantValue class takes a generic parameter T that indicates +the Foundation class being wrapped by this class.

+ +
+
+ +
+
+
+
+ + + +

Creating a Style Constant Value

+ +
+
    +
  • +
    + + + + +valueWithRawValue: + +
    +
    +
    +
    +

    Creates and returns an MGLStyleConstantValue object containing a raw value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)valueWithRawValue:(nonnull T)rawValue;
    + +
    +
    +

    Swift

    + 
    convenience init(rawValue: T)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + rawValue + + +
    +

    The constant value contained by the object.

    + +
    +
    +
    +
    +

    Return Value

    +

    An MGLStyleConstantValue object containing rawValue, which is + treated as a constant value.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Initializing a Style Constant Value

+ +
+
    +
  • +
    + + + + -initWithRawValue: + +
    +
    +
    +
    +

    Returns an MGLStyleConstantValue object containing a raw value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithRawValue:(nonnull T)rawValue;
    + +
    +
    +

    Swift

    + 
    init(rawValue: T)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + rawValue + + +
    +

    The value contained by the receiver.

    + +
    +
    +
    +
    +

    Return Value

    +

    An MGLStyleConstantValue object containing rawValue.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Accessing the Underlying Value

+ +
+
    +
  • +
    + + + + rawValue + +
    +
    +
    +
    +

    The raw value contained by the receiver.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) T _Nonnull rawValue;
    + +
    +
    +

    Swift

    + 
    var rawValue: T { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLStyleFunction.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLStyleFunction.html new file mode 100644 index 0000000000..a74fccee00 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLStyleFunction.html @@ -0,0 +1,888 @@ + + + + MGLStyleFunction Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLStyleFunction Class Reference +
+
+ +
+ +
+ +
+
+

MGLStyleFunction

 +
+
+ 
@interface MGLStyleFunction <T> : MGLStyleValue<T>
+ +
+
+

An MGLStyleFunction is a value function defining a style value that changes +as the zoom level changes. The layout and paint attribute properties of an +MGLStyleLayer object can be set to MGLStyleFunction objects. Use a zoom +level function to create the illusion of depth and control data density.

+ +

The MGLStyleFunction class takes a generic parameter T that indicates the +Foundation class being wrapped by this class.

+ +
+
+ +
+
+
+
+ + + +

Creating a Style Function

+ +
+
    +
  • +
    + + + + +functionWithStops: + +
    +
    +
    +
    +

    Creates and returns an MGLStyleFunction object representing a linear zoom +level function with any number of stops.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)functionWithStops:
+    (nonnull NSDictionary<NSNumber *, MGLStyleValue<T> *> *)stops;
    + +
    +
    +

    Swift

    + 
    convenience init(stops: [NSNumber : MGLStyleValue
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + stops + + +
    +

    A dictionary associating zoom levels with style values.

    + +
    +
    +
    +
    +

    Return Value

    +

    An MGLStyleFunction object with the given stops.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Creates and returns an MGLStyleFunction object representing a zoom level +function with an exponential interpolation base and any number of stops.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)
+functionWithInterpolationBase:(CGFloat)interpolationBase
+                        stops:(nonnull NSDictionary<NSNumber *,
+                                                    MGLStyleValue<T> *> *)stops;
    + +
    +
    +

    Swift

    + 
    convenience init(interpolationBase: CGFloat, stops: [NSNumber : MGLStyleValue
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + interpolationBase + + +
    +

    The exponential base of the interpolation curve.

    + +
    +
    + + stops + + +
    +

    A dictionary associating zoom levels with style values.

    + +
    +
    +
    +
    +

    Return Value

    +

    An MGLStyleFunction object with the given interpolation base and stops.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Initializing a Style Function

+ +
+
    +
  • + +
    +
    +
    +

    Returns an MGLStyleFunction object representing a zoom level function with an +exponential interpolation base and any number of stops.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)
+initWithInterpolationBase:(CGFloat)interpolationBase
+                    stops:
+                        (nonnull NSDictionary<NSNumber *, MGLStyleValue<T> *> *)
+                            stops;
    + +
    +
    +

    Swift

    + 
    init(interpolationBase: CGFloat, stops: [NSNumber : MGLStyleValue
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + interpolationBase + + +
    +

    The exponential base of the interpolation curve.

    + +
    +
    + + stops + + +
    +

    A dictionary associating zoom levels with style values.

    + +
    +
    +
    +
    +

    Return Value

    +

    An MGLStyleFunction object with the given interpolation base and stops.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Accessing the Parameters of a Function

+ +
+
    +
  • +
    + + + + interpolationBase + +
    +
    +
    +
    +

    The exponential interpolation base of the function’s interpolation curve.

    + +

    The exponential interpolation base controls the rate at which the function’s output values +increase. A value of 1 causes the function to increase linearly by zoom level. +A higher exponential interpolation base causes the function’s output values to vary +exponentially, increasing more rapidly towards the high end of the function’s +range. The default value of this property is 1, for a linear curve.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) CGFloat interpolationBase;
    + +
    +
    +

    Swift

    + 
    var interpolationBase: CGFloat { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + stops + +
    +
    +
    +
    +

    A dictionary associating zoom levels with style values.

    + +

    Each of the function’s stops is represented by one key-value pair in the +dictionary. Each key in the dictionary is an NSNumber object containing a +floating-point zoom level. Each value in the dictionary is an MGLStyleValue +object containing the value of the style attribute when the map is at the +associated zoom level. An MGLStyleFunction object may not be used recursively +as a stop value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readwrite, copy, nonatomic)
+    NSDictionary<NSNumber *, MGLStyleValue<T> *> *_Nonnull stops;
    + +
    +
    +

    Swift

    + 
    var stops: [NSNumber : MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLStyleLayer.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLStyleLayer.html new file mode 100644 index 0000000000..205bc1720b --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLStyleLayer.html @@ -0,0 +1,798 @@ + + + + MGLStyleLayer Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLStyleLayer Class Reference +
+
+ +
+ +
+ +
+
+

MGLStyleLayer

 +
+
+ 
@interface MGLStyleLayer : NSObject
+ +
+
+

MGLStyleLayer is an abstract base class for style layers. A style layer +manages the layout and appearance of content at a specific z-index in a style. +An MGLStyle object consists of one or more MGLStyleLayer objects.

+ +

Each style layer defined by the style JSON file is represented at runtime by an +MGLStyleLayer object, which you can use to refine the map’s appearance. You +can also add and remove style layers dynamically.

+ +

Do not create instances of this class directly, and do not create your own +subclasses of this class. Instead, create instances of +MGLBackgroundStyleLayer and the concrete subclasses of +MGLForegroundStyleLayer.

+ +
+
+ +
+
+
+
+ + + +

Initializing a Style Layer

+ +
+
    +
  • +
    + + + + -initWithIdentifier: + +
    +
    +
    +
    +

    Returns a style layer object initialized with the given identifier.

    + +

    After initializing and configuring the style layer, add it to a map view’s +style using the -[MGLStyle addLayer:] or +-[MGLStyle insertLayer:belowLayer:] method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithIdentifier:(nonnull NSString *)identifier;
    + +
    +
    +

    Swift

    + 
    init(identifier: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + identifier + + +
    +

    A string that uniquely identifies the layer in the style to + which it is added.

    + +
    +
    +
    +
    +

    Return Value

    +

    An initialized style layer.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Identifying a Style Layer

+ +
+
    +
  • +
    + + + + identifier + +
    +
    +
    +
    +

    A string that uniquely identifies the style layer in the style to which it is +added.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, copy, nonatomic) NSString *_Nonnull identifier;
    + +
    +
    +

    Swift

    + 
    var identifier: String { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Configuring a Style Layer’s Visibility

+ +
+
    +
  • +
    + + + + visible + +
    +
    +
    +
    +

    Whether this layer is displayed. A value of NO hides the layer.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (getter=isVisible, assign, readwrite, nonatomic) BOOL visible;
    + +
    +
    +

    Swift

    + 
    var isVisible: Bool { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + maximumZoomLevel + +
    +
    +
    +
    +

    The maximum zoom level at which the layer gets parsed and appears.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) float maximumZoomLevel;
    + +
    +
    +

    Swift

    + 
    var maximumZoomLevel: Float { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + minimumZoomLevel + +
    +
    +
    +
    +

    The minimum zoom level at which the layer gets parsed and appears.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic) float minimumZoomLevel;
    + +
    +
    +

    Swift

    + 
    var minimumZoomLevel: Float { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLStyleValue.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLStyleValue.html new file mode 100644 index 0000000000..e856423778 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLStyleValue.html @@ -0,0 +1,776 @@ + + + + MGLStyleValue Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLStyleValue Class Reference +
+
+ +
+ +
+ +
+
+

MGLStyleValue

 +
+
+ 
@interface MGLStyleValue <T> : NSObject
+ +
+
+

An MGLStyleValue object is a generic container for a style attribute value. +The layout and paint attribute properties of MGLStyleLayer can be set to +MGLStyleValue objects.

+ +

The MGLStyleValue class itself represents a class cluster. Under the hood, a +particular MGLStyleValue object may be either an MGLStyleConstantValue to +represent a constant value or an MGLStyleFunction to represent a value +function. Do not initialize an MGLStyleValue object directly; instead, use +one of the class factory methods to create an MGLStyleValue object.

+ +

The MGLStyleValue class takes a generic parameter T that indicates the +Foundation class being wrapped by this class. Common values for T include:

+ +
    +
  • NSNumber (for Boolean values and floating-point numbers)
    • +
  • NSValue (for CGVector, NSEdgeInsets, UIEdgeInsets, and enumerations)
    • +
  • NSString
    • +
  • NSColor or UIColor
    • +
  • NSArray
    • +
+ +
+
+ +
+
+
+
+ + + +

Creating a Style Value

+ +
+
    +
  • +
    + + + + +valueWithRawValue: + +
    +
    +
    +
    +

    Creates and returns an MGLStyleConstantValue object containing a raw value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)valueWithRawValue:(nonnull T)rawValue;
    + +
    +
    +

    Swift

    + 
    convenience init(rawValue: T)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + rawValue + + +
    +

    The constant value contained by the object.

    + +
    +
    +
    +
    +

    Return Value

    +

    An MGLStyleConstantValue object containing rawValue, which is + treated as a constant value.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + +valueWithStops: + +
    +
    +
    +
    +

    Creates and returns an MGLStyleFunction object representing a linear zoom +level function with any number of stops.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)valueWithStops:
+    (nonnull NSDictionary<NSNumber *, MGLStyleValue<T> *> *)stops;
    + +
    +
    +

    Swift

    + 
    convenience init(stops: [NSNumber : MGLStyleValue
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + stops + + +
    +

    A dictionary associating zoom levels with style values.

    + +
    +
    +
    +
    +

    Return Value

    +

    An MGLStyleFunction object with the given stops.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Creates and returns an MGLStyleFunction object representing a zoom level +function with an exponential interpolation base and any number of stops.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    + (nonnull instancetype)
+valueWithInterpolationBase:(CGFloat)interpolationBase
+                     stops:(nonnull NSDictionary<NSNumber *, MGLStyleValue<T> *>
+                                *)stops;
    + +
    +
    +

    Swift

    + 
    convenience init(interpolationBase: CGFloat, stops: [NSNumber : MGLStyleValue
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + interpolationBase + + +
    +

    The exponential base of the interpolation curve.

    + +
    +
    + + stops + + +
    +

    A dictionary associating zoom levels with style values.

    + +
    +
    +
    +
    +

    Return Value

    +

    An MGLStyleFunction object with the given interpolation base and stops.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLSymbolStyleLayer.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLSymbolStyleLayer.html new file mode 100644 index 0000000000..7fee270a08 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLSymbolStyleLayer.html @@ -0,0 +1,2840 @@ + + + + MGLSymbolStyleLayer Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLSymbolStyleLayer Class Reference +
+
+ +
+ +
+ +
+
+

MGLSymbolStyleLayer

 +
+
+ 
@interface MGLSymbolStyleLayer : MGLVectorStyleLayer
+ +
+
+

An MGLSymbolStyleLayer is a style layer that renders icon and text labels at +points or along lines on the map.

+ +

Use a symbol style layer to configure the visual appearance of labels for +features in vector tiles loaded by an MGLVectorSource object or MGLShape or +MGLFeature instances in an MGLShapeSource object.

+ +

You can access an existing symbol style layer using the +-[MGLStyle layerWithIdentifier:] method if you know its identifier; +otherwise, find it using the MGLStyle.layers property. You can also create a +new symbol style layer and add it to the style using a method such as +-[MGLStyle addLayer:].

+ +

Example

+
let layer = MGLSymbolStyleLayer(identifier: coffeeshops, source: pois)
+layer.sourceLayerIdentifier = pois
+layer.iconImageName = MGLStyleValue(rawValue: coffee)
+layer.iconScale = MGLStyleValue(rawValue: 0.5)
+layer.text = MGLStyleValue(rawValue: {name})
+layer.textTranslation = MGLStyleValue(rawValue: NSValue(cgVector: CGVector(dx: 10, dy: 0)))
+layer.textJustification = MGLStyleValue(rawValue: NSValue(mglTextJustification: .left))
+layer.textAnchor = MGLStyleValue(rawValue: NSValue(mglTextAnchor: .left))
+layer.predicate = NSPredicate(format: %K == %@, venue-type, coffee)
+mapView.style?.addLayer(layer)
+

+ +
+
+ +
+
+
+
+ + + +

Accessing the Layout Attributes

+ +
+
    +
  • +
    + + + + iconAllowsOverlap + +
    +
    +
    +
    +

    If true, the icon will be visible even if it collides with other previously +drawn symbols.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing NO. Set this property to nil to reset it to +the default value.

    + +

    This property is only applied to the style if iconImageName is non-nil. +Otherwise, it is ignored.

    + +

    This attribute corresponds to the icon-allow-overlap +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *iconAllowsOverlap;
    + +
    +
    +

    Swift

    + 
    var iconAllowsOverlap: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + iconIgnoresPlacement + +
    +
    +
    +
    +

    If true, other symbols can be visible even if they collide with the icon.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing NO. Set this property to nil to reset it to +the default value.

    + +

    This property is only applied to the style if iconImageName is non-nil. +Otherwise, it is ignored.

    + +

    This attribute corresponds to the icon-ignore-placement +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *iconIgnoresPlacement;
    + +
    +
    +

    Swift

    + 
    var iconIgnoresPlacement: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + iconImageName + +
    +
    +
    +
    +

    A string with {tokens} replaced, referencing the data property to pull from.

    + +

    This attribute corresponds to the icon-image +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSString *> *iconImageName;
    + +
    +
    +

    Swift

    + 
    var iconImageName: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + iconOffset + +
    +
    +
    +
    +

    Offset distance of icon from its anchor.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing a CGVector struct set to 0 rightward and 0 +upward. Set this property to nil to reset it to the default value.

    + +

    This property is only applied to the style if iconImageName is non-nil. +Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *iconOffset;
    + +
    +
    +

    Swift

    + 
    var iconOffset: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + iconOptional + +
    +
    +
    +
    +

    If true, text will display without their corresponding icons when the icon +collides with other symbols and the text does not.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing NO. Set this property to nil to reset it to +the default value.

    + +

    This property is only applied to the style if iconImageName is non-nil, and +text is non-nil. Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (getter=isIconOptional, assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *iconOptional;
    + +
    +
    +

    Swift

    + 
    var iconOptional: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + iconPadding + +
    +
    +
    +
    +

    Size of the additional area around the icon bounding box used for detecting +symbol collisions.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 2. Set this property to nil to reset +it to the default value.

    + +

    This property is only applied to the style if iconImageName is non-nil. +Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *iconPadding;
    + +
    +
    +

    Swift

    + 
    var iconPadding: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + iconRotation + +
    +
    +
    +
    +

    Rotates the icon clockwise.

    + +

    This property is measured in degrees.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 0. Set this property to nil to reset +it to the default value.

    + +

    This property is only applied to the style if iconImageName is non-nil. +Otherwise, it is ignored.

    + +

    This attribute corresponds to the icon-rotate +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *iconRotation;
    + +
    +
    +

    Swift

    + 
    var iconRotation: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + iconRotationAlignment + +
    +
    +
    +
    +

    In combination with symbolPlacement, determines the rotation behavior of +icons.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing MGLIconRotationAlignmentAuto. Set this property +to nil to reset it to the default value.

    + +

    This property is only applied to the style if iconImageName is non-nil. +Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *iconRotationAlignment;
    + +
    +
    +

    Swift

    + 
    var iconRotationAlignment: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + iconScale + +
    +
    +
    +
    +

    Scale factor for icon. 1 is original size, 3 triples the size.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 1. Set this property to nil to reset +it to the default value.

    + +

    This property is only applied to the style if iconImageName is non-nil. +Otherwise, it is ignored.

    + +

    This attribute corresponds to the icon-size +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *iconScale;
    + +
    +
    +

    Swift

    + 
    var iconScale: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + iconTextFit + +
    +
    +
    +
    +

    Scales the icon to fit around the associated text.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing MGLIconTextFitNone. Set this property to nil to +reset it to the default value.

    + +

    This property is only applied to the style if iconImageName is non-nil, and +text is non-nil. Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *iconTextFit;
    + +
    +
    +

    Swift

    + 
    var iconTextFit: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + iconTextFitPadding + +
    +
    +
    +
    +

    Size of the additional area added to dimensions determined by iconTextFit.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing NSEdgeInsetsZero. Set this property to nil to +reset it to the default value.

    + +

    This property is only applied to the style if iconImageName is non-nil, and +text is non-nil, and iconTextFit is set to an MGLStyleValue object +containing an NSValue object containing MGLIconTextFitBoth, +MGLIconTextFitWidth, or MGLIconTextFitHeight. Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *iconTextFitPadding;
    + +
    +
    +

    Swift

    + 
    var iconTextFitPadding: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + keepsIconUpright + +
    +
    +
    +
    +

    If true, the icon may be flipped to prevent it from being rendered upside-down.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing NO. Set this property to nil to reset it to +the default value.

    + +

    This property is only applied to the style if iconImageName is non-nil, and +iconRotationAlignment is set to an MGLStyleValue object containing an +NSValue object containing MGLIconRotationAlignmentMap, and +symbolPlacement is set to an MGLStyleValue object containing an NSValue +object containing MGLSymbolPlacementLine. Otherwise, it is ignored.

    + +

    This attribute corresponds to the icon-keep-upright +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *keepsIconUpright;
    + +
    +
    +

    Swift

    + 
    var keepsIconUpright: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + keepsTextUpright + +
    +
    +
    +
    +

    If true, the text may be flipped vertically to prevent it from being rendered +upside-down.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing YES. Set this property to nil to reset it to +the default value.

    + +

    This property is only applied to the style if text is non-nil, and +textRotationAlignment is set to an MGLStyleValue object containing an +NSValue object containing MGLTextRotationAlignmentMap, and +symbolPlacement is set to an MGLStyleValue object containing an NSValue +object containing MGLSymbolPlacementLine. Otherwise, it is ignored.

    + +

    This attribute corresponds to the text-keep-upright +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *keepsTextUpright;
    + +
    +
    +

    Swift

    + 
    var keepsTextUpright: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + maximumTextAngle + +
    +
    +
    +
    +

    Maximum angle change between adjacent characters.

    + +

    This property is measured in degrees.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 45. Set this property to nil to +reset it to the default value.

    + +

    This property is only applied to the style if text is non-nil, and +symbolPlacement is set to an MGLStyleValue object containing an NSValue +object containing MGLSymbolPlacementLine. Otherwise, it is ignored.

    + +

    This attribute corresponds to the text-max-angle +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *maximumTextAngle;
    + +
    +
    +

    Swift

    + 
    var maximumTextAngle: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + maximumTextWidth + +
    +
    +
    +
    +

    The maximum line width for text wrapping.

    + +

    This property is measured in ems.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 10. Set this property to nil to +reset it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +

    This attribute corresponds to the text-max-width +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *maximumTextWidth;
    + +
    +
    +

    Swift

    + 
    var maximumTextWidth: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + symbolAvoidsEdges + +
    +
    +
    +
    +

    If true, the symbols will not cross tile edges to avoid mutual collisions. +Recommended in layers that don’t have enough padding in the vector tile to +prevent collisions, or if it is a point symbol layer placed after a line symbol +layer.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing NO. Set this property to nil to reset it to +the default value.

    + +

    This attribute corresponds to the symbol-avoid-edges +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *symbolAvoidsEdges;
    + +
    +
    +

    Swift

    + 
    var symbolAvoidsEdges: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + symbolPlacement + +
    +
    +
    +
    +

    Label placement relative to its geometry.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing MGLSymbolPlacementPoint. Set this property to +nil to reset it to the default value.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *symbolPlacement;
    + +
    +
    +

    Swift

    + 
    var symbolPlacement: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + symbolSpacing + +
    +
    +
    +
    +

    Distance between two symbol anchors.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 250. Set this property to nil to +reset it to the default value.

    + +

    This property is only applied to the style if symbolPlacement is set to an +MGLStyleValue object containing an NSValue object containing +MGLSymbolPlacementLine. Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *symbolSpacing;
    + +
    +
    +

    Swift

    + 
    var symbolSpacing: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + text + +
    +
    +
    +
    +

    Value to use for a text label. Feature properties are specified using tokens +like {field_name}.

    + +

    The default value of this property is an MGLStyleValue object containing the +empty string. Set this property to nil to reset it to the default value.

    + +

    This attribute corresponds to the text-field +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSString *> *text;
    + +
    +
    +

    Swift

    + 
    var text: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textAllowsOverlap + +
    +
    +
    +
    +

    If true, the text will be visible even if it collides with other previously +drawn symbols.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing NO. Set this property to nil to reset it to +the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +

    This attribute corresponds to the text-allow-overlap +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *textAllowsOverlap;
    + +
    +
    +

    Swift

    + 
    var textAllowsOverlap: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textAnchor + +
    +
    +
    +
    +

    Part of the text placed closest to the anchor.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing MGLTextAnchorCenter. Set this property to nil +to reset it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *textAnchor;
    + +
    +
    +

    Swift

    + 
    var textAnchor: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textFontNames + +
    +
    +
    +
    +

    An array of font face names used to display the text.

    + +

    Each font name must be included in the {fontstack} portion of the JSON +stylesheet’s glyphs +property. You can register a custom font when designing the style in Mapbox +Studio. Fonts installed on the system are not used.

    + +

    The first font named in the array is applied to the text. For each character in +the text, if the first font lacks a glyph for the character, the next font is +applied as a fallback, and so on.

    + +

    The default value of this property is an MGLStyleValue object containing the +array Open Sans Regular, Arial Unicode MS Regular. Set this property to +nil to reset it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +

    This attribute corresponds to the text-font +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSArray<NSString *> *> *textFontNames;
    + +
    +
    +

    Swift

    + 
    var textFontNames: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textFontSize + +
    +
    +
    +
    +

    Font size.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 16. Set this property to nil to +reset it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +

    This attribute corresponds to the text-size +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *textFontSize;
    + +
    +
    +

    Swift

    + 
    var textFontSize: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textIgnoresPlacement + +
    +
    +
    +
    +

    If true, other symbols can be visible even if they collide with the text.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing NO. Set this property to nil to reset it to +the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +

    This attribute corresponds to the text-ignore-placement +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *textIgnoresPlacement;
    + +
    +
    +

    Swift

    + 
    var textIgnoresPlacement: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textJustification + +
    +
    +
    +
    +

    Text justification options.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing MGLTextJustificationCenter. Set this property to +nil to reset it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +

    This attribute corresponds to the text-justify +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *textJustification;
    + +
    +
    +

    Swift

    + 
    var textJustification: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textLetterSpacing + +
    +
    +
    +
    +

    Text tracking amount.

    + +

    This property is measured in ems.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 0. Set this property to nil to reset +it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *textLetterSpacing;
    + +
    +
    +

    Swift

    + 
    var textLetterSpacing: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textLineHeight + +
    +
    +
    +
    +

    Text leading value for multi-line text.

    + +

    This property is measured in ems.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 1.2. Set this property to nil to +reset it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *textLineHeight;
    + +
    +
    +

    Swift

    + 
    var textLineHeight: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textOffset + +
    +
    +
    +
    +

    Offset distance of text from its anchor.

    + +

    This property is measured in ems.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing a CGVector struct set to 0 ems rightward and 0 +ems upward. Set this property to nil to reset it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *textOffset;
    + +
    +
    +

    Swift

    + 
    var textOffset: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textOptional + +
    +
    +
    +
    +

    If true, icons will display without their corresponding text when the text +collides with other symbols and the icon does not.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing NO. Set this property to nil to reset it to +the default value.

    + +

    This property is only applied to the style if text is non-nil, and +iconImageName is non-nil. Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (getter=isTextOptional, assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *textOptional;
    + +
    +
    +

    Swift

    + 
    var textOptional: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textPadding + +
    +
    +
    +
    +

    Size of the additional area around the text bounding box used for detecting +symbol collisions.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 2. Set this property to nil to reset +it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *textPadding;
    + +
    +
    +

    Swift

    + 
    var textPadding: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textPitchAlignment + +
    +
    +
    +
    +

    Orientation of text when map is pitched.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing MGLTextPitchAlignmentAuto. Set this property to +nil to reset it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *textPitchAlignment;
    + +
    +
    +

    Swift

    + 
    var textPitchAlignment: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textRotation + +
    +
    +
    +
    +

    Rotates the text clockwise.

    + +

    This property is measured in degrees.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 0. Set this property to nil to reset +it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +

    This attribute corresponds to the text-rotate +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *textRotation;
    + +
    +
    +

    Swift

    + 
    var textRotation: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textRotationAlignment + +
    +
    +
    +
    +

    In combination with symbolPlacement, determines the rotation behavior of the +individual glyphs forming the text.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing MGLTextRotationAlignmentAuto. Set this property +to nil to reset it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *textRotationAlignment;
    + +
    +
    +

    Swift

    + 
    var textRotationAlignment: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textTransform + +
    +
    +
    +
    +

    Specifies how to capitalize text.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing MGLTextTransformNone. Set this property to nil +to reset it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *textTransform;
    + +
    +
    +

    Swift

    + 
    var textTransform: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Accessing the Paint Attributes

+ +
+
    +
  • +
    + + + + iconColor + +
    +
    +
    +
    +

    The tint color to apply to the icon. The iconImageName property must be set +to a template image.

    + +

    The default value of this property is an MGLStyleValue object containing +NSColor.blackColor. Set this property to nil to reset it to the default +value.

    + +

    This property is only applied to the style if iconImageName is non-nil. +Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSColor *> *iconColor;
    + +
    +
    +

    Swift

    + 
    var iconColor: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + iconHaloBlur + +
    +
    +
    +
    +

    Fade out the halo towards the outside.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 0. Set this property to nil to reset +it to the default value.

    + +

    This property is only applied to the style if iconImageName is non-nil. +Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *iconHaloBlur;
    + +
    +
    +

    Swift

    + 
    var iconHaloBlur: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + iconHaloColor + +
    +
    +
    +
    +

    The color of the icon’s halo. The iconImageName property must be set to a +template image.

    + +

    The default value of this property is an MGLStyleValue object containing +NSColor.clearColor. Set this property to nil to reset it to the default +value.

    + +

    This property is only applied to the style if iconImageName is non-nil. +Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSColor *> *iconHaloColor;
    + +
    +
    +

    Swift

    + 
    var iconHaloColor: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + iconHaloWidth + +
    +
    +
    +
    +

    Distance of halo to the icon outline.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 0. Set this property to nil to reset +it to the default value.

    + +

    This property is only applied to the style if iconImageName is non-nil. +Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *iconHaloWidth;
    + +
    +
    +

    Swift

    + 
    var iconHaloWidth: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + iconOpacity + +
    +
    +
    +
    +

    The opacity at which the icon will be drawn.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 1. Set this property to nil to reset +it to the default value.

    + +

    This property is only applied to the style if iconImageName is non-nil. +Otherwise, it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *iconOpacity;
    + +
    +
    +

    Swift

    + 
    var iconOpacity: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + iconTranslation + +
    +
    +
    +
    +

    Distance that the icon’s anchor is moved from its original placement.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing a CGVector struct set to 0 points rightward and 0 +points upward. Set this property to nil to reset it to the default value.

    + +

    This property is only applied to the style if iconImageName is non-nil. +Otherwise, it is ignored.

    + +

    This attribute corresponds to the icon-translate +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *iconTranslation;
    + +
    +
    +

    Swift

    + 
    var iconTranslation: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + iconTranslationAnchor + +
    +
    +
    +
    +

    Controls the translation reference point.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing MGLIconTranslationAnchorMap. Set this property to +nil to reset it to the default value.

    + +

    This property is only applied to the style if iconImageName is non-nil, and +iconTranslation is non-nil. Otherwise, it is ignored.

    + +

    This attribute corresponds to the icon-translate-anchor +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *iconTranslationAnchor;
    + +
    +
    +

    Swift

    + 
    var iconTranslationAnchor: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textColor + +
    +
    +
    +
    +

    The color with which the text will be drawn.

    + +

    The default value of this property is an MGLStyleValue object containing +NSColor.blackColor. Set this property to nil to reset it to the default +value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSColor *> *textColor;
    + +
    +
    +

    Swift

    + 
    var textColor: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textHaloBlur + +
    +
    +
    +
    +

    The halo’s fadeout distance towards the outside.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 0. Set this property to nil to reset +it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *textHaloBlur;
    + +
    +
    +

    Swift

    + 
    var textHaloBlur: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textHaloColor + +
    +
    +
    +
    +

    The color of the text’s halo, which helps it stand out from backgrounds.

    + +

    The default value of this property is an MGLStyleValue object containing +NSColor.clearColor. Set this property to nil to reset it to the default +value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSColor *> *textHaloColor;
    + +
    +
    +

    Swift

    + 
    var textHaloColor: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textHaloWidth + +
    +
    +
    +
    +

    Distance of halo to the font outline. Max text halo width is ¼ of the +font-size.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 0. Set this property to nil to reset +it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *textHaloWidth;
    + +
    +
    +

    Swift

    + 
    var textHaloWidth: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textOpacity + +
    +
    +
    +
    +

    The opacity at which the text will be drawn.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSNumber object containing the float 1. Set this property to nil to reset +it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSNumber *> *textOpacity;
    + +
    +
    +

    Swift

    + 
    var textOpacity: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textTranslation + +
    +
    +
    +
    +

    Distance that the text’s anchor is moved from its original placement.

    + +

    This property is measured in points.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing a CGVector struct set to 0 points rightward and 0 +points upward. Set this property to nil to reset it to the default value.

    + +

    This property is only applied to the style if text is non-nil. Otherwise, +it is ignored.

    + +

    This attribute corresponds to the text-translate +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *textTranslation;
    + +
    +
    +

    Swift

    + 
    var textTranslation: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + textTranslationAnchor + +
    +
    +
    +
    +

    Controls the translation reference point.

    + +

    The default value of this property is an MGLStyleValue object containing an +NSValue object containing MGLTextTranslationAnchorMap. Set this property to +nil to reset it to the default value.

    + +

    This property is only applied to the style if text is non-nil, and +textTranslation is non-nil. Otherwise, it is ignored.

    + +

    This attribute corresponds to the text-translate-anchor +layout property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, null_resettable)
+    MGLStyleValue<NSValue *> *textTranslationAnchor;
    + +
    +
    +

    Swift

    + 
    var textTranslationAnchor: MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLTilePyramidOfflineRegion.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLTilePyramidOfflineRegion.html new file mode 100644 index 0000000000..6b272219c1 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLTilePyramidOfflineRegion.html @@ -0,0 +1,821 @@ + + + + MGLTilePyramidOfflineRegion Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLTilePyramidOfflineRegion Class Reference +
+
+ +
+ +
+ +
+
+

MGLTilePyramidOfflineRegion

 +
+
+ 
@interface MGLTilePyramidOfflineRegion
+    : NSObject <MGLOfflineRegion, NSSecureCoding, NSCopying>
+ +
+
+

An offline region defined by a style URL, geographic coordinate bounds, and +range of zoom levels.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + styleURL + +
    +
    +
    +
    +

    URL of the style whose resources are required for offline viewing.

    + +

    In addition to the JSON stylesheet, different styles may require different font +glyphs, sprite sheets, and other resources.

    + +

    The URL may be a full HTTP or HTTPS URL or a Mapbox URL indicating the style’s +map ID (mapbox://styles/{user}/{style}).

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) NSURL *_Nonnull styleURL;
    + +
    +
    +

    Swift

    + 
    var styleURL: URL { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + bounds + +
    +
    +
    +
    +

    The coordinate bounds for the geographic region covered by the downloaded +tiles.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) MGLCoordinateBounds bounds;
    + +
    +
    +

    Swift

    + 
    var bounds: MGLCoordinateBounds { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + minimumZoomLevel + +
    +
    +
    +
    +

    The minimum zoom level for which to download tiles and other resources.

    + +

    For more information about zoom levels, -[MGLMapView zoomLevel].

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) double minimumZoomLevel;
    + +
    +
    +

    Swift

    + 
    var minimumZoomLevel: Double { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + maximumZoomLevel + +
    +
    +
    +
    +

    The maximum zoom level for which to download tiles and other resources.

    + +

    For more information about zoom levels, -[MGLMapView zoomLevel].

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) double maximumZoomLevel;
    + +
    +
    +

    Swift

    + 
    var maximumZoomLevel: Double { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Initializes a newly created offline region with the given style URL, geographic +coordinate bounds, and range of zoom levels.

    + +

    This is the designated initializer for MGLTilePyramidOfflineRegion.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithStyleURL:(nullable NSURL *)styleURL
+                                  bounds:(MGLCoordinateBounds)bounds
+                           fromZoomLevel:(double)minimumZoomLevel
+                             toZoomLevel:(double)maximumZoomLevel;
    + +
    +
    +

    Swift

    + 
    init(styleURL: URL?, bounds: MGLCoordinateBounds, fromZoomLevel minimumZoomLevel: Double, toZoomLevel maximumZoomLevel: Double)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + styleURL + + +
    +

    URL of the map style for which to download resources. The URL + may be a full HTTP or HTTPS URL or a Mapbox URL indicating the style’s map + ID (mapbox://styles/{user}/{style}). Specify nil for the default style. + Relative file URLs cannot be used as offline style URLs. To download the + online resources required by a local style, specify a URL to an online copy + of the style.

    + +
    +
    + + bounds + + +
    +

    The coordinate bounds for the geographic region to be covered by + the downloaded tiles.

    + +
    +
    + + minimumZoomLevel + + +
    +

    The minimum zoom level to be covered by the downloaded + tiles. This parameter should be set to at least 0 but no greater than the + value of the maximumZoomLevel parameter. For each required tile source, if + this parameter is set to a value less than the tile source’s minimum zoom + level, the download covers zoom levels down to the tile source’s minimum + zoom level.

    + +
    +
    + + maximumZoomLevel + + +
    +

    The maximum zoom level to be covered by the downloaded + tiles. This parameter should be set to at least the value of the + minimumZoomLevel parameter. For each required tile source, if this + parameter is set to a value greater than the tile source’s minimum zoom + level, the download covers zoom levels up to the tile source’s maximum zoom + level.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLTileSource.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLTileSource.html new file mode 100644 index 0000000000..b890612a03 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLTileSource.html @@ -0,0 +1,938 @@ + + + + MGLTileSource Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLTileSource Class Reference +
+
+ +
+ +
+ +
+
+

MGLTileSource

 +
+
+ 
@interface MGLTileSource : MGLSource
+ +
+
+

MGLTileSource is a map content source that supplies map tiles to be shown on +the map. The location of and metadata about the tiles are defined either by an +option dictionary or by an external file that conforms to the +TileJSON specification. +A tile source is added to an MGLStyle object along with one or more +MGLRasterStyleLayer or MGLVectorStyleLayer objects. Use a style layer to +control the appearance of content supplied by the tile source.

+ +

Do not create instances of this class directly, and do not create your own +subclasses of this class. Instead, create instances of MGLRasterSource and +MGLVectorSource.

+ +
+
+ +
+
+
+
+ + + +

Initializing a Source

+ +
+
    +
  • + +
    +
    +
    +

    Returns a tile source initialized with an identifier and configuration URL.

    + +

    After initializing and configuring the source, add it to a map view’s style +using the -[MGLStyle addSource:] method.

    + +

    The URL may be a full HTTP or HTTPS URL or, for tile sets hosted by Mapbox, a +Mapbox URL indicating a map identifier (mapbox://<mapid>). The URL should +point to a JSON file that conforms to the +TileJSON specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)initWithIdentifier:(nonnull NSString *)identifier
+                          configurationURL:(nonnull NSURL *)configurationURL;
    + +
    +
    +

    Swift

    + 
    init(identifier: String, configurationURL: URL)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + identifier + + +
    +

    A string that uniquely identifies the source in the style to + which it is added.

    + +
    +
    + + configurationURL + + +
    +

    A URL to a TileJSON configuration file describing the + source’s contents and other metadata.

    + +
    +
    +
    +
    +

    Return Value

    +

    An initialized tile source.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns a tile source initialized an identifier, tile URL templates, and +options.

    + +

    After initializing and configuring the source, add it to a map view’s style +using the -[MGLStyle addSource:] method.

    + +

    Tile URL templates

    + +

    Tile URL templates are strings that specify the URLs of the tile images to +load. Each template resembles an absolute URL, but with any number of +placeholder strings that the source evaluates based on the tile it needs to +load. For example:

    + +
      +
    • http://www.example.com/tiles/{z}/{x}/{y}.pbf could be + evaluated as http://www.example.com/tiles/14/6/9.pbf.
      • +
    • http://www.example.com/tiles/{z}/{x}/{y}{ratio}.png could be + evaluated as http://www.example.com/tiles/14/6/9@2x.png.
      • +
    + +

    Tile sources support the following placeholder strings in tile URL templates, +all of which are optional:

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Placeholder stringDescription
    {x}The index of the tile along the map’s x axis according to Spherical + Mercator projection. If the value is 0, the tile’s left edge corresponds + to the 180th meridian west. If the value is 2z−1, + the tile’s right edge corresponds to the 180th meridian east.
    {y}The index of the tile along the map’s y axis according to Spherical + Mercator projection. If the value is 0, the tile’s tile edge corresponds + to arctan(sinh(π)), or approximately 85.0511 degrees north. If the value + is 2z−1, the tile’s bottom edge corresponds to + −arctan(sinh(π)), or approximately 85.0511 degrees south. The y axis is + inverted if the options parameter contains + MGLTileSourceOptionTileCoordinateSystem with a value of + MGLTileCoordinateSystemTMS.
    {z}The tile’s zoom level. At zoom level 0, each tile covers the entire + world map; at zoom level 1, it covers ¼ of the world; at zoom level 2, + 1⁄16 of the world, and so on. For tiles loaded by + a MGLRasterSource object, whether the tile zoom level + matches the map’s current zoom level depends on the value of the + source’s tile size as specified in the + MGLTileSourceOptionTileSize key of the + options parameter.
    {bbox-epsg-3857}The tile’s bounding box, expressed as a comma-separated list of the + tile’s western, southern, eastern, and northern extents according to + Spherical Mercator (EPSG:3857) projection. The bounding box is typically + used with map services conforming to the + Web Map Service + protocol.
    {quadkey}A quadkey indicating both the tile’s location and its zoom level. The + quadkey is typically used with + Bing Maps. +
    {ratio}A suffix indicating the resolution of the tile image. The suffix is the + empty string for standard resolution displays and @2x for + Retina displays, including displays for which + NSScreen.backingScaleFactor or UIScreen.scale + is 3.
    {prefix}Two hexadecimal digits chosen such that each visible tile has a + different prefix. The prefix is typically used for domain sharding.
    + +

    For more information about the {x}, {y}, and {z} placeholder strings, +consult the +OpenStreetMap Wiki.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull instancetype)
+initWithIdentifier:(nonnull NSString *)identifier
+  tileURLTemplates:(nonnull NSArray<NSString *> *)tileURLTemplates
+           options:(nullable NSDictionary<MGLTileSourceOption, id> *)options;
    + +
    +
    +

    Swift

    + 
    init(identifier: String, tileURLTemplates: [String], options: [MGLTileSourceOption : Any]? = nil)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + identifier + + +
    +

    A string that uniquely identifies the source in the style to + which it is added.

    + +
    +
    + + tileURLTemplates + + +
    +

    An array of tile URL template strings. Only the first + string is used; any additional strings are ignored.

    + +
    +
    + + options + + +
    +

    A dictionary containing configuration options. See + MGLTileSourceOption for available keys and values. Pass in nil to use + the default values.

    + +
    +
    +
    +
    +

    Return Value

    +

    An initialized tile source.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Accessing a Source’s Content

+ +
+
    +
  • +
    + + + + configurationURL + +
    +
    +
    +
    +

    The URL to the TileJSON configuration file that specifies the contents of the +source.

    + +

    If the receiver was initialized using +-initWithIdentifier:tileURLTemplates:options, this property is set to nil.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, copy, nonatomic, nullable) NSURL *configurationURL;
    + +
    +
    +

    Swift

    + 
    var configurationURL: URL? { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Accessing Attribution Strings

+ +
+
    +
  • +
    + + + + attributionInfos + +
    +
    +
    +
    +

    An array of MGLAttributionInfo objects that define the attribution +statements to be displayed when the map is shown to the user.

    + +

    By default, this array is empty. If the source is initialized with a +configuration URL, this array is also empty until the configuration JSON file +is loaded.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, copy, nonatomic)
+    NSArray<MGLAttributionInfo *> *_Nonnull attributionInfos;
    + +
    +
    +

    Swift

    + 
    var attributionInfos: [MGLAttributionInfo] { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLVectorStyleLayer.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLVectorStyleLayer.html new file mode 100644 index 0000000000..d966d714c6 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Classes/MGLVectorStyleLayer.html @@ -0,0 +1,754 @@ + + + + MGLVectorStyleLayer Class Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLVectorStyleLayer Class Reference +
+
+ +
+ +
+ +
+
+

MGLVectorStyleLayer

 +
+
+ 
@interface MGLVectorStyleLayer : MGLForegroundStyleLayer
+ +
+
+

MGLVectorStyleLayer is an abstract superclass for style layers whose content +is defined by an MGLShapeSource or MGLVectorSource object.

+ +

Do not create instances of this class directly, and do not create your own +subclasses of this class. Instead, create instances of the following concrete +subclasses: MGLCircleStyleLayer, MGLFillStyleLayer, MGLLineStyleLayer, +and MGLSymbolStyleLayer.

+ +
+
+ +
+
+
+
+ + + +

Refining a Style Layer’s Content

+ +
+
    +
  • +
    + + + + sourceLayerIdentifier + +
    +
    +
    +
    +

    Identifier of the layer within the source identified by the sourceIdentifier +property from which the receiver obtains the data to style.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, nullable)
+    NSString *sourceLayerIdentifier;
    + +
    +
    +

    Swift

    + 
    var sourceLayerIdentifier: String? { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + predicate + +
    +
    +
    +
    +

    The style layer’s predicate.

    + +

    Use the style layer’s predicate to include only the features in the source +layer that satisfy a condition that you define. If the style layer initially +comes from the style, its predicate corresponds to the +filter +property in the style JSON.

    + +

    The following comparison operators are supported.

    + +
      +
    • NSEqualToPredicateOperatorType (=, ==)
      • +
    • NSGreaterThanOrEqualToPredicateOperatorType (>=, =>)
      • +
    • NSLessThanOrEqualToPredicateOperatorType (<=, =<)
      • +
    • NSGreaterThanPredicateOperatorType (>)
      • +
    • NSLessThanPredicateOperatorType (<)
      • +
    • NSNotEqualToPredicateOperatorType (!=, <>)
      • +
    • NSBetweenPredicateOperatorType (BETWEEN)
      • +
    + +

    The following compound operators are supported:

    + +
      +
    • NSAndPredicateType (AND, &&)
      • +
    • NSOrPredicateType (OR, ||)
      • +
    • NSNotPredicateType (NOT, !)
      • +
    + +

    The following aggregate operators are supported:

    + +
      +
    • NSInPredicateOperatorType (IN)
      • +
    • NSContainsPredicateOperatorType (CONTAINS)
      • +
    + +

    To test whether a feature has or lacks a specific attribute, compare the +attribute to NULL or NIL. Predicates created using the ++[NSPredicate predicateWithValue:] method are also supported. String +operators and custom operators are not supported.

    + +

    For details about the predicate format string syntax, consult the “Predicate +Format String Syntax” chapter of the +“Predicate Programming Guide” +in Apple developer documentation.

    + +

    The predicate’s left-hand expression must be a string that identifies a feature +attribute or, alternatively, one of the following special attributes:

    + + + + + + + + + + + + + + + + + + + +
    AttributeMeaning
    $id + A value that uniquely identifies the feature in the containing source. + For details on the types of values that may be associated with this key, + consult the documentation for the MGLFeature protocol’s + identifier property. +
    $type + The type of geometry represented by the feature. A feature’s type is + guaranteed to be one of the following strings: +
      +
    • + Point for point features, corresponding to the + MGLPointAnnotation class +
      • +
    • + LineString for polyline features, corresponding to + the MGLPolyline class +
      • +
    • + Polygon for polygon features, corresponding to the + MGLPolygon class +
      • +
    +
    point_countThe number of point features in a given cluster.
    + +

    The predicate’s right-hand expression must be an NSString (to match strings) +or NSNumber (to match numbers, including Boolean values) or an array of +NSStrings or NSNumbers, depending on the operator and the type of values +expected for the attribute being tested. For floating-point values, use +-[NSNumber numberWithDouble:] instead of -[NSNumber numberWithFloat:] +to avoid precision issues.

    + +

    Automatic type casting is not performed. Therefore, a feature only matches this +predicate if its value for the attribute in question is of the same type as the +value specified in the predicate. Also, operator modifiers such as c (for +case insensitivity), d (for diacritic insensitivity), and l (for locale +sensitivity) are unsupported for comparison and aggregate operators that are +used in the predicate.

    + +

    It is possible to create expressions that contain special characters in the +predicate format syntax. This includes the $ in the $id and $type special +style attributes and also hyphen-minus and tag:subtag. However, you must use +%K in the format string to represent these variables: +@"%K == 'LineString'", @"$type".

    + +

    Example

    + +

    To filter the layer to include only the features whose index attribute is 5 +or 10 and whose ele attribute is at least 1,500, you could create an +NSCompoundPredicate along these lines:

    + +
    let layer = MGLLineStyleLayer(identifier: "contour", source: terrain)
+layer.sourceLayerIdentifier = "contours"
+layer.predicate = NSPredicate(format: "(index == 5 || index == 10) && ele >= 1500.0")
+mapView.style?.addLayer(layer)
+
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (assign, readwrite, nonatomic, nullable) NSPredicate *predicate;
    + +
    +
    +

    Swift

    + 
    var predicate: NSPredicate? { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Content Primitives.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Content Primitives.html new file mode 100644 index 0000000000..2d564bd056 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Content Primitives.html @@ -0,0 +1,867 @@ + + + + Content Primitives Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + Content Primitives Reference +
+
+ +
+ +
+ +
+
+

Content Primitives

 + +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Content Sources.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Content Sources.html new file mode 100644 index 0000000000..1fce7803c7 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Content Sources.html @@ -0,0 +1,844 @@ + + + + Content Sources Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + Content Sources Reference +
+
+ +
+ +
+ +
+
+

Content Sources

 + +
+
+ +
+
+
+
    +
  • +
    + + + + MGLSource + +
    +
    +
    +
    +

    MGLSource is an abstract base class for map content sources. A map content +source supplies content to be shown on the map. A source is added to an +MGLStyle object along with an MGLForegroundStyleLayer object. The +foreground style layer defines the appearance of any content supplied by the +source.

    + +

    Each source defined by the style JSON file is represented at runtime by an +MGLSource object that you can use to refine the map’s content. You can also +add and remove sources dynamically using methods such as +-[MGLStyle addSource:] and -[MGLStyle sourceWithIdentifier:].

    + +

    Do not create instances of this class directly, and do not create your own +subclasses of this class. Instead, create instances of MGLShapeSource and the +concrete subclasses of MGLTileSource, MGLVectorSource and MGLRasterSource.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLSource : NSObject
    + +
    +
    +

    Swift

    + 
    class MGLSource : NSObject
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLTileSource + +
    +
    +
    +
    +

    MGLTileSource is a map content source that supplies map tiles to be shown on +the map. The location of and metadata about the tiles are defined either by an +option dictionary or by an external file that conforms to the +TileJSON specification. +A tile source is added to an MGLStyle object along with one or more +MGLRasterStyleLayer or MGLVectorStyleLayer objects. Use a style layer to +control the appearance of content supplied by the tile source.

    + +

    Do not create instances of this class directly, and do not create your own +subclasses of this class. Instead, create instances of MGLRasterSource and +MGLVectorSource.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLTileSource : MGLSource
    + +
    +
    +

    Swift

    + 
    class MGLTileSource : MGLSource
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLShapeSource + +
    +
    +
    +
    +

    MGLShapeSource is a map content source that supplies vector shapes to be +shown on the map. The shapes may be instances of MGLShape or MGLFeature, +or they may be defined by local or external +GeoJSON code. A shape source is added to an +MGLStyle object along with an MGLVectorStyleLayer object. The vector style +layer defines the appearance of any content supplied by the shape source.

    + +

    Each +geojson +source defined by the style JSON file is represented at runtime by an +MGLShapeSource object that you can use to refine the map’s content and +initialize new style layers. You can also add and remove sources dynamically +using methods such as -[MGLStyle addSource:] and +-[MGLStyle sourceWithIdentifier:].

    + +

    Any vector style layer initialized with a shape source should have a nil +value in its sourceLayerIdentifier property.

    + +

    Example

    +
    var coordinates: [CLLocationCoordinate2D] = [
+    CLLocationCoordinate2D(latitude: 37.77, longitude: -122.42),
+    CLLocationCoordinate2D(latitude: 38.91, longitude: -77.04),
+]
+let polyline = MGLPolylineFeature(coordinates: &coordinates, count: UInt(coordinates.count))
+let source = MGLShapeSource(identifier: lines, features: [polyline], options: nil)
+mapView.style?.addSource(source)
+

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLShapeSource : MGLSource
    + +
    +
    +

    Swift

    + 
    class MGLShapeSource : MGLSource
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLRasterSource + +
    +
    +
    +
    +

    MGLRasterSource is a map content source that supplies raster image tiles to +be shown on the map. The location of and metadata about the tiles are defined +either by an option dictionary or by an external file that conforms to the +TileJSON specification. +A raster source is added to an MGLStyle object along with one or more +MGLRasterStyleLayer objects. Use a raster style layer to control the +appearance of content supplied by the raster source.

    + +

    Each +raster +source defined by the style JSON file is represented at runtime by an +MGLRasterSource object that you can use to initialize new style layers. You +can also add and remove sources dynamically using methods such as +-[MGLStyle addSource:] and -[MGLStyle sourceWithIdentifier:].

    + +

    Example

    +
    let source = MGLRasterSource(identifier: clouds, tileURLTemplates: [https://example.com/raster-tiles/{z}/{x}/{y}.png], options: [
+    .minimumZoomLevel: 9,
+    .maximumZoomLevel: 16,
+    .tileSize: 512,
+    .attributionInfos: [
+        MGLAttributionInfo(title: NSAttributedString(string: © Mapbox), url: URL(string: http://mapbox.com))
+    ]
+])
+mapView.style?.addSource(source)
+

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLRasterSource : MGLTileSource
    + +
    +
    +

    Swift

    + 
    class MGLRasterSource : MGLTileSource
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLVectorSource + +
    +
    +
    +
    +

    MGLVectorSource is a map content source that supplies tiled vector data in +Mapbox Vector Tile format to +be shown on the map. The location of and metadata about the tiles are defined +either by an option dictionary or by an external file that conforms to the +TileJSON specification. +A vector source is added to an MGLStyle object along with one or more +MGLVectorStyleLayer objects. A vector style layer defines the appearance of +any content supplied by the vector source.

    + +

    Each +vector +source defined by the style JSON file is represented at runtime by an +MGLVectorSource object that you can use to initialize new style layers. You +can also add and remove sources dynamically using methods such as +-[MGLStyle addSource:] and -[MGLStyle sourceWithIdentifier:].

    + +

    Within each vector tile, each geometric coordinate must lie between +−1 × extent and +(extent × 2) − 1, inclusive. Any vector style +layer initialized with a vector source must have a non-nil value in its +sourceLayerIdentifier property.

    + +

    Example

    +
    let source = MGLVectorSource(identifier: pois, tileURLTemplates: [https://example.com/vector-tiles/{z}/{x}/{y}.mvt], options: [
+    .minimumZoomLevel: 9,
+    .maximumZoomLevel: 16,
+    .attributionInfos: [
+        MGLAttributionInfo(title: NSAttributedString(string: © Mapbox), url: URL(string: http://mapbox.com))
+    ]
+])
+mapView.style?.addSource(source)
+

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLVectorSource : MGLTileSource
    + +
    +
    +

    Swift

    + 
    class MGLVectorSource : MGLTileSource
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLCircleScaleAlignment.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLCircleScaleAlignment.html new file mode 100644 index 0000000000..42611e1173 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLCircleScaleAlignment.html @@ -0,0 +1,622 @@ + + + + MGLCircleScaleAlignment Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLCircleScaleAlignment Enum Reference +
+
+ +
+ +
+ +
+
+

MGLCircleScaleAlignment

 +
+
+ 
enum MGLCircleScaleAlignment : NSUInteger {}
+ +
+
+

Controls the scaling behavior of the circle when the map is pitched.

+ +

Values of this type are used in the MGLCircleStyleLayer.circleScaleAlignment +property.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLCircleTranslationAnchor.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLCircleTranslationAnchor.html new file mode 100644 index 0000000000..fc3cd7e3df --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLCircleTranslationAnchor.html @@ -0,0 +1,622 @@ + + + + MGLCircleTranslationAnchor Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLCircleTranslationAnchor Enum Reference +
+
+ +
+ +
+ +
+
+

MGLCircleTranslationAnchor

 +
+
+ 
enum MGLCircleTranslationAnchor : NSUInteger {}
+ +
+
+

Controls the translation reference point.

+ +

Values of this type are used in the MGLCircleStyleLayer.circleTranslationAnchor +property.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLErrorCode.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLErrorCode.html new file mode 100644 index 0000000000..522d7d5341 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLErrorCode.html @@ -0,0 +1,691 @@ + + + + MGLErrorCode Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLErrorCode Enum Reference +
+
+ +
+ +
+ +
+
+

MGLErrorCode

 +
+
+ 
enum MGLErrorCode : NSInteger {}
+ +
+
+

Error constants for the Mapbox SDK.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLFillTranslationAnchor.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLFillTranslationAnchor.html new file mode 100644 index 0000000000..1e4d6557f1 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLFillTranslationAnchor.html @@ -0,0 +1,622 @@ + + + + MGLFillTranslationAnchor Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLFillTranslationAnchor Enum Reference +
+
+ +
+ +
+ +
+
+

MGLFillTranslationAnchor

 +
+
+ 
enum MGLFillTranslationAnchor : NSUInteger {}
+ +
+
+

Controls the translation reference point.

+ +

Values of this type are used in the MGLFillStyleLayer.fillTranslationAnchor +property.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLIconRotationAlignment.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLIconRotationAlignment.html new file mode 100644 index 0000000000..7d03e57716 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLIconRotationAlignment.html @@ -0,0 +1,665 @@ + + + + MGLIconRotationAlignment Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLIconRotationAlignment Enum Reference +
+
+ +
+ +
+ +
+
+

MGLIconRotationAlignment

 +
+
+ 
enum MGLIconRotationAlignment : NSUInteger {}
+ +
+
+

In combination with symbolPlacement, determines the rotation behavior of +icons.

+ +

Values of this type are used in the MGLSymbolStyleLayer.iconRotationAlignment +property.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLIconTextFit.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLIconTextFit.html new file mode 100644 index 0000000000..b827b3756d --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLIconTextFit.html @@ -0,0 +1,694 @@ + + + + MGLIconTextFit Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLIconTextFit Enum Reference +
+
+ +
+ +
+ +
+
+

MGLIconTextFit

 +
+
+ 
enum MGLIconTextFit : NSUInteger {}
+ +
+
+

Scales the icon to fit around the associated text.

+ +

Values of this type are used in the MGLSymbolStyleLayer.iconTextFit +property.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLIconTranslationAnchor.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLIconTranslationAnchor.html new file mode 100644 index 0000000000..96c5a86ba3 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLIconTranslationAnchor.html @@ -0,0 +1,622 @@ + + + + MGLIconTranslationAnchor Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLIconTranslationAnchor Enum Reference +
+
+ +
+ +
+ +
+
+

MGLIconTranslationAnchor

 +
+
+ 
enum MGLIconTranslationAnchor : NSUInteger {}
+ +
+
+

Controls the translation reference point.

+ +

Values of this type are used in the MGLSymbolStyleLayer.iconTranslationAnchor +property.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLLineCap.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLLineCap.html new file mode 100644 index 0000000000..8e101fef91 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLLineCap.html @@ -0,0 +1,662 @@ + + + + MGLLineCap Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLLineCap Enum Reference +
+
+ +
+ +
+ +
+
+

MGLLineCap

 +
+
+ 
enum MGLLineCap : NSUInteger {}
+ +
+
+

The display of line endings.

+ +

Values of this type are used in the MGLLineStyleLayer.lineCap +property.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + MGLLineCapButt + +
    +
    +
    +
    +

    A cap with a squared-off end which is drawn to the exact endpoint of the +line.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLLineCapButt
    + +
    +
    +

    Swift

    + 
    case butt = 0
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + MGLLineCapRound + +
    +
    +
    +
    +

    A cap with a rounded end which is drawn beyond the endpoint of the line at +a radius of one-half of the line’s width and centered on the endpoint of +the line.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLLineCapRound
    + +
    +
    +

    Swift

    + 
    case round = 1
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + MGLLineCapSquare + +
    +
    +
    +
    +

    A cap with a squared-off end which is drawn beyond the endpoint of the line +at a distance of one-half of the line’s width.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLLineCapSquare
    + +
    +
    +

    Swift

    + 
    case square = 2
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLLineJoin.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLLineJoin.html new file mode 100644 index 0000000000..e82f83d12b --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLLineJoin.html @@ -0,0 +1,662 @@ + + + + MGLLineJoin Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLLineJoin Enum Reference +
+
+ +
+ +
+ +
+
+

MGLLineJoin

 +
+
+ 
enum MGLLineJoin : NSUInteger {}
+ +
+
+

The display of lines when joining.

+ +

Values of this type are used in the MGLLineStyleLayer.lineJoin +property.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + MGLLineJoinBevel + +
    +
    +
    +
    +

    A join with a squared-off end which is drawn beyond the endpoint of the +line at a distance of one-half of the line’s width.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLLineJoinBevel
    + +
    +
    +

    Swift

    + 
    case bevel = 0
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + MGLLineJoinRound + +
    +
    +
    +
    +

    A join with a rounded end which is drawn beyond the endpoint of the line at +a radius of one-half of the line’s width and centered on the endpoint of +the line.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLLineJoinRound
    + +
    +
    +

    Swift

    + 
    case round = 1
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + MGLLineJoinMiter + +
    +
    +
    +
    +

    A join with a sharp, angled corner which is drawn with the outer sides +beyond the endpoint of the path until they meet.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLLineJoinMiter
    + +
    +
    +

    Swift

    + 
    case miter = 2
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLLineTranslationAnchor.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLLineTranslationAnchor.html new file mode 100644 index 0000000000..b5bc8888e9 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLLineTranslationAnchor.html @@ -0,0 +1,622 @@ + + + + MGLLineTranslationAnchor Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLLineTranslationAnchor Enum Reference +
+
+ +
+ +
+ +
+
+

MGLLineTranslationAnchor

 +
+
+ 
enum MGLLineTranslationAnchor : NSUInteger {}
+ +
+
+

Controls the translation reference point.

+ +

Values of this type are used in the MGLLineStyleLayer.lineTranslationAnchor +property.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLMapDebugMaskOptions.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLMapDebugMaskOptions.html new file mode 100644 index 0000000000..215cb9937a --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLMapDebugMaskOptions.html @@ -0,0 +1,805 @@ + + + + MGLMapDebugMaskOptions Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLMapDebugMaskOptions Enum Reference +
+
+ +
+ +
+ +
+
+

MGLMapDebugMaskOptions

 +
+
+ 
enum MGLMapDebugMaskOptions : NSUInteger {}
+ +
+
+

Options for enabling debugging features in an MGLMapView instance.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +

    Edges of tile boundaries are shown as thick, red lines to help diagnose + tile clipping issues.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLMapDebugTileBoundariesMask = 1 << 1
    + +
    +
    +

    Swift

    + 
    static var tileBoundariesMask: MGLMapDebugMaskOptions { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Each tile shows its tile coordinate (x/y/z) in the upper-left corner.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLMapDebugTileInfoMask = 1 << 2
    + +
    +
    +

    Swift

    + 
    static var tileInfoMask: MGLMapDebugMaskOptions { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Each tile shows a timestamp indicating when it was loaded.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLMapDebugTimestampsMask = 1 << 3
    + +
    +
    +

    Swift

    + 
    static var timestampsMask: MGLMapDebugMaskOptions { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Edges of glyphs and symbols are shown as faint, green lines to help + diagnose collision and label placement issues.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLMapDebugCollisionBoxesMask = 1 << 4
    + +
    +
    +

    Swift

    + 
    static var collisionBoxesMask: MGLMapDebugMaskOptions { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Each drawing operation is replaced by a translucent fill. Overlapping + drawing operations appear more prominent to help diagnose overdrawing. + - note: This option does nothing in Release builds of the SDK.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLMapDebugOverdrawVisualizationMask = 1 << 5
    + +
    +
    +

    Swift

    + 
    static var overdrawVisualizationMask: MGLMapDebugMaskOptions { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    The stencil buffer is shown instead of the color buffer. + - note: This option does nothing in Release builds of the SDK.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLMapDebugStencilBufferMask = 1 << 6
    + +
    +
    +

    Swift

    + 
    static var stencilBufferMask: MGLMapDebugMaskOptions { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    The depth buffer is shown instead of the color buffer. + - note: This option does nothing in Release builds of the SDK.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLMapDebugDepthBufferMask = 1 << 7
    + +
    +
    +

    Swift

    + 
    static var depthBufferMask: MGLMapDebugMaskOptions { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLOfflinePackState.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLOfflinePackState.html new file mode 100644 index 0000000000..2675fa9904 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLOfflinePackState.html @@ -0,0 +1,746 @@ + + + + MGLOfflinePackState Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLOfflinePackState Enum Reference +
+
+ +
+ +
+ +
+
+

MGLOfflinePackState

 +
+
+ 
enum MGLOfflinePackState : NSInteger {}
+ +
+
+

The state an offline pack is currently in.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLSymbolPlacement.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLSymbolPlacement.html new file mode 100644 index 0000000000..ea0d1be17d --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLSymbolPlacement.html @@ -0,0 +1,623 @@ + + + + MGLSymbolPlacement Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLSymbolPlacement Enum Reference +
+
+ +
+ +
+ +
+
+

MGLSymbolPlacement

 +
+
+ 
enum MGLSymbolPlacement : NSUInteger {}
+ +
+
+

Label placement relative to its geometry.

+ +

Values of this type are used in the MGLSymbolStyleLayer.symbolPlacement +property.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +

    The label is placed at the point where the geometry is located.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLSymbolPlacementPoint
    + +
    +
    +

    Swift

    + 
    case point = 0
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    The label is placed along the line of the geometry. Can only be used on +LineString and Polygon geometries.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLSymbolPlacementLine
    + +
    +
    +

    Swift

    + 
    case line = 1
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLTextAnchor.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLTextAnchor.html new file mode 100644 index 0000000000..a32bf4158b --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLTextAnchor.html @@ -0,0 +1,874 @@ + + + + MGLTextAnchor Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLTextAnchor Enum Reference +
+
+ +
+ +
+ +
+
+

MGLTextAnchor

 +
+
+ 
enum MGLTextAnchor : NSUInteger {}
+ +
+
+

Part of the text placed closest to the anchor.

+ +

Values of this type are used in the MGLSymbolStyleLayer.textAnchor +property.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + MGLTextAnchorCenter + +
    +
    +
    +
    +

    The center of the text is placed closest to the anchor.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLTextAnchorCenter
    + +
    +
    +

    Swift

    + 
    case center = 0
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + MGLTextAnchorLeft + +
    +
    +
    +
    +

    The left side of the text is placed closest to the anchor.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLTextAnchorLeft
    + +
    +
    +

    Swift

    + 
    case left = 1
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + MGLTextAnchorRight + +
    +
    +
    +
    +

    The right side of the text is placed closest to the anchor.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLTextAnchorRight
    + +
    +
    +

    Swift

    + 
    case right = 2
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + MGLTextAnchorTop + +
    +
    +
    +
    +

    The top of the text is placed closest to the anchor.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLTextAnchorTop
    + +
    +
    +

    Swift

    + 
    case top = 3
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + MGLTextAnchorBottom + +
    +
    +
    +
    +

    The bottom of the text is placed closest to the anchor.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLTextAnchorBottom
    + +
    +
    +

    Swift

    + 
    case bottom = 4
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + MGLTextAnchorTopLeft + +
    +
    +
    +
    +

    The top left corner of the text is placed closest to the anchor.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLTextAnchorTopLeft
    + +
    +
    +

    Swift

    + 
    case topLeft = 5
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + MGLTextAnchorTopRight + +
    +
    +
    +
    +

    The top right corner of the text is placed closest to the anchor.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLTextAnchorTopRight
    + +
    +
    +

    Swift

    + 
    case topRight = 6
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    The bottom left corner of the text is placed closest to the anchor.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLTextAnchorBottomLeft
    + +
    +
    +

    Swift

    + 
    case bottomLeft = 7
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    The bottom right corner of the text is placed closest to the anchor.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLTextAnchorBottomRight
    + +
    +
    +

    Swift

    + 
    case bottomRight = 8
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLTextJustification.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLTextJustification.html new file mode 100644 index 0000000000..1ea3cf5a90 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLTextJustification.html @@ -0,0 +1,658 @@ + + + + MGLTextJustification Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLTextJustification Enum Reference +
+
+ +
+ +
+ +
+
+

MGLTextJustification

 +
+
+ 
enum MGLTextJustification : NSUInteger {}
+ +
+
+

Text justification options.

+ +

Values of this type are used in the MGLSymbolStyleLayer.textJustification +property.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLTextPitchAlignment.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLTextPitchAlignment.html new file mode 100644 index 0000000000..265cf78b07 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLTextPitchAlignment.html @@ -0,0 +1,658 @@ + + + + MGLTextPitchAlignment Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLTextPitchAlignment Enum Reference +
+
+ +
+ +
+ +
+
+

MGLTextPitchAlignment

 +
+
+ 
enum MGLTextPitchAlignment : NSUInteger {}
+ +
+
+

Orientation of text when map is pitched.

+ +

Values of this type are used in the MGLSymbolStyleLayer.textPitchAlignment +property.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLTextRotationAlignment.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLTextRotationAlignment.html new file mode 100644 index 0000000000..956eae8bb1 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLTextRotationAlignment.html @@ -0,0 +1,665 @@ + + + + MGLTextRotationAlignment Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLTextRotationAlignment Enum Reference +
+
+ +
+ +
+ +
+
+

MGLTextRotationAlignment

 +
+
+ 
enum MGLTextRotationAlignment : NSUInteger {}
+ +
+
+

In combination with symbolPlacement, determines the rotation behavior of the +individual glyphs forming the text.

+ +

Values of this type are used in the MGLSymbolStyleLayer.textRotationAlignment +property.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLTextTransform.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLTextTransform.html new file mode 100644 index 0000000000..4c14611183 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLTextTransform.html @@ -0,0 +1,658 @@ + + + + MGLTextTransform Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLTextTransform Enum Reference +
+
+ +
+ +
+ +
+
+

MGLTextTransform

 +
+
+ 
enum MGLTextTransform : NSUInteger {}
+ +
+
+

Specifies how to capitalize text.

+ +

Values of this type are used in the MGLSymbolStyleLayer.textTransform +property.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLTextTranslationAnchor.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLTextTranslationAnchor.html new file mode 100644 index 0000000000..ab9376c6b9 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLTextTranslationAnchor.html @@ -0,0 +1,622 @@ + + + + MGLTextTranslationAnchor Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLTextTranslationAnchor Enum Reference +
+
+ +
+ +
+ +
+
+

MGLTextTranslationAnchor

 +
+
+ 
enum MGLTextTranslationAnchor : NSUInteger {}
+ +
+
+

Controls the translation reference point.

+ +

Values of this type are used in the MGLSymbolStyleLayer.textTranslationAnchor +property.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLTileCoordinateSystem.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLTileCoordinateSystem.html new file mode 100644 index 0000000000..b1afb9482f --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLTileCoordinateSystem.html @@ -0,0 +1,628 @@ + + + + MGLTileCoordinateSystem Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLTileCoordinateSystem Enum Reference +
+
+ +
+ +
+ +
+
+

MGLTileCoordinateSystem

 +
+
+ 
enum MGLTileCoordinateSystem : NSUInteger {}
+ +
+
+

Tile coordinate systems that determine how tile coordinates in tile URLs are +interpreted.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +

    The origin is at the top-left (northwest), and y values increase +southwards.

    + +

    This tile coordinate system is used by Mapbox and OpenStreetMap tile +servers.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLTileCoordinateSystemXYZ = 0
    + +
    +
    +

    Swift

    + 
    case XYZ = 0
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    The origin is at the bottom-left (southwest), and y values increase +northwards.

    + +

    This tile coordinate system is used by tile servers that conform to the +Tile Map Service Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    MGLTileCoordinateSystemTMS
    + +
    +
    +

    Swift

    + 
    case TMS = 1
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLUserTrackingMode.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLUserTrackingMode.html new file mode 100644 index 0000000000..5d290383fc --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Enums/MGLUserTrackingMode.html @@ -0,0 +1,692 @@ + + + + MGLUserTrackingMode Enum Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLUserTrackingMode Enum Reference +
+
+ +
+ +
+ +
+
+

MGLUserTrackingMode

 +
+
+ 
enum MGLUserTrackingMode : NSUInteger {}
+ +
+
+

The mode used to track the user location on the map. Used with +MGLMapView.userTrackingMode.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Formatters.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Formatters.html new file mode 100644 index 0000000000..9da04fbb68 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Formatters.html @@ -0,0 +1,674 @@ + + + + Formatters Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + Formatters Reference +
+
+ +
+ +
+ +
+
+

Formatters

 + +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +

    The MGLClockDirectionFormatter class provides properly formatted descriptions +of headings relative to the user, known as clock positions. For +example, a value of 90 may be formatted as “3 o’clock”, depending on the +locale.

    + +

    Use this class to create localized heading strings when displaying directions +relative to the user’s current location and heading. To format a direction +irrespective of the user’s orientation, use MGLCompassDirectionFormatter +instead.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLClockDirectionFormatter : NSFormatter
    + +
    +
    +

    Swift

    + 
    class MGLClockDirectionFormatter : Formatter
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • + +
    +
    +
    +

    The MGLCompassDirectionFormatter class provides properly formatted +descriptions of absolute headings. For example, a value of 90 may be +formatted as “east”, depending on the locale.

    + +

    Use this class to create localized heading strings when displaying directions +irrespective of the user’s current location. To format a direction relative to +the user’s current location, use MGLClockDirectionFormatter instead.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLCompassDirectionFormatter : NSFormatter
    + +
    +
    +

    Swift

    + 
    class MGLCompassDirectionFormatter : Formatter
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • + +
    +
    +
    +

    The MGLCoordinateFormatter class provides properly formatted descriptions of +geographic coordinate pairs. Use this class to create localized coordinate +strings when displaying location information to users.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLCoordinateFormatter : NSFormatter
    + +
    +
    +

    Swift

    + 
    class MGLCoordinateFormatter : Formatter
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Geometry.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Geometry.html new file mode 100644 index 0000000000..1c6312db6b --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Geometry.html @@ -0,0 +1,1106 @@ + + + + Geometry Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + Geometry Reference +
+
+ +
+ +
+ +
+
+

Geometry

 + +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Guides.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Guides.html new file mode 100644 index 0000000000..dc56590ec2 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Guides.html @@ -0,0 +1,535 @@ + + + + Guides Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + Guides Reference +
+
+ +
+ +
+ +
+
+

Guides

 + +
+
+ +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Maps.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Maps.html new file mode 100644 index 0000000000..6a21c6d7bd --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Maps.html @@ -0,0 +1,782 @@ + + + + Maps Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + Maps Reference +
+
+ +
+ +
+ +
+
+

Maps

 + +
+
+ +
+
+
+
    +
  • +
    + + + + MGLAccountManager + +
    +
    +
    +
    +

    The MGLAccountManager object provides a global way to set a Mapbox API access +token.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLAccountManager : NSObject
    + +
    +
    +

    Swift

    + 
    class MGLAccountManager : NSObject
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLMapCamera + +
    +
    +
    +
    +

    An MGLMapCamera object represents a viewpoint from which the user observes +some point on an MGLMapView.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLMapCamera : NSObject <NSSecureCoding, NSCopying>
    + +
    +
    +

    Swift

    + 
    class MGLMapCamera : NSObject, NSSecureCoding, NSCopying
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLMapView + +
    +
    +
    +
    +

    An interactive, customizable map view with an interface similar to the one +provided by Apple’s MapKit.

    + +

    Using MGLMapView, you can embed the map inside a view, allow users to +manipulate it with standard gestures, animate the map between different +viewpoints, and present information in the form of annotations and overlays.

    + +

    The map view loads scalable vector tiles that conform to the +Mapbox Vector Tile Specification. +It styles them with a style that conforms to the +Mapbox Style Specification. +Such styles can be designed in +Mapbox Studio and hosted on +mapbox.com.

    + +

    A collection of Mapbox-hosted styles is available through the MGLStyle class. +These basic styles use +Mapbox Streets +or Mapbox Satellite data +sources, but you can specify a custom style that makes use of your own data.

    + +

    Mapbox-hosted vector tiles and styles require an API access token, which you +can obtain from the +Mapbox account page. +Access tokens associate requests to Mapbox’s vector tile and style APIs with +your Mapbox account. They also deter other developers from using your styles +without your permission.

    + +
    +

    Note

    + You are responsible for getting permission to use the map data and for +ensuring that your use adheres to the relevant terms of use. + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLMapView : NSView
    + +
    +
    +

    Swift

    + 
    class MGLMapView : NSView
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLMapViewDelegate + +
    +
    +
    +
    +

    The MGLMapViewDelegate protocol defines a set of optional methods that you +can use to receive messages from an MGLMapView instance. Because many map +operations require the MGLMapView class to load data asynchronously, the map +view calls these methods to notify your application when specific operations +complete. The map view also uses these methods to request information about +annotations displayed on the map, such as the styles and interaction modes to +apply to individual annotations.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @protocol MGLMapViewDelegate <NSObject>
    + +
    +
    +

    Swift

    + 
    protocol MGLMapViewDelegate : NSObjectProtocol
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLUserTrackingMode + +
    +
    +
    +
    +

    The mode used to track the user location on the map. Used with +MGLMapView.userTrackingMode.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum MGLUserTrackingMode : NSUInteger {}
    + +
    +
    +

    Swift

    + 
    enum MGLUserTrackingMode : UInt
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Offline Maps.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Offline Maps.html new file mode 100644 index 0000000000..f142781bd4 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Offline Maps.html @@ -0,0 +1,786 @@ + + + + Offline Maps Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + Offline Maps Reference +
+
+ +
+ +
+ +
+
+

Offline Maps

 + +
+
+ +
+
+
+
    +
  • +
    + + + + MGLOfflineRegion + +
    +
    +
    +
    +

    An object conforming to the MGLOfflineRegion protocol determines which +resources are required by an MGLOfflinePack object. At present, only +instances of MGLTilePyramidOfflineRegion may be used as MGLOfflinePack +regions, but additional conforming implementations may be added in the future.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @protocol MGLOfflineRegion <NSObject>
    + +
    +
    +

    Swift

    + 
    protocol MGLOfflineRegion : NSObjectProtocol
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLOfflineStorage + +
    +
    +
    +
    +

    MGLOfflineStorage implements a singleton (shared object) that manages offline +packs. All of this class’s instance methods are asynchronous, reflecting the +fact that offline resources are stored in a database. The shared object +maintains a canonical collection of offline packs in its packs property.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLOfflineStorage : NSObject
    + +
    +
    +

    Swift

    + 
    class MGLOfflineStorage : NSObject
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLOfflinePack + +
    +
    +
    +
    +

    An MGLOfflinePack represents a collection of resources necessary for viewing +a region offline to a local database.

    + +

    To create an instance of MGLOfflinePack, use the ++[MGLOfflineStorage addPackForRegion:withContext:completionHandler:] method. +A pack created using -[MGLOfflinePack init] is immediately invalid.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLOfflinePack : NSObject
    + +
    +
    +

    Swift

    + 
    class MGLOfflinePack : NSObject
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    A structure containing information about an offline pack’s current download +progress.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    struct MGLOfflinePackProgress {}
    + +
    +
    +

    Swift

    + 
    struct MGLOfflinePackProgress
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + MGLOfflinePackState + +
    +
    +
    +
    +

    The state an offline pack is currently in.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum MGLOfflinePackState : NSInteger {}
    + +
    +
    +

    Swift

    + 
    enum MGLOfflinePackState : Int
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Other Categories.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Other Categories.html new file mode 100644 index 0000000000..7e9d0795f5 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Other Categories.html @@ -0,0 +1,720 @@ + + + + Other Categories Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + Other Categories Reference +
+
+ +
+ +
+ +
+
+

Other Categories

 +

The following categories are available globally.

+ +
+
+ +
+
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Other Classes.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Other Classes.html new file mode 100644 index 0000000000..88aec6310d --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Other Classes.html @@ -0,0 +1,668 @@ + + + + Other Classes Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + Other Classes Reference +
+
+ +
+ +
+ +
+
+

Other Classes

 +

The following classes are available globally.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + MGLAttributionInfo + +
    +
    +
    +
    +

    Information about an attribution statement, usually a copyright or trademark +statement, associated with a map content source.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLAttributionInfo : NSObject
    + +
    +
    +

    Swift

    + 
    class MGLAttributionInfo : NSObject
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLStyleConstantValue + +
    +
    +
    +
    +

    An MGLStyleConstantValue object is a generic container for a style attribute +value that remains constant as the zoom level changes. The layout and paint +attribute properties of MGLStyleLayer objects can be set to +MGLStyleConstantValue objects.

    + +

    The MGLStyleConstantValue class takes a generic parameter T that indicates +the Foundation class being wrapped by this class.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLStyleConstantValue <T> : MGLStyleValue<T>
    + +
    +
    +

    Swift

    + 
    class MGLStyleConstantValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + MGLStyleFunction + +
    +
    +
    +
    +

    An MGLStyleFunction is a value function defining a style value that changes +as the zoom level changes. The layout and paint attribute properties of an +MGLStyleLayer object can be set to MGLStyleFunction objects. Use a zoom +level function to create the illusion of depth and control data density.

    + +

    The MGLStyleFunction class takes a generic parameter T that indicates the +Foundation class being wrapped by this class.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLStyleFunction <T> : MGLStyleValue<T>
    + +
    +
    +

    Swift

    + 
    class MGLStyleFunction
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Other Constants.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Other Constants.html new file mode 100644 index 0000000000..a60ddb9a74 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Other Constants.html @@ -0,0 +1,1539 @@ + + + + Other Constants Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + Other Constants Reference +
+
+ +
+ +
+ +
+
+

Other Constants

 +

The following constants are available globally.

+ +
+
+ +
+
+
+ +
+
+
    +
  • + +
    +
    +
    +

    An NSNumber object containing a floating-point number that specifies the +width and height (measured in points) at which the map displays each raster +image tile when the map’s zoom level is an integer. The raster source scales +its images up or down when the map’s zoom level falls between two integers.

    + +

    The default value for this option is 512. Version 4 of the +Mapbox Maps API +requires a value of 256, as do many third-party tile servers, so consult your +provider’s documentation for the correct value.

    + +

    This option is only applicable to MGLRasterSource objects; it is ignored when +initializing MGLVectorSource objects.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern const MGLTileSourceOption _Nonnull MGLTileSourceOptionTileSize
    + +
    +
    +

    Swift

    + 
    static let tileSize: MGLTileSourceOption
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • + +
    +
    +
    +

    An NSNumber object containing a Boolean enabling or disabling clustering. +If the shape property contains point shapes, setting this option to +YES clusters the points by radius into groups. The default value is NO.

    + +

    This attribute corresponds to the +cluster +source property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern const MGLShapeSourceOption _Nonnull MGLShapeSourceOptionClustered
    + +
    +
    +

    Swift

    + 
    static let clustered: MGLShapeSourceOption
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    An NSNumber object containing an integer; specifies the radius of each +cluster if clustering is enabled. A value of 512 produces a radius equal to +the width of a tile. The default value is 50.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern const MGLShapeSourceOption _Nonnull MGLShapeSourceOptionClusterRadius
    + +
    +
    +

    Swift

    + 
    static let clusterRadius: MGLShapeSourceOption
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    An NSNumber object containing an integer; specifies the maximum zoom level at +which to cluster points if clustering is enabled. Defaults to one zoom level +less than the value of MGLShapeSourceOptionMaximumZoomLevel so that, at the +maximum zoom level, the shapes are not clustered.

    + +

    This attribute corresponds to the +clusterMaxZoom +source property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern const MGLShapeSourceOption _Nonnull MGLShapeSourceOptionMaximumZoomLevelForClustering
    + +
    +
    +

    Swift

    + 
    static let maximumZoomLevelForClustering: MGLShapeSourceOption
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    An NSNumber object containing an integer; specifies the maximum zoom level at +which to create vector tiles. A greater value produces greater detail at high +zoom levels. The default value is 18.

    + +

    This attribute corresponds to the +maxzoom +source property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern const MGLShapeSourceOption _Nonnull MGLShapeSourceOptionMaximumZoomLevel
    + +
    +
    +

    Swift

    + 
    static let maximumZoomLevel: MGLShapeSourceOption
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    An NSNumber object containing an integer; specifies the size of the tile +buffer on each side. A value of 0 produces no buffer. A value of 512 produces a +buffer as wide as the tile itself. Larger values produce fewer rendering +artifacts near tile edges and slower performance. The default value is 128.

    + +

    This attribute corresponds to the +buffer +source property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern const MGLShapeSourceOption _Nonnull MGLShapeSourceOptionBuffer
    + +
    +
    +

    Swift

    + 
    static let buffer: MGLShapeSourceOption
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    An NSNumber object containing a double; specifies the Douglas-Peucker +simplification tolerance. A greater value produces simpler geometries and +improves performance. The default value is 0.375.

    + +

    This attribute corresponds to the +tolerance +source property in the Mapbox Style Specification.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern const MGLShapeSourceOption _Nonnull MGLShapeSourceOptionSimplificationTolerance
    + +
    +
    +

    Swift

    + 
    static let simplificationTolerance: MGLShapeSourceOption
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • + +
    +
    +
    +

    A version number identifying the default version of the suite of default styles +provided by Mapbox. This version number may be passed into one of the +“StyleURLWithVersion” class methods of MGLStyle.

    + +

    The value of this constant generally corresponds to the latest released version +as of the date on which this SDK was published. You can use this constant to +ascertain the style used by MGLMapView and MGLTilePyramidOfflineRegion when +no style URL is specified. Consult the +Mapbox Styles API documentation +for the most up-to-date style versioning information.

    + +
    +

    Warning

    + The value of this constant may change in a future release of the SDK. +If you use any feature that depends on a specific aspect of a default style +– for instance, the minimum zoom level that includes roads – you may use the +current value of this constant or the underlying style URL, but do not use +the constant itself. Such details may change significantly from version to +version. + +
    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    static const NSInteger MGLStyleDefaultVersion = 9
    + +
    +
    +

    Swift

    + 
    let MGLStyleDefaultVersion: Int
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+ +
+
+
    +
  • +
    + + + + MGLErrorDomain + +
    +
    +
    +
    +

    Indicates an error occurred in the Mapbox SDK.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    extern const NSErrorDomain _Nonnull MGLErrorDomain
    + +
    +
    +

    Swift

    + 
    let MGLErrorDomain: String
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Other Enums.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Other Enums.html new file mode 100644 index 0000000000..6d4dee1ac5 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Other Enums.html @@ -0,0 +1,1314 @@ + + + + Other Enums Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + Other Enums Reference +
+
+ +
+ +
+ +
+
+

Other Enums

 +

The following enums are available globally.

+ +
+
+ +
+
+
+ +
+
+ +
+
+ +
+
+ +
+
+
    +
  • + +
    +
    +
    +

    Tile coordinate systems that determine how tile coordinates in tile URLs are +interpreted.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    enum MGLTileCoordinateSystem : NSUInteger {}
    + +
    +
    +

    Swift

    + 
    enum MGLTileCoordinateSystem : UInt
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Other Type Definitions.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Other Type Definitions.html new file mode 100644 index 0000000000..6ea33193ef --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Other Type Definitions.html @@ -0,0 +1,794 @@ + + + + Other Type Definitions Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + Other Type Definitions Reference +
+
+ +
+ +
+ +
+
+

Other Type Definitions

 +

The following type definitions are available globally.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +

    A key in the userInfo property of a notification posted by MGLOfflinePack.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef NSString *MGLOfflinePackUserInfoKey
    + +
    +
    +

    Swift

    + 
    struct MGLOfflinePackUserInfoKey : RawRepresentable, _SwiftNewtypeWrapper, Equatable, Hashable, Comparable, _ObjectiveCBridgeable
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    A block to be called once an offline pack has been completely created and +added.

    + +

    An application typically calls the -resume method on the pack inside this +completion handler to begin the download.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef void (^MGLOfflinePackAdditionCompletionHandler)(
+    MGLOfflinePack *_Nullable, NSError *_Nullable)
    + +
    +
    +

    Swift

    + 
    typealias MGLOfflinePackAdditionCompletionHandler = (MGLOfflinePack?, Error?) -> Void
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + pack + + +
    +

    Contains a pointer to the newly added pack, or nil if there was + an error creating or adding the pack.

    + +
    +
    + + error + + +
    +

    Contains a pointer to an error object (if any) indicating why the + pack could not be created or added.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    A block to be called once an offline pack has been completely invalidated and +removed.

    + +

    Avoid any references to the pack inside this completion handler: by the time +this completion handler is executed, the pack has become invalid, and any +messages passed to it will raise an exception.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef void (^MGLOfflinePackRemovalCompletionHandler)(NSError *_Nullable)
    + +
    +
    +

    Swift

    + 
    typealias MGLOfflinePackRemovalCompletionHandler = (Error?) -> Void
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + error + + +
    +

    Contains a pointer to an error object (if any) indicating why the + pack could not be invalidated or removed.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLShapeSourceOption + +
    +
    +
    +
    +

    Options for MGLShapeSource objects.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef NSString *MGLShapeSourceOption
    + +
    +
    +

    Swift

    + 
    struct MGLShapeSourceOption : RawRepresentable, _SwiftNewtypeWrapper, Equatable, Hashable, Comparable, _ObjectiveCBridgeable
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLTileSourceOption + +
    +
    +
    +
    +

    Options for MGLTileSource objects.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    typedef NSString *MGLTileSourceOption
    + +
    +
    +

    Swift

    + 
    struct MGLTileSourceOption : RawRepresentable, _SwiftNewtypeWrapper, Equatable, Hashable, Comparable, _ObjectiveCBridgeable
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Protocols/MGLAnnotation.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Protocols/MGLAnnotation.html new file mode 100644 index 0000000000..a7b4eb094e --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Protocols/MGLAnnotation.html @@ -0,0 +1,729 @@ + + + + MGLAnnotation Protocol Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLAnnotation Protocol Reference +
+
+ +
+ +
+ +
+
+

MGLAnnotation

 +
+
+ 
@protocol MGLAnnotation <NSObject>
+ +
+
+

The MGLAnnotation protocol is used to provide annotation-related information +to a map view. To use this protocol, you adopt it in any custom objects that +store or represent annotation data. Each object then serves as the source of +information about a single map annotation and provides critical information, +such as the annotation’s location on the map. Annotation objects do not provide +the visual representation of the annotation but typically coordinate (in +conjunction with the map view’s delegate) the creation of an appropriate +objects to handle the display.

+ +

An object that adopts this protocol must implement the coordinate property. +The other methods of this protocol are optional.

+ +
+
+ +
+
+
+
+ + + +

Position Attributes

+ +
+
    +
  • +
    + + + + coordinate + +
    +
    +
    +
    +

    The center point (specified as a map coordinate) of the annotation. (required) +(read-only)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) CLLocationCoordinate2D coordinate;
    + +
    +
    +

    Swift

    + 
    var coordinate: CLLocationCoordinate2D { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Title Attributes

+ +
+
    +
  • +
    + + + + title + +
    +
    +
    +
    +

    The string containing the annotation’s title.

    + +

    Although this property is optional, if you support the selection of annotations +in your map view, you are expected to provide this property. This string is +displayed in the callout for the associated annotation.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @optional
+@property (readonly, copy, nonatomic, nullable) NSString *title;
    + +
    +
    +

    Swift

    + 
    optional var title: String? { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + subtitle + +
    +
    +
    +
    +

    The string containing the annotation’s subtitle.

    + +

    This string is displayed in the callout for the associated annotation.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @optional
+@property (readonly, copy, nonatomic, nullable) NSString *subtitle;
    + +
    +
    +

    Swift

    + 
    optional var subtitle: String? { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + toolTip + +
    +
    +
    +
    +

    The string containing the annotation’s tooltip.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @optional
+@property (readonly, copy, nonatomic, nullable) NSString *toolTip;
    + +
    +
    +

    Swift

    + 
    optional var toolTip: String? { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Protocols/MGLFeature.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Protocols/MGLFeature.html new file mode 100644 index 0000000000..75cecb78bf --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Protocols/MGLFeature.html @@ -0,0 +1,801 @@ + + + + MGLFeature Protocol Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLFeature Protocol Reference +
+
+ +
+ +
+ +
+
+

MGLFeature

 +
+
+ 
@protocol MGLFeature <MGLAnnotation>
+ +
+
+

The MGLFeature protocol is used to provide details about geographic features +contained in an MGLShapeSource or MGLVectorSource object. Each concrete +subclass of MGLShape in turn has a subclass that conforms to this protocol. A +feature object associates a shape with an optional identifier and attributes.

+ +

You can add custom data to display on the map by creating feature objects and +adding them to an MGLShapeSource using the +-[MGLShapeSource initWithIdentifier:shape:options:] method or +MGLShapeSource.shape property. Similarly, you can add MGLPointFeature, +MGLPolylineFeature, and MGLPolygonFeature objects to the map as annotations +using -[MGLMapView addAnnotations:] and related methods.

+ +

In addition to adding data to the map, you can also extract data from the map: +-[MGLMapView visibleFeaturesAtPoint:] and related methods return feature +objects that correspond to features in the source. This enables you to inspect +the properties of features in vector tiles loaded by MGLVectorSource objects. +You also reuse these feature objects as overlay annotations.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + identifier + +
    +
    +
    +
    +

    An object that uniquely identifies the feature in its containing content +source.

    + +

    You can configure an MGLVectorStyleLayer object to include or exclude a +specific feature in an MGLShapeSource or MGLVectorSource. In the +MGLVectorStyleLayer.predicate property, compare the special $id attribute +to the feature’s identifier.

    + +

    In vector tiles loaded by MGLVectorSource objects, the identifier corresponds +to the +feature identifier +(id). If the source does not specify the feature’s identifier, the value of +this property is nil. If specified, the identifier may be an integer, +floating-point number, or string. These data types are mapped to instances of +the following Foundation classes:

    + + + + + + + + + + +
    In the tile sourceThis property
    Integer NSNumber (use the unsignedLongLongValue or longLongValue property)
    Floating-point number NSNumber (use the doubleValue property)
    String NSString
    + +

    For details about the identifiers used in most Mapbox-provided styles, consult +the +Mapbox Streets +layer reference.

    + +

    The identifier should be set before adding the feature to an MGLShapeSource +object; setting it afterwards has no effect on the map’s contents. While it is +possible to change this value on feature instances obtained from +-[MGLMapView visibleFeaturesAtPoint:] and related methods, doing so likewise +has no effect on the map’s contents.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readwrite, copy, nonatomic, nullable) id identifier;
    + +
    +
    +

    Swift

    + 
    var identifier: Any? { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + attributes + +
    +
    +
    +
    +

    A dictionary of attributes for this feature.

    + +

    You can configure an MGLVectorStyleLayer object to include or exclude a +specific feature in an MGLShapeSource or MGLVectorSource. In the +MGLVectorStyleLayer.predicate property, compare a key of the attribute +dictionary to the value you want to include. For example, if you want an +MGLLineStyleLayer object to display only important features, you might assign +a value above 50 to the important features’ importance attribute, then set +MGLVectorStyleLayer.predicate to an NSPredicate with the format +importance > 50.

    + +

    You can also configure some attributes of an MGLSymbolStyleLayer object to +include the value of an attribute in this dictionary whenever it renders this +feature. For example, to label features in an MGLShapeSource object by their +names, you can assign a name attribute to each of the source’s features, then +set MGLSymbolStyleLayer.textField to an MGLStyleValue object containing the +string {name}.

    + +

    In vector tiles loaded by MGLVectorSource objects, the keys and values of +each feature’s attribute dictionary are determined by the source. Each +attribute name is a string, while each attribute value may be a null value, +Boolean value, integer, floating-point number, or string. These data types are +mapped to instances of the following Foundation classes:

    + + + + + + + + + + + + +
    In the tile sourceIn this dictionary
    Null NSNull
    Boolean NSNumber (use the boolValue property)
    Integer NSNumber (use the unsignedLongLongValue or longLongValue property)
    Floating-point number NSNumber (use the doubleValue property)
    String NSString
    + +

    For details about the attribute names and values found in Mapbox-provided +vector tile sources, consult the +Mapbox Streets +and +Mapbox Terrain +layer references.

    + +

    Note that while it is possible to change this value on feature +instances obtained from -[MGLMapView visibleFeaturesAtPoint:] and related +methods, there will be no effect on the map. Setting this value can be useful +when the feature instance is used to initialize an MGLShapeSource and that +source is added to the map and styled.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readwrite, copy, nonatomic)
+    NSDictionary<NSString *, id> *_Nonnull attributes;
    + +
    +
    +

    Swift

    + 
    var attributes: [String : Any] { get set }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -attributeForKey: + +
    +
    +
    +
    +

    Returns the feature attribute for the given attribute name.

    + +

    See the attributes property’s documentation for details on keys and values +associated with this method.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nullable id)attributeForKey:(nonnull NSString *)key;
    + +
    +
    +

    Swift

    + 
    func attribute(forKey key: String) -> Any?
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + -geoJSONDictionary + +
    +
    +
    +
    +

    Returns a dictionary that can be serialized as a GeoJSON Feature representation +of an instance of an MGLFeature subclass.

    + +

    The dictionary includes a geometry key corresponding to the receiver’s +underlying geometry data, a properties key corresponding to the receiver’s +attributes property, and an id key corresponding to the receiver’s +identifier property.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull NSDictionary<NSString *, id> *)geoJSONDictionary;
    + +
    +
    +

    Swift

    + 
    func geoJSONDictionary() -> [String : Any]
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Protocols/MGLMapViewDelegate.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Protocols/MGLMapViewDelegate.html new file mode 100644 index 0000000000..dcbff6458a --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Protocols/MGLMapViewDelegate.html @@ -0,0 +1,1930 @@ + + + + MGLMapViewDelegate Protocol Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLMapViewDelegate Protocol Reference +
+
+ +
+ +
+ +
+
+

MGLMapViewDelegate

 +
+
+ 
@protocol MGLMapViewDelegate <NSObject>
+ +
+
+

The MGLMapViewDelegate protocol defines a set of optional methods that you +can use to receive messages from an MGLMapView instance. Because many map +operations require the MGLMapView class to load data asynchronously, the map +view calls these methods to notify your application when specific operations +complete. The map view also uses these methods to request information about +annotations displayed on the map, such as the styles and interaction modes to +apply to individual annotations.

+ +
+
+ +
+
+
+
+ + + +

Responding to Map Viewpoint Changes

+ +
+
    +
  • + +
    +
    +
    +

    Tells the delegate that the viewpoint depicted by the map view is about to +change.

    + +

    This method is called whenever the currently displayed map camera will start +changing for any reason.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)mapView:(nonnull MGLMapView *)mapView
+    cameraWillChangeAnimated:(BOOL)animated;
    + +
    +
    +

    Swift

    + 
    optional func mapView(_ mapView: MGLMapView, cameraWillChangeAnimated animated: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + mapView + + +
    +

    The map view whose viewpoint will change.

    + +
    +
    + + animated + + +
    +

    Whether the change will cause an animated effect on the map.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Tells the delegate that the viewpoint depicted by the map view is changing.

    + +

    This method is called as the currently displayed map camera changes as part of +an animation, whether due to a user gesture or due to a call to a method such +as -[MGLMapView setCamera:animated:]. During the animation, this method may +be called many times to report updates to the viewpoint. Therefore, your +implementation of this method should be as lightweight as possible to avoid +affecting performance.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)mapViewCameraIsChanging:(nonnull MGLMapView *)mapView;
    + +
    +
    +

    Swift

    + 
    optional func mapViewCameraIsChanging(_ mapView: MGLMapView)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + mapView + + +
    +

    The map view whose viewpoint is changing.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Tells the delegate that the viewpoint depicted by the map view has finished +changing.

    + +

    This method is called whenever the currently displayed map camera has finished +changing, after any calls to -mapViewRegionIsChanging: due to animation.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)mapView:(nonnull MGLMapView *)mapView
+    cameraDidChangeAnimated:(BOOL)animated;
    + +
    +
    +

    Swift

    + 
    optional func mapView(_ mapView: MGLMapView, cameraDidChangeAnimated animated: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + mapView + + +
    +

    The map view whose viewpoint has changed.

    + +
    +
    + + animated + + +
    +

    Whether the change caused an animated effect on the map.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Loading the Map

+ +
+
    +
  • + +
    +
    +
    +

    Tells the delegate that the map view will begin to load.

    + +

    This method is called whenever the map view starts loading, including when a +new style has been set and the map must reload.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)mapViewWillStartLoadingMap:(nonnull MGLMapView *)mapView;
    + +
    +
    +

    Swift

    + 
    optional func mapViewWillStartLoadingMap(_ mapView: MGLMapView)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + mapView + + +
    +

    The map view that is starting to load.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Tells the delegate that the map view has finished loading.

    + +

    This method is called whenever the map view finishes loading, either after the +initial load or after a style change has forced a reload.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)mapViewDidFinishLoadingMap:(nonnull MGLMapView *)mapView;
    + +
    +
    +

    Swift

    + 
    optional func mapViewDidFinishLoadingMap(_ mapView: MGLMapView)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + mapView + + +
    +

    The map view that has finished loading.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Tells the delegate that the map view was unable to load data needed for +displaying the map.

    + +

    This method may be called for a variety of reasons, including a network +connection failure or a failure to fetch the style from the server. You can use +the given error message to notify the user that map data is unavailable.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)mapViewDidFailLoadingMap:(nonnull MGLMapView *)mapView
+                       withError:(nonnull NSError *)error;
    + +
    +
    +

    Swift

    + 
    optional func mapViewDidFailLoadingMap(_ mapView: MGLMapView, withError error: Error)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + mapView + + +
    +

    The map view that is unable to load the data.

    + +
    +
    + + error + + +
    +

    The reason the data could not be loaded.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Tells the delegate that the map view is about to redraw.

    + +

    This method is called any time the map view needs to redraw due to a change in +the viewpoint or style property transition. This method may be called very +frequently, even moreso than -mapViewRegionIsChanging:. Therefore, your +implementation of this method should be as lightweight as possible to avoid +affecting performance.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)mapViewWillStartRenderingFrame:(nonnull MGLMapView *)mapView;
    + +
    +
    +

    Swift

    + 
    optional func mapViewWillStartRenderingFrame(_ mapView: MGLMapView)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + mapView + + +
    +

    The map view that is about to redraw.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Tells the delegate that the map view has just redrawn.

    + +

    This method is called any time the map view needs to redraw due to a change in +the viewpoint or style property transition. This method may be called very +frequently, even moreso than -mapViewRegionIsChanging:. Therefore, your +implementation of this method should be as lightweight as possible to avoid +affecting performance.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)mapViewDidFinishRenderingFrame:(nonnull MGLMapView *)mapView
+                         fullyRendered:(BOOL)fullyRendered;
    + +
    +
    +

    Swift

    + 
    optional func mapViewDidFinishRenderingFrame(_ mapView: MGLMapView, fullyRendered: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + mapView + + +
    +

    The map view that has just redrawn.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Tells the delegate that the map has just finished loading a style.

    + +

    This method is called during the initialization of the map view and after any +subsequent loading of a new style. This method is called between the +-mapViewWillStartRenderingMap: and -mapViewDidFinishRenderingMap: delegate +methods. Changes to sources or layers of the current style do not cause this +method to be called.

    + +

    This method is the earliest opportunity to modify the layout or appearance of +the current style before the map view is displayed to the user.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)mapView:(nonnull MGLMapView *)mapView
+    didFinishLoadingStyle:(nonnull MGLStyle *)style;
    + +
    +
    +

    Swift

    + 
    optional func mapView(_ mapView: MGLMapView, didFinishLoadingStyle style: Any!)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + mapView + + +
    +

    The map view that has just loaded a style.

    + +
    +
    + + style + + +
    +

    The style that was loaded.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Managing the Appearance of Annotations

+ +
+
    +
  • + +
    +
    +
    +

    Returns an annotation image object to mark the given point annotation object on +the map.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nullable MGLAnnotationImage *)mapView:(nonnull MGLMapView *)mapView
+                      imageForAnnotation:(nonnull id<MGLAnnotation>)annotation;
    + +
    +
    +

    Swift

    + 
    optional func mapView(_ mapView: MGLMapView, imageForAnnotation annotation: Any) -> MGLAnnotationImage?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + mapView + + +
    +

    The map view that requested the annotation image.

    + +
    +
    + + annotation + + +
    +

    The object representing the annotation that is about to be + displayed.

    + +
    +
    +
    +
    +

    Return Value

    +

    The image object to display for the given annotation or nil if you + want to display the default marker image.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns the alpha value to use when rendering a shape annotation.

    + +

    A value of 0.0 results in a completely transparent shape. A value of 1.0, the +default, results in a completely opaque shape.

    + +

    This method sets the opacity of an entire shape, inclusive of its stroke and +fill. To independently set the values for stroke or fill, specify an alpha +component in the color returned by -mapView:strokeColorForShapeAnnotation: or +-mapView:fillColorForPolygonAnnotation:.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (CGFloat)mapView:(nonnull MGLMapView *)mapView
+    alphaForShapeAnnotation:(nonnull MGLShape *)annotation;
    + +
    +
    +

    Swift

    + 
    optional func mapView(_ mapView: MGLMapView, alphaForShapeAnnotation annotation: MGLShape) -> CGFloat
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + mapView + + +
    +

    The map view rendering the shape annotation.

    + +
    +
    + + annotation + + +
    +

    The annotation being rendered.

    + +
    +
    +
    +
    +

    Return Value

    +

    An alpha value between 0 and 1.0.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns the color to use when rendering the outline of a shape annotation.

    + +

    The default stroke color is the selected menu item color. If a pattern color is +specified, the result is undefined.

    + +

    Opacity may be set by specifying an alpha component. The default alpha value is +1.0 and results in a completely opaque stroke.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull NSColor *)mapView:(nonnull MGLMapView *)mapView
+    strokeColorForShapeAnnotation:(nonnull MGLShape *)annotation;
    + +
    +
    +

    Swift

    + 
    optional func mapView(_ mapView: MGLMapView, strokeColorForShapeAnnotation annotation: MGLShape) -> Any!
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + mapView + + +
    +

    The map view rendering the shape annotation.

    + +
    +
    + + annotation + + +
    +

    The annotation being rendered.

    + +
    +
    +
    +
    +

    Return Value

    +

    A color to use for the shape outline.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns the color to use when rendering the fill of a polygon annotation.

    + +

    The default fill color is the selected menu item color. If a pattern color is +specified, the result is undefined.

    + +

    Opacity may be set by specifying an alpha component. The default alpha value is +1.0 and results in a completely opaque shape.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nonnull NSColor *)mapView:(nonnull MGLMapView *)mapView
+    fillColorForPolygonAnnotation:(nonnull MGLPolygon *)annotation;
    + +
    +
    +

    Swift

    + 
    optional func mapView(_ mapView: MGLMapView, fillColorForPolygonAnnotation annotation: MGLPolygon) -> Any!
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + mapView + + +
    +

    The map view rendering the polygon annotation.

    + +
    +
    + + annotation + + +
    +

    The annotation being rendered.

    + +
    +
    +
    +
    +

    Return Value

    +

    The polygon’s interior fill color.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns the line width in points to use when rendering the outline of a +polyline annotation.

    + +

    By default, the polyline is outlined with a line 3.0 points wide.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (CGFloat)mapView:(nonnull MGLMapView *)mapView
+    lineWidthForPolylineAnnotation:(nonnull MGLPolyline *)annotation;
    + +
    +
    +

    Swift

    + 
    optional func mapView(_ mapView: MGLMapView, lineWidthForPolylineAnnotation annotation: MGLPolyline) -> CGFloat
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + mapView + + +
    +

    The map view rendering the polygon annotation.

    + +
    +
    + + annotation + + +
    +

    The annotation being rendered.

    + +
    +
    +
    +
    +

    Return Value

    +

    A line width for the polyline, measured in points.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Selecting Annotations

+ +
+
    +
  • + +
    +
    +
    +

    Tells the delegate that one of its annotations has been selected.

    + +

    You can use this method to track changes to the selection state of annotations.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)mapView:(nonnull MGLMapView *)mapView
+    didSelectAnnotation:(nonnull id<MGLAnnotation>)annotation;
    + +
    +
    +

    Swift

    + 
    optional func mapView(_ mapView: MGLMapView, didSelectAnnotation annotation: Any)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + mapView + + +
    +

    The map view containing the annotation.

    + +
    +
    + + annotation + + +
    +

    The annotation that was selected.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Tells the delegate that one of its annotations has been deselected.

    + +

    You can use this method to track changes in the selection state of annotations.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (void)mapView:(nonnull MGLMapView *)mapView
+    didDeselectAnnotation:(nonnull id<MGLAnnotation>)annotation;
    + +
    +
    +

    Swift

    + 
    optional func mapView(_ mapView: MGLMapView, didDeselectAnnotation annotation: Any)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + mapView + + +
    +

    The map view containing the annotation.

    + +
    +
    + + annotation + + +
    +

    The annotation that was deselected.

    + +
    +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ + + +

Managing Callout Popovers

+ +
+
    +
  • + +
    +
    +
    +

    Returns a Boolean value indicating whether the annotation is able to display +extra information in a callout popover.

    + +

    This method is called after an annotation is selected, before any callout is +displayed for the annotation.

    + +

    If the return value is YES, a callout popover is shown when the user clicks +on an annotation, selecting it. The default callout displays the annotation’s +title and subtitle. You can customize the popover’s contents by implementing +the -mapView:calloutViewControllerForAnnotation: method.

    + +

    If the return value is NO, or if this method is absent from the delegate, or +if the annotation lacks a title, the annotation will not show a callout even +when selected.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (BOOL)mapView:(nonnull MGLMapView *)mapView
+    annotationCanShowCallout:(nonnull id<MGLAnnotation>)annotation;
    + +
    +
    +

    Swift

    + 
    optional func mapView(_ mapView: MGLMapView, annotationCanShowCallout annotation: Any) -> Bool
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + mapView + + +
    +

    The map view that has selected the annotation.

    + +
    +
    + + annotation + + +
    +

    The object representing the annotation.

    + +
    +
    +
    +
    +

    Return Value

    +

    A Boolean value indicating whether the annotation should show a + callout.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns a view controller to manage the callout popover’s content view.

    + +

    Like any instance of NSPopover, an annotation callout manages its contents +with a view controller. The annotation object is the view controller’s +represented object. This means that you can bind controls in the view +controller’s content view to KVO-compliant properties of the annotation object, +such as title and subtitle.

    + +

    If each annotation should have an identical callout, you can set the +MGLMapView.calloutViewController property instead.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (nullable NSViewController *)mapView:(nonnull MGLMapView *)mapView
+    calloutViewControllerForAnnotation:(nonnull id<MGLAnnotation>)annotation;
    + +
    +
    +

    Swift

    + 
    optional func mapView(_ mapView: MGLMapView, calloutViewControllerForAnnotation annotation: Any) -> Any!
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + mapView + + +
    +

    The map view that is requesting a callout view controller.

    + +
    +
    + + annotation + + +
    +

    The object representing the annotation.

    + +
    +
    +
    +
    +

    Return Value

    +

    A view controller for the given annotation.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Protocols/MGLOverlay.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Protocols/MGLOverlay.html new file mode 100644 index 0000000000..f5233c2462 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Protocols/MGLOverlay.html @@ -0,0 +1,698 @@ + + + + MGLOverlay Protocol Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLOverlay Protocol Reference +
+
+ +
+ +
+ +
+
+

MGLOverlay

 +
+
+ 
@protocol MGLOverlay <MGLAnnotation>
+ +
+
+

The MGLOverlay protocol defines a specific type of annotation that represents +both a point and an area on a map. Overlay objects are essentially data objects +that contain the geographic data needed to represent the map area. Overlays can +take the form of a polyline or polygon.

+ +

You use overlays to layer more sophisticated content on top of a map view. For +example, you could use an overlay to show the boundaries of a national park or +trace a bus route along city streets. This SDK defines several concrete classes +that conform to this protocol and define standard shapes.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + coordinate + +
    +
    +
    +
    +

    A coordinate representing the overlay. (required) (read-only)

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) CLLocationCoordinate2D coordinate;
    + +
    +
    +

    Swift

    + 
    var coordinate: CLLocationCoordinate2D { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + overlayBounds + +
    +
    +
    +
    +

    The cooordinate rectangle that encompasses the overlay. (required) (read-only)

    + +

    This property contains the smallest rectangle that completely encompasses the +overlay. Implementers of this protocol must set this area when implementing +their overlay class, and after setting it, you must not change it.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @property (readonly, nonatomic) MGLCoordinateBounds overlayBounds;
    + +
    +
    +

    Swift

    + 
    var overlayBounds: MGLCoordinateBounds { get }
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    Returns a Boolean indicating whether the specified rectangle intersects the +receiver’s shape.

    + +

    You can implement this method to provide more specific bounds checking for an +overlay. If you do not implement it, the bounding rectangle is used to detect +intersections.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    - (BOOL)intersectsOverlayBounds:(MGLCoordinateBounds)overlayBounds;
    + +
    +
    +

    Swift

    + 
    func intersects(_ overlayBounds: MGLCoordinateBounds) -> Bool
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + overlayBounds + + +
    +

    The rectangle to intersect with the receiver’s area.

    + +
    +
    +
    +
    +

    Return Value

    +

    YES if any part of the map rectangle intersects the receiver’s shape + or NO if it does not.

    + +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Shapes and Annotations.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Shapes and Annotations.html new file mode 100644 index 0000000000..9c5b6b58ff --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Shapes and Annotations.html @@ -0,0 +1,1226 @@ + + + + Shapes and Annotations Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + Shapes and Annotations Reference +
+
+ +
+ +
+ +
+
+

Shapes and Annotations

 + +
+
+ +
+
+
+
    +
  • +
    + + + + MGLAnnotation + +
    +
    +
    +
    +

    The MGLAnnotation protocol is used to provide annotation-related information +to a map view. To use this protocol, you adopt it in any custom objects that +store or represent annotation data. Each object then serves as the source of +information about a single map annotation and provides critical information, +such as the annotation’s location on the map. Annotation objects do not provide +the visual representation of the annotation but typically coordinate (in +conjunction with the map view’s delegate) the creation of an appropriate +objects to handle the display.

    + +

    An object that adopts this protocol must implement the coordinate property. +The other methods of this protocol are optional.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @protocol MGLAnnotation <NSObject>
    + +
    +
    +

    Swift

    + 
    protocol MGLAnnotation : NSObjectProtocol
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLAnnotationImage + +
    +
    +
    +
    +

    The MGLAnnotationImage class is responsible for presenting point-based +annotations visually on an MGLMapView instance. Annotation image objects pair +NSImage objects with annotation-related metadata. They may be recycled later +and put into a reuse queue that is maintained by the map view.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLAnnotationImage : NSObject <NSSecureCoding>
    + +
    +
    +

    Swift

    + 
    class MGLAnnotationImage : NSObject, NSSecureCoding
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLOverlay + +
    +
    +
    +
    +

    The MGLOverlay protocol defines a specific type of annotation that represents +both a point and an area on a map. Overlay objects are essentially data objects +that contain the geographic data needed to represent the map area. Overlays can +take the form of a polyline or polygon.

    + +

    You use overlays to layer more sophisticated content on top of a map view. For +example, you could use an overlay to show the boundaries of a national park or +trace a bus route along city streets. This SDK defines several concrete classes +that conform to this protocol and define standard shapes.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @protocol MGLOverlay <MGLAnnotation>
    + +
    +
    +

    Swift

    + 
    protocol MGLOverlay : MGLAnnotation
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+ +
+
+
    +
  • +
    + + + + MGLMultiPoint + +
    +
    +
    +
    +

    The MGLMultiPoint class is an abstract superclass used to define shapes +composed of multiple vertices.

    + +

    You do not create instances of this class directly. Instead, you create +instances of the MGLPolyline or MGLPolygon classes. However, you can use +the method and properties of this class to access information about the +vertices of the line or polygon.

    + +

    Do not confuse MGLMultiPoint with MGLPointCollection, which represents a +collection of related but disconnected points.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLMultiPoint : MGLShape
    + +
    +
    +

    Swift

    + 
    class MGLMultiPoint : MGLShape
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+ +
+
+ +
+
+ +
+
+ +
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Structs/MGLCoordinateBounds.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Structs/MGLCoordinateBounds.html new file mode 100644 index 0000000000..348f5bbf05 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Structs/MGLCoordinateBounds.html @@ -0,0 +1,619 @@ + + + + MGLCoordinateBounds Struct Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLCoordinateBounds Struct Reference +
+
+ +
+ +
+ +
+
+

MGLCoordinateBounds

 +
+
+ 
struct MGLCoordinateBounds {}
+ +
+
+

A rectangular area as measured on a two-dimensional map projection.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + sw + +
    +
    +
    +
    +

    Coordinate at the southwest corner.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    CLLocationCoordinate2D sw
    + +
    +
    +

    Swift

    + 
    var sw: CLLocationCoordinate2D
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + ne + +
    +
    +
    +
    +

    Coordinate at the northeast corner.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    CLLocationCoordinate2D ne
    + +
    +
    +

    Swift

    + 
    var ne: CLLocationCoordinate2D
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Structs/MGLCoordinateSpan.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Structs/MGLCoordinateSpan.html new file mode 100644 index 0000000000..ae98e40872 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Structs/MGLCoordinateSpan.html @@ -0,0 +1,619 @@ + + + + MGLCoordinateSpan Struct Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLCoordinateSpan Struct Reference +
+
+ +
+ +
+ +
+
+

MGLCoordinateSpan

 +
+
+ 
struct MGLCoordinateSpan {}
+ +
+
+

Defines the area spanned by an MGLCoordinateBounds.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Structs/MGLOfflinePackProgress.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Structs/MGLOfflinePackProgress.html new file mode 100644 index 0000000000..1c85a02f87 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Structs/MGLOfflinePackProgress.html @@ -0,0 +1,776 @@ + + + + MGLOfflinePackProgress Struct Reference + + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + MGLOfflinePackProgress Struct Reference +
+
+ +
+ +
+ +
+
+

MGLOfflinePackProgress

 +
+
+ 
struct MGLOfflinePackProgress {}
+ +
+
+

A structure containing information about an offline pack’s current download +progress.

+ +
+
+ +
+
+
+
    +
  • + +
    +
    +
    +

    The number of resources, including tiles, that have been completely +downloaded and are ready to use offline.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    uint64_t countOfResourcesCompleted
    + +
    +
    +

    Swift

    + 
    var countOfResourcesCompleted: UInt64
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + countOfBytesCompleted + +
    +
    +
    +
    +

    The cumulative size of the downloaded resources on disk, including tiles, +measured in bytes.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    uint64_t countOfBytesCompleted
    + +
    +
    +

    Swift

    + 
    var countOfBytesCompleted: UInt64
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • +
    + + + + countOfTilesCompleted + +
    +
    +
    +
    +

    The number of tiles that have been completely downloaded and are ready +to use offline.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    uint64_t countOfTilesCompleted
    + +
    +
    +

    Swift

    + 
    var countOfTilesCompleted: UInt64
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    The cumulative size of the downloaded tiles on disk, measured in bytes.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    uint64_t countOfTileBytesCompleted
    + +
    +
    +

    Swift

    + 
    var countOfTileBytesCompleted: UInt64
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    The minimum number of resources that must be downloaded in order to view +the pack’s full region without any omissions.

    + +

    At the beginning of a download, this count is a lower bound; the number of +expected resources may increase as the download progresses.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    uint64_t countOfResourcesExpected
    + +
    +
    +

    Swift

    + 
    var countOfResourcesExpected: UInt64
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
  • + +
    +
    +
    +

    The maximum number of resources that must be downloaded in order to view +the pack’s full region without any omissions.

    + +

    At the beginning of a download, when the exact number of required resources +is unknown, this field is set to UINT64_MAX. Thus this count is always an +upper bound.

    + +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    uint64_t maximumResourcesExpected
    + +
    +
    +

    Swift

    + 
    var maximumResourcesExpected: UInt64
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Style Layers.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Style Layers.html new file mode 100644 index 0000000000..0ab8bf8416 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Style Layers.html @@ -0,0 +1,1057 @@ + + + + Style Layers Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + Style Layers Reference +
+
+ +
+ +
+ +
+
+

Style Layers

 + +
+
+ +
+
+
+
    +
  • +
    + + + + MGLStyleLayer + +
    +
    +
    +
    +

    MGLStyleLayer is an abstract base class for style layers. A style layer +manages the layout and appearance of content at a specific z-index in a style. +An MGLStyle object consists of one or more MGLStyleLayer objects.

    + +

    Each style layer defined by the style JSON file is represented at runtime by an +MGLStyleLayer object, which you can use to refine the map’s appearance. You +can also add and remove style layers dynamically.

    + +

    Do not create instances of this class directly, and do not create your own +subclasses of this class. Instead, create instances of +MGLBackgroundStyleLayer and the concrete subclasses of +MGLForegroundStyleLayer.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLStyleLayer : NSObject
    + +
    +
    +

    Swift

    + 
    class MGLStyleLayer : NSObject
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
    +
    +

    An MGLBackgroundStyleLayer is a style layer that covers the entire map. Use a +background style layer to configure a color or pattern to show below all other +map content. If the style’s other layers use the Mapbox Streets source, the +background style layer is responsible for drawing land, whereas the oceans and +other bodies of water are drawn by MGLFillStyleLayer objects.

    + +

    A background style layer is typically the bottommost layer in a style, because +it covers the entire map and can occlude any layers below it. You can therefore +access it by getting the last item in the MGLStyle.layers array.

    + +

    If the background style layer is transparent or omitted from the style, any +portion of the map view that does not show another style layer is transparent.

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLBackgroundStyleLayer : MGLStyleLayer
    + +
    +
    +

    Swift

    + 
    class MGLBackgroundStyleLayer : MGLStyleLayer
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLRasterStyleLayer + +
    +
    +
    +
    +

    An MGLRasterStyleLayer is a style layer that renders raster tiles on the map.

    + +

    Use a raster style layer to configure the color parameters of raster tiles +loaded by an MGLRasterSource object. For example, you could use a raster +style layer to render Mapbox +Satellite imagery, a raster tile +set uploaded to Mapbox Studio, or a raster map authored in TileMill, the classic +Mapbox Editor, or Mapbox Studio Classic.

    + +

    You can access an existing raster style layer using the +-[MGLStyle layerWithIdentifier:] method if you know its identifier; +otherwise, find it using the MGLStyle.layers property. You can also create a +new raster style layer and add it to the style using a method such as +-[MGLStyle addLayer:].

    + +

    Example

    +
    let layer = MGLRasterStyleLayer(identifier: clouds, source: source)
+layer.rasterOpacity = MGLStyleValue(rawValue: 0.5)
+mapView.style?.addLayer(layer)
+

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLRasterStyleLayer : MGLForegroundStyleLayer
    + +
    +
    +

    Swift

    + 
    class MGLRasterStyleLayer : MGLForegroundStyleLayer
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+ +
+
+
    +
  • +
    + + + + MGLCircleStyleLayer + +
    +
    +
    +
    +

    An MGLCircleStyleLayer is a style layer that renders one or more filled +circles on the map.

    + +

    Use a circle style layer to configure the visual appearance of point or point +collection features in vector tiles loaded by an MGLVectorSource object or +MGLPointAnnotation, MGLPointFeature, MGLPointCollection, or +MGLPointCollectionFeature instances in an MGLShapeSource object.

    + +

    A circle style layer renders circles whose radii are measured in screen units. +To display circles on the map whose radii correspond to real-world distances, +use many-sided regular polygons and configure their appearance using an +MGLFillStyleLayer object.

    + +

    You can access an existing circle style layer using the +-[MGLStyle layerWithIdentifier:] method if you know its identifier; +otherwise, find it using the MGLStyle.layers property. You can also create a +new circle style layer and add it to the style using a method such as +-[MGLStyle addLayer:].

    + +

    Example

    +
    let layer = MGLCircleStyleLayer(identifier: circles, source: population)
+layer.sourceLayerIdentifier = population
+layer.circleColor = MGLStyleValue(rawValue: .green)
+layer.circleRadius = MGLStyleValue(interpolationBase: 1.75, stops: [
+    12: MGLStyleValue(rawValue: 2),
+    22: MGLStyleValue(rawValue: 180)
+])
+layer.circleOpacity = MGLStyleValue(rawValue: 0.7)
+layer.predicate = NSPredicate(format: %K == %@, marital-status, married)
+mapView.style?.addLayer(layer)
+

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLCircleStyleLayer : MGLVectorStyleLayer
    + +
    +
    +

    Swift

    + 
    class MGLCircleStyleLayer : MGLVectorStyleLayer
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+ +
+
+
    +
  • +
    + + + + MGLLineStyleLayer + +
    +
    +
    +
    +

    An MGLLineStyleLayer is a style layer that renders one or more stroked +polylines on the map.

    + +

    Use a line style layer to configure the visual appearance of polyline or +multipolyline features in vector tiles loaded by an MGLVectorSource object or +MGLPolyline, MGLPolylineFeature, MGLMultiPolyline, or +MGLMultiPolylineFeature instances in an MGLShapeSource object.

    + +

    You can access an existing line style layer using the +-[MGLStyle layerWithIdentifier:] method if you know its identifier; +otherwise, find it using the MGLStyle.layers property. You can also create a +new line style layer and add it to the style using a method such as +-[MGLStyle addLayer:].

    + +

    Example

    +
    let layer = MGLLineStyleLayer(identifier: trails-path, source: trails)
+layer.sourceLayerIdentifier = trails
+layer.lineWidth = MGLStyleValue(interpolationBase: 1.5, stops: [
+    14: MGLStyleValue(rawValue: 2),
+    18: MGLStyleValue(rawValue: 20),
+])
+layer.lineColor = MGLStyleValue(rawValue: .brown)
+layer.lineCap = MGLStyleValue(rawValue: NSValue(mglLineCap: .round))
+layer.predicate = NSPredicate(format: %K == %@, trail-type, mountain-biking)
+mapView.style?.addLayer(layer)
+

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLLineStyleLayer : MGLVectorStyleLayer
    + +
    +
    +

    Swift

    + 
    class MGLLineStyleLayer : MGLVectorStyleLayer
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
    +
  • +
    + + + + MGLSymbolStyleLayer + +
    +
    +
    +
    +

    An MGLSymbolStyleLayer is a style layer that renders icon and text labels at +points or along lines on the map.

    + +

    Use a symbol style layer to configure the visual appearance of labels for +features in vector tiles loaded by an MGLVectorSource object or MGLShape or +MGLFeature instances in an MGLShapeSource object.

    + +

    You can access an existing symbol style layer using the +-[MGLStyle layerWithIdentifier:] method if you know its identifier; +otherwise, find it using the MGLStyle.layers property. You can also create a +new symbol style layer and add it to the style using a method such as +-[MGLStyle addLayer:].

    + +

    Example

    +
    let layer = MGLSymbolStyleLayer(identifier: coffeeshops, source: pois)
+layer.sourceLayerIdentifier = pois
+layer.iconImageName = MGLStyleValue(rawValue: coffee)
+layer.iconScale = MGLStyleValue(rawValue: 0.5)
+layer.text = MGLStyleValue(rawValue: {name})
+layer.textTranslation = MGLStyleValue(rawValue: NSValue(cgVector: CGVector(dx: 10, dy: 0)))
+layer.textJustification = MGLStyleValue(rawValue: NSValue(mglTextJustification: .left))
+layer.textAnchor = MGLStyleValue(rawValue: NSValue(mglTextAnchor: .left))
+layer.predicate = NSPredicate(format: %K == %@, venue-type, coffee)
+mapView.style?.addLayer(layer)
+

    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLSymbolStyleLayer : MGLVectorStyleLayer
    + +
    +
    +

    Swift

    + 
    class MGLSymbolStyleLayer : MGLVectorStyleLayer
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Styling the Map.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Styling the Map.html new file mode 100644 index 0000000000..063376ae31 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/Styling the Map.html @@ -0,0 +1,653 @@ + + + + Styling the Map Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + Styling the Map Reference +
+
+ +
+ +
+ +
+
+

Styling the Map

 + +
+
+ +
+
+
+ +
+
+
    +
  • +
    + + + + MGLStyleValue + +
    +
    +
    +
    +

    An MGLStyleValue object is a generic container for a style attribute value. +The layout and paint attribute properties of MGLStyleLayer can be set to +MGLStyleValue objects.

    + +

    The MGLStyleValue class itself represents a class cluster. Under the hood, a +particular MGLStyleValue object may be either an MGLStyleConstantValue to +represent a constant value or an MGLStyleFunction to represent a value +function. Do not initialize an MGLStyleValue object directly; instead, use +one of the class factory methods to create an MGLStyleValue object.

    + +

    The MGLStyleValue class takes a generic parameter T that indicates the +Foundation class being wrapped by this class. Common values for T include:

    + +
      +
    • NSNumber (for Boolean values and floating-point numbers)
      • +
    • NSValue (for CGVector, NSEdgeInsets, UIEdgeInsets, and enumerations)
      • +
    • NSString
      • +
    • NSColor or UIColor
      • +
    • NSArray
      • +
    + + See more +
    +
    +

    Declaration

    +
    +

    Objective-C

    + 
    @interface MGLStyleValue <T> : NSObject
    + +
    +
    +

    Swift

    + 
    class MGLStyleValue
    + +
    +
    +
    + + + View Source on GitHub + +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/css/highlight.css b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/css/highlight.css new file mode 100644 index 0000000000..8db1704115 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/css/highlight.css @@ -0,0 +1,187 @@ +/* Rouge Syntax Highlighting, Mapbox Base style +------------------------------------------------------- */ +.highlight .hll { + background-color: #ffffcc; } + +/* No Styling, Just Default: + .highlight .nx, Normal Text + .highlight .ni Name.Entity + .highlight .nf Name.Entity + .highlight .no Name.Constant +*/ +/* Comments */ +.highlight .o, +.highlight .c, +.highlight .c1, +.highlight .cp, +.highlight .cm { + color: #999; + font-style: italic; } + +.highlight .err { + color: #F00000; + background-color: #F0A0A0; } + +/* Error */ +.highlight .k { + color: #404040; + font-weight: bold; } + +/* Keyword */ +.highlight .css .k { + font-weight: normal; } + +.highlight .cs { + color: #404040; + font-style: italic; } + +/* Comment.Special */ +.highlight .gd { + color: #A00000; } + +/* Generic.Deleted */ +.highlight .ge { + font-style: italic; } + +/* Generic.Emph */ +.highlight .gs { + font-weight: bold; } + +/* Generic.Strong */ +.highlight .gr { + color: #FF0000; } + +/* Generic.Error */ +.highlight .gh { + color: #000080; } + +/* Generic.Heading */ +.highlight .gi { + color: #00A000; } + +/* Generic.Inserted */ +.highlight .go { + color: #808080; } + +/* Generic.Output */ +.highlight .gp { + color: #c65d09; } + +/* Generic.Prompt */ +.highlight .gu { + color: #800080; } + +/* Generic.Subheading */ +.highlight .gt { + color: #0040D0; } + +/* Generic.Traceback */ +.highlight .kc { + color: #D24400; } + +/* Keyword.Constant */ +/* Keyword.Declaration + * Keyword.Namespace + * Keyword.Reserved */ +.highlight .kd, +.highlight .kn, +.highlight .kr, +.highlight .nt { + color: #0B5A91; } + +/* Name.Tag */ +/* Literal.Number */ +.highlight .mh, +.highlight .mo, +.highlight .il, +.highlight .mi, +.highlight .kt, +.highlight .mf, +.highlight .nl, +.highlight .na, +.highlight .m { + color: #0C9DC2; } + +/* Keyword.Type */ +.highlight .kp { + color: #0080f0; } + +/* Keyword.Pseudo */ +.highlight .nc { + color: #DF6637; } + +/* Name.Class */ +.highlight .css .nc { + color: #75A21C; } + +.highlight .nd { + color: #505050; } + +/* Name.Decorator */ +.highlight .ne { + color: #F00000; } + +/* Name.Exception */ +.highlight .nn { + color: #0e84b5; } + +/* Name.Namespace */ +.highlight .nf, +.highlight .nv { + color: #003060; } + +/* Name.Variable */ +.highlight .ow { + color: #404040; } + +/* Operator.Word */ +.highlight .w { + color: #bbbbbb; } + +/* Text.Whitespace */ +.highlight .sc { + color: #8080F0; } + +/* Literal.String.Char */ +.highlight .sd { + color: #D04020; } + +/* Literal.String.Doc */ +/* Name.Builtin / Name.Builtin.Pseudo */ +.highlight .bp, +.highlight .nb { + color: #007020; } + +/* Literal.String */ +.highlight .s, +.highlight .sh, +.highlight .sb, +.highlight .s1, +.highlight .sr, +.highlight .se { + color: #75A21C; } + +.highlight .si { + background-color: #eee; } + +/* Literal.String.Interpol */ +.highlight .p { + color: #444444; } + +/* Normal Text */ +.highlight .ss { + color: #f0c080; } + +/* Literal.String.Symbol */ +.highlight .vc { + color: #c0c0f0; } + +/* Name.Variable.Class */ +.highlight .vg { + color: #f08040; } + +/* Name.Variable.Global */ +.highlight .vi { + color: #a0a0f0; } + +/* Name.Variable.Instance */ diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/css/jazzy.css b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/css/jazzy.css new file mode 100644 index 0000000000..de35538af3 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/css/jazzy.css @@ -0,0 +1,493 @@ +*, *:before, *:after { + box-sizing: inherit; } + +body { + margin: 0; + background: #fff; + color: #0B293A; + font: 14px/25px "Open Sans", "Helvetica Neue", Helvetica, Arial, sans-serif; + -webkit-font-smoothing: antialiased; + box-sizing: border-box; } + +h1 { + font-family: "Open Sans Bold", "Helvetica Neue", Helvetica, Arial, sans-serif; + font-size: 1.7rem; + font-weight: normal; + color: #0B293A; + margin: 0.5em 0 0.6em; } + +h1 a { + color: #0B293A; } + +h2 { + font-family: "Open Sans Bold", "Helvetica Neue", Helvetica, Arial, sans-serif; + font-size: 1.5rem; + font-weight: normal; + color: #0B293A; + margin: 1em 0 0.6em; } + +h3 { + font-family: "Open Sans Bold", "Helvetica Neue", Helvetica, Arial, sans-serif; + font-size: 14px; + font-weight: normal; + color: #0B293A; + margin: 1em 0 0.3em; } + +h4 { + font-family: "Open Sans Bold", "Helvetica Neue", Helvetica, Arial, sans-serif; + font-size: 1rem; + font-weight: normal; + color: #0B293A; + margin: 1.275em 0 0.85em; } + +h5, h6 { + font-family: "Open Sans Bold", "Helvetica Neue", Helvetica, Arial, sans-serif; + font-size: 1rem; + font-weight: normal; + color: #0B293A; + margin: 1.275em 0 0.85em; } + +p { + margin: 0 0 1em; } + +ul, ol { + padding: 0 0 0 1.5em; + margin: 0 0 0.85em; } + +ul.item-container { + padding: 0px; } + +ul:first-of-type, +ol:first-of-type { + margin: 0px; } + +blockquote { + margin: 0 0 0.85em; + padding: 0 15px; + color: #858585; + border-left: 4px solid #e5e5e5; } + +img { + max-width: 100%; } + +a { + color: #3887BE; + text-decoration: none; } + a > *:hover, a:hover, a:focus { + opacity: 0.7; } + a:focus { + box-shadow: inset 0 0 0 1px rgba(0, 0, 0, 0.05); } + +table { + background: #fff; + width: 100%; + font-size: 13px; + line-height: 23px; + border-collapse: collapse; + border-spacing: 0; + overflow: auto; + margin: 0 0 0.85em; } + +th, td { + padding: 6px 13px; + border: 1px solid rgba(12, 40, 73, 0.08); } + +pre { + margin: 0 0 1.275em; + padding: .85em 1em; + overflow: auto; + background: #F5F8FC; + font-family: Menlo, Bitstream Vera Sans Mono, Monaco, Consolas, monospacee; + border-radius: 4px; } + +code { + font-family: Menlo, Bitstream Vera Sans Mono, Monaco, Consolas, monospacee; + font-size: 13px; + line-height: .85em; } + +p > code, li > code { + background: #F5F8FC; + padding: 0.1em 0.2em; + font-weight: bold; + border: 1px solid #D5D5D5; + border-radius: 4px; } + +td > code, +.graybox code { + font-weight: bold; + font-size: 12px; } + +pre code { + padding: 0; + white-space: pre; } + +.content-wrapper { + display: flex; + flex-direction: column; } + @media (min-width: 768px) { + .content-wrapper { + flex-direction: row; } } + +.limiter { + max-width: 1360px; + margin: auto; + padding: 0px 30px; } + +.space-right2 { + margin-right: 20px; } + +.header-container { + background: #3A68D8; } + +.header { + display: flex; + padding: 12px 0px; + font-size: 12px; + color: #999; } + @media (max-width: 768px) { + .header { + display: block; } } + +.header-tag { + vertical-align: text-top; + line-height: 10px; + background: rgba(255, 255, 255, 0.1); + border-radius: 4px; + padding: 2px 5px; + margin-left: 5px; + opacity: 0.9; } + +.header-col { + margin: 5px 0 0 0; + padding: 0; } + +.header-col--primary { + flex: 1; } + +.header-link { + font-family: "Open Sans Bold", "Helvetica Neue", Helvetica, Arial, sans-serif; + color: #fff; } + +.header-image, .header-icon { + padding-right: 2px; + vertical-align: -4px; + height: 16px; } + +.breadcrumbs { + font-size: 13px; + padding: 8px 0px; + margin: 0; + background: #F5F8FC; + border-bottom: 1px solid rgba(12, 40, 73, 0.08); } + +.carat { + height: 10px; + margin: 0 5px; } + +.navigation { + order: 2; + font-size: 13px; + padding-top: 20px; } + @media (min-width: 768px) { + .navigation { + order: 1; + width: 25%; + min-width: 175px; + max-width: 300px; + padding-bottom: 64px; + line-height: 20px; + overflow: hidden; + border-right: 1px solid rgba(12, 40, 73, 0.08); } } + +.nav-groups { + list-style-type: none; + padding-left: 0; } + +.nav-group-name { + padding: 8px 0 8px 0px; } + +.small-heading, h4 { + font-size: 13px; + font-family: "Open Sans Bold", "Helvetica Neue", Helvetica, Arial, sans-serif; + text-transform: uppercase; + color: #0B293A; + letter-spacing: 1px; } + +.nav-group-tasks { + margin: 8px 0; + padding: 0 0 0 0; } + +.nav-group-task { + font-size: 1em; + list-style-type: none; + white-space: nowrap; + overflow: hidden; + text-overflow: ellipsis; + color: #3887BE; } + +.nav-group-task[data-url^="Protocols/"] > .nav-group-task-link::after, .nav-group-task[data-name="MGLForegroundStyleLayer"] .nav-group-task-link::after, +.nav-group-task[data-name="MGLMultiPoint"] .nav-group-task-link::after, +.nav-group-task[data-name="MGLShape"] .nav-group-task-link::after, +.nav-group-task[data-name="MGLSource"] .nav-group-task-link::after, +.nav-group-task[data-name="MGLStyleLayer"] .nav-group-task-link::after, +.nav-group-task[data-name="MGLTileSource"] .nav-group-task-link::after, +.nav-group-task[data-name="MGLVectorStyleLayer"] .nav-group-task-link::after { + color: #999; + font-size: 90%; + margin-left: 0.5em; } + +.nav-group-task[data-url^="Protocols/"] > .nav-group-task-link::after { + content: "(Protocol)"; } + +.nav-group-task[data-name="MGLForegroundStyleLayer"] .nav-group-task-link::after, +.nav-group-task[data-name="MGLMultiPoint"] .nav-group-task-link::after, +.nav-group-task[data-name="MGLShape"] .nav-group-task-link::after, +.nav-group-task[data-name="MGLSource"] .nav-group-task-link::after, +.nav-group-task[data-name="MGLStyleLayer"] .nav-group-task-link::after, +.nav-group-task[data-name="MGLTileSource"] .nav-group-task-link::after, +.nav-group-task[data-name="MGLVectorStyleLayer"] .nav-group-task-link::after { + content: "(Abstract Class)"; } + +.nav-group-name > .small-heading, +.nav-group-task-link { + display: block; } + +.nav-group-task-link { + color: rgba(11, 41, 58, 0.75); } + +.main-content { + order: 1; } + @media (min-width: 768px) { + .main-content { + order: 2; + flex: 1; + padding-bottom: 60px; + max-width: 80%; } } + +.section { + padding: 0px 20px; } + @media (max-width: 768px) { + .section { + padding: inherit; } } + +.section-content { + margin: 0 auto; + padding: 16px 0; + border-bottom: 1px solid rgba(12, 40, 73, 0.08); } + +.section-content img { + margin: 0 auto; } + +.section-name { + color: #0B293A; + display: block; } + +.anchor-icon { + margin-left: 4px; + opacity: 0.7; + display: inline-block; + background: url("../img/link.svg"); + background-repeat: no-repeat; + width: 10px; + height: 10px; } + +h1 > .anchor-icon { + margin-bottom: 2px; } + +.declaration .highlight { + font-size: 15px; + overflow-x: initial; + padding: 8px 0; + line-height: 20px; + margin: 0; + background-color: transparent; + border: none; } + +.highlight a { + text-decoration: underline; } + +.task-group-section { + border-top: 1px solid #ddd; } + +.task-group { + padding-top: 0px; } + +.task-name-container a[name]:before { + content: ""; + display: block; } + +.item { + width: 100%; + list-style-type: none; } + .item a[name]:before { + content: ""; + display: block; } + .item .token { + margin-left: 0px; + font-size: 13px; + display: flex; + padding: 5px 0px; + line-height: 14px; } + .item .token-name { + display: inline-block; + white-space: nowrap; + overflow: hidden; + text-overflow: ellipsis; } + .item .token-icon { + background: url("../img/plus.svg"); + width: 17px; + display: inline-block; + vertical-align: middle; + height: 13px; + opacity: 1; + margin-left: 5px; + background-repeat: no-repeat; } + .item .token-icon-minus { + background: url("../img/minus.svg"); + background-repeat: no-repeat; } + .item .declaration-note { + font-size: 13px; + color: #808080; + font-style: italic; } + +.pointer-container { + border-bottom: 1px solid #ddd; + left: -23px; + padding-bottom: 13px; + position: relative; + width: 110%; } + +.pointer { + left: 21px; + top: 7px; + display: block; + position: absolute; + width: 12px; + height: 12px; + border-left: 1px solid #ddd; + border-top: 1px solid #ddd; + background: #fdfeff; + transform: rotate(45deg); } + +.height-container { + display: none; + position: relative; + width: 100%; + overflow: hidden; } + .height-container .section { + background: #fdfeff; + border: 1px solid rgba(12, 40, 73, 0.08); + padding: 15px 20px; + border-radius: 4px; + margin: 10px 0px 30px; } + +.aside, .language { + padding: 6px 12px; + margin: 12px 0; + border-left: 4px solid #dddddd; + overflow-y: hidden; } + .aside .aside-title, .language .aside-title { + font-size: 10px; + font-family: "Open Sans Bold", "Helvetica Neue", Helvetica, Arial, sans-serif; + letter-spacing: 2px; + text-transform: uppercase; + padding: 2px 8px; + display: inline; + border-radius: 4px; + margin: 0; + -webkit-user-select: none; } + .aside p:last-child, .language p:last-child { + margin-bottom: 0; } + +.language { + background: #F5F8FC; + border-radius: 4px; + border-left: 4px solid #3A68D8; } + +.aside.aside-see, .aside.aside-note { + background: #F5F8FC; + border-radius: 4px; } + .aside.aside-see .aside-title, .aside.aside-note .aside-title { + padding-left: 0px; } + +.aside-warning { + border-left: 4px solid #ff6666; } + .aside-warning .aside-title { + color: #ff0000; } + +.graybox { + width: 100%; + border-collapse: separate; + border: solid rgba(12, 40, 73, 0.08) 1px; + border-radius: 6px; + -moz-border-radius: 6px; } + .graybox p { + margin: 0; + word-break: break-word; + min-width: 50px; } + .graybox td { + padding: 5px 25px 5px 10px; + vertical-align: middle; } + .graybox tr td:first-of-type { + text-align: right; + padding: 7px; + vertical-align: top; + word-break: normal; + width: 40px; + border-left: none; + border-top: none; } + .graybox th, .graybox td { + border-right: none; + border-top: none; } + .graybox td:first-child, .graybox th:first-child { + border-left: none; } + .graybox tr:last-of-type td { + border-bottom: none; } + +.show-on-github-icon { + width: 16px; + display: inline-block !important; + vertical-align: -3px; + padding-left: 2px; } + +.show-on-github a { + margin: 10px 0 10px; + display: inline-block; + font-size: 13px; } + +.footer { + border-top: 1px rgba(12, 40, 73, 0.08) solid; + padding: 8px 16px; + color: #888; } + .footer p { + display: inline; } + .footer a { + color: #555; } + +html.dash .header, html.dash .breadcrumbs, html.dash .navigation { + display: none; } +html.dash .height-container { + display: block; } + +@font-face { + font-family: 'Open Sans'; + src: url("../fonts/opensans-regular.eot"); + src: url("../fonts/opensans-regular.eot#iefix") format("embedded-opentype"), url("../fonts/opensans-regular.woff") format("woff"); } +@font-face { + font-family: 'Open Sans Bold'; + src: url("../fonts/opensans-bold.eot"); + src: url("../fonts/opensans-bold.eot#iefix") format("embedded-opentype"), url("../fonts/opensans-bold.woff") format("woff"); } +.strong { + font-family: "Open Sans Bold", "Helvetica Neue", Helvetica, Arial, sans-serif; } + +.text-purple { + color: #9595D1; } + +.text-blue { + color: #4092C5; } + +.keyline-purple { + border-color: #9595D1; } + +.keyline-blue { + border-color: #4092C5; } diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/fonts/opensans-bold.eot b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/fonts/opensans-bold.eot new file mode 100755 index 0000000000..7d99f603d7 Binary files /dev/null and b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/fonts/opensans-bold.eot differ diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/fonts/opensans-bold.woff b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/fonts/opensans-bold.woff new file mode 100755 index 0000000000..005fadcd02 Binary files /dev/null and b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/fonts/opensans-bold.woff differ diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/fonts/opensans-regular.eot b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/fonts/opensans-regular.eot new file mode 100755 index 0000000000..73abfc002d Binary files /dev/null and b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/fonts/opensans-regular.eot differ diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/fonts/opensans-regular.woff b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/fonts/opensans-regular.woff new file mode 100755 index 0000000000..af925a255a Binary files /dev/null and b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/fonts/opensans-regular.woff differ diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/for-style-authors.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/for-style-authors.html new file mode 100644 index 0000000000..ec481e4f87 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/for-style-authors.html @@ -0,0 +1,1195 @@ + + + + For Style Authors Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + For Style Authors Reference +
+
+ +
+ +
+ +
+
+ + +

Information for Style Authors

+ +

A style defines a map view’s content and appearance. If you’ve authored a +style using +Mapbox Studio’s Styles editor or as +JSON in a text editor, you can use that style in this SDK and manipulate it +afterwards in code. This document provides information you can use to ensure a +seamless transition from Mapbox Studio to your application.

+

Designing for macOS

+ +

When designing your style, consider the context in which your application shows +the style. There are a number of considerations specific to macOS that may +not be obvious when designing your style in Mapbox Studio on the Web. A map view +is essentially a graphical user interface element, so many of same issues in +user interface design also apply when designing a map style.

+

Color

+ +

Ensure sufficient contrast in your application’s user interface when your map +style is present. Standard user interface elements such as toolbars, sidebars, +and sheets often overlap the map view with a translucent, blurred background, so +make sure the contents of these elements remain legible with the map view +underneath.

+

Typography and graphics

+ +

Design sprite images and choose font weights that look crisp on both +standard-resolution displays and Retina displays. This SDK supports the same +resolutions as macOS. +Standard-resolution displays are often found on external monitors. Even with +built-in screens, some of your users may use the Larger Text option in Display +Preferences, which is essentially standard resolution, to make text easier to +read.

+ +

Icon and text labels should be legible regardless of the map’s orientation. +By default, this SDK makes it easy for your users to rotate or tilt the map +using multitouch trackpad gestures or keyboard shortcuts. +If you do not intend your design to accommodate rotation and tilting, disable +these gestures using the MGLMapView.rotateEnabled and +MGLMapView.pitchEnabled properties, respectively, or the corresponding +inspectables in Interface Builder.

+

Interactivity

+ +

Pay attention to whether elements of your style appear to be interactive. +An icon with a shadow or shading effect may appear to be clickable. +You can make an icon or text label interactive by installing a gesture +recognizer and performing feature querying (e.g., +-[MGLMapView visibleFeaturesAtPoint:]) to get details about the selected +feature. +You can install cursor or tooltip tracking rectangles to indicate interactive +features as an alternative to prominent hover effects.

+ +

Make sure your users can easily distinguish any interactive elements from the +surrounding map, such as pins or a route line. If your application supports +printing, consider using the +runtime styling API to optimize your style +for ink economy before printing the map view.

+ +

For more information about user interface design, consult Apple’s +macOS Human Interface Guidelines.

+

Applying your style

+ +

You set an MGLMapView object’s style either in code, by setting the +MGLMapView.styleURL property, or in Interface Builder, by setting the “Style +URL” inspectable. The URL must point to a local or remote style JSON file. The +style JSON file format is defined by the +Mapbox Style Specification. This +SDK supports the functionality defined by version 8 of the specification unless +otherwise noted in the +style specification documentation.

+

Manipulating the style at runtime

+ +

The runtime styling API enables you to modify every aspect of a style +dynamically as a user interacts with your application. The style itself is +represented at runtime by an MGLStyle object, which provides access to various +MGLSource and MGLStyleLayer objects that represent content sources and style +layers, respectively.

+ +

The names of runtime styling classes and properties on macOS are generally +consistent with the style specification and Mapbox Studio’s Styles editor. Any +exceptions are listed in this document.

+ +

To avoid conflicts with Objective-C keywords or Cocoa terminology, this SDK uses +the following terms for concepts defined in the style specification:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
In the style specificationIn the SDK
classstyle class
filterpredicate
ididentifier
imagestyle image
layerstyle layer
propertyattribute
SDF icontemplate image
sourcecontent source
+

Specifying the map’s content

+ +

Each source defined by a style JSON file is represented at runtime by a content +source object that you can use to initialize new style layers. The content +source object is a member of one of the following subclasses of MGLSource:

+ + + + + + + + + + + + + + + + + + + +
In style JSONIn the SDK
geojsonMGLShapeSource
rasterMGLRasterSource
vectorMGLVectorSource
+ +

image and video sources are not supported.

+

Tile sources

+ +

Raster and vector sources may be defined in TileJSON configuration files. This +SDK supports the properties defined in the style specification, which are a +subset of the keys defined in version 2.1.0 of the +TileJSON +specification. As an alternative to authoring a custom TileJSON file, you may +supply various tile source options when creating a raster or vector source. +These options are detailed in the MGLTileSourceOption documentation:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
In style JSONIn TileJSONIn the SDK
url—configurationURL parameter in -[MGLTileSource initWithIdentifier:configurationURL:]
tilestilestileURLTemplates parameter in -[MGLTileSource initWithIdentifier:tileURLTemplates:options:]
minzoomminzoomMGLTileSourceOptionMinimumZoomLevel
maxzoommaxzoomMGLTileSourceOptionMaximumZoomLevel
tileSize—MGLTileSourceOptionTileSize
attributionattributionMGLTileSourceOptionAttributionHTMLString (but consider specifying MGLTileSourceOptionAttributionInfos instead for improved security)
schemeschemeMGLTileSourceOptionTileCoordinateSystem
+

Shape sources

+ +

Shape sources also accept various options. These options are detailed in the +MGLShapeSourceOption documentation:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
In style JSONIn the SDK
dataurl parameter in -[MGLShapeSource initWithIdentifier:URL:options:]
maxzoomMGLShapeSourceOptionMaximumZoomLevel
bufferMGLShapeSourceOptionBuffer
toleranceMGLShapeSourceOptionSimplificationTolerance
clusterMGLShapeSourceOptionClustered
clusterRadiusMGLShapeSourceOptionClusterRadius
clusterMaxZoomMGLShapeSourceOptionMaximumZoomLevelForClustering
+ +

To create a shape source from local GeoJSON data, first +convert the GeoJSON data into a shape, +then use the -[MGLShapeSource initWithIdentifier:shape:options:] method.

+

Configuring the map content’s appearance

+ +

Each layer defined by the style JSON file is represented at runtime by a style +layer object, which you can use to refine the map’s appearance. The style layer +object is a member of one of the following subclasses of MGLStyleLayer:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
In style JSONIn the SDK
backgroundMGLBackgroundStyleLayer
circleMGLCircleStyleLayer
fillMGLFillStyleLayer
lineMGLLineStyleLayer
rasterMGLRasterStyleLayer
symbolMGLSymbolStyleLayer
+ +

You configure layout and paint attributes by setting properties on these style +layer objects. The property names generally correspond to the style JSON +properties, except for the use of camelCase instead of kebab-case. Properties +whose names differ from the style specification are listed below:

+

Circle style layers

+ + + + + + + + + + + + + + + + + + + + + + + +
In style JSONIn Objective-CIn Swift
circle-pitch-scaleMGLCircleStyleLayer.circleScaleAlignmentMGLCircleStyleLayer.circleScaleAlignment
circle-translateMGLCircleStyleLayer.circleTranslationMGLCircleStyleLayer.circleTranslation
circle-translate-anchorMGLCircleStyleLayer.circleTranslationAnchorMGLCircleStyleLayer.circleTranslationAnchor
+

Fill style layers

+ + + + + + + + + + + + + + + + + + + + + + + +
In style JSONIn Objective-CIn Swift
fill-antialiasMGLFillStyleLayer.fillAntialiasedMGLFillStyleLayer.isFillAntialiased
fill-translateMGLFillStyleLayer.fillTranslationMGLFillStyleLayer.fillTranslation
fill-translate-anchorMGLFillStyleLayer.fillTranslationAnchorMGLFillStyleLayer.fillTranslationAnchor
+

Line style layers

+ + + + + + + + + + + + + + + + + + + + + + + +
In style JSONIn Objective-CIn Swift
line-dasharrayMGLLineStyleLayer.lineDashPatternMGLLineStyleLayer.lineDashPattern
line-translateMGLLineStyleLayer.lineTranslationMGLLineStyleLayer.lineTranslation
line-translate-anchorMGLLineStyleLayer.lineTranslationAnchorMGLLineStyleLayer.lineTranslationAnchor
+

Raster style layers

+ + + + + + + + + + + + + + + + + + + + + + + +
In style JSONIn Objective-CIn Swift
raster-brightness-maxMGLRasterStyleLayer.maximumRasterBrightnessMGLRasterStyleLayer.maximumRasterBrightness
raster-brightness-minMGLRasterStyleLayer.minimumRasterBrightnessMGLRasterStyleLayer.minimumRasterBrightness
raster-hue-rotateMGLRasterStyleLayer.rasterHueRotationMGLRasterStyleLayer.rasterHueRotation
+

Symbol style layers

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
In style JSONIn Objective-CIn Swift
icon-allow-overlapMGLSymbolStyleLayer.iconAllowsOverlapMGLSymbolStyleLayer.iconAllowsOverlap
icon-ignore-placementMGLSymbolStyleLayer.iconIgnoresPlacementMGLSymbolStyleLayer.iconIgnoresPlacement
icon-imageMGLSymbolStyleLayer.iconImageNameMGLSymbolStyleLayer.iconImageName
icon-optionalMGLSymbolStyleLayer.iconOptionalMGLSymbolStyleLayer.isIconOptional
icon-rotateMGLSymbolStyleLayer.iconRotationMGLSymbolStyleLayer.iconRotation
icon-sizeMGLSymbolStyleLayer.iconScaleMGLSymbolStyleLayer.iconScale
icon-keep-uprightMGLSymbolStyleLayer.keepsIconUprightMGLSymbolStyleLayer.keepsIconUpright
text-keep-uprightMGLSymbolStyleLayer.keepsTextUprightMGLSymbolStyleLayer.keepsTextUpright
text-max-angleMGLSymbolStyleLayer.maximumTextAngleMGLSymbolStyleLayer.maximumTextAngle
text-max-widthMGLSymbolStyleLayer.maximumTextWidthMGLSymbolStyleLayer.maximumTextWidth
symbol-avoid-edgesMGLSymbolStyleLayer.symbolAvoidsEdgesMGLSymbolStyleLayer.symbolAvoidsEdges
text-fieldMGLSymbolStyleLayer.textMGLSymbolStyleLayer.text
text-allow-overlapMGLSymbolStyleLayer.textAllowsOverlapMGLSymbolStyleLayer.textAllowsOverlap
text-fontMGLSymbolStyleLayer.textFontNamesMGLSymbolStyleLayer.textFontNames
text-sizeMGLSymbolStyleLayer.textFontSizeMGLSymbolStyleLayer.textFontSize
text-ignore-placementMGLSymbolStyleLayer.textIgnoresPlacementMGLSymbolStyleLayer.textIgnoresPlacement
text-justifyMGLSymbolStyleLayer.textJustificationMGLSymbolStyleLayer.textJustification
text-optionalMGLSymbolStyleLayer.textOptionalMGLSymbolStyleLayer.isTextOptional
text-rotateMGLSymbolStyleLayer.textRotationMGLSymbolStyleLayer.textRotation
icon-translateMGLSymbolStyleLayer.iconTranslationMGLSymbolStyleLayer.iconTranslation
icon-translate-anchorMGLSymbolStyleLayer.iconTranslationAnchorMGLSymbolStyleLayer.iconTranslationAnchor
text-translateMGLSymbolStyleLayer.textTranslationMGLSymbolStyleLayer.textTranslation
text-translate-anchorMGLSymbolStyleLayer.textTranslationAnchorMGLSymbolStyleLayer.textTranslationAnchor
+

Setting attribute values

+ +

Each property representing a layout or paint attribute is set to an +MGLStyleValue object, which is either an MGLStyleConstantValue object (for +constant values) or an MGLStyleFunction object (for zoom level functions). The +style value object is a container for the raw value or function parameters that +you want the attribute to be set to.

+ +

In contrast to the JSON type that the style specification defines for each +layout or paint property, the style value object often contains a more specific +Foundation or Cocoa type. General rules for attribute types are listed below. +Pay close attention to the SDK documentation for the attribute you want to get +or set.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
In style JSONIn Objective-CIn Swift
ColorNSColorNSColor
EnumNSValue (see NSValue(MGLAdditions))NSValue (see NSValue(MGLAdditions))
StringNSStringString
BooleanNSNumber.boolValueBool
NumberNSNumber.floatValueFloat
Array (-dasharray)NSArray<NSNumber>[Float]
Array (-font)NSArray<NSString>[String]
Array (-offset, -translate)NSValue containing CGVectorNSValue containing CGVector
Array (-padding)NSValue.edgeInsetsValueNSValue.edgeInsetsValue
+ +

For padding attributes, note that the arguments to +NSEdgeInsetsMake() in Objective-C and +EdgeInsets(top:left:bottom:right:) in Swift are specified in counterclockwise +order, in contrast to the clockwise order defined by the style specification.

+ +

Additionally, on macOS, a screen coordinate of (0, 0) is located at the +lower-left corner of the screen. Therefore, a positive CGVector.dy means an +offset or translation upward, while a negative CGVector.dy means an offset or +translation downward. This is the reverse of how CGVector is interpreted on +iOS.

+

Filtering sources

+ +

You can filter a shape or vector source by setting the +MGLVectorStyleLayer.predicate property to an NSPredicate object. Below is a +table of style JSON operators and the corresponding operators used in the +predicate format string:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
In style JSONIn the format string
["has", key]key != nil
["!has", key]key == nil
["==", key, value]key == value
["!=", key, value]key != value
[">", key, value]key > value
[">=", key, value]key >= value
["<", key, value]key < value
["<=", key, value]key <= value
["in", key, v0, …, vn]key IN {v0, …, vn}
["!in", key, v0, …, vn]NOT key IN {v0, …, vn}
["all", f0, …, fn]p0 AND … AND pn
["any", f0, …, fn]p0 OR … OR pn
["none", f0, …, fn]NOT (p0 OR … OR pn)
+ +

See the MGLVectorStyleLayer.predicate documentation for a full description of +the supported operators and operand types.

+ +
+
+ + +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/img/carat.png b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/img/carat.png new file mode 100755 index 0000000000..29d2f7fd49 Binary files /dev/null and b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/img/carat.png differ diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/img/dash.png b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/img/dash.png new file mode 100755 index 0000000000..6f694c7a01 Binary files /dev/null and b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/img/dash.png differ diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/img/github.svg b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/img/github.svg new file mode 100644 index 0000000000..5b2fa95ab7 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/img/github.svg @@ -0,0 +1,4 @@ + + + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/img/link.svg b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/img/link.svg new file mode 100644 index 0000000000..7053b958b4 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/img/link.svg @@ -0,0 +1,12 @@ + + + + Page 1 Copy + Created with Sketch. + + + + + + + \ No newline at end of file diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/img/mapbox.svg b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/img/mapbox.svg new file mode 100644 index 0000000000..a0c1ee44a4 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/img/mapbox.svg @@ -0,0 +1,21 @@ + + + + layer1 + Created with Sketch. + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/img/minus.svg b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/img/minus.svg new file mode 100644 index 0000000000..432a468d82 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/img/minus.svg @@ -0,0 +1,12 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/img/plus.svg b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/img/plus.svg new file mode 100644 index 0000000000..77338665e5 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/img/plus.svg @@ -0,0 +1,12 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/img/screenshot.jpg b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/img/screenshot.jpg new file mode 100644 index 0000000000..5341a3d6f0 Binary files /dev/null and b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/img/screenshot.jpg differ diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/index.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/index.html new file mode 100644 index 0000000000..d45104485d --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/index.html @@ -0,0 +1,657 @@ + + + + Mapbox macOS SDK Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + Mapbox macOS SDK Reference +
+
+ +
+ +
+ +
+
+ +

Mapbox macOS SDK

+ +

Put interactive, scalable world maps into your native Cocoa application with the open-source Mapbox macOS SDK.

+ +
    +
  • Mapbox-curated map styles and vector tiles make it easy to get started.
    • +
  • Customize every aspect of the map’s appearance in code or visually using Mapbox Studio.
    • +
  • High-performance OpenGL rendering and multitouch gestures keep your users happy.
    • +
  • A well-designed, fully documented API helps you stay productive.
    • +
  • Develop across multiple platforms, including iOS, using the same styles and similar APIs.
    • +
+ +

The Mapbox macOS SDK is compatible with macOS 10.10.0 and above for Cocoa applications developed in Objective-C, Swift, Interface Builder, or AppleScript. For hybrid applications, consider Mapbox GL JS.

+ +

+ +

Mapbox macOS SDK releases are available on GitHub – look for the releases that begin with “macos-”. You can also integrate the Mapbox macOS SDK into your application using CocoaPods.

+

Installation

+ +
    +

  1. Open the project editor, select your application target, then go to the General tab. Drag Mapbox.framework from the dynamic folder into the “Embedded Binaries” section. (Don’t drag it into the “Linked Frameworks and Libraries” section; Xcode will add it there automatically.) In the sheet that appears, make sure “Copy items if needed” is checked, then click Finish.

    2. +

  2. Mapbox vector tiles require a Mapbox account and API access token. In the project editor, select the application target, then go to the Info tab. Under the “Custom macOS Target Properties” section, set MGLMapboxAccessToken to your access token. You can obtain an access token from the Mapbox account page.

    3. +
+

Usage

+ +

In a storyboard or XIB, add a view to your view controller. (Drag Custom View from the Object library to the View Controller scene on the Interface Builder canvas.) In the Identity inspector, set the view’s custom class to MGLMapView. If you need to manipulate the map view programmatically:

+ +
    +
  1. Switch to the Assistant Editor.
    2. +
  2. Import the Mapbox module.
    3. +
  3. Connect the map view to a new outlet in your view controller class. (Control-drag from the map view in Interface Builder to a valid location in your view controller implementation.) The resulting outlet declaration should look something like this:
    4. +
+
// ViewController.m
+@import Mapbox;
+
+@interface ViewController : NSViewController
+
+@property (strong) IBOutlet MGLMapView *mapView;
+
+@end
+
+
// ViewController.swift
+import Mapbox
+
+class ViewController: NSViewController {
+    @IBOutlet var mapView: MGLMapView!
+}
+
+
-- AppDelegate.applescript
+script AppDelegate
+    property parent : class "NSObject"
+    property theMapView : missing value
+end script
+
+ +

Full API documentation is included in this package, within the documentation folder, and online. The Mapbox iOS SDK’s API documentation and online examples apply to the Mapbox macOS SDK with few differences, mostly around unimplemented features like user location tracking.

+ +

Mapbox does not officially support the macOS SDK to the same extent as the iOS SDK; however, bug reports and pull requests are certainly welcome.

+

Changes in version 0.3.0

+ +

This version of the Mapbox macOS SDK corresponds to version 3.4.0 of the Mapbox iOS SDK. The two SDKs have very similar feature sets. The main differences are the lack of user location tracking and annotation views. Some APIs have been adapted to macOS conventions, particularly the use of NSPopover for callout views.

+

Packaging

+ +
    +
  • Fixed an issue causing code signing failures and bloating the framework. (#5850)
    • +
  • Xcode 7.3 or higher is now required for using this SDK. (#6059)
    • +
  • Fixed an issue with symbols not being properly stripped from the dynamic framework when built with make xpackage SYMBOLS=NO. (#6531)
    • +
  • The API reference has a sharper look. (#7422)
    • +
  • Added documentation for the Info.plist keys used by this SDK. (#6833)
    • +
+

Styles and data

+ +
    +
  • A new runtime styling API allows you to adjust the style and content of the base map dynamically. All the options available in Mapbox Studio are now exposed via MGLStyle and subclasses of MGLStyleLayer and MGLSource. (#5727)
    • +
  • MGLMapView’s styleURL property can now be set to an absolute file URL. (#6026)
    • +
  • When creating an MGLShapeSource, you can now specify options for clustering point features within the shape source. Similarly, GeoJSON sources specified by the stylesheet at design time can specify the cluster, clusterMaxZoom, and clusterRadius attributes. (#5724)
    • +
  • When creating an MGLTileSource, you can now specify that the tile URLs use TMS coordinates by setting MGLTileSourceOptionTileCoordinateSystem to MGLTileCoordinateSystemTMS. TileJSON files can specify "scheme": "tms". (#2270)
    • +
  • Fixed an issue causing abstract MGLMultiPointFeature objects to be returned in feature query results. Now concrete MGLPointCollectionFeature objects are returned. MGLMultiPointFeature is now an alias of MGLPointCollectionFeature. (#6742)
    • +
  • Fixed rendering artifacts and missing glyphs that occurred after viewing a large number of CJK characters on the map. (#5908)
    • +
  • Fixed an issue where the style zoom levels were not respected when deciding when to render a layer. (#5811)
    • +
  • Fixed an issue where feature querying sometimes failed to return the expected features when the map was tilted. (#6773)
    • +
  • MGLFeature’s attributes and identifier properties are now writable. (#6728)
    • +
  • Attribution views now display the correct attribution for the current style. (#5999)
    • +
  • If MGLMapView is unable to obtain or parse a style, it now calls its delegate’s -mapViewDidFailLoadingMap:withError: method. (#6145)
    • +
  • Added the -[MGLMapViewDelegate mapView:didFinishLoadingStyle:] delegate method, which offers the earliest opportunity to modify the layout or appearance of the current style before the map view is displayed to the user. (#6636)
    • +
  • Fixed an issue causing stepwise zoom functions to be misinterpreted. (#6328)
    • +
  • A source’s tiles are no longer rendered when the map is outside the source’s supported zoom levels. (#6345)
    • +
  • Fixed crashes that could occur when loading a malformed stylesheet. (#5736)
    • +
  • Improved style parsing performance. (#6170)
    • +
  • Improved feature querying performance. (#6514)
    • +
  • Fixed an issue where shapes that cannot currently be visually represented as annotations were still shown on the map as point annotations. (#6764)
    • +
+

Annotations

+ +
    +
  • Added showAnnotations:animated: and showAnnotations:edgePadding:animated:, which moves the map viewport to show the specified annotations. (#5749)
    • +
  • Added new methods to MGLMultiPoint for changing the vertices along a polyline annotation or the exterior of a polygon annotation. (#6565)
    • +
  • Added new APIs to MGLMapView to query for visible annotations. (6061)
    • +
  • Shape, feature, and annotation classes now conform to NSSecureCoding. (#6559)
    • +
  • Various method arguments that are represented as C arrays of CLLocationCoordinate2D instances have been marked const to streamline bridging to Swift. (#7215)
    • +
  • To make an MGLPolyline or MGLPolygon span the antimeridian, specify coordinates with longitudes greater than 180° or less than −180°. (#6088)
    • +
  • Fixed an issue where placing a point annotation on Null Island also placed a duplicate annotation on its antipode. (#3563)
    • +
  • Fixed an issue that caused an assertion failure if a MGLShapeCollection (a GeoJSON GeometryCollection) was created with an empty array of shapes. (#7632)
    • +
  • Improved the precision of annotations at zoom levels greater than 18. (#5517)
    • +
+

Networking and offline maps

+ +
    +
  • Fixed an issue preventing an MGLMapView from loading tiles while an offline pack is downloading. (#6446)
    • +
  • Fixed an issue causing an MGLOfflinePack’s progress to continue to update after calling -suspend. (#6186)
    • +
  • Fixed an issue preventing cached annotation images from displaying while the device is offline. (#6358)
    • +
  • Fixed a crash that could occur when the device is disconnected while downloading an offline pack. (#6293)
    • +
  • Fixed a crash that occurred when encountering a rate-limit error in response to a network request. (#6223)
    • +
  • Added support for an MGLMapboxAPIBaseURL key in an app’s Info.plist in order to customize the base URL used for retrieving map data, styles, and other resources. (#6709)
    • +
  • Query parameters are no longer stripped from mapbox: URLs used as resource URLs. (#6182, #6432)
    • +
  • Database errors are now logged to the console. (#6291)
    • +
+

Other changes

+ +
    +
  • Raster tiles such as those from Mapbox Satellite are now cached, eliminating flashing while panning back and forth. (#7091)
    • +
  • Fixed an issue where the map view’s center would always be calculated as if the view occupied the entire window. (#6102)
    • +
  • Notification names and user info keys are now string enumeration values for ease of use in Swift. (#6794)
    • +
  • Fixed a typo in the documentation for the MGLCompassDirectionFormatter class. (#5879)
    • +
  • The NSClickGestureRecognizer on MGLMapView that is used for selecting annotations now fails if a click does not select an annotation. (#7246)
    • +
+ +
+
+ + +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/infoplist-keys.html b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/infoplist-keys.html new file mode 100644 index 0000000000..1bc06349a3 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/infoplist-keys.html @@ -0,0 +1,546 @@ + + + + Info.plist Keys Reference + + + + + + + + + + + + + + +
+
+
+

+ + Mapbox macOS SDK Docs + macOS SDK Reference + + +

+ +

+ + + + + View on GitHub + +

+ +

+ + + Install in Dash + +

+
+
+
+ +
+
+ Mapbox macOS SDK Reference + + Info.plist Keys Reference +
+
+ +
+ +
+ +
+
+ +

Info.plist Keys

+ +

The Mapbox macOS SDK supports custom Info.plist keys in your application in order to configure various settings.

+

MGLMapboxAccessToken

+ +

Set the Mapbox access token to be used by all instances of MGLMapView in the current application.

+ +

Mapbox-hosted vector tiles and styles require an API access token, which you can obtain from the Mapbox account page. Access tokens associate requests to Mapbox’s vector tile and style APIs with your Mapbox account. They also deter other developers from using your styles without your permission.

+ +

As an alternative, you can use +[MGLAccountManager setAccessToken:] to set a token in code. See our guide for some tips on keeping access tokens in open source code private.

+

MGLMapboxAPIBaseURL

+ +

Use this key if you need to customize the API base URL used throughout the SDK. If unset, the default Mapbox API is used.

+ +

The default value is https://api.mapbox.com.

+ +
+
+ + +
+
+
+

© 2014–2017 Mapbox. See license for more details.

Generated by jazzy ♪♫ v0.7.3, a Realm project. +
+ + + diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/js/jazzy.js b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/js/jazzy.js new file mode 100755 index 0000000000..e07f181acc --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/js/jazzy.js @@ -0,0 +1,47 @@ +window.jazzy = {'docset': false} +if (typeof window.dash != 'undefined') { + document.documentElement.className += ' dash' + window.jazzy.docset = true +} +if (navigator.userAgent.match(/xcode/i)) { + document.documentElement.className += ' xcode' + window.jazzy.docset = true +} + +// On doc load, toggle the URL hash discussion if present +$(document).ready(function() { + if (!window.jazzy.docset) { + var linkToHash = $('a[href="' + window.location.hash +'"]'); + linkToHash.trigger("click"); + } +}); + +// On token click, toggle its discussion and animate token.marginLeft +$(".token").click(function(event) { + if (window.jazzy.docset) { + return; + } + var link = $(this); + var linkIcon = link.find('.token-icon'); + var animationDuration = 300; + var tokenOffset = "0px"; + var original = link.css('marginLeft') == tokenOffset; + linkIcon.toggleClass('token-icon-minus'); + link.animate({'margin-left':original ? "0px" : tokenOffset}, animationDuration); + $content = link.parent().parent().next(); + $content.slideToggle(animationDuration); + + // Keeps the document from jumping to the hash. + var href = $(this).attr('href'); + if (history.pushState) { + history.pushState({}, '', href); + } else { + location.hash = href; + } + event.preventDefault(); +}); + +// Dumb down quotes within code blocks that delimit strings instead of quotations. +$("code q").replaceWith(function () { + return ["\"", $(this).contents(), "\""]; +}); diff --git a/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/js/jquery.min.js b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/js/jquery.min.js new file mode 100755 index 0000000000..ab28a24729 --- /dev/null +++ b/macos/0.3.0-rc.1/docsets/Mapbox.docset/Contents/Resources/Documents/js/jquery.min.js @@ -0,0 +1,4 @@ +/*! jQuery v1.11.1 | (c) 2005, 2014 jQuery Foundation, Inc. | jquery.org/license */ +!function(a,b){"object"==typeof module&&"object"==typeof module.exports?module.exports=a.document?b(a,!0):function(a){if(!a.document)throw new Error("jQuery requires a window with a document");return b(a)}:b(a)}("undefined"!=typeof window?window:this,function(a,b){var c=[],d=c.slice,e=c.concat,f=c.push,g=c.indexOf,h={},i=h.toString,j=h.hasOwnProperty,k={},l="1.11.1",m=function(a,b){return new m.fn.init(a,b)},n=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,o=/^-ms-/,p=/-([\da-z])/gi,q=function(a,b){return b.toUpperCase()};m.fn=m.prototype={jquery:l,constructor:m,selector:"",length:0,toArray:function(){return d.call(this)},get:function(a){return null!=a?0>a?this[a+this.length]:this[a]:d.call(this)},pushStack:function(a){var b=m.merge(this.constructor(),a);return b.prevObject=this,b.context=this.context,b},each:function(a,b){return m.each(this,a,b)},map:function(a){return this.pushStack(m.map(this,function(b,c){return a.call(b,c,b)}))},slice:function(){return this.pushStack(d.apply(this,arguments))},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},eq:function(a){var b=this.length,c=+a+(0>a?b:0);return this.pushStack(c>=0&&b>c?[this[c]]:[])},end:function(){return this.prevObject||this.constructor(null)},push:f,sort:c.sort,splice:c.splice},m.extend=m.fn.extend=function(){var a,b,c,d,e,f,g=arguments[0]||{},h=1,i=arguments.length,j=!1;for("boolean"==typeof g&&(j=g,g=arguments[h]||{},h++),"object"==typeof g||m.isFunction(g)||(g={}),h===i&&(g=this,h--);i>h;h++)if(null!=(e=arguments[h]))for(d in e)a=g[d],c=e[d],g!==c&&(j&&c&&(m.isPlainObject(c)||(b=m.isArray(c)))?(b?(b=!1,f=a&&m.isArray(a)?a:[]):f=a&&m.isPlainObject(a)?a:{},g[d]=m.extend(j,f,c)):void 0!==c&&(g[d]=c));return g},m.extend({expando:"jQuery"+(l+Math.random()).replace(/\D/g,""),isReady:!0,error:function(a){throw new Error(a)},noop:function(){},isFunction:function(a){return"function"===m.type(a)},isArray:Array.isArray||function(a){return"array"===m.type(a)},isWindow:function(a){return null!=a&&a==a.window},isNumeric:function(a){return!m.isArray(a)&&a-parseFloat(a)>=0},isEmptyObject:function(a){var b;for(b in a)return!1;return!0},isPlainObject:function(a){var b;if(!a||"object"!==m.type(a)||a.nodeType||m.isWindow(a))return!1;try{if(a.constructor&&!j.call(a,"constructor")&&!j.call(a.constructor.prototype,"isPrototypeOf"))return!1}catch(c){return!1}if(k.ownLast)for(b in a)return j.call(a,b);for(b in a);return void 0===b||j.call(a,b)},type:function(a){return null==a?a+"":"object"==typeof a||"function"==typeof a?h[i.call(a)]||"object":typeof a},globalEval:function(b){b&&m.trim(b)&&(a.execScript||function(b){a.eval.call(a,b)})(b)},camelCase:function(a){return a.replace(o,"ms-").replace(p,q)},nodeName:function(a,b){return a.nodeName&&a.nodeName.toLowerCase()===b.toLowerCase()},each:function(a,b,c){var d,e=0,f=a.length,g=r(a);if(c){if(g){for(;f>e;e++)if(d=b.apply(a[e],c),d===!1)break}else for(e in a)if(d=b.apply(a[e],c),d===!1)break}else if(g){for(;f>e;e++)if(d=b.call(a[e],e,a[e]),d===!1)break}else for(e in a)if(d=b.call(a[e],e,a[e]),d===!1)break;return a},trim:function(a){return null==a?"":(a+"").replace(n,"")},makeArray:function(a,b){var c=b||[];return null!=a&&(r(Object(a))?m.merge(c,"string"==typeof a?[a]:a):f.call(c,a)),c},inArray:function(a,b,c){var d;if(b){if(g)return g.call(b,a,c);for(d=b.length,c=c?0>c?Math.max(0,d+c):c:0;d>c;c++)if(c in b&&b[c]===a)return c}return-1},merge:function(a,b){var c=+b.length,d=0,e=a.length;while(c>d)a[e++]=b[d++];if(c!==c)while(void 0!==b[d])a[e++]=b[d++];return a.length=e,a},grep:function(a,b,c){for(var d,e=[],f=0,g=a.length,h=!c;g>f;f++)d=!b(a[f],f),d!==h&&e.push(a[f]);return e},map:function(a,b,c){var d,f=0,g=a.length,h=r(a),i=[];if(h)for(;g>f;f++)d=b(a[f],f,c),null!=d&&i.push(d);else for(f in a)d=b(a[f],f,c),null!=d&&i.push(d);return e.apply([],i)},guid:1,proxy:function(a,b){var c,e,f;return"string"==typeof b&&(f=a[b],b=a,a=f),m.isFunction(a)?(c=d.call(arguments,2),e=function(){return a.apply(b||this,c.concat(d.call(arguments)))},e.guid=a.guid=a.guid||m.guid++,e):void 0},now:function(){return+new Date},support:k}),m.each("Boolean Number String Function Array Date RegExp Object Error".split(" "),function(a,b){h["[object "+b+"]"]=b.toLowerCase()});function r(a){var b=a.length,c=m.type(a);return"function"===c||m.isWindow(a)?!1:1===a.nodeType&&b?!0:"array"===c||0===b||"number"==typeof b&&b>0&&b-1 in a}var s=function(a){var b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u="sizzle"+-new Date,v=a.document,w=0,x=0,y=gb(),z=gb(),A=gb(),B=function(a,b){return a===b&&(l=!0),0},C="undefined",D=1<<31,E={}.hasOwnProperty,F=[],G=F.pop,H=F.push,I=F.push,J=F.slice,K=F.indexOf||function(a){for(var b=0,c=this.length;c>b;b++)if(this[b]===a)return b;return-1},L="checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped",M="[\\x20\\t\\r\\n\\f]",N="(?:\\\\.|[\\w-]|[^\\x00-\\xa0])+",O=N.replace("w","w#"),P="\\["+M+"*("+N+")(?:"+M+"*([*^$|!~]?=)"+M+"*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|("+O+"))|)"+M+"*\\]",Q=":("+N+")(?:\\((('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|((?:\\\\.|[^\\\\()[\\]]|"+P+")*)|.*)\\)|)",R=new RegExp("^"+M+"+|((?:^|[^\\\\])(?:\\\\.)*)"+M+"+$","g"),S=new RegExp("^"+M+"*,"+M+"*"),T=new RegExp("^"+M+"*([>+~]|"+M+")"+M+"*"),U=new RegExp("="+M+"*([^\\]'\"]*?)"+M+"*\\]","g"),V=new RegExp(Q),W=new RegExp("^"+O+"$"),X={ID:new RegExp("^#("+N+")"),CLASS:new RegExp("^\\.("+N+")"),TAG:new RegExp("^("+N.replace("w","w*")+")"),ATTR:new RegExp("^"+P),PSEUDO:new RegExp("^"+Q),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+L+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/^(?:input|select|textarea|button)$/i,Z=/^h\d$/i,$=/^[^{]+\{\s*\[native \w/,_=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ab=/[+~]/,bb=/'|\\/g,cb=new RegExp("\\\\([\\da-f]{1,6}"+M+"?|("+M+")|.)","ig"),db=function(a,b,c){var d="0x"+b-65536;return d!==d||c?b:0>d?String.fromCharCode(d+65536):String.fromCharCode(d>>10|55296,1023&d|56320)};try{I.apply(F=J.call(v.childNodes),v.childNodes),F[v.childNodes.length].nodeType}catch(eb){I={apply:F.length?function(a,b){H.apply(a,J.call(b))}:function(a,b){var c=a.length,d=0;while(a[c++]=b[d++]);a.length=c-1}}}function fb(a,b,d,e){var f,h,j,k,l,o,r,s,w,x;if((b?b.ownerDocument||b:v)!==n&&m(b),b=b||n,d=d||[],!a||"string"!=typeof a)return d;if(1!==(k=b.nodeType)&&9!==k)return[];if(p&&!e){if(f=_.exec(a))if(j=f[1]){if(9===k){if(h=b.getElementById(j),!h||!h.parentNode)return d;if(h.id===j)return d.push(h),d}else if(b.ownerDocument&&(h=b.ownerDocument.getElementById(j))&&t(b,h)&&h.id===j)return d.push(h),d}else{if(f[2])return I.apply(d,b.getElementsByTagName(a)),d;if((j=f[3])&&c.getElementsByClassName&&b.getElementsByClassName)return I.apply(d,b.getElementsByClassName(j)),d}if(c.qsa&&(!q||!q.test(a))){if(s=r=u,w=b,x=9===k&&a,1===k&&"object"!==b.nodeName.toLowerCase()){o=g(a),(r=b.getAttribute("id"))?s=r.replace(bb,"\\$&"):b.setAttribute("id",s),s="[id='"+s+"'] ",l=o.length;while(l--)o[l]=s+qb(o[l]);w=ab.test(a)&&ob(b.parentNode)||b,x=o.join(",")}if(x)try{return I.apply(d,w.querySelectorAll(x)),d}catch(y){}finally{r||b.removeAttribute("id")}}}return i(a.replace(R,"$1"),b,d,e)}function gb(){var a=[];function b(c,e){return a.push(c+" ")>d.cacheLength&&delete b[a.shift()],b[c+" "]=e}return b}function hb(a){return a[u]=!0,a}function ib(a){var b=n.createElement("div");try{return!!a(b)}catch(c){return!1}finally{b.parentNode&&b.parentNode.removeChild(b),b=null}}function jb(a,b){var c=a.split("|"),e=a.length;while(e--)d.attrHandle[c[e]]=b}function kb(a,b){var c=b&&a,d=c&&1===a.nodeType&&1===b.nodeType&&(~b.sourceIndex||D)-(~a.sourceIndex||D);if(d)return d;if(c)while(c=c.nextSibling)if(c===b)return-1;return a?1:-1}function lb(a){return function(b){var c=b.nodeName.toLowerCase();return"input"===c&&b.type===a}}function mb(a){return function(b){var c=b.nodeName.toLowerCase();return("input"===c||"button"===c)&&b.type===a}}function nb(a){return hb(function(b){return b=+b,hb(function(c,d){var e,f=a([],c.length,b),g=f.length;while(g--)c[e=f[g]]&&(c[e]=!(d[e]=c[e]))})})}function ob(a){return a&&typeof a.getElementsByTagName!==C&&a}c=fb.support={},f=fb.isXML=function(a){var b=a&&(a.ownerDocument||a).documentElement;return b?"HTML"!==b.nodeName:!1},m=fb.setDocument=function(a){var b,e=a?a.ownerDocument||a:v,g=e.defaultView;return e!==n&&9===e.nodeType&&e.documentElement?(n=e,o=e.documentElement,p=!f(e),g&&g!==g.top&&(g.addEventListener?g.addEventListener("unload",function(){m()},!1):g.attachEvent&&g.attachEvent("onunload",function(){m()})),c.attributes=ib(function(a){return a.className="i",!a.getAttribute("className")}),c.getElementsByTagName=ib(function(a){return a.appendChild(e.createComment("")),!a.getElementsByTagName("*").length}),c.getElementsByClassName=$.test(e.getElementsByClassName)&&ib(function(a){return a.innerHTML="
",a.firstChild.className="i",2===a.getElementsByClassName("i").length}),c.getById=ib(function(a){return o.appendChild(a).id=u,!e.getElementsByName||!e.getElementsByName(u).length}),c.getById?(d.find.ID=function(a,b){if(typeof b.getElementById!==C&&p){var c=b.getElementById(a);return c&&c.parentNode?[c]:[]}},d.filter.ID=function(a){var b=a.replace(cb,db);return function(a){return a.getAttribute("id")===b}}):(delete d.find.ID,d.filter.ID=function(a){var b=a.replace(cb,db);return function(a){var c=typeof a.getAttributeNode!==C&&a.getAttributeNode("id");return c&&c.value===b}}),d.find.TAG=c.getElementsByTagName?function(a,b){return typeof b.getElementsByTagName!==C?b.getElementsByTagName(a):void 0}:function(a,b){var c,d=[],e=0,f=b.getElementsByTagName(a);if("*"===a){while(c=f[e++])1===c.nodeType&&d.push(c);return d}return f},d.find.CLASS=c.getElementsByClassName&&function(a,b){return typeof b.getElementsByClassName!==C&&p?b.getElementsByClassName(a):void 0},r=[],q=[],(c.qsa=$.test(e.querySelectorAll))&&(ib(function(a){a.innerHTML="",a.querySelectorAll("[msallowclip^='']").length&&q.push("[*^$]="+M+"*(?:''|\"\")"),a.querySelectorAll("[selected]").length||q.push("\\["+M+"*(?:value|"+L+")"),a.querySelectorAll(":checked").length||q.push(":checked")}),ib(function(a){var b=e.createElement("input");b.setAttribute("type","hidden"),a.appendChild(b).setAttribute("name","D"),a.querySelectorAll("[name=d]").length&&q.push("name"+M+"*[*^$|!~]?="),a.querySelectorAll(":enabled").length||q.push(":enabled",":disabled"),a.querySelectorAll("*,:x"),q.push(",.*:")})),(c.matchesSelector=$.test(s=o.matches||o.webkitMatchesSelector||o.mozMatchesSelector||o.oMatchesSelector||o.msMatchesSelector))&&ib(function(a){c.disconnectedMatch=s.call(a,"div"),s.call(a,"[s!='']:x"),r.push("!=",Q)}),q=q.length&&new RegExp(q.join("|")),r=r.length&&new RegExp(r.join("|")),b=$.test(o.compareDocumentPosition),t=b||$.test(o.contains)?function(a,b){var c=9===a.nodeType?a.documentElement:a,d=b&&b.parentNode;return a===d||!(!d||1!==d.nodeType||!(c.contains?c.contains(d):a.compareDocumentPosition&&16&a.compareDocumentPosition(d)))}:function(a,b){if(b)while(b=b.parentNode)if(b===a)return!0;return!1},B=b?function(a,b){if(a===b)return l=!0,0;var d=!a.compareDocumentPosition-!b.compareDocumentPosition;return d?d:(d=(a.ownerDocument||a)===(b.ownerDocument||b)?a.compareDocumentPosition(b):1,1&d||!c.sortDetached&&b.compareDocumentPosition(a)===d?a===e||a.ownerDocument===v&&t(v,a)?-1:b===e||b.ownerDocument===v&&t(v,b)?1:k?K.call(k,a)-K.call(k,b):0:4&d?-1:1)}:function(a,b){if(a===b)return l=!0,0;var c,d=0,f=a.parentNode,g=b.parentNode,h=[a],i=[b];if(!f||!g)return a===e?-1:b===e?1:f?-1:g?1:k?K.call(k,a)-K.call(k,b):0;if(f===g)return kb(a,b);c=a;while(c=c.parentNode)h.unshift(c);c=b;while(c=c.parentNode)i.unshift(c);while(h[d]===i[d])d++;return d?kb(h[d],i[d]):h[d]===v?-1:i[d]===v?1:0},e):n},fb.matches=function(a,b){return fb(a,null,null,b)},fb.matchesSelector=function(a,b){if((a.ownerDocument||a)!==n&&m(a),b=b.replace(U,"='$1']"),!(!c.matchesSelector||!p||r&&r.test(b)||q&&q.test(b)))try{var d=s.call(a,b);if(d||c.disconnectedMatch||a.document&&11!==a.document.nodeType)return d}catch(e){}return fb(b,n,null,[a]).length>0},fb.contains=function(a,b){return(a.ownerDocument||a)!==n&&m(a),t(a,b)},fb.attr=function(a,b){(a.ownerDocument||a)!==n&&m(a);var e=d.attrHandle[b.toLowerCase()],f=e&&E.call(d.attrHandle,b.toLowerCase())?e(a,b,!p):void 0;return void 0!==f?f:c.attributes||!p?a.getAttribute(b):(f=a.getAttributeNode(b))&&f.specified?f.value:null},fb.error=function(a){throw new Error("Syntax error, unrecognized expression: "+a)},fb.uniqueSort=function(a){var b,d=[],e=0,f=0;if(l=!c.detectDuplicates,k=!c.sortStable&&a.slice(0),a.sort(B),l){while(b=a[f++])b===a[f]&&(e=d.push(f));while(e--)a.splice(d[e],1)}return k=null,a},e=fb.getText=function(a){var b,c="",d=0,f=a.nodeType;if(f){if(1===f||9===f||11===f){if("string"==typeof a.textContent)return a.textContent;for(a=a.firstChild;a;a=a.nextSibling)c+=e(a)}else if(3===f||4===f)return a.nodeValue}else while(b=a[d++])c+=e(b);return c},d=fb.selectors={cacheLength:50,createPseudo:hb,match:X,attrHandle:{},find:{},relative:{">":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(a){return a[1]=a[1].replace(cb,db),a[3]=(a[3]||a[4]||a[5]||"").replace(cb,db),"~="===a[2]&&(a[3]=" "+a[3]+" "),a.slice(0,4)},CHILD:function(a){return a[1]=a[1].toLowerCase(),"nth"===a[1].slice(0,3)?(a[3]||fb.error(a[0]),a[4]=+(a[4]?a[5]+(a[6]||1):2*("even"===a[3]||"odd"===a[3])),a[5]=+(a[7]+a[8]||"odd"===a[3])):a[3]&&fb.error(a[0]),a},PSEUDO:function(a){var b,c=!a[6]&&a[2];return X.CHILD.test(a[0])?null:(a[3]?a[2]=a[4]||a[5]||"":c&&V.test(c)&&(b=g(c,!0))&&(b=c.indexOf(")",c.length-b)-c.length)&&(a[0]=a[0].slice(0,b),a[2]=c.slice(0,b)),a.slice(0,3))}},filter:{TAG:function(a){var b=a.replace(cb,db).toLowerCase();return"*"===a?function(){return!0}:function(a){return a.nodeName&&a.nodeName.toLowerCase()===b}},CLASS:function(a){var b=y[a+" "];return b||(b=new RegExp("(^|"+M+")"+a+"("+M+"|$)"))&&y(a,function(a){return b.test("string"==typeof a.className&&a.className||typeof a.getAttribute!==C&&a.getAttribute("class")||"")})},ATTR:function(a,b,c){return function(d){var e=fb.attr(d,a);return null==e?"!="===b:b?(e+="","="===b?e===c:"!="===b?e!==c:"^="===b?c&&0===e.indexOf(c):"*="===b?c&&e.indexOf(c)>-1:"$="===b?c&&e.slice(-c.length)===c:"~="===b?(" "+e+" ").indexOf(c)>-1:"|="===b?e===c||e.slice(0,c.length+1)===c+"-":!1):!0}},CHILD:function(a,b,c,d,e){var f="nth"!==a.slice(0,3),g="last"!==a.slice(-4),h="of-type"===b;return 1===d&&0===e?function(a){return!!a.parentNode}:function(b,c,i){var j,k,l,m,n,o,p=f!==g?"nextSibling":"previousSibling",q=b.parentNode,r=h&&b.nodeName.toLowerCase(),s=!i&&!h;if(q){if(f){while(p){l=b;while(l=l[p])if(h?l.nodeName.toLowerCase()===r:1===l.nodeType)return!1;o=p="only"===a&&!o&&"nextSibling"}return!0}if(o=[g?q.firstChild:q.lastChild],g&&s){k=q[u]||(q[u]={}),j=k[a]||[],n=j[0]===w&&j[1],m=j[0]===w&&j[2],l=n&&q.childNodes[n];while(l=++n&&l&&l[p]||(m=n=0)||o.pop())if(1===l.nodeType&&++m&&l===b){k[a]=[w,n,m];break}}else if(s&&(j=(b[u]||(b[u]={}))[a])&&j[0]===w)m=j[1];else while(l=++n&&l&&l[p]||(m=n=0)||o.pop())if((h?l.nodeName.toLowerCase()===r:1===l.nodeType)&&++m&&(s&&((l[u]||(l[u]={}))[a]=[w,m]),l===b))break;return m-=e,m===d||m%d===0&&m/d>=0}}},PSEUDO:function(a,b){var c,e=d.pseudos[a]||d.setFilters[a.toLowerCase()]||fb.error("unsupported pseudo: "+a);return e[u]?e(b):e.length>1?(c=[a,a,"",b],d.setFilters.hasOwnProperty(a.toLowerCase())?hb(function(a,c){var d,f=e(a,b),g=f.length;while(g--)d=K.call(a,f[g]),a[d]=!(c[d]=f[g])}):function(a){return e(a,0,c)}):e}},pseudos:{not:hb(function(a){var b=[],c=[],d=h(a.replace(R,"$1"));return d[u]?hb(function(a,b,c,e){var f,g=d(a,null,e,[]),h=a.length;while(h--)(f=g[h])&&(a[h]=!(b[h]=f))}):function(a,e,f){return b[0]=a,d(b,null,f,c),!c.pop()}}),has:hb(function(a){return function(b){return fb(a,b).length>0}}),contains:hb(function(a){return function(b){return(b.textContent||b.innerText||e(b)).indexOf(a)>-1}}),lang:hb(function(a){return W.test(a||"")||fb.error("unsupported lang: "+a),a=a.replace(cb,db).toLowerCase(),function(b){var c;do if(c=p?b.lang:b.getAttribute("xml:lang")||b.getAttribute("lang"))return c=c.toLowerCase(),c===a||0===c.indexOf(a+"-");while((b=b.parentNode)&&1===b.nodeType);return!1}}),target:function(b){var c=a.location&&a.location.hash;return c&&c.slice(1)===b.id},root:function(a){return a===o},focus:function(a){return a===n.activeElement&&(!n.hasFocus||n.hasFocus())&&!!(a.type||a.href||~a.tabIndex)},enabled:function(a){return a.disabled===!1},disabled:function(a){return a.disabled===!0},checked:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&!!a.checked||"option"===b&&!!a.selected},selected:function(a){return a.parentNode&&a.parentNode.selectedIndex,a.selected===!0},empty:function(a){for(a=a.firstChild;a;a=a.nextSibling)if(a.nodeType<6)return!1;return!0},parent:function(a){return!d.pseudos.empty(a)},header:function(a){return Z.test(a.nodeName)},input:function(a){return Y.test(a.nodeName)},button:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&"button"===a.type||"button"===b},text:function(a){var b;return"input"===a.nodeName.toLowerCase()&&"text"===a.type&&(null==(b=a.getAttribute("type"))||"text"===b.toLowerCase())},first:nb(function(){return[0]}),last:nb(function(a,b){return[b-1]}),eq:nb(function(a,b,c){return[0>c?c+b:c]}),even:nb(function(a,b){for(var c=0;b>c;c+=2)a.push(c);return a}),odd:nb(function(a,b){for(var c=1;b>c;c+=2)a.push(c);return a}),lt:nb(function(a,b,c){for(var d=0>c?c+b:c;--d>=0;)a.push(d);return a}),gt:nb(function(a,b,c){for(var d=0>c?c+b:c;++db;b++)d+=a[b].value;return d}function rb(a,b,c){var d=b.dir,e=c&&"parentNode"===d,f=x++;return b.first?function(b,c,f){while(b=b[d])if(1===b.nodeType||e)return a(b,c,f)}:function(b,c,g){var h,i,j=[w,f];if(g){while(b=b[d])if((1===b.nodeType||e)&&a(b,c,g))return!0}else while(b=b[d])if(1===b.nodeType||e){if(i=b[u]||(b[u]={}),(h=i[d])&&h[0]===w&&h[1]===f)return j[2]=h[2];if(i[d]=j,j[2]=a(b,c,g))return!0}}}function sb(a){return a.length>1?function(b,c,d){var e=a.length;while(e--)if(!a[e](b,c,d))return!1;return!0}:a[0]}function tb(a,b,c){for(var d=0,e=b.length;e>d;d++)fb(a,b[d],c);return c}function ub(a,b,c,d,e){for(var f,g=[],h=0,i=a.length,j=null!=b;i>h;h++)(f=a[h])&&(!c||c(f,d,e))&&(g.push(f),j&&b.push(h));return g}function vb(a,b,c,d,e,f){return d&&!d[u]&&(d=vb(d)),e&&!e[u]&&(e=vb(e,f)),hb(function(f,g,h,i){var j,k,l,m=[],n=[],o=g.length,p=f||tb(b||"*",h.nodeType?[h]:h,[]),q=!a||!f&&b?p:ub(p,m,a,h,i),r=c?e||(f?a:o||d)?[]:g:q;if(c&&c(q,r,h,i),d){j=ub(r,n),d(j,[],h,i),k=j.length;while(k--)(l=j[k])&&(r[n[k]]=!(q[n[k]]=l))}if(f){if(e||a){if(e){j=[],k=r.length;while(k--)(l=r[k])&&j.push(q[k]=l);e(null,r=[],j,i)}k=r.length;while(k--)(l=r[k])&&(j=e?K.call(f,l):m[k])>-1&&(f[j]=!(g[j]=l))}}else r=ub(r===g?r.splice(o,r.length):r),e?e(null,g,r,i):I.apply(g,r)})}function wb(a){for(var b,c,e,f=a.length,g=d.relative[a[0].type],h=g||d.relative[" "],i=g?1:0,k=rb(function(a){return a===b},h,!0),l=rb(function(a){return K.call(b,a)>-1},h,!0),m=[function(a,c,d){return!g&&(d||c!==j)||((b=c).nodeType?k(a,c,d):l(a,c,d))}];f>i;i++)if(c=d.relative[a[i].type])m=[rb(sb(m),c)];else{if(c=d.filter[a[i].type].apply(null,a[i].matches),c[u]){for(e=++i;f>e;e++)if(d.relative[a[e].type])break;return vb(i>1&&sb(m),i>1&&qb(a.slice(0,i-1).concat({value:" "===a[i-2].type?"*":""})).replace(R,"$1"),c,e>i&&wb(a.slice(i,e)),f>e&&wb(a=a.slice(e)),f>e&&qb(a))}m.push(c)}return sb(m)}function xb(a,b){var c=b.length>0,e=a.length>0,f=function(f,g,h,i,k){var l,m,o,p=0,q="0",r=f&&[],s=[],t=j,u=f||e&&d.find.TAG("*",k),v=w+=null==t?1:Math.random()||.1,x=u.length;for(k&&(j=g!==n&&g);q!==x&&null!=(l=u[q]);q++){if(e&&l){m=0;while(o=a[m++])if(o(l,g,h)){i.push(l);break}k&&(w=v)}c&&((l=!o&&l)&&p--,f&&r.push(l))}if(p+=q,c&&q!==p){m=0;while(o=b[m++])o(r,s,g,h);if(f){if(p>0)while(q--)r[q]||s[q]||(s[q]=G.call(i));s=ub(s)}I.apply(i,s),k&&!f&&s.length>0&&p+b.length>1&&fb.uniqueSort(i)}return k&&(w=v,j=t),r};return c?hb(f):f}return h=fb.compile=function(a,b){var c,d=[],e=[],f=A[a+" "];if(!f){b||(b=g(a)),c=b.length;while(c--)f=wb(b[c]),f[u]?d.push(f):e.push(f);f=A(a,xb(e,d)),f.selector=a}return f},i=fb.select=function(a,b,e,f){var i,j,k,l,m,n="function"==typeof a&&a,o=!f&&g(a=n.selector||a);if(e=e||[],1===o.length){if(j=o[0]=o[0].slice(0),j.length>2&&"ID"===(k=j[0]).type&&c.getById&&9===b.nodeType&&p&&d.relative[j[1].type]){if(b=(d.find.ID(k.matches[0].replace(cb,db),b)||[])[0],!b)return e;n&&(b=b.parentNode),a=a.slice(j.shift().value.length)}i=X.needsContext.test(a)?0:j.length;while(i--){if(k=j[i],d.relative[l=k.type])break;if((m=d.find[l])&&(f=m(k.matches[0].replace(cb,db),ab.test(j[0].type)&&ob(b.parentNode)||b))){if(j.splice(i,1),a=f.length&&qb(j),!a)return I.apply(e,f),e;break}}}return(n||h(a,o))(f,b,!p,e,ab.test(a)&&ob(b.parentNode)||b),e},c.sortStable=u.split("").sort(B).join("")===u,c.detectDuplicates=!!l,m(),c.sortDetached=ib(function(a){return 1&a.compareDocumentPosition(n.createElement("div"))}),ib(function(a){return a.innerHTML="","#"===a.firstChild.getAttribute("href")})||jb("type|href|height|width",function(a,b,c){return c?void 0:a.getAttribute(b,"type"===b.toLowerCase()?1:2)}),c.attributes&&ib(function(a){return a.innerHTML="",a.firstChild.setAttribute("value",""),""===a.firstChild.getAttribute("value")})||jb("value",function(a,b,c){return c||"input"!==a.nodeName.toLowerCase()?void 0:a.defaultValue}),ib(function(a){return null==a.getAttribute("disabled")})||jb(L,function(a,b,c){var d;return c?void 0:a[b]===!0?b.toLowerCase():(d=a.getAttributeNode(b))&&d.specified?d.value:null}),fb}(a);m.find=s,m.expr=s.selectors,m.expr[":"]=m.expr.pseudos,m.unique=s.uniqueSort,m.text=s.getText,m.isXMLDoc=s.isXML,m.contains=s.contains;var t=m.expr.match.needsContext,u=/^<(\w+)\s*\/?>(?:<\/\1>|)$/,v=/^.[^:#\[\.,]*$/;function w(a,b,c){if(m.isFunction(b))return m.grep(a,function(a,d){return!!b.call(a,d,a)!==c});if(b.nodeType)return m.grep(a,function(a){return a===b!==c});if("string"==typeof b){if(v.test(b))return m.filter(b,a,c);b=m.filter(b,a)}return m.grep(a,function(a){return m.inArray(a,b)>=0!==c})}m.filter=function(a,b,c){var d=b[0];return c&&(a=":not("+a+")"),1===b.length&&1===d.nodeType?m.find.matchesSelector(d,a)?[d]:[]:m.find.matches(a,m.grep(b,function(a){return 1===a.nodeType}))},m.fn.extend({find:function(a){var b,c=[],d=this,e=d.length;if("string"!=typeof a)return this.pushStack(m(a).filter(function(){for(b=0;e>b;b++)if(m.contains(d[b],this))return!0}));for(b=0;e>b;b++)m.find(a,d[b],c);return c=this.pushStack(e>1?m.unique(c):c),c.selector=this.selector?this.selector+" "+a:a,c},filter:function(a){return this.pushStack(w(this,a||[],!1))},not:function(a){return this.pushStack(w(this,a||[],!0))},is:function(a){return!!w(this,"string"==typeof a&&t.test(a)?m(a):a||[],!1).length}});var x,y=a.document,z=/^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]*))$/,A=m.fn.init=function(a,b){var c,d;if(!a)return this;if("string"==typeof a){if(c="<"===a.charAt(0)&&">"===a.charAt(a.length-1)&&a.length>=3?[null,a,null]:z.exec(a),!c||!c[1]&&b)return!b||b.jquery?(b||x).find(a):this.constructor(b).find(a);if(c[1]){if(b=b instanceof m?b[0]:b,m.merge(this,m.parseHTML(c[1],b&&b.nodeType?b.ownerDocument||b:y,!0)),u.test(c[1])&&m.isPlainObject(b))for(c in b)m.isFunction(this[c])?this[c](b[c]):this.attr(c,b[c]);return this}if(d=y.getElementById(c[2]),d&&d.parentNode){if(d.id!==c[2])return x.find(a);this.length=1,this[0]=d}return this.context=y,this.selector=a,this}return a.nodeType?(this.context=this[0]=a,this.length=1,this):m.isFunction(a)?"undefined"!=typeof x.ready?x.ready(a):a(m):(void 0!==a.selector&&(this.selector=a.selector,this.context=a.context),m.makeArray(a,this))};A.prototype=m.fn,x=m(y);var B=/^(?:parents|prev(?:Until|All))/,C={children:!0,contents:!0,next:!0,prev:!0};m.extend({dir:function(a,b,c){var d=[],e=a[b];while(e&&9!==e.nodeType&&(void 0===c||1!==e.nodeType||!m(e).is(c)))1===e.nodeType&&d.push(e),e=e[b];return d},sibling:function(a,b){for(var c=[];a;a=a.nextSibling)1===a.nodeType&&a!==b&&c.push(a);return c}}),m.fn.extend({has:function(a){var b,c=m(a,this),d=c.length;return this.filter(function(){for(b=0;d>b;b++)if(m.contains(this,c[b]))return!0})},closest:function(a,b){for(var c,d=0,e=this.length,f=[],g=t.test(a)||"string"!=typeof a?m(a,b||this.context):0;e>d;d++)for(c=this[d];c&&c!==b;c=c.parentNode)if(c.nodeType<11&&(g?g.index(c)>-1:1===c.nodeType&&m.find.matchesSelector(c,a))){f.push(c);break}return this.pushStack(f.length>1?m.unique(f):f)},index:function(a){return a?"string"==typeof a?m.inArray(this[0],m(a)):m.inArray(a.jquery?a[0]:a,this):this[0]&&this[0].parentNode?this.first().prevAll().length:-1},add:function(a,b){return this.pushStack(m.unique(m.merge(this.get(),m(a,b))))},addBack:function(a){return this.add(null==a?this.prevObject:this.prevObject.filter(a))}});function D(a,b){do a=a[b];while(a&&1!==a.nodeType);return a}m.each({parent:function(a){var b=a.parentNode;return b&&11!==b.nodeType?b:null},parents:function(a){return m.dir(a,"parentNode")},parentsUntil:function(a,b,c){return m.dir(a,"parentNode",c)},next:function(a){return D(a,"nextSibling")},prev:function(a){return D(a,"previousSibling")},nextAll:function(a){return m.dir(a,"nextSibling")},prevAll:function(a){return m.dir(a,"previousSibling")},nextUntil:function(a,b,c){return m.dir(a,"nextSibling",c)},prevUntil:function(a,b,c){return m.dir(a,"previousSibling",c)},siblings:function(a){return m.sibling((a.parentNode||{}).firstChild,a)},children:function(a){return m.sibling(a.firstChild)},contents:function(a){return m.nodeName(a,"iframe")?a.contentDocument||a.contentWindow.document:m.merge([],a.childNodes)}},function(a,b){m.fn[a]=function(c,d){var e=m.map(this,b,c);return"Until"!==a.slice(-5)&&(d=c),d&&"string"==typeof d&&(e=m.filter(d,e)),this.length>1&&(C[a]||(e=m.unique(e)),B.test(a)&&(e=e.reverse())),this.pushStack(e)}});var E=/\S+/g,F={};function G(a){var b=F[a]={};return m.each(a.match(E)||[],function(a,c){b[c]=!0}),b}m.Callbacks=function(a){a="string"==typeof a?F[a]||G(a):m.extend({},a);var b,c,d,e,f,g,h=[],i=!a.once&&[],j=function(l){for(c=a.memory&&l,d=!0,f=g||0,g=0,e=h.length,b=!0;h&&e>f;f++)if(h[f].apply(l[0],l[1])===!1&&a.stopOnFalse){c=!1;break}b=!1,h&&(i?i.length&&j(i.shift()):c?h=[]:k.disable())},k={add:function(){if(h){var d=h.length;!function f(b){m.each(b,function(b,c){var d=m.type(c);"function"===d?a.unique&&k.has(c)||h.push(c):c&&c.length&&"string"!==d&&f(c)})}(arguments),b?e=h.length:c&&(g=d,j(c))}return this},remove:function(){return h&&m.each(arguments,function(a,c){var d;while((d=m.inArray(c,h,d))>-1)h.splice(d,1),b&&(e>=d&&e--,f>=d&&f--)}),this},has:function(a){return a?m.inArray(a,h)>-1:!(!h||!h.length)},empty:function(){return h=[],e=0,this},disable:function(){return h=i=c=void 0,this},disabled:function(){return!h},lock:function(){return i=void 0,c||k.disable(),this},locked:function(){return!i},fireWith:function(a,c){return!h||d&&!i||(c=c||[],c=[a,c.slice?c.slice():c],b?i.push(c):j(c)),this},fire:function(){return k.fireWith(this,arguments),this},fired:function(){return!!d}};return k},m.extend({Deferred:function(a){var b=[["resolve","done",m.Callbacks("once memory"),"resolved"],["reject","fail",m.Callbacks("once memory"),"rejected"],["notify","progress",m.Callbacks("memory")]],c="pending",d={state:function(){return c},always:function(){return e.done(arguments).fail(arguments),this},then:function(){var a=arguments;return m.Deferred(function(c){m.each(b,function(b,f){var g=m.isFunction(a[b])&&a[b];e[f[1]](function(){var a=g&&g.apply(this,arguments);a&&m.isFunction(a.promise)?a.promise().done(c.resolve).fail(c.reject).progress(c.notify):c[f[0]+"With"](this===d?c.promise():this,g?[a]:arguments)})}),a=null}).promise()},promise:function(a){return null!=a?m.extend(a,d):d}},e={};return d.pipe=d.then,m.each(b,function(a,f){var g=f[2],h=f[3];d[f[1]]=g.add,h&&g.add(function(){c=h},b[1^a][2].disable,b[2][2].lock),e[f[0]]=function(){return e[f[0]+"With"](this===e?d:this,arguments),this},e[f[0]+"With"]=g.fireWith}),d.promise(e),a&&a.call(e,e),e},when:function(a){var b=0,c=d.call(arguments),e=c.length,f=1!==e||a&&m.isFunction(a.promise)?e:0,g=1===f?a:m.Deferred(),h=function(a,b,c){return function(e){b[a]=this,c[a]=arguments.length>1?d.call(arguments):e,c===i?g.notifyWith(b,c):--f||g.resolveWith(b,c)}},i,j,k;if(e>1)for(i=new Array(e),j=new Array(e),k=new Array(e);e>b;b++)c[b]&&m.isFunction(c[b].promise)?c[b].promise().done(h(b,k,c)).fail(g.reject).progress(h(b,j,i)):--f;return f||g.resolveWith(k,c),g.promise()}});var H;m.fn.ready=function(a){return m.ready.promise().done(a),this},m.extend({isReady:!1,readyWait:1,holdReady:function(a){a?m.readyWait++:m.ready(!0)},ready:function(a){if(a===!0?!--m.readyWait:!m.isReady){if(!y.body)return setTimeout(m.ready);m.isReady=!0,a!==!0&&--m.readyWait>0||(H.resolveWith(y,[m]),m.fn.triggerHandler&&(m(y).triggerHandler("ready"),m(y).off("ready")))}}});function I(){y.addEventListener?(y.removeEventListener("DOMContentLoaded",J,!1),a.removeEventListener("load",J,!1)):(y.detachEvent("onreadystatechange",J),a.detachEvent("onload",J))}function J(){(y.addEventListener||"load"===event.type||"complete"===y.readyState)&&(I(),m.ready())}m.ready.promise=function(b){if(!H)if(H=m.Deferred(),"complete"===y.readyState)setTimeout(m.ready);else if(y.addEventListener)y.addEventListener("DOMContentLoaded",J,!1),a.addEventListener("load",J,!1);else{y.attachEvent("onreadystatechange",J),a.attachEvent("onload",J);var c=!1;try{c=null==a.frameElement&&y.documentElement}catch(d){}c&&c.doScroll&&!function e(){if(!m.isReady){try{c.doScroll("left")}catch(a){return setTimeout(e,50)}I(),m.ready()}}()}return H.promise(b)};var K="undefined",L;for(L in m(k))break;k.ownLast="0"!==L,k.inlineBlockNeedsLayout=!1,m(function(){var a,b,c,d;c=y.getElementsByTagName("body")[0],c&&c.style&&(b=y.createElement("div"),d=y.createElement("div"),d.style.cssText="position:absolute;border:0;width:0;height:0;top:0;left:-9999px",c.appendChild(d).appendChild(b),typeof b.style.zoom!==K&&(b.style.cssText="display:inline;margin:0;border:0;padding:1px;width:1px;zoom:1",k.inlineBlockNeedsLayout=a=3===b.offsetWidth,a&&(c.style.zoom=1)),c.removeChild(d))}),function(){var a=y.createElement("div");if(null==k.deleteExpando){k.deleteExpando=!0;try{delete a.test}catch(b){k.deleteExpando=!1}}a=null}(),m.acceptData=function(a){var b=m.noData[(a.nodeName+" ").toLowerCase()],c=+a.nodeType||1;return 1!==c&&9!==c?!1:!b||b!==!0&&a.getAttribute("classid")===b};var M=/^(?:\{[\w\W]*\}|\[[\w\W]*\])$/,N=/([A-Z])/g;function O(a,b,c){if(void 0===c&&1===a.nodeType){var d="data-"+b.replace(N,"-$1").toLowerCase();if(c=a.getAttribute(d),"string"==typeof c){try{c="true"===c?!0:"false"===c?!1:"null"===c?null:+c+""===c?+c:M.test(c)?m.parseJSON(c):c}catch(e){}m.data(a,b,c)}else c=void 0}return c}function P(a){var b;for(b in a)if(("data"!==b||!m.isEmptyObject(a[b]))&&"toJSON"!==b)return!1;return!0}function Q(a,b,d,e){if(m.acceptData(a)){var f,g,h=m.expando,i=a.nodeType,j=i?m.cache:a,k=i?a[h]:a[h]&&h; +if(k&&j[k]&&(e||j[k].data)||void 0!==d||"string"!=typeof b)return k||(k=i?a[h]=c.pop()||m.guid++:h),j[k]||(j[k]=i?{}:{toJSON:m.noop}),("object"==typeof b||"function"==typeof b)&&(e?j[k]=m.extend(j[k],b):j[k].data=m.extend(j[k].data,b)),g=j[k],e||(g.data||(g.data={}),g=g.data),void 0!==d&&(g[m.camelCase(b)]=d),"string"==typeof b?(f=g[b],null==f&&(f=g[m.camelCase(b)])):f=g,f}}function R(a,b,c){if(m.acceptData(a)){var d,e,f=a.nodeType,g=f?m.cache:a,h=f?a[m.expando]:m.expando;if(g[h]){if(b&&(d=c?g[h]:g[h].data)){m.isArray(b)?b=b.concat(m.map(b,m.camelCase)):b in d?b=[b]:(b=m.camelCase(b),b=b in d?[b]:b.split(" ")),e=b.length;while(e--)delete d[b[e]];if(c?!P(d):!m.isEmptyObject(d))return}(c||(delete g[h].data,P(g[h])))&&(f?m.cleanData([a],!0):k.deleteExpando||g!=g.window?delete g[h]:g[h]=null)}}}m.extend({cache:{},noData:{"applet ":!0,"embed ":!0,"object ":"clsid:D27CDB6E-AE6D-11cf-96B8-444553540000"},hasData:function(a){return a=a.nodeType?m.cache[a[m.expando]]:a[m.expando],!!a&&!P(a)},data:function(a,b,c){return Q(a,b,c)},removeData:function(a,b){return R(a,b)},_data:function(a,b,c){return Q(a,b,c,!0)},_removeData:function(a,b){return R(a,b,!0)}}),m.fn.extend({data:function(a,b){var c,d,e,f=this[0],g=f&&f.attributes;if(void 0===a){if(this.length&&(e=m.data(f),1===f.nodeType&&!m._data(f,"parsedAttrs"))){c=g.length;while(c--)g[c]&&(d=g[c].name,0===d.indexOf("data-")&&(d=m.camelCase(d.slice(5)),O(f,d,e[d])));m._data(f,"parsedAttrs",!0)}return e}return"object"==typeof a?this.each(function(){m.data(this,a)}):arguments.length>1?this.each(function(){m.data(this,a,b)}):f?O(f,a,m.data(f,a)):void 0},removeData:function(a){return this.each(function(){m.removeData(this,a)})}}),m.extend({queue:function(a,b,c){var d;return a?(b=(b||"fx")+"queue",d=m._data(a,b),c&&(!d||m.isArray(c)?d=m._data(a,b,m.makeArray(c)):d.push(c)),d||[]):void 0},dequeue:function(a,b){b=b||"fx";var c=m.queue(a,b),d=c.length,e=c.shift(),f=m._queueHooks(a,b),g=function(){m.dequeue(a,b)};"inprogress"===e&&(e=c.shift(),d--),e&&("fx"===b&&c.unshift("inprogress"),delete f.stop,e.call(a,g,f)),!d&&f&&f.empty.fire()},_queueHooks:function(a,b){var c=b+"queueHooks";return m._data(a,c)||m._data(a,c,{empty:m.Callbacks("once memory").add(function(){m._removeData(a,b+"queue"),m._removeData(a,c)})})}}),m.fn.extend({queue:function(a,b){var c=2;return"string"!=typeof a&&(b=a,a="fx",c--),arguments.lengthh;h++)b(a[h],c,g?d:d.call(a[h],h,b(a[h],c)));return e?a:j?b.call(a):i?b(a[0],c):f},W=/^(?:checkbox|radio)$/i;!function(){var a=y.createElement("input"),b=y.createElement("div"),c=y.createDocumentFragment();if(b.innerHTML="
a",k.leadingWhitespace=3===b.firstChild.nodeType,k.tbody=!b.getElementsByTagName("tbody").length,k.htmlSerialize=!!b.getElementsByTagName("link").length,k.html5Clone="<:nav>"!==y.createElement("nav").cloneNode(!0).outerHTML,a.type="checkbox",a.checked=!0,c.appendChild(a),k.appendChecked=a.checked,b.innerHTML="",k.noCloneChecked=!!b.cloneNode(!0).lastChild.defaultValue,c.appendChild(b),b.innerHTML="",k.checkClone=b.cloneNode(!0).cloneNode(!0).lastChild.checked,k.noCloneEvent=!0,b.attachEvent&&(b.attachEvent("onclick",function(){k.noCloneEvent=!1}),b.cloneNode(!0).click()),null==k.deleteExpando){k.deleteExpando=!0;try{delete b.test}catch(d){k.deleteExpando=!1}}}(),function(){var b,c,d=y.createElement("div");for(b in{submit:!0,change:!0,focusin:!0})c="on"+b,(k[b+"Bubbles"]=c in a)||(d.setAttribute(c,"t"),k[b+"Bubbles"]=d.attributes[c].expando===!1);d=null}();var X=/^(?:input|select|textarea)$/i,Y=/^key/,Z=/^(?:mouse|pointer|contextmenu)|click/,$=/^(?:focusinfocus|focusoutblur)$/,_=/^([^.]*)(?:\.(.+)|)$/;function ab(){return!0}function bb(){return!1}function cb(){try{return y.activeElement}catch(a){}}m.event={global:{},add:function(a,b,c,d,e){var f,g,h,i,j,k,l,n,o,p,q,r=m._data(a);if(r){c.handler&&(i=c,c=i.handler,e=i.selector),c.guid||(c.guid=m.guid++),(g=r.events)||(g=r.events={}),(k=r.handle)||(k=r.handle=function(a){return typeof m===K||a&&m.event.triggered===a.type?void 0:m.event.dispatch.apply(k.elem,arguments)},k.elem=a),b=(b||"").match(E)||[""],h=b.length;while(h--)f=_.exec(b[h])||[],o=q=f[1],p=(f[2]||"").split(".").sort(),o&&(j=m.event.special[o]||{},o=(e?j.delegateType:j.bindType)||o,j=m.event.special[o]||{},l=m.extend({type:o,origType:q,data:d,handler:c,guid:c.guid,selector:e,needsContext:e&&m.expr.match.needsContext.test(e),namespace:p.join(".")},i),(n=g[o])||(n=g[o]=[],n.delegateCount=0,j.setup&&j.setup.call(a,d,p,k)!==!1||(a.addEventListener?a.addEventListener(o,k,!1):a.attachEvent&&a.attachEvent("on"+o,k))),j.add&&(j.add.call(a,l),l.handler.guid||(l.handler.guid=c.guid)),e?n.splice(n.delegateCount++,0,l):n.push(l),m.event.global[o]=!0);a=null}},remove:function(a,b,c,d,e){var f,g,h,i,j,k,l,n,o,p,q,r=m.hasData(a)&&m._data(a);if(r&&(k=r.events)){b=(b||"").match(E)||[""],j=b.length;while(j--)if(h=_.exec(b[j])||[],o=q=h[1],p=(h[2]||"").split(".").sort(),o){l=m.event.special[o]||{},o=(d?l.delegateType:l.bindType)||o,n=k[o]||[],h=h[2]&&new RegExp("(^|\\.)"+p.join("\\.(?:.*\\.|)")+"(\\.|$)"),i=f=n.length;while(f--)g=n[f],!e&&q!==g.origType||c&&c.guid!==g.guid||h&&!h.test(g.namespace)||d&&d!==g.selector&&("**"!==d||!g.selector)||(n.splice(f,1),g.selector&&n.delegateCount--,l.remove&&l.remove.call(a,g));i&&!n.length&&(l.teardown&&l.teardown.call(a,p,r.handle)!==!1||m.removeEvent(a,o,r.handle),delete k[o])}else for(o in k)m.event.remove(a,o+b[j],c,d,!0);m.isEmptyObject(k)&&(delete r.handle,m._removeData(a,"events"))}},trigger:function(b,c,d,e){var f,g,h,i,k,l,n,o=[d||y],p=j.call(b,"type")?b.type:b,q=j.call(b,"namespace")?b.namespace.split("."):[];if(h=l=d=d||y,3!==d.nodeType&&8!==d.nodeType&&!$.test(p+m.event.triggered)&&(p.indexOf(".")>=0&&(q=p.split("."),p=q.shift(),q.sort()),g=p.indexOf(":")<0&&"on"+p,b=b[m.expando]?b:new m.Event(p,"object"==typeof b&&b),b.isTrigger=e?2:3,b.namespace=q.join("."),b.namespace_re=b.namespace?new RegExp("(^|\\.)"+q.join("\\.(?:.*\\.|)")+"(\\.|$)"):null,b.result=void 0,b.target||(b.target=d),c=null==c?[b]:m.makeArray(c,[b]),k=m.event.special[p]||{},e||!k.trigger||k.trigger.apply(d,c)!==!1)){if(!e&&!k.noBubble&&!m.isWindow(d)){for(i=k.delegateType||p,$.test(i+p)||(h=h.parentNode);h;h=h.parentNode)o.push(h),l=h;l===(d.ownerDocument||y)&&o.push(l.defaultView||l.parentWindow||a)}n=0;while((h=o[n++])&&!b.isPropagationStopped())b.type=n>1?i:k.bindType||p,f=(m._data(h,"events")||{})[b.type]&&m._data(h,"handle"),f&&f.apply(h,c),f=g&&h[g],f&&f.apply&&m.acceptData(h)&&(b.result=f.apply(h,c),b.result===!1&&b.preventDefault());if(b.type=p,!e&&!b.isDefaultPrevented()&&(!k._default||k._default.apply(o.pop(),c)===!1)&&m.acceptData(d)&&g&&d[p]&&!m.isWindow(d)){l=d[g],l&&(d[g]=null),m.event.triggered=p;try{d[p]()}catch(r){}m.event.triggered=void 0,l&&(d[g]=l)}return b.result}},dispatch:function(a){a=m.event.fix(a);var b,c,e,f,g,h=[],i=d.call(arguments),j=(m._data(this,"events")||{})[a.type]||[],k=m.event.special[a.type]||{};if(i[0]=a,a.delegateTarget=this,!k.preDispatch||k.preDispatch.call(this,a)!==!1){h=m.event.handlers.call(this,a,j),b=0;while((f=h[b++])&&!a.isPropagationStopped()){a.currentTarget=f.elem,g=0;while((e=f.handlers[g++])&&!a.isImmediatePropagationStopped())(!a.namespace_re||a.namespace_re.test(e.namespace))&&(a.handleObj=e,a.data=e.data,c=((m.event.special[e.origType]||{}).handle||e.handler).apply(f.elem,i),void 0!==c&&(a.result=c)===!1&&(a.preventDefault(),a.stopPropagation()))}return k.postDispatch&&k.postDispatch.call(this,a),a.result}},handlers:function(a,b){var c,d,e,f,g=[],h=b.delegateCount,i=a.target;if(h&&i.nodeType&&(!a.button||"click"!==a.type))for(;i!=this;i=i.parentNode||this)if(1===i.nodeType&&(i.disabled!==!0||"click"!==a.type)){for(e=[],f=0;h>f;f++)d=b[f],c=d.selector+" ",void 0===e[c]&&(e[c]=d.needsContext?m(c,this).index(i)>=0:m.find(c,this,null,[i]).length),e[c]&&e.push(d);e.length&&g.push({elem:i,handlers:e})}return h]","i"),hb=/^\s+/,ib=/<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/gi,jb=/<([\w:]+)/,kb=/\s*$/g,rb={option:[1,""],legend:[1,"
","
"],area:[1,"",""],param:[1,"",""],thead:[1,"","
"],tr:[2,"","
"],col:[2,"","
"],td:[3,"","
"],_default:k.htmlSerialize?[0,"",""]:[1,"X
","
"]},sb=db(y),tb=sb.appendChild(y.createElement("div"));rb.optgroup=rb.option,rb.tbody=rb.tfoot=rb.colgroup=rb.caption=rb.thead,rb.th=rb.td;function ub(a,b){var c,d,e=0,f=typeof a.getElementsByTagName!==K?a.getElementsByTagName(b||"*"):typeof a.querySelectorAll!==K?a.querySelectorAll(b||"*"):void 0;if(!f)for(f=[],c=a.childNodes||a;null!=(d=c[e]);e++)!b||m.nodeName(d,b)?f.push(d):m.merge(f,ub(d,b));return void 0===b||b&&m.nodeName(a,b)?m.merge([a],f):f}function vb(a){W.test(a.type)&&(a.defaultChecked=a.checked)}function wb(a,b){return m.nodeName(a,"table")&&m.nodeName(11!==b.nodeType?b:b.firstChild,"tr")?a.getElementsByTagName("tbody")[0]||a.appendChild(a.ownerDocument.createElement("tbody")):a}function xb(a){return a.type=(null!==m.find.attr(a,"type"))+"/"+a.type,a}function yb(a){var b=pb.exec(a.type);return b?a.type=b[1]:a.removeAttribute("type"),a}function zb(a,b){for(var c,d=0;null!=(c=a[d]);d++)m._data(c,"globalEval",!b||m._data(b[d],"globalEval"))}function Ab(a,b){if(1===b.nodeType&&m.hasData(a)){var c,d,e,f=m._data(a),g=m._data(b,f),h=f.events;if(h){delete g.handle,g.events={};for(c in h)for(d=0,e=h[c].length;e>d;d++)m.event.add(b,c,h[c][d])}g.data&&(g.data=m.extend({},g.data))}}function Bb(a,b){var c,d,e;if(1===b.nodeType){if(c=b.nodeName.toLowerCase(),!k.noCloneEvent&&b[m.expando]){e=m._data(b);for(d in e.events)m.removeEvent(b,d,e.handle);b.removeAttribute(m.expando)}"script"===c&&b.text!==a.text?(xb(b).text=a.text,yb(b)):"object"===c?(b.parentNode&&(b.outerHTML=a.outerHTML),k.html5Clone&&a.innerHTML&&!m.trim(b.innerHTML)&&(b.innerHTML=a.innerHTML)):"input"===c&&W.test(a.type)?(b.defaultChecked=b.checked=a.checked,b.value!==a.value&&(b.value=a.value)):"option"===c?b.defaultSelected=b.selected=a.defaultSelected:("input"===c||"textarea"===c)&&(b.defaultValue=a.defaultValue)}}m.extend({clone:function(a,b,c){var d,e,f,g,h,i=m.contains(a.ownerDocument,a);if(k.html5Clone||m.isXMLDoc(a)||!gb.test("<"+a.nodeName+">")?f=a.cloneNode(!0):(tb.innerHTML=a.outerHTML,tb.removeChild(f=tb.firstChild)),!(k.noCloneEvent&&k.noCloneChecked||1!==a.nodeType&&11!==a.nodeType||m.isXMLDoc(a)))for(d=ub(f),h=ub(a),g=0;null!=(e=h[g]);++g)d[g]&&Bb(e,d[g]);if(b)if(c)for(h=h||ub(a),d=d||ub(f),g=0;null!=(e=h[g]);g++)Ab(e,d[g]);else Ab(a,f);return d=ub(f,"script"),d.length>0&&zb(d,!i&&ub(a,"script")),d=h=e=null,f},buildFragment:function(a,b,c,d){for(var e,f,g,h,i,j,l,n=a.length,o=db(b),p=[],q=0;n>q;q++)if(f=a[q],f||0===f)if("object"===m.type(f))m.merge(p,f.nodeType?[f]:f);else if(lb.test(f)){h=h||o.appendChild(b.createElement("div")),i=(jb.exec(f)||["",""])[1].toLowerCase(),l=rb[i]||rb._default,h.innerHTML=l[1]+f.replace(ib,"<$1>")+l[2],e=l[0];while(e--)h=h.lastChild;if(!k.leadingWhitespace&&hb.test(f)&&p.push(b.createTextNode(hb.exec(f)[0])),!k.tbody){f="table"!==i||kb.test(f)?""!==l[1]||kb.test(f)?0:h:h.firstChild,e=f&&f.childNodes.length;while(e--)m.nodeName(j=f.childNodes[e],"tbody")&&!j.childNodes.length&&f.removeChild(j)}m.merge(p,h.childNodes),h.textContent="";while(h.firstChild)h.removeChild(h.firstChild);h=o.lastChild}else p.push(b.createTextNode(f));h&&o.removeChild(h),k.appendChecked||m.grep(ub(p,"input"),vb),q=0;while(f=p[q++])if((!d||-1===m.inArray(f,d))&&(g=m.contains(f.ownerDocument,f),h=ub(o.appendChild(f),"script"),g&&zb(h),c)){e=0;while(f=h[e++])ob.test(f.type||"")&&c.push(f)}return h=null,o},cleanData:function(a,b){for(var d,e,f,g,h=0,i=m.expando,j=m.cache,l=k.deleteExpando,n=m.event.special;null!=(d=a[h]);h++)if((b||m.acceptData(d))&&(f=d[i],g=f&&j[f])){if(g.events)for(e in g.events)n[e]?m.event.remove(d,e):m.removeEvent(d,e,g.handle);j[f]&&(delete j[f],l?delete d[i]:typeof d.removeAttribute!==K?d.removeAttribute(i):d[i]=null,c.push(f))}}}),m.fn.extend({text:function(a){return V(this,function(a){return void 0===a?m.text(this):this.empty().append((this[0]&&this[0].ownerDocument||y).createTextNode(a))},null,a,arguments.length)},append:function(){return this.domManip(arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=wb(this,a);b.appendChild(a)}})},prepend:function(){return this.domManip(arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=wb(this,a);b.insertBefore(a,b.firstChild)}})},before:function(){return this.domManip(arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this)})},after:function(){return this.domManip(arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this.nextSibling)})},remove:function(a,b){for(var c,d=a?m.filter(a,this):this,e=0;null!=(c=d[e]);e++)b||1!==c.nodeType||m.cleanData(ub(c)),c.parentNode&&(b&&m.contains(c.ownerDocument,c)&&zb(ub(c,"script")),c.parentNode.removeChild(c));return this},empty:function(){for(var a,b=0;null!=(a=this[b]);b++){1===a.nodeType&&m.cleanData(ub(a,!1));while(a.firstChild)a.removeChild(a.firstChild);a.options&&m.nodeName(a,"select")&&(a.options.length=0)}return this},clone:function(a,b){return a=null==a?!1:a,b=null==b?a:b,this.map(function(){return m.clone(this,a,b)})},html:function(a){return V(this,function(a){var b=this[0]||{},c=0,d=this.length;if(void 0===a)return 1===b.nodeType?b.innerHTML.replace(fb,""):void 0;if(!("string"!=typeof a||mb.test(a)||!k.htmlSerialize&&gb.test(a)||!k.leadingWhitespace&&hb.test(a)||rb[(jb.exec(a)||["",""])[1].toLowerCase()])){a=a.replace(ib,"<$1>");try{for(;d>c;c++)b=this[c]||{},1===b.nodeType&&(m.cleanData(ub(b,!1)),b.innerHTML=a);b=0}catch(e){}}b&&this.empty().append(a)},null,a,arguments.length)},replaceWith:function(){var a=arguments[0];return this.domManip(arguments,function(b){a=this.parentNode,m.cleanData(ub(this)),a&&a.replaceChild(b,this)}),a&&(a.length||a.nodeType)?this:this.remove()},detach:function(a){return this.remove(a,!0)},domManip:function(a,b){a=e.apply([],a);var c,d,f,g,h,i,j=0,l=this.length,n=this,o=l-1,p=a[0],q=m.isFunction(p);if(q||l>1&&"string"==typeof p&&!k.checkClone&&nb.test(p))return this.each(function(c){var d=n.eq(c);q&&(a[0]=p.call(this,c,d.html())),d.domManip(a,b)});if(l&&(i=m.buildFragment(a,this[0].ownerDocument,!1,this),c=i.firstChild,1===i.childNodes.length&&(i=c),c)){for(g=m.map(ub(i,"script"),xb),f=g.length;l>j;j++)d=i,j!==o&&(d=m.clone(d,!0,!0),f&&m.merge(g,ub(d,"script"))),b.call(this[j],d,j);if(f)for(h=g[g.length-1].ownerDocument,m.map(g,yb),j=0;f>j;j++)d=g[j],ob.test(d.type||"")&&!m._data(d,"globalEval")&&m.contains(h,d)&&(d.src?m._evalUrl&&m._evalUrl(d.src):m.globalEval((d.text||d.textContent||d.innerHTML||"").replace(qb,"")));i=c=null}return this}}),m.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(a,b){m.fn[a]=function(a){for(var c,d=0,e=[],g=m(a),h=g.length-1;h>=d;d++)c=d===h?this:this.clone(!0),m(g[d])[b](c),f.apply(e,c.get());return this.pushStack(e)}});var Cb,Db={};function Eb(b,c){var d,e=m(c.createElement(b)).appendTo(c.body),f=a.getDefaultComputedStyle&&(d=a.getDefaultComputedStyle(e[0]))?d.display:m.css(e[0],"display");return e.detach(),f}function Fb(a){var b=y,c=Db[a];return c||(c=Eb(a,b),"none"!==c&&c||(Cb=(Cb||m("