[ios] Update more URLs to docs.mapbox.com/ios

This commit is contained in:
Jason Wray
2019-01-24 16:45:51 -08:00
committed by Jason Wray
parent d7cd06eb55
commit 67e5761e72
34 changed files with 109 additions and 104 deletions

View File

@@ -18,8 +18,8 @@ NS_ASSUME_NONNULL_BEGIN
The other methods of this protocol are optional.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/annotation-models/">
Annotation models</a> and <a href="https://www.mapbox.com/ios-sdk/maps/examples/annotation-views/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/annotation-models/">
Annotation models</a> and <a href="https://docs.mapbox.com/ios/maps/examples/annotation-views/">
Annotation views</a> examples to learn how to add objects that follow the
`MGLAnnotation` protocol.
*/

View File

@@ -185,7 +185,7 @@ MGL_EXPORT
identifier and attributes.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/runtime-multiple-annotations/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/runtime-multiple-annotations/">
Dynamically style interactive points</a> example to learn how to initialize
`MGLPointFeature` objects and add them to your map.
*/
@@ -200,7 +200,7 @@ MGL_EXPORT
@see `MGLCluster`
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/clustering/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/clustering/">
Clustering point data</a> example to learn how to initialize
clusters and add them to your map.
*/
@@ -217,7 +217,7 @@ MGL_EXPORT
feature in GeoJSON.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/line-geojson/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/line-geojson/">
Add a line annotation from GeoJSON</a> example to learn how to initialize an
`MGLPolylineFeature` and add it to an `MGLMapView` object.
*/
@@ -284,7 +284,7 @@ MGL_EXPORT
in GeoJSON.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/shape-collection/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/shape-collection/">
Add multiple shapes from a single shape source</a> example to learn how to
add shape data to your map using an `MGLShapeCollectionFeature` object.
*/

View File

