mapsglmaps/com.xweather.mapsgl.types

Package-level declarations

Types

Anchor

enum Anchor : Enum<Anchor>

Mapbox-style icon/text anchor (icon-anchor / text-anchor). Serialized by com.xweather.mapsgl.style.makeJSONObject.

AnchorOffset

data class AnchorOffset(var x: Double = 0.0, var y: Double = 0.0)

Pixel offset from Anchor (icon-offset / text-offset), serialized as [x, y].

AuthenticationException

class AuthenticationException(message: String) : Exception

ColorBand

enum ColorBand : Enum<ColorBand>

Encoded-tile color channel used by com.xweather.mapsgl.style.SamplePaint.channel (0 red … 3 alpha).

ColorSampling

interface ColorSampling : EncodedSampling

Encoded sampling plus a colorScale ramp (com.xweather.mapsgl.style.SamplePaint).

Coordinate

data class Coordinate(var lat: Double, var lon: Double)

CoordinateBounds

data class CoordinateBounds(val north: Double, val west: Double, val south: Double, val east: Double)

Geographic bounding box in degrees (WGS84).

DataQuality

enum DataQuality : Enum<DataQuality>

Determines the quality of the data when rendered.

DataSourceConsumer

class DataSourceConsumer(val layerId: String, var sourceLayerId: String? = null) : LayerMetadata

DataSourceKind

enum DataSourceKind : Enum<DataSourceKind>

Kind of data a com.xweather.mapsgl.sources.source.spec.SourceDescriptor provides.

DataSourceType

typealias ~~DataSourceType~~ = DataSourceKind

ElevationScale

data class ElevationScale(var metersToTile: Float, var metersToLabelSpace: Float)

EncodedSampling

interface EncodedSampling

Sampling knobs for encoded-grid layers (com.xweather.mapsgl.style.SamplePaint implements this).

Headers

typealias Headers = <Error class: unknown class><Any, Any>

Headers.kt

ILayerMetadata

interface ILayerMetadata

InterpolationMode

enum InterpolationMode : Enum<InterpolationMode>

How encoded samples are interpolated across neighboring texels in SamplePaint.

LayerMetadata

open class LayerMetadata(val layerId: String, val sourceLayerId: String? = null) : ILayerMetadata

LayerType

enum LayerType : Enum<LayerType>

MapsGL layer kinds used on com.xweather.mapsgl.layers.spec.LayerDescriptor.type.

MapProvider

interface MapProvider : Observable

Read-only view of map camera and viewport state for layers and utilities that cannot depend on Mapbox types directly.

Observable

interface Observable

Minimal publish/subscribe hook used by MapProvider implementations for named events.

PlotCoordinate

data class PlotCoordinate(var x: Float, var y: Float, var z: Float)

A PlotCoordinate represents a projected three-dimensional position where { x: 0, y: 0, z: 0 } represents the top-left corner of the viewport or render region, and { x: 1, y: 1, z: 0 } represents the bottom-right corner. The coordinate z value is only used for spherical and three-dimensional map projections as altitude.

Point

data class Point(val x: Double, val y: Double)

Represents a Cartesian position.

Point3Int

data class Point3Int(val x: Int, val y: Int, val z: Int = 0)

Rect

data class Rect(val left: Int, val right: Int, val top: Int, val bottom: Int)

RendererSpecification

interface RendererSpecification

SampleChannel

class SampleChannel(var rawValue: Int)

SampleExpression

enum SampleExpression : Enum<SampleExpression>

How a SamplePaint derives a scalar or vector from encoded raster bands.

Size

data class Size(var width: Int, var height: Int = width)

If you specify one integer, both height and width will be set to that value.

TextJustification

enum TextJustification : Enum<TextJustification>

Horizontal alignment of a text label (text-justify).

TextTransform

enum TextTransform : Enum<TextTransform>

Case transform for a text label (text-transform).

TileSize

data class TileSize(var width: Int, var height: Int)

Logical tile dimensions in pixels (typically 256 or 512).

URLRequest

class URLRequest(val urlString: String, var method: String = "GET", var headers: MutableMap<String, String> = emptyMap<String, String>().toMutableMap(), var queryParams: MutableMap<String, String> = emptyMap<String, String>().toMutableMap(), var body: String? = null, var contentType: String = "application/json", var connectTimeoutMs: Int = 0, var readTimeoutMs: Int = 0)

URLResponse

data class URLResponse(val data: Any?, val headers: Map<String, List<String>>, val statusCode: Int, val contentType: String?)

Functions

TileSize

fun TileSize(size: Int): TileSize

Square TileSize with size × size pixels.