MLNBackgroundStyleLayer class
An MLNBackgroundStyleLayer 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 MLNBackgroundStyleLayer 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 MLNStyle/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.
- Inheritance
-
- Object
- MLNStyleLayer
- MLNBackgroundStyleLayer
Constructors
- MLNBackgroundStyleLayer()
-
Returns a new instance of MLNBackgroundStyleLayer constructed with the default
newmethod.factory - MLNBackgroundStyleLayer.castFrom(ObjCObjectBase other)
-
Constructs a MLNBackgroundStyleLayer that points to the same underlying object as
other. -
MLNBackgroundStyleLayer.castFromPointer(Pointer<
ObjCObject> other, {bool retain = false, bool release = false}) - Constructs a MLNBackgroundStyleLayer that wraps the given raw object pointer.
Properties
- backgroundColor ↔ NSExpression
-
The color with which the background will be drawn.
getter/setter pair
- backgroundColorTransition ↔ MLNTransition
-
The transition affecting any changes to this layer’s
backgroundColorproperty.getter/setter pair - backgroundOpacity ↔ NSExpression
-
The opacity at which the background will be drawn.
getter/setter pair
- backgroundOpacityTransition ↔ MLNTransition
-
The transition affecting any changes to this layer’s
backgroundOpacityproperty.getter/setter pair - backgroundPattern ↔ NSExpression
-
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).
getter/setter pair
- backgroundPatternTransition ↔ MLNTransition
-
The transition affecting any changes to this layer’s
backgroundPatternproperty.getter/setter pair - debugDescription$1 → NSString
-
debugDescription
no setterinherited
- description$1 → NSString
-
description
no setterinherited
- hash$1 → int
-
hash
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- identifier → NSString
-
A string that uniquely identifies the style layer in the style to which it is
added.
no setterinherited
- isProxy → bool
-
isProxy
no setterinherited
- maximumZoomLevel ↔ double
-
The maximum zoom level at which the layer gets parsed and appears. This value is a floating-point
number.
getter/setter pairinherited
- minimumZoomLevel ↔ double
-
The minimum zoom level at which the layer gets parsed and appears. This value is a floating-point
number.
getter/setter pairinherited
- ref → ObjCObjectRef
-
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- superclass$1 → ObjCObjectBase
-
superclass
no setterinherited
- visible ↔ bool
-
Whether this layer is displayed. A value of
NOhides the layer.getter/setter pairinherited
Methods
-
autorelease(
) → MLNBackgroundStyleLayer -
autorelease
override
-
class$1(
) → ObjCObjectBase -
class
inherited
-
conformsToProtocol$1(
Protocol aProtocol) → bool -
conformsToProtocol:
inherited
-
copy(
) → ObjCObjectBase -
copy
inherited
-
dealloc(
) → void -
dealloc
inherited
-
doesNotRecognizeSelector(
Pointer< ObjCSelector> aSelector) → void -
doesNotRecognizeSelector:
inherited
-
forwardingTargetForSelector(
Pointer< ObjCSelector> aSelector) → ObjCObjectBase -
forwardingTargetForSelector:
inherited
-
forwardInvocation(
NSInvocation anInvocation) → void -
forwardInvocation:
inherited
-
init(
) → MLNBackgroundStyleLayer -
init
override
-
initWithIdentifier(
NSString identifier) → MLNBackgroundStyleLayer - Returns a background style layer initialized with an identifier.
-
isEqual(
ObjCObjectBase object) → bool -
isEqual:
inherited
-
isKindOfClass(
ObjCObjectBase aClass) → bool -
isKindOfClass:
inherited
-
isMemberOfClass(
ObjCObjectBase aClass) → bool -
isMemberOfClass:
inherited
-
methodForSelector(
Pointer< ObjCSelector> aSelector) → Pointer<NativeFunction< Void Function()> > -
methodForSelector:
inherited
-
methodSignatureForSelector(
Pointer< ObjCSelector> aSelector) → NSMethodSignature -
methodSignatureForSelector:
inherited
-
mutableCopy(
) → ObjCObjectBase -
mutableCopy
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
performSelector(
Pointer< ObjCSelector> aSelector) → ObjCObjectBase -
performSelector:
inherited
-
performSelector$1(
Pointer< ObjCSelector> aSelector, {required ObjCObjectBase withObject}) → ObjCObjectBase -
performSelector:withObject:
inherited
-
performSelector$2(
Pointer< ObjCSelector> aSelector, {required ObjCObjectBase withObject, required ObjCObjectBase withObject$1}) → ObjCObjectBase -
performSelector:withObject:withObject:
inherited
-
release(
) → void -
release
inherited
-
respondsToSelector(
Pointer< ObjCSelector> aSelector) → bool -
respondsToSelector:
inherited
-
retain(
) → MLNBackgroundStyleLayer -
retain
override
-
retainCount(
) → int -
retainCount
inherited
-
self$1(
) → MLNBackgroundStyleLayer -
self
override
-
toString(
) → String -
A string representation of this object.
inherited
-
zone(
) → Pointer< NSZone> -
zone
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
alloc(
) → MLNBackgroundStyleLayer -
alloc
override
-
allocWithZone(
Pointer< NSZone> zone) → MLNBackgroundStyleLayer -
allocWithZone:
override
-
isInstance(
ObjCObjectBase obj) → bool -
Returns whether
objis an instance of MLNBackgroundStyleLayer.override -
new$(
) → MLNBackgroundStyleLayer -
new
override