@@ -150,7 +150,7 @@ NS_INLINE BOOL MGLCoordinateBoundsIntersectsCoordinateBounds(MGLCoordinateBounds
Returns `YES` if the coordinate is within the coordinate bounds.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/constraining-gestures/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/constraining-gestures/">
Restrict map panning to an area</a> example to learn how to use
`MGLCoordinateInCoordinateBounds` to determine if a point is within, or
intersects, a given bounding box.

View File

@@ -43,7 +43,7 @@ MGL_EXPORT
```
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/image-source/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/image-source/">
Add an image</a> example to learn how to add an image to your map using
`MGLImageSource`.
*/

View File

@@ -11,12 +11,12 @@ NS_ASSUME_NONNULL_BEGIN
some point on an `MGLMapView`.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/camera-animation/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/camera-animation/">
Camera animation</a> example to learn how to create a camera that rotates
around a central point. See the <a href="https://www.mapbox.com/ios-sdk/maps/
examples/constraining-gestures/">Restrict map panning to an area</a> example
to learn how to restrict map panning using `MGLMapViewDelegate`'s
`-mapView:shouldChangeFromCamera:toCamera:` method.
around a central point. See the <a href="https://docs.mapbox.com/ios/maps/examples/constraining-gestures/">
Restrict map panning to an area</a> example to learn how to restrict map
panning using `MGLMapViewDelegate`'s
`-mapView:shouldChangeFromCamera:toCamera:` method.
*/
MGL_EXPORT
@interface MGLMapCamera : NSObject <NSSecureCoding, NSCopying>

View File

@@ -165,7 +165,7 @@ typedef void (^MGLMapSnapshotCompletionHandler)(MGLMapSnapshot* _Nullable snapsh
```
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/map-snapshotter/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/map-snapshotter/">
Create a static map snapshot</a> example to learn how to use the
`MGLMapSnapshotter` to generate a static image based on an `MGLMapView`
object's style, camera, and view bounds.

View File

@@ -28,7 +28,7 @@ NS_ASSUME_NONNULL_BEGIN
path.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/offline-pack/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/offline-pack/">
Download an offline map</a> example to learn how to calculate the progress
of an offline download.
*/
@@ -184,7 +184,7 @@ typedef NS_ENUM(NSUInteger, MGLResourceKind) {
maintains a canonical collection of offline packs in its `packs` property.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/offline-pack/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/offline-pack/">
Download an offline map</a> example to learn how to create and register an
offline pack for a defined region.
*/

View File

@@ -36,9 +36,9 @@ NS_ASSUME_NONNULL_BEGIN
in GeoJSON.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/marker/">
Mark a place on the map with an annotation</a>, <a href="https://www.mapbox.com/ios-sdk/maps/examples/marker-image/">
Mark a place on the map with an image</a>, and <a href="https://www.mapbox.com/ios-sdk/maps/examples/default-callout/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/marker/">
Mark a place on the map with an annotation</a>, <a href="https://docs.mapbox.com/ios/maps/examples/marker-image/">
Mark a place on the map with an image</a>, and <a href="https://docs.mapbox.com/ios/maps/examples/default-callout/">
Default callout usage</a> examples to learn how to add `MGLPointAnnotation`
objects to your map.
*/

View File

@@ -46,7 +46,7 @@ NS_ASSUME_NONNULL_BEGIN
than −180 degrees or greater than 180 degrees.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/polygon/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/polygon/">
Add a polygon annotation</a> example to learn how to initialize an
`MGLPolygon` object from an array of coordinates.
*/

View File

@@ -52,7 +52,7 @@ NS_ASSUME_NONNULL_BEGIN
geometry in GeoJSON.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/annotation-models/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/annotation-models/">
Annotation models</a> example to learn how to add an `MGLPolyine` object to
your map.
*/

View File

@@ -54,7 +54,7 @@ FOUNDATION_EXTERN MGL_EXPORT const MGLTileSourceOption MGLTileSourceOptionTileSi
```
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/source-custom-raster/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/source-custom-raster/">
Add raster imagery</a> example to learn how to add a `MGLRasterStyleLayer`
to your map using an `MGLRasterTileSource`.
*/

View File

@@ -27,7 +27,7 @@ typedef NSString *MGLShapeSourceOption NS_STRING_ENUM;
is ignored when creating an `MGLComputedShapeSource` object.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/clustering/">Cluster point data</a> and <a href="https://www.mapbox.com/ios-sdk/maps/examples/clustering-with-images/">Use images to cluster point data</a> examples to learn how to cluster point data with this `MGLShapeSourceOption`.
See the <a href="https://docs.mapbox.com/ios/maps/examples/clustering/">Cluster point data</a> and <a href="https://docs.mapbox.com/ios/maps/examples/clustering-with-images/">Use images to cluster point data</a> examples to learn how to cluster point data with this `MGLShapeSourceOption`.
*/
FOUNDATION_EXTERN MGL_EXPORT const MGLShapeSourceOption MGLShapeSourceOptionClustered;
@@ -149,7 +149,7 @@ FOUNDATION_EXTERN MGL_EXPORT const MGLShapeSourceOption MGLShapeSourceOptionLine
```
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/clustering/">Cluster point data</a>, <a href="https://www.mapbox.com/ios-sdk/maps/examples/clustering-with-images/">Use images to cluster point data</a>, and <a href="https://www.mapbox.com/ios-sdk/maps/examples/live-data/">Add live data</a> examples to learn how to add data to your map using this `MGLSource` object.
See the <a href="https://docs.mapbox.com/ios/maps/examples/clustering/">Cluster point data</a>, <a href="https://docs.mapbox.com/ios/maps/examples/clustering-with-images/">Use images to cluster point data</a>, and <a href="https://docs.mapbox.com/ios/maps/examples/live-data/">Add live data</a> examples to learn how to add data to your map using this `MGLSource` object.
*/
MGL_EXPORT
@interface MGLShapeSource : MGLSource
@@ -175,7 +175,7 @@ MGL_EXPORT
@return An initialized shape source.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/live-data/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/live-data/">
Add live data</a> example to learn how to add live data to your map by
updating the an `MGLShapeSource` object's `URL` property.
*/
@@ -209,7 +209,7 @@ MGL_EXPORT
@return An initialized shape source.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/runtime-animate-line/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/runtime-animate-line/">
Animate a line</a> example to learn how to animate line data by continously
updating an `MGLShapeSource`'s `shape` attribute.
*/

View File

@@ -54,7 +54,7 @@ FOUNDATION_EXTERN MGL_EXPORT MGLExceptionName const MGLRedundantSourceIdentifier
that it's safe to modify the map's style.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/default-styles/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/default-styles/">
Default styles</a> example to learn how to initialize an `MGLMapView` object
with a Mapbox default style using `MGLStyle`'s class methods.
*/
@@ -184,7 +184,7 @@ MGL_EXPORT
significantly from version to version.
#### Related example
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/satellite-style/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/satellite-style/">
Satellite styles</a> example to learn how to initialize a map with the Mapbox
Satellite style.
*/
@@ -220,7 +220,7 @@ MGL_EXPORT
change significantly from version to version.
#### Related example
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/satellite-style/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/satellite-style/">
Satellite styles</a> example to learn how to initialize a map with the Mapbox
Satellite Streets style.
*/
@@ -426,7 +426,7 @@ MGL_EXPORT
@param sibling An existing layer in the style.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/shape-collection/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/shape-collection/">
Add multiple shapes from a single shape source</a> example to learn how to
add a layer to your map below an existing layer.
*/
@@ -451,7 +451,7 @@ MGL_EXPORT
@param sibling An existing layer in the style.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/image-source/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/image-source/">
Add an image</a> example to learn how to add a layer to your map above an
existing layer.
*/
@@ -514,8 +514,8 @@ MGL_EXPORT
@param name The name of the image to set to the style.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/clustering-with-images/">
Use images to cluster point data</a> and <a href="https://www.mapbox.com/ios-sdk/maps/examples/clustering/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/clustering-with-images/">
Use images to cluster point data</a> and <a href="https://docs.mapbox.com/ios/maps/examples/clustering/">
Cluster point data</a> examples to learn how to add images to your map using
an `MGLStyle` object.
*/

View File

@@ -45,7 +45,7 @@ MGL_EXPORT
Whether this layer is displayed. A value of `NO` hides the layer.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/runtime-toggle-layer/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/runtime-toggle-layer/">
Show and hide a layer</a> example to learn how to toggle an `MGLStyleLayer`
object's visibility.
*/

View File

@@ -14,7 +14,7 @@ NS_ASSUME_NONNULL_BEGIN
use the MGLShapeOfflineRegion class instead.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/offline-pack/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/offline-pack/">
Download an offline map</a> example to learn how to define an offline region
to be downloaded to a user's device.
*/

View File

@@ -55,7 +55,7 @@ NS_ASSUME_NONNULL_BEGIN
```
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/dds-circle-layer/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/dds-circle-layer/">
Data-driven circles</a> example to learn how to add data to your map using
an `MGLVectorTileSource` object.
*/

View File

@@ -114,9 +114,9 @@ FOUNDATION_EXTERN MGL_EXPORT const MGLExpressionInterpolationMode MGLExpressionI
@param stops The stops must be an `NSDictionary` constant `NSExpression`.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/dds-circle-layer/">
Data-driven circles</a>, <a href="https://www.mapbox.com/ios-sdk/maps/examples/clustering/">
Cluster point data</a>, and <a href="https://www.mapbox.com/ios-sdk/maps/examples/clustering-with-images/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/dds-circle-layer/">
Data-driven circles</a>, <a href="https://docs.mapbox.com/ios/maps/examples/clustering/">
Cluster point data</a>, and <a href="https://docs.mapbox.com/ios/maps/examples/clustering-with-images/">
Use images to cluster point data</a> examples to learn how to use this
expression to style a map layer based on an attribute value.
*/
@@ -134,7 +134,7 @@ FOUNDATION_EXTERN MGL_EXPORT const MGLExpressionInterpolationMode MGLExpressionI
@param stops The stops expression.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/heatmap-example/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/heatmap-example/">
Create a heatmap layer</a> example to learn how to style an `MGLHeatmapStyleLayer`
based on zoom level and point density with this expression.
*/

View File

@@ -59,7 +59,7 @@ To add any Objective-C type, constant, or member to the iOS SDK’s public inter
1. Ensure that the symbol is pure Objective-C and does not rely on any language features specific to Objective-C++ or the C11 dialect of C – so no namespaced types or classes named with emoji! 🙃 Most projects that depend on this SDK are either written in pure Objective-C (GNU99 dialect) or Swift, which cannot yet bridge C++ types.
1. Name the symbol according to [Cocoa naming conventions](https://developer.apple.com/library/prerelease/content/documentation/Cocoa/Conceptual/CodingGuidelines/CodingGuidelines.html#//apple_ref/doc/uid/10000146i). Use the `MGL` class prefix to avoid conflicts with client code. If the symbol has an analogue in MapKit, name the symbol according to MapKit.
1. Provide full documentation comments. We use [jazzy](https://github.com/realm/jazzy/) to produce the documentation found in the SDK distribution and [on the website for this SDK](https://www.mapbox.com/ios-sdk/api/). We also recognize that many developers rely on Xcode’s Quick Help feature. jazzy supports Markdown formatting; however, Quick Help supports only [HeaderDoc](https://developer.apple.com/legacy/library/documentation/DeveloperTools/Conceptual/HeaderDoc/intro/intro.html) syntax and a subset of Doxygen syntax. For hyperlinks, use HTML syntax, which is recognized by both tools.
1. Provide full documentation comments. We use [jazzy](https://github.com/realm/jazzy/) to produce the documentation found in the SDK distribution and [on the website for this SDK](https://docs.mapbox.com/ios/api/maps/). We also recognize that many developers rely on Xcode’s Quick Help feature. jazzy supports Markdown formatting; however, Quick Help supports only [HeaderDoc](https://developer.apple.com/legacy/library/documentation/DeveloperTools/Conceptual/HeaderDoc/intro/intro.html) syntax and a subset of Doxygen syntax. For hyperlinks, use HTML syntax, which is recognized by both tools.
### Making a type or constant public

View File

@@ -6,7 +6,7 @@
@implementation MGLStyleLayerIntegrationTests
- (MGLCircleStyleLayer*)setupCircleStyleLayer {
// Adapted from https://www.mapbox.com/ios-sdk/examples/dds-circle-layer/
// Adapted from https://docs.mapbox.com/ios/examples/dds-circle-layer/
// "mapbox://examples.2uf7qges" is a map ID referencing a tileset. For more
// more information, see docs.mapbox.com/help/glossary/map-id/
@@ -23,7 +23,7 @@
- (void)testForInterpolatingExpressionRenderCrashWithEmptyStops {
// Tests: https://github.com/mapbox/mapbox-gl-native/issues/9539
// Adapted from https://www.mapbox.com/ios-sdk/examples/dds-circle-layer/
// Adapted from https://docs.mapbox.com/ios/examples/dds-circle-layer/
self.mapView.centerCoordinate = CLLocationCoordinate2DMake(38.897,-77.039);
self.mapView.zoomLevel = 10.5;
@@ -42,7 +42,7 @@
- (void)testForSteppingExpressionRenderCrashWithEmptyStops {
// Tests: https://github.com/mapbox/mapbox-gl-native/issues/9539
// Adapted from https://www.mapbox.com/ios-sdk/examples/dds-circle-layer/
// Adapted from https://docs.mapbox.com/ios/examples/dds-circle-layer/
self.mapView.centerCoordinate = CLLocationCoordinate2DMake(38.897,-77.039);
self.mapView.zoomLevel = 10.5;

View File

@@ -7,12 +7,12 @@ Pod::Spec.new do |m|
m.summary = 'Open source vector map solution for iOS with full styling capabilities.'
m.description = 'Open source, OpenGL-based vector map solution for iOS with full styling capabilities and Cocoa Touch APIs.'
m.homepage = 'https://www.mapbox.com/ios-sdk/'
m.homepage = 'https://docs.mapbox.com/ios/maps/'
m.license = { :type => 'BSD', :file => 'LICENSE.md' }
m.author = { 'Mapbox' => 'mobile@mapbox.com' }
m.screenshot = "https://www.mapbox.com/ios-sdk/api/#{version}/img/screenshot.png"
m.screenshot = "https://docs.mapbox.com/ios/api/maps/#{version}/img/screenshot.png"
m.social_media_url = 'https://twitter.com/mapbox'
m.documentation_url = 'https://www.mapbox.com/ios-sdk/api/'
m.documentation_url = 'https://docs.mapbox.com/ios/api/maps/'
m.source = {
:http => "https://mapbox.s3.amazonaws.com/mapbox-gl-native/ios/builds/mapbox-ios-sdk-nightly-dynamic.zip",

View File

@@ -7,12 +7,12 @@ Pod::Spec.new do |m|
m.summary = 'Open source vector map solution for iOS with full styling capabilities.'
m.description = 'Open source, OpenGL-based vector map solution for iOS with full styling capabilities and Cocoa Touch APIs.'
m.homepage = 'https://www.mapbox.com/ios-sdk/'
m.homepage = 'https://docs.mapbox.com/ios/maps/'
m.license = { :type => 'BSD', :file => 'LICENSE.md' }
m.author = { 'Mapbox' => 'mobile@mapbox.com' }
m.screenshot = "https://www.mapbox.com/ios-sdk/api/#{version}/img/screenshot.png"
m.screenshot = "https://docs.mapbox.com/ios/api/maps/#{version}/img/screenshot.png"
m.social_media_url = 'https://twitter.com/mapbox'
m.documentation_url = 'https://www.mapbox.com/ios-sdk/api/'
m.documentation_url = 'https://docs.mapbox.com/ios/api/maps/'
m.source = {
:http => "https://mapbox.s3.amazonaws.com/mapbox-gl-native/ios/builds/mapbox-ios-sdk-#{m.version.to_s}-dynamic.zip",

View File

@@ -7,12 +7,12 @@ Pod::Spec.new do |m|
m.summary = 'Open source vector map solution for iOS with full styling capabilities.'
m.description = 'Open source, OpenGL-based vector map solution for iOS with full styling capabilities and Cocoa Touch APIs.'
m.homepage = 'https://www.mapbox.com/ios-sdk/'
m.homepage = 'https://docs.mapbox.com/ios/maps/'
m.license = { :type => 'BSD', :file => 'LICENSE.md' }
m.author = { 'Mapbox' => 'mobile@mapbox.com' }
m.screenshot = "https://www.mapbox.com/ios-sdk/api/#{version}/img/screenshot.png"
m.screenshot = "https://docs.mapbox.com/ios/api/maps/#{version}/img/screenshot.png"
m.social_media_url = 'https://twitter.com/mapbox'
m.documentation_url = 'https://www.mapbox.com/ios-sdk/api/'
m.documentation_url = 'https://docs.mapbox.com/ios/api/maps/'
m.source = {
:http => "https://mapbox.s3.amazonaws.com/mapbox-gl-native/ios/builds/mapbox-ios-sdk-#{m.version.to_s}-dynamic.zip",

View File

@@ -1,10 +1,10 @@
# [Mapbox Maps SDK for iOS](https://www.mapbox.com/ios-sdk/)
# [Mapbox Maps SDK for iOS](https://docs.mapbox.com/ios/maps/)
[![Circle CI build status](https://circleci.com/gh/mapbox/mapbox-gl-native.svg?style=shield)](https://circleci.com/gh/mapbox/workflows/mapbox-gl-native/tree/master)
A library based on [Mapbox GL Native](../../README.md) for embedding interactive map views with scalable, customizable vector maps into Cocoa Touch applications on iOS using Objective-C, Swift, or Interface Builder.
This repository is for day-to-day development of the SDK. Building the SDK yourself requires [a number of dependencies and steps](../../INSTALL.md) that are unnecessary for developing production applications. For production applications, please consider installing an official, prebuilt release instead; see the [Mapbox iOS SDK website](https://www.mapbox.com/ios-sdk/) for installation instructions.
This repository is for day-to-day development of the SDK. Building the SDK yourself requires [a number of dependencies and steps](../../INSTALL.md) that are unnecessary for developing production applications. For production applications, please consider installing an official, prebuilt release instead; see the [Mapbox Maps SDK for iOS website](https://docs.mapbox.com/ios/maps/) for installation instructions.
* [Integrate the Mapbox Maps SDK for iOS into your application](https://www.mapbox.com/install/ios/).
* [Learn about custom builds](INSTALL.md)

View File

@@ -2,7 +2,7 @@ module: Mapbox
author: Mapbox
author_url: https://www.mapbox.com/
github_url: https://github.com/mapbox/mapbox-gl-native
dash_url: https://www.mapbox.com/ios-sdk/docsets/Mapbox.xml
dash_url: https://docs.mapbox.com/ios/docsets/Mapbox.xml
copyright: '© 2014–2019 [Mapbox](https://www.mapbox.com/). See [license](https://github.com/mapbox/mapbox-gl-native/blob/master/LICENSE.md) for more details.'
head: |

View File

@@ -55,7 +55,7 @@ jazzy \
--module-version ${SHORT_VERSION} \
--readme ${README} \
--documentation="platform/{darwin,ios}/docs/guides/*.md" \
--root-url https://www.mapbox.com/ios-sdk/api/${RELEASE_VERSION}/ \
--root-url https://docs.mapbox.com/ios/api/maps/${RELEASE_VERSION}/ \
--theme ${THEME} \
--output ${OUTPUT}

View File

@@ -11,7 +11,7 @@ NS_ASSUME_NONNULL_BEGIN
by the map view.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/marker-image/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/marker-image/">
Mark a place on the map with an image</a> example to learn how use an image
as a marker using `MGLAnnotationImage`.
*/

View File

@@ -224,7 +224,7 @@ MGL_EXPORT
change is immediate.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/annotation-vie
See the <a href="https://docs.mapbox.com/ios/maps/examples/annotation-vie
ws/">Annotation views</a> example to learn how to modify an
`MGLAnnotationView`'s behavior when it is selected.
*/
@@ -257,7 +257,7 @@ MGL_EXPORT
continue to completion.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/draggable-views
See the <a href="https://docs.mapbox.com/ios/maps/examples/draggable-views
/">Draggable annotation views</a> to learn how to enable users to drag
`MGLAnnotationView` objects on your map.
*/

View File

@@ -13,7 +13,7 @@ NS_ASSUME_NONNULL_BEGIN
use the optional methods available in the `MGLCalloutViewDelegate` protocol.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/custom-callout/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/custom-callout/">
Display custom views as callouts</a> example to learn how to customize an
`MGLCalloutView`.
*/

View File

@@ -53,7 +53,9 @@ typedef NS_ENUM(NSUInteger, MGLAnnotationVerticalAlignment) {
`MGLMapView.userTrackingMode`.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/user-tracking-mode/">Switch between user tracking modes</a> example to learn how to toggle modes and how each mode behaves.
See the <a href="https://docs.mapbox.com/ios/maps/examples/user-tracking-mode/">
Switch between user tracking modes</a> example to learn how to toggle modes and
how each mode behaves.
*/
typedef NS_ENUM(NSUInteger, MGLUserTrackingMode) {
/** The map does not follow the user location. */
@@ -156,7 +158,7 @@ FOUNDATION_EXTERN MGL_EXPORT MGLExceptionName const MGLResourceNotFoundException
ensuring that your use adheres to the relevant terms of use.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/simple-map-view/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/simple-map-view/">
Simple map view</a> example to learn how to initialize a basic `MGLMapView`.
*/
MGL_EXPORT IB_DESIGNABLE
@@ -185,13 +187,14 @@ MGL_EXPORT IB_DESIGNABLE
@return An initialized map view.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/custom-style/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/custom-style/">
Apply a style designed in Mapbox Studio</a> example to learn how to
initialize an `MGLMapView` with a custom style. See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/raster-styles/">
Appy a style designed in Mapbox Studio Classic</a> example to learn how to
intialize an `MGLMapView` with a Studio Classic style _or_ a custom style
JSON. See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/source-custom-vector/">
Use third-party vector tiles</a> example to learn how to initialize an
initialize an `MGLMapView` with a custom style. See the
<a href="https://docs.mapbox.com/ios/maps/examples/raster-styles/"> Apply a
style designed in Mapbox Studio Classic</a> example to learn how to intialize
an `MGLMapView` with a Studio Classic style _or_ a custom style JSON. See the
<a href="https://docs.mapbox.com/ios/maps/examples/source-custom-vector/"> Use
third-party vector tiles</a> example to learn how to initialize an
`MGLMapView` with a third-party tile source.
*/
- (instancetype)initWithFrame:(CGRect)frame styleURL:(nullable NSURL *)styleURL;
@@ -248,7 +251,7 @@ MGL_EXPORT IB_DESIGNABLE
you want to introspect individual style attributes, use the `style` property.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/switch-styles/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/switch-styles/">
Switch between map styles</a> example to learn how to change the style of
a map at runtime.
*/
@@ -421,7 +424,7 @@ MGL_EXPORT IB_DESIGNABLE
`-setUserTrackingMode:animated:` method instead.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/user-location-annotation/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/user-location-annotation/">
Customize the user location annotation</a> to learn how to customize the
default user location annotation shown by `MGLUserTrackingMode`.
*/
@@ -918,7 +921,7 @@ MGL_EXPORT IB_DESIGNABLE
immediately.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/camera-animation/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/camera-animation/">
Camera animation</a> example to learn how to trigger an animation that
rotates around a central point.
*/
@@ -937,7 +940,7 @@ MGL_EXPORT IB_DESIGNABLE
is `0`, this parameter is ignored.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/camera-animation/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/camera-animation/">
Camera animation</a> example to learn how to create a timed animation that
rotates around a central point for a specific duration.
*/
@@ -1185,7 +1188,7 @@ MGL_EXPORT IB_DESIGNABLE
@return The geographic coordinate at the given point.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/point-conversion/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/point-conversion/">
Point conversion</a> example to learn how to convert a `CGPoint` to a map
coordinate.
*/
@@ -1204,7 +1207,7 @@ MGL_EXPORT IB_DESIGNABLE
corresponding to the given geographic coordinate.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/point-conversion/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/point-conversion/">
Point conversion</a> example to learn how to convert a map coordinate to a
`CGPoint` object.
*/
@@ -1281,8 +1284,8 @@ MGL_EXPORT IB_DESIGNABLE
annotation object.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/annotation-models/">
Annotation models</a> and <a href="https://www.mapbox.com/ios-sdk/maps/examples/line-geojson/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/annotation-models/">
Annotation models</a> and <a href="https://docs.mapbox.com/ios/maps/examples/line-geojson/">
Add a line annotation from GeoJSON</a> examples to learn how to add an
annotation to an `MGLMapView` object.
*/
@@ -1352,7 +1355,7 @@ MGL_EXPORT IB_DESIGNABLE
such object exists in the reuse queue.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/annotation-view-image/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/annotation-view-image/">
Add annotation views and images</a> example learn how to most efficiently
reuse an `MGLAnnotationImage`.
*/
@@ -1517,7 +1520,7 @@ MGL_EXPORT IB_DESIGNABLE
represent features in the sources used by the current style.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/select-layer/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/select-layer/">
Select a feature within a layer</a> example to learn how to query an
`MGLMapView` object for visible `MGLFeature` objects.
*/

View File

@@ -43,7 +43,7 @@ NS_ASSUME_NONNULL_BEGIN
`oldCamera` or change to `newCamera`.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/constraining-gestures/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/constraining-gestures/">
Restrict map panning to an area</a> example to learn how to use this method
and `MGLMapCamera` objects to restrict a users ability to pan your map.
*/
@@ -116,7 +116,7 @@ NS_ASSUME_NONNULL_BEGIN
@param mapView The map view whose viewpoint is changing.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/clustering/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/clustering/">
Cluster point data</a> example to learn how to trigger an action whenever
the map region changes.
*/
@@ -268,8 +268,8 @@ NS_ASSUME_NONNULL_BEGIN
@param style The style that was loaded.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/runtime-multiple-annotations/">
Dynamically style interactive points</a> and <a href="https://www.mapbox.com/ios-sdk/maps/examples/shape-collection/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/runtime-multiple-annotations/">
Dynamically style interactive points</a> and <a href="https://docs.mapbox.com/ios/maps/examples/shape-collection/">
Add multiple shapes from a single shape source</a> examples to learn how to
ensure a map's style has loaded before modifying it at runtime.
*/
@@ -374,9 +374,9 @@ NS_ASSUME_NONNULL_BEGIN
`nil` if you want to display the default marker image or an annotation view.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/annotation-models/">
Annotation models</a>, <a href="https://www.mapbox.com/ios-sdk/maps/examples/annotation-view-image/">
Add annotation views and images</a>, and <a href="https://www.mapbox.com/ios-sdk/maps/examples/marker-image/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/annotation-models/">
Annotation models</a>, <a href="https://docs.mapbox.com/ios/maps/examples/annotation-view-image/">
Add annotation views and images</a>, and <a href="https://docs.mapbox.com/ios/maps/examples/marker-image/">
Mark a place on the map with an image</a> examples to learn to specify which
image should be used for `MGLAnnotation` objects that have been added to
your map.
@@ -414,7 +414,7 @@ NS_ASSUME_NONNULL_BEGIN
@return A color to use for the shape outline.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/annotation-models/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/annotation-models/">
Annotation models</a> example to learn how to modify the outline color of an
`MGLShape` object that has been added to your map as an annotation.
*/
@@ -434,7 +434,7 @@ NS_ASSUME_NONNULL_BEGIN
@return The polygon’s interior fill color.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/polygon/">Add
See the <a href="https://docs.mapbox.com/ios/maps/examples/polygon/">Add
a polygon annotation</a> example to learn how to modify the color of a an
`MGLPolygon` at runtime.
*/
@@ -451,7 +451,7 @@ NS_ASSUME_NONNULL_BEGIN
@return A line width for the polyline, measured in points.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/line-geojson/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/line-geojson/">
Add a line annotation from GeoJSON</a> example to learn how to modify the
line width of an `MGLPolylineFeature` on your map.
*/
@@ -483,7 +483,7 @@ NS_ASSUME_NONNULL_BEGIN
want to display an annotation image instead.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/annotation-view-image/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/annotation-view-image/">
Add annotation views and images</a> example to learn how to specify what
`MGLViewAnnotation` to use for a given `MGLPointAnnotation` object on your
map.
@@ -530,7 +530,7 @@ NS_ASSUME_NONNULL_BEGIN
@param annotation The annotation that was selected.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/runtime-multiple-annotations/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/runtime-multiple-annotations/">
Dynamically style interactive points</a> example to learn how to remove an
annotation view if it has already been selected.
*/
@@ -609,9 +609,9 @@ NS_ASSUME_NONNULL_BEGIN
callout.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/annotation-view-image/">
Add annotation views and images</a>, <a href="https://www.mapbox.com/ios-sdk/maps/examples/custom-callout/">
Display custom views as callouts</a>, and <a href="https://www.mapbox.com/ios-sdk/maps/examples/default-callout/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/annotation-view-image/">
Add annotation views and images</a>, <a href="https://docs.mapbox.com/ios/maps/examples/custom-callout/">
Display custom views as callouts</a>, and <a href="https://docs.mapbox.com/ios/maps/examples/default-callout/">
Default callout usage</a> examples to learn how to show callouts for
`MGLAnnotation` objects.
*/
@@ -633,7 +633,7 @@ NS_ASSUME_NONNULL_BEGIN
default callout view.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/custom-callout/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/custom-callout/">
Display custom views as callouts</a> example to learn how to customize an
`MGLAnnotation` object's `MGLCalloutView`.
*/
@@ -664,7 +664,7 @@ NS_ASSUME_NONNULL_BEGIN
@return The accessory view to display.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/default-callout/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/default-callout/">
Default callout usage</a> example to learn how to modify the view that is
displayed on the left side of the standard callout bubble.
*/
@@ -695,7 +695,7 @@ NS_ASSUME_NONNULL_BEGIN
@return The accessory view to display.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/default-callout/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/default-callout/">
Default callout usage</a> example to learn how to modify the view that is
displayed on the right side of the standard callout bubble.
*/
@@ -725,7 +725,7 @@ NS_ASSUME_NONNULL_BEGIN
@param control The control that was tapped.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/default-callout/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/default-callout/">
Default callout usage</a> example to learn how to trigger an action when the
standard callout bubble's accessory control is tapped.
*/
@@ -748,7 +748,7 @@ NS_ASSUME_NONNULL_BEGIN
@param annotation The annotation whose callout was tapped.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/custom-callout/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/custom-callout/">
Display custom views as callouts</a> example to learn how to trigger an
action when an `MGLAnnotation`s `MGLCalloutView` is tapped.
*/

View File

@@ -189,7 +189,7 @@ static NSString * const MGLVariableGeofence = @"VariableGeofence";
@"End users must be able to opt out of Mapbox Telemetry in your app, either inside Settings (via Settings.bundle) or inside this app. "
@"By default, this opt-out control is included as a menu item in the attribution action sheet. "
@"If you reimplement the opt-out control inside this app, disable this assertion by setting MGLMapboxMetricsEnabledSettingShownInApp to YES in Info.plist."
@"\n\nSee https://www.mapbox.com/ios-sdk/#telemetry_opt_out for more information."
@"\n\nSee https://docs.mapbox.com/help/how-mapbox-works/attribution/#mapbox-maps-sdk-for-ios for more information."
@"\n\nAdditionally, by hiding this attribution control you agree to display the required attribution elsewhere in this app."];
}
}

View File

@@ -13,7 +13,9 @@ NS_ASSUME_NONNULL_BEGIN
`userLocation` property of the map view displayed in your application.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/user-location-annotation/">Customize the user location annotation</a> example to learn how to overide the default user location annotation.
See the <a href="https://docs.mapbox.com/ios/maps/examples/user-location-annotation/">
Customize the user location annotation</a> example to learn how to overide the
default user location annotation.
*/
MGL_EXPORT
@interface MGLUserLocation : NSObject <MGLAnnotation, NSSecureCoding>

View File

@@ -27,7 +27,7 @@ MGL_EXPORT
is inactive.
#### Related examples
See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/user-location-annotation/">
See the <a href="https://docs.mapbox.com/ios/maps/examples/user-location-annotation/">
Customize the user location annotation</a> example to learn how to customize
the default user location annotation object.
*/

View File

@@ -6,7 +6,7 @@ Put interactive, scalable world maps into your native Cocoa application with the
* Customize every aspect of the map’s appearance in code or visually using [Mapbox Studio](https://www.mapbox.com/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](https://www.mapbox.com/maps/), including [iOS](https://www.mapbox.com/ios-sdk/), using the same styles and similar APIs.
* Develop across [multiple platforms](https://www.mapbox.com/maps/), including [iOS](https://docs.mapbox.com/ios/maps/), using the same styles and similar APIs.
![](https://raw.githubusercontent.com/mapbox/mapbox-gl-native/master/platform/macos/docs/img/screenshot.jpg)
@@ -93,6 +93,6 @@ script AppDelegate
end script
```
Full API documentation is included in this package, within the `documentation` folder, and [online](https://mapbox.github.io/mapbox-gl-native/macos/). The [Mapbox Maps SDK for iOS](https://www.mapbox.com/ios-sdk/) has [API documentation](https://www.mapbox.com/ios-sdk/api/) and [online examples](https://www.mapbox.com/ios-sdk/examples/) that apply to the Mapbox Maps SDK for macOS with few differences, mostly around unimplemented features like user location tracking.
Full API documentation is included in this package, within the `documentation` folder, and [online](https://mapbox.github.io/mapbox-gl-native/macos/). The [Mapbox Maps SDK for iOS](https://docs.mapbox.com/ios/maps/) has [API documentation](https://docs.mapbox.com/ios/api/maps/) and [online examples](https://docs.mapbox.com/ios/maps/examples/) that apply to the Mapbox Maps SDK for macOS 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](https://github.com/mapbox/mapbox-gl-native/issues/) are certainly welcome.