MapLibre Compose API Reference

0.11.1

maplibre-native-bindings/org.maplibre.kmp.native.map/MapCanvas

MapCanvas

class MapCanvas(mapObserver: MapObserver, mapOptions: MapOptions = MapOptions(), resourceOptions: ResourceOptions = ResourceOptions(), clientOptions: ClientOptions = ClientOptions(), onMapReady: (MapLibreMap, MapCanvas) -> Unit = { _, _ -> }) : Canvas(source)

A Canvas that automatically initializes and manages a MapLibre map. This class encapsulates all the initialization logic and provides a callback when the map is ready for configuration.

Constructors

constructor(mapObserver: MapObserver, mapOptions: MapOptions = MapOptions(), resourceOptions: ResourceOptions = ResourceOptions(), clientOptions: ClientOptions = ClientOptions(), onMapReady: (MapLibreMap, MapCanvas) -> Unit = { _, _ -> })

Properties

var background: Color

val bufferStrategy: BufferStrategy

componentOrientation

var componentOrientation: ComponentOrientation

var cursor: Cursor

var dropTarget: DropTarget

var enabled: Boolean

var focusable: Boolean

focusTraversalKeysEnabled

var focusTraversalKeysEnabled: Boolean

var foreground: Color

val height: Int

var ignoreRepaint: Boolean

var locale: Locale

var name: String

val parent: Container

val valid: Boolean

var visible: Boolean

val x: Int

val y: Int

Functions

open fun ~~action~~(p0: Event, p1: Any): Boolean

open fun add(p0: PopupMenu)

addComponentListener

open fun addComponentListener(p0: ComponentListener)

addFocusListener

open fun addFocusListener(p0: FocusListener)

addHierarchyBoundsListener

open fun addHierarchyBoundsListener(p0: HierarchyBoundsListener)

addHierarchyListener

open fun addHierarchyListener(p0: HierarchyListener)

addInputMethodListener

open fun addInputMethodListener(p0: InputMethodListener)

open fun addKeyListener(p0: KeyListener)

addMouseListener

open fun addMouseListener(p0: MouseListener)

addMouseMotionListener

open fun addMouseMotionListener(p0: MouseMotionListener)

addMouseWheelListener

open fun addMouseWheelListener(p0: MouseWheelListener)

open override fun addNotify()

addPropertyChangeListener

open fun addPropertyChangeListener(p0: PropertyChangeListener)

open fun addPropertyChangeListener(p0: String, p1: PropertyChangeListener)

applyComponentOrientation

open fun applyComponentOrientation(p0: ComponentOrientation)

areFocusTraversalKeysSet

open fun areFocusTraversalKeysSet(p0: Int): Boolean

open fun ~~bounds~~(): Rectangle

open fun checkImage(p0: Image, p1: ImageObserver): Int

open fun checkImage(p0: Image, p1: Int, p2: Int, p3: ImageObserver): Int

open operator fun contains(p0: Point): Boolean

open fun contains(p0: Int, p1: Int): Boolean

createBufferStrategy

open override fun createBufferStrategy(p0: Int)

open override fun createBufferStrategy(p0: Int, p1: BufferCapabilities)

open fun createImage(p0: ImageProducer): Image

open fun createImage(p0: Int, p1: Int): Image

createVolatileImage

open fun createVolatileImage(p0: Int, p1: Int): VolatileImage

open fun createVolatileImage(p0: Int, p1: Int, p2: ImageCapabilities): VolatileImage

open fun ~~deliverEvent~~(p0: Event)

open fun ~~disable~~()

fun dispatchEvent(p0: AWTEvent)

open fun doLayout()

open fun ~~enable~~()

open fun ~~enable~~(p0: Boolean)

enableInputMethods

open fun enableInputMethods(p0: Boolean)

firePropertyChange

open fun firePropertyChange(p0: String, p1: Byte, p2: Byte)

open fun firePropertyChange(p0: String, p1: Char, p2: Char)

open fun firePropertyChange(p0: String, p1: Double, p2: Double)

open fun firePropertyChange(p0: String, p1: Float, p2: Float)

open fun firePropertyChange(p0: String, p1: Long, p2: Long)

open fun firePropertyChange(p0: String, p1: Short, p2: Short)

