summaryrefslogtreecommitdiff
path: root/platform/ios/src/MGLCompassButton.h
diff options
context:
space:
mode:
Diffstat (limited to 'platform/ios/src/MGLCompassButton.h')
-rw-r--r--platform/ios/src/MGLCompassButton.h22
1 files changed, 22 insertions, 0 deletions
diff --git a/platform/ios/src/MGLCompassButton.h b/platform/ios/src/MGLCompassButton.h
new file mode 100644
index 0000000000..9c3d9d1c77
--- /dev/null
+++ b/platform/ios/src/MGLCompassButton.h
@@ -0,0 +1,22 @@
+#import <UIKit/UIKit.h>
+
+#import "MGLTypes.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ A specialized view that displays the current compass heading for its associated map.
+ */
+MGL_EXPORT
+@interface MGLCompassButton : UIImageView
+
+/**
+ The visibility of the compass button.
+
+ You can configure a compass button to be visible all the time or only when the compass heading changes.
+ */
+@property (nonatomic, assign) MGLOrnamentVisibility compassVisibility;
+
+@end
+
+NS_ASSUME_NONNULL_END