Light

class Light : LightDslReceiver, StyleContract.StyleLightExtension

The global light source.

Check the online documentation.

Constructors

Light
Link copied to clipboard
fun Light()

Types

Companion
Link copied to clipboard
object Companion
Static variables and methods.

Functions

anchor
Link copied to clipboard
open override fun anchor(anchor: Expression): Light
Set the Anchor property
open override fun anchor(anchor: Anchor): Light
Set the Anchor property.
bindTo
Link copied to clipboard
open override fun bindTo(delegate: StyleInterface)
Bind the light to the map controller.
color
Link copied to clipboard
open override fun color(color: Expression): Light
Set the Color property
open override fun color(@ColorInt() color: Int): Light
Set the Color property.
open override fun color(color: String): Light
Set the Color property.
colorTransition
Link copied to clipboard
open override fun colorTransition(options: StyleTransition): Light
Set the Color property transition options.
open override fun colorTransition(block: StyleTransition.Builder.() -> Unit): Light
equals
Link copied to clipboard
open operator fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
open fun hashCode(): Int
intensity
Link copied to clipboard
open override fun intensity(intensity: Expression): Light
Set the Intensity property
open override fun intensity(intensity: Double): Light
Set the Intensity property.
intensityTransition
Link copied to clipboard
open override fun intensityTransition(options: StyleTransition): Light
Set the Intensity property transition options.
open override fun intensityTransition(block: StyleTransition.Builder.() -> Unit): Light
position
Link copied to clipboard
open override fun position(position: Expression): Light
Set the Position property
open override fun position(position: LightPosition): Light
Set the Position property.
open override fun position(radialCoordinate: Double, azimuthalAngle: Double, polarAngle: Double): Light
DSL for setting LightPosition.
positionTransition
Link copied to clipboard
open override fun positionTransition(options: StyleTransition): Light
Set the Position property transition options.
open override fun positionTransition(block: StyleTransition.Builder.() -> Unit): Light
toString
Link copied to clipboard
open fun toString(): String

Properties

anchor
Link copied to clipboard
val anchor: Anchor?
Whether extruded geometries are lit relative to the map or viewport.
anchorAsExpression
Link copied to clipboard
val anchorAsExpression: Expression?
This is an Expression representation of "anchor".
color
Link copied to clipboard
val color: String?
Color tint for lighting extruded geometries.
colorAsColorInt
Link copied to clipboard
val colorAsColorInt: Int?
Color tint for lighting extruded geometries.
colorAsExpression
Link copied to clipboard
val colorAsExpression: Expression?
This is an Expression representation of "color".
colorTransition
Link copied to clipboard
val colorTransition: StyleTransition?
Color property transition options.
intensity
Link copied to clipboard
val intensity: Double?
Intensity of lighting (on a scale from 0 to 1).
intensityAsExpression
Link copied to clipboard
val intensityAsExpression: Expression?
This is an Expression representation of "intensity".
intensityTransition
Link copied to clipboard
val intensityTransition: StyleTransition?
Intensity property transition options.
position
Link copied to clipboard
val position: LightPosition?
Position of the light source relative to lit (extruded) geometries, in r radial coordinate, a azimuthal angle, p polar angle where r indicates the distance from the center of the base of an object to its light, a indicates the position of the light relative to 0 degree (0 degree when light.anchor is set to viewport corresponds to the top of the viewport, or 0 degree when light.anchor is set to map corresponds to due north, and degrees proceed clockwise), and p indicates the height of the light (from 0 degree, directly above, to 180 degree, directly below).
positionAsExpression
Link copied to clipboard
val positionAsExpression: Expression?
This is an Expression representation of "position".
positionTransition
Link copied to clipboard
val positionTransition: StyleTransition?
Position property transition options.