Class MapOptions

Index

Constructors

Methods

getAmbientLightColor getBackgroundBitmap getBaseProjection getClearColor getDoubleClickMaxDuration getDPI getDrawDistance getEnvelopeThreadPoolSize getFieldOfViewY getFocusPointOffset getLongClickDuration getMainLightColor getMainLightDirection getPanBounds getPanningMode getPivotMode getRenderProjectionMode getSkyColor getTileDrawSize getTileThreadPoolSize getTiltRange getZoomRange isClickTypeDetection isDoubleClickDetection isKineticPan isKineticRotation isKineticZoom isLayersLabelsProcessedInReverseOrder isRestrictedPanning isRotatable isRotationGestures isSeamlessPanning isTiltGestureReversed isUserInput isZoomGestures setAmbientLightColor setBackgroundBitmap setBaseProjection setClearColor setClickTypeDetection setDoubleClickDetection setDoubleClickMaxDuration setDPI setDrawDistance setEnvelopeThreadPoolSize setFieldOfViewY setFocusPointOffset setKineticPan setKineticRotation setKineticZoom setLayersLabelsProcessedInReverseOrder setLongClickDuration setMainLightColor setMainLightDirection setPanBounds setPanningMode setPivotMode setRenderProjectionMode setRestrictedPanning setRotatable setRotationGestures setSeamlessPanning setTileDrawSize setTileThreadPoolSize setTiltGestureReversed setTiltRange setUserInput setZoomGestures setZoomRange

Constructors

constructor

new MapOptions(): MapOptions
Returns MapOptions

Methods

getAmbientLightColor

getAmbientLightColor(): any
Returns any
native Carto Color
- Defined in packages/ui-carto/ui/index.d.ts:62

getBackgroundBitmap

getBackgroundBitmap(): any
Returns any
native Carto Bitmap
- Defined in packages/ui-carto/ui/index.d.ts:66

getBaseProjection

getBaseProjection(): any
Returns any
- Defined in packages/ui-carto/ui/index.d.ts:67

getClearColor

getClearColor(): any
Returns any
native Carto Color
- Defined in packages/ui-carto/ui/index.d.ts:71

getDoubleClickMaxDuration

getDoubleClickMaxDuration(): number
Returns number
- Defined in packages/ui-carto/ui/index.d.ts:179

getDPI

getDPI(): number
Returns number
- Defined in packages/ui-carto/ui/index.d.ts:72

getDrawDistance

getDrawDistance(): number
Returns number
- Defined in packages/ui-carto/ui/index.d.ts:73

getEnvelopeThreadPoolSize

getEnvelopeThreadPoolSize(): number
Returns number
- Defined in packages/ui-carto/ui/index.d.ts:74

getFieldOfViewY

getFieldOfViewY(): number
Returns number
- Defined in packages/ui-carto/ui/index.d.ts:75

getFocusPointOffset

getFocusPointOffset(): any
Returns any
native Carto MapPos
- Defined in packages/ui-carto/ui/index.d.ts:79

getLongClickDuration

getLongClickDuration(): number
Returns number
- Defined in packages/ui-carto/ui/index.d.ts:177

getMainLightColor

getMainLightColor(): any
Returns any
native Carto Color
- Defined in packages/ui-carto/ui/index.d.ts:83

getMainLightDirection

getMainLightDirection(): any
Returns any
native Carto MapVec
- Defined in packages/ui-carto/ui/index.d.ts:87

getPanBounds

getPanBounds(): any
Returns any
native Carto MapBounds
- Defined in packages/ui-carto/ui/index.d.ts:91

getPanningMode

getPanningMode(): any
Returns any
- Defined in packages/ui-carto/ui/index.d.ts:92

getPivotMode

getPivotMode(): any
Returns any
- Defined in packages/ui-carto/ui/index.d.ts:93

getRenderProjectionMode

getRenderProjectionMode(): any
Returns any
- Defined in packages/ui-carto/ui/index.d.ts:94

getSkyColor

getSkyColor(): any
Returns any
native Carto Color
- Defined in packages/ui-carto/ui/index.d.ts:98

getTileDrawSize

getTileDrawSize(): number
Returns number
- Defined in packages/ui-carto/ui/index.d.ts:99

getTileThreadPoolSize

getTileThreadPoolSize(): number
Returns number
- Defined in packages/ui-carto/ui/index.d.ts:100

getTiltRange

getTiltRange(): any
Returns any
native Carto MapRange
- Defined in packages/ui-carto/ui/index.d.ts:104

getZoomRange

getZoomRange(): any
Returns any
- Defined in packages/ui-carto/ui/index.d.ts:105

isClickTypeDetection

isClickTypeDetection(): boolean
Returns boolean
- Defined in packages/ui-carto/ui/index.d.ts:106

isDoubleClickDetection

isDoubleClickDetection(): boolean
Returns boolean
- Defined in packages/ui-carto/ui/index.d.ts:176

isKineticPan

isKineticPan(): boolean
Returns boolean
- Defined in packages/ui-carto/ui/index.d.ts:107

isKineticRotation

isKineticRotation(): boolean
Returns boolean
- Defined in packages/ui-carto/ui/index.d.ts:108

isKineticZoom

isKineticZoom(): boolean
Returns boolean
- Defined in packages/ui-carto/ui/index.d.ts:109

isLayersLabelsProcessedInReverseOrder

isLayersLabelsProcessedInReverseOrder(): boolean
Returns boolean
- Defined in packages/ui-carto/ui/index.d.ts:182

isRestrictedPanning

isRestrictedPanning(): boolean
Returns boolean
- Defined in packages/ui-carto/ui/index.d.ts:110

isRotatable

isRotatable(): boolean
Returns boolean
- Defined in packages/ui-carto/ui/index.d.ts:111

isRotationGestures

isRotationGestures(): boolean
Returns boolean
- Defined in packages/ui-carto/ui/index.d.ts:116

isSeamlessPanning

isSeamlessPanning(): boolean
Returns boolean
- Defined in packages/ui-carto/ui/index.d.ts:112

isTiltGestureReversed

isTiltGestureReversed(): boolean
Returns boolean
- Defined in packages/ui-carto/ui/index.d.ts:113

isUserInput

isUserInput(): boolean
Returns boolean
- Defined in packages/ui-carto/ui/index.d.ts:114

isZoomGestures

isZoomGestures(): boolean
Returns boolean
- Defined in packages/ui-carto/ui/index.d.ts:115

setAmbientLightColor

setAmbientLightColor(color: any): void
Parameters
- color: any
  native Carto Color
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:120

setBackgroundBitmap

setBackgroundBitmap(backgroundBitmap: any): void
Parameters
- backgroundBitmap: any
  native Carto Bitmap
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:124

setBaseProjection

setBaseProjection(baseProjection: any): void
Parameters
- baseProjection: any
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:125

setClearColor

setClearColor(color: any): void
Parameters
- color: any
  native Carto Color
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:129

setClickTypeDetection

setClickTypeDetection(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:130

setDoubleClickDetection

setDoubleClickDetection(param0: boolean): void
Parameters
- param0: boolean
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:175

setDoubleClickMaxDuration

setDoubleClickMaxDuration(param0: number): void
Parameters
- param0: number
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:180

setDPI

setDPI(dpi: number): void
Parameters
- dpi: number
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:131

setDrawDistance

setDrawDistance(drawDistance: number): void
Parameters
- drawDistance: number
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:132

setEnvelopeThreadPoolSize

setEnvelopeThreadPoolSize(poolSize: number): void
Parameters
- poolSize: number
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:133

setFieldOfViewY

setFieldOfViewY(fovY: number): void
Parameters
- fovY: number
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:134

setFocusPointOffset

setFocusPointOffset(offset: any): void
Parameters
- offset: any
  native Carto MapPos
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:138

setKineticPan

setKineticPan(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:139

setKineticRotation

setKineticRotation(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:140

setKineticZoom

setKineticZoom(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:141

setLayersLabelsProcessedInReverseOrder

setLayersLabelsProcessedInReverseOrder(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:181

setLongClickDuration

setLongClickDuration(param0: number): void
Parameters
- param0: number
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:178

setMainLightColor

setMainLightColor(color: any): void
Parameters
- color: any
  native Carto Color
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:146

setMainLightDirection

setMainLightDirection(direction: any): void
Parameters
- direction: any
  native Carto MapVec
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:150

setPanBounds

setPanBounds(panBounds: any): void
Parameters
- panBounds: any
  native Carto MapBounds
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:154

setPanningMode

setPanningMode(panningMode: any): void
Parameters
- panningMode: any
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:155

setPivotMode

setPivotMode(pivotMode: any): void
Parameters
- pivotMode: any
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:156

setRenderProjectionMode

setRenderProjectionMode(mode: any): void
Parameters
- mode: any
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:157

setRestrictedPanning

setRestrictedPanning(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:158

setRotatable

setRotatable(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:159

setRotationGestures

setRotationGestures(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:142

setSeamlessPanning

setSeamlessPanning(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:160

setTileDrawSize

setTileDrawSize(tileDrawSize: number): void
Parameters
- tileDrawSize: number
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:161

setTileThreadPoolSize

setTileThreadPoolSize(poolSize: number): void
Parameters
- poolSize: number
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:162

setTiltGestureReversed

setTiltGestureReversed(reversed: boolean): void
Parameters
- reversed: boolean
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:163

setTiltRange

setTiltRange(tiltRange: any): void
Parameters
- tiltRange: any
  native Carto MapRange
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:167

setUserInput

setUserInput(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:168

setZoomGestures

setZoomGestures(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
- Defined in packages/ui-carto/ui/index.d.ts:169

setZoomRange

setZoomRange(zoomRange: any): any
Parameters
- zoomRange: any
  native Carto MapRange
Returns any
- Defined in packages/ui-carto/ui/index.d.ts:173