Jet Link Simulations

Jet Link Simulations

  • Docs
  • API Reference
  • Help

MapElement

Creates a map that has a camera view from a "top down" position. Can be used to show airports, NAVAIDS, fixes, etc.

JLS.core.MapElement

new MapElement(options)

    import { MapElement } from 'path/to/elements'

    const bmpText  = new MapElement({
        origin                          : { ref: 'map', x: 0, y: 0, w: 400, h: 400 },
        backgroundColor                 = '000000',
        projection                      = 'oblique-azimuth',
        coordinateSystem                = 'cartesian-center-origin', // or cartesian-bottom-center-origin
        orientation                     = 'track-up', // or north-up
        reticulePosition                = { lat: 0, long: 0 },
        loadRadius                      = null,
        maxZoomMileRange                = 600,
        maxZoomLevel                    = 36,
        zoomLevel                       = 1,
        displayOffsets                  = { top: 0, bottom: 0, left: 0, right: 0 },
        inViewOverflow                  = +0.15,
        aircraftHeading                 = 360,
        declutterGroups                 = [
                                            [
                                                'navaids',
                                                'fixes',
                                                'waypoints',
                                                'airports',
                                                'route',
                                            ],
                                            [
                                                'fixes',
                                                'waypoints',
                                                'airports',
                                                'route',
                                            ],
                                            [
                                                'airports',
                                                'route',
                                            ],
                                        ],
        navDataLayerOrder               = [
                                        'active_drawn_route',
                                        'act_waypoints',
                                        'modified_drawn_route',
                                        'mod_waypoints',
                                        'runways',
                                        'airports',
                                        'fixes',
                                        'vors',
                                        'vortacs',
                                        'ndbs',
                                        'markers',
                                        'obstacles',
                                        'airways',
        ],
        customSymbolPrefix              = null,
        customSymbols                   = {},
    })

Members

originRef

A string reference that can be set to uniquely identify this object.

originX

The X position of this object on a canvas.

originY

The Y position of this object on a canvas.

originW

The width of the object when displayed on a canvas.

originH

The height of the ojbect when displayed on a canvas.

projection

The map projection to use. Only allowed one now is oblique-azimuth.

coordinateSystem

The coordinate system to use. This determines if items are in center or at bottom.

reticulePosition

The lat/long of the position to project from. This is where the map is centered on.

loadRadius

Determines how many data coordinates to load and store.

displayOffsets

Applies a mask to the map view so it can be used seamlessly with other elements that need to be overlayed on it.

inViewOverflow

Determines how strict applied mask is.

aircraftHeading

The aircraft's heading.

cache

A cache object that holds any cached map data.

maxZoomMileRange

Value set to determine how zoom levels will be generated.

maxZoomMeterRange

Value set to determine how zoom levels will be generated.

maxZoomLevel

Value set to determine what the max zoom level generated should be.

zoomLevel

The current zoom level of the map.

orientation

The maps orientation, either track-up or north-up.

declutterGroups

Determines which groups of assets will be shown together on declutter toggle.

customSymbolPrefix

A prefixed applied to correctly route to the custom assets in the asset loader.

customSymbols

A collection of custom symbols to use for the map.

declutterLevel

The current declutter level of the map.

navDataTypes

Allowed nav data types.

navRouteDataTypes

Allowed nav route types.

mapDataVisibility

The visibility of the displayed data.

navData

The raw, unparsed nav data.

navDataLayerOrder

Determines how the nav data is positioned on it's z-axis.

rawMapData

The raw, unparsed map data.

renderedNavData

A reference to the data that is currently being rendered to the map view.

Methods

  • new MapElement(options)
  • Members
    • originRef
    • originX
    • originY
    • originW
    • originH
    • projection
    • coordinateSystem
    • reticulePosition
    • loadRadius
    • displayOffsets
    • inViewOverflow
    • aircraftHeading
    • cache
    • maxZoomMileRange
    • maxZoomMeterRange
    • maxZoomLevel
    • zoomLevel
    • orientation
    • declutterGroups
    • customSymbolPrefix
    • customSymbols
    • declutterLevel
    • navDataTypes
    • navRouteDataTypes
    • mapDataVisibility
    • navData
    • navDataLayerOrder
    • rawMapData
    • renderedNavData
  • Methods
Jet Link Simulations
Docs
Getting StartedGuidesAPI Reference
Community
User ShowcaseStack OverflowProject ChatTwitter
More
BlogGitHub
Copyright © 2020 Name or Your Company Name