getAccessibleContext

open override fun getAccessibleContext(): AccessibleContext

open fun getAlignmentX(): Float

open fun getAlignmentY(): Float

open fun getBaseline(p0: Int, p1: Int): Int

getBaselineResizeBehavior

open fun getBaselineResizeBehavior(): Component.BaselineResizeBehavior

open fun getBounds(): Rectangle

open fun getBounds(p0: Rectangle): Rectangle

open fun getColorModel(): ColorModel

open fun getComponentAt(p0: Point): Component

open fun getComponentAt(p0: Int, p1: Int): Component

getComponentListeners

open fun getComponentListeners(): Array<ComponentListener>

getFocusCycleRootAncestor

open fun getFocusCycleRootAncestor(): Container

getFocusListeners

open fun getFocusListeners(): Array<FocusListener>

getFocusTraversalKeys

open fun getFocusTraversalKeys(p0: Int): MutableSet<AWTKeyStroke>

open fun getFontMetrics(p0: Font): FontMetrics

open fun getGraphics(): Graphics

getGraphicsConfiguration

open fun getGraphicsConfiguration(): GraphicsConfiguration

getHierarchyBoundsListeners

open fun getHierarchyBoundsListeners(): Array<HierarchyBoundsListener>

getHierarchyListeners

open fun getHierarchyListeners(): Array<HierarchyListener>

getInputContext

open fun getInputContext(): InputContext

getInputMethodListeners

open fun getInputMethodListeners(): Array<InputMethodListener>

getInputMethodRequests

open fun getInputMethodRequests(): InputMethodRequests

getKeyListeners

open fun getKeyListeners(): Array<KeyListener>

open fun <T : EventListener> getListeners(p0: Class<T>): Array<T>

open fun getLocation(): Point

open fun getLocation(p0: Point): Point

getLocationOnScreen

open fun getLocationOnScreen(): Point

open fun getMaximumSize(): Dimension

open fun getMinimumSize(): Dimension

getMouseListeners

open fun getMouseListeners(): Array<MouseListener>

getMouseMotionListeners

open fun getMouseMotionListeners(): Array<MouseMotionListener>

getMousePosition

open fun getMousePosition(): Point

getMouseWheelListeners

open fun getMouseWheelListeners(): Array<MouseWheelListener>

getPreferredSize

open fun getPreferredSize(): Dimension

getPropertyChangeListeners

open fun getPropertyChangeListeners(): Array<PropertyChangeListener>

open fun getPropertyChangeListeners(p0: String): Array<PropertyChangeListener>

open fun getSize(): Dimension

open fun getSize(p0: Dimension): Dimension

open fun getToolkit(): Toolkit

fun getTreeLock(): Any

open fun ~~gotFocus~~(p0: Event, p1: Any): Boolean

open fun ~~handleEvent~~(p0: Event): Boolean

open fun hasFocus(): Boolean

open fun ~~hide~~()

open override fun imageUpdate(p0: Image, p1: Int, p2: Int, p3: Int, p4: Int, p5: Int): Boolean

open fun ~~inside~~(p0: Int, p1: Int): Boolean

open fun invalidate()

isBackgroundSet

open fun isBackgroundSet(): Boolean

open fun isCursorSet(): Boolean

open fun isDisplayable(): Boolean

isDoubleBuffered

open fun isDoubleBuffered(): Boolean

isFocusCycleRoot

open fun isFocusCycleRoot(p0: Container): Boolean

open fun isFocusOwner(): Boolean

isFocusTraversable

open fun ~~isFocusTraversable~~(): Boolean

open fun isFontSet(): Boolean

isForegroundSet

open fun isForegroundSet(): Boolean

open fun isLightweight(): Boolean

isMaximumSizeSet

open fun isMaximumSizeSet(): Boolean

isMinimumSizeSet

open fun isMinimumSizeSet(): Boolean

open fun isOpaque(): Boolean

isPreferredSizeSet

open fun isPreferredSizeSet(): Boolean

open fun isShowing(): Boolean

open fun ~~keyDown~~(p0: Event, p1: Int): Boolean

open fun ~~keyUp~~(p0: Event, p1: Int): Boolean

open fun ~~layout~~()

open fun list()

open fun list(p0: PrintStream)

open fun list(p0: PrintWriter)

open fun list(p0: PrintStream, p1: Int)

open fun list(p0: PrintWriter, p1: Int)

open fun ~~locate~~(p0: Int, p1: Int): Component

open fun ~~location~~(): Point

open fun ~~lostFocus~~(p0: Event, p1: Any): Boolean

open fun ~~minimumSize~~(): Dimension

open fun ~~mouseDown~~(p0: Event, p1: Int, p2: Int): Boolean

open fun ~~mouseDrag~~(p0: Event, p1: Int, p2: Int): Boolean

open fun ~~mouseEnter~~(p0: Event, p1: Int, p2: Int): Boolean

open fun ~~mouseExit~~(p0: Event, p1: Int, p2: Int): Boolean

open fun ~~mouseMove~~(p0: Event, p1: Int, p2: Int): Boolean

open fun ~~mouseUp~~(p0: Event, p1: Int, p2: Int): Boolean

open fun ~~move~~(p0: Int, p1: Int)

open fun ~~nextFocus~~()

open override fun paint(g: Graphics)

open fun paintAll(p0: Graphics)

open override fun ~~postEvent~~(p0: Event): Boolean

open fun ~~preferredSize~~(): Dimension

open fun prepareImage(p0: Image, p1: ImageObserver): Boolean

open fun prepareImage(p0: Image, p1: Int, p2: Int, p3: ImageObserver): Boolean

open fun print(p0: Graphics)

open fun printAll(p0: Graphics)

open override fun remove(p0: MenuComponent)

removeComponentListener

open fun removeComponentListener(p0: ComponentListener)

removeFocusListener

open fun removeFocusListener(p0: FocusListener)

removeHierarchyBoundsListener

open fun removeHierarchyBoundsListener(p0: HierarchyBoundsListener)

removeHierarchyListener

open fun removeHierarchyListener(p0: HierarchyListener)

removeInputMethodListener

open fun removeInputMethodListener(p0: InputMethodListener)

removeKeyListener

open fun removeKeyListener(p0: KeyListener)

removeMouseListener

open fun removeMouseListener(p0: MouseListener)

removeMouseMotionListener

open fun removeMouseMotionListener(p0: MouseMotionListener)

removeMouseWheelListener

open fun removeMouseWheelListener(p0: MouseWheelListener)

open override fun removeNotify()

removePropertyChangeListener

open fun removePropertyChangeListener(p0: PropertyChangeListener)

open fun removePropertyChangeListener(p0: String, p1: PropertyChangeListener)

open fun repaint()

open fun repaint(p0: Long)

open fun repaint(p0: Int, p1: Int, p2: Int, p3: Int)

open fun repaint(p0: Long, p1: Int, p2: Int, p3: Int, p4: Int)

open fun requestFocus()

open fun requestFocus(p0: FocusEvent.Cause)

requestFocusInWindow

open fun requestFocusInWindow(): Boolean

open fun requestFocusInWindow(p0: FocusEvent.Cause): Boolean

open fun ~~reshape~~(p0: Int, p1: Int, p2: Int, p3: Int)

open fun ~~resize~~(p0: Dimension)

open fun ~~resize~~(p0: Int, p1: Int)

open fun revalidate()

open fun setBounds(p0: Rectangle)

open fun setBounds(p0: Int, p1: Int, p2: Int, p3: Int)

setFocusTraversalKeys

open fun setFocusTraversalKeys(p0: Int, p1: MutableSet<out AWTKeyStroke>)

open fun setLocation(p0: Point)

open fun setLocation(p0: Int, p1: Int)

open fun setMaximumSize(p0: Dimension)

open fun setMinimumSize(p0: Dimension)

setMixingCutoutShape

open fun setMixingCutoutShape(p0: Shape)

setPreferredSize

open fun setPreferredSize(p0: Dimension)

open fun setSize(p0: Dimension)

open fun setSize(p0: Int, p1: Int)

open fun ~~show~~()

open fun ~~show~~(p0: Boolean)

open fun ~~size~~(): Dimension

open override fun toString(): String

open fun transferFocus()

transferFocusBackward

open fun transferFocusBackward()

transferFocusUpCycle

open fun transferFocusUpCycle()

open override fun update(g: Graphics)

open fun validate()