Map class

Конструкторы

Map

Отображает карту в указанном контейнере.

Методы

addEventListener

Добавьте прослушиватель событий в карту. Если слой не указан, прослушиватель события будет добавлен в контейнер Map Canvas; в противном случае прослушиватель события будет добавлен в указанный уровень карты.

addEventListener

Добавьте прослушиватель событий в карту. Если слой не указан, прослушиватель события будет добавлен в контейнер Map Canvas; в противном случае прослушиватель события будет добавлен в указанный уровень карты.

addHtml

Добавляет настраиваемый элемент HTMLElement к сопоставлению в указанной позиции.

addLinestrings

Добавьте коллекцию линестрингс к сопоставлению. Если слой уже существует, все параметры, ранее заданные пользователем, будут по умолчанию иметь предыдущие значения; в противном случае они по умолчанию будут иметь значения по умолчанию [[Линестринглайероптионс]].

addPins

Добавьте коллекцию точек в карту в качестве ПИН-кодов. Если слой уже существует, все параметры, ранее заданные пользователем, будут по умолчанию иметь предыдущие значения; в противном случае они по умолчанию будут иметь значения по умолчанию [[Пинлайероптионс]].

addPolygons

Добавьте в карту коллекцию многоугольников. Если слой уже существует, все параметры, ранее заданные пользователем, будут по умолчанию иметь предыдущие значения; в противном случае они по умолчанию будут иметь значения по умолчанию [[Полигонлайероптионс]].

addRaster

Добавляет растровый слой в карту. Если слой уже существует, все параметры, ранее заданные пользователем, будут по умолчанию иметь предыдущие значения; в противном случае они по умолчанию будут иметь значения по умолчанию [[Растерлайероптионс]].

getCamera

Возвращает текущие свойства камеры.

getCanvas

Возвращает Хтмлканваселемент, на который рисуется карта.

getCanvasContainer

Возвращает элемент HTMLElement, который содержит Хтмлканваселемент карты. События карты (например, панорамирование и масштабирование) присоединяются к этому элементу.

getLayers

Возвращает список слоев карты снизу вверх.

getMapContainer

Возвращает элемент HTMLElement, содержащий карту.

getServiceOptions

Возвращает параметры службы, с помощью которой был инициализирован элемент управления картой.

getStyle

Возвращает параметры текущего стиля элемента управления карты.

getTraffic

Возврат параметров текущего трафика элемента управления Map.

getUserInteraction

Возвращает параметры обработчика взаимодействия текущего пользователя для элемента управления Map.

removeEventListener

Удаление прослушивателя событий из сопоставления для указанного типа и обратного вызова.

removeEventListener

Удаление прослушивателя событий из сопоставления для указанного типа и обратного вызова.

removeHtml

Удаляет настраиваемый элемент HTMLElement из карты.

removeLayers

Удаляет коллекцию слоев из карты.

setCamera

Настройте камеру элемента управления карты с помощью анимационного перехода. Все параметры, которые не указаны, будут по умолчанию использоваться в соответствии с текущими значениями.

setCameraBounds

Задайте границы камеры для элемента управления карты.

setStyle

Задайте параметры стиля элемента управления карты. Все параметры, которые не указаны, будут по умолчанию использоваться в соответствии с текущими значениями.

setTraffic

Задайте параметры трафика для карты. Все параметры, которые не указаны, будут по умолчанию использоваться в соответствии с текущими значениями.

setUserInteraction

Настройка обработчиков взаимодействия пользователя для элемента управления карты. Все параметры, которые не указаны, будут по умолчанию использоваться в соответствии с текущими значениями.

Сведения о конструкторе

Map

Отображает карту в указанном контейнере.

new Map(container: string, options: function)

Параметры

container
string

Идентификатор элемента, в котором должно отображаться сопоставление.

options
function

Варианты начального отображения и взаимодействия с картой.

Сведения о методе

addEventListener

Добавьте прослушиватель событий в карту. Если слой не указан, прослушиватель события будет добавлен в контейнер Map Canvas; в противном случае прослушиватель события будет добавлен в указанный уровень карты.

function addEventListener(type: string, callback: any)

Параметры

type
string

Тип прослушивателя событий. @todo необходимости указать их.

callback
any

Обратный вызов, срабатывающий при возникновении события.

addEventListener

Добавьте прослушиватель событий в карту. Если слой не указан, прослушиватель события будет добавлен в контейнер Map Canvas; в противном случае прослушиватель события будет добавлен в указанный уровень карты.

function addEventListener(type: string, layer: string, callback: any)

Параметры

type
string
layer
string
callback
any

addHtml

Добавляет настраиваемый элемент HTMLElement к сопоставлению в указанной позиции.

function addHtml(element: HTMLElement, position: Position)

Параметры

element
HTMLElement

Элемент HTMLElement, который требуется добавить.

position
@azure-atlas-javscript-sdk.Position

Позиция для размещения элемента.

Возвращаемое значение

string

addLinestrings

Добавьте коллекцию линестрингс к сопоставлению. Если слой уже существует, все параметры, ранее заданные пользователем, будут по умолчанию иметь предыдущие значения; в противном случае они по умолчанию будут иметь значения по умолчанию [[Линестринглайероптионс]].

function addLinestrings(linestrings: Array<Feature<LineString>>, options?: LinestringLayerOptions)

Параметры

linestrings
Array<@azure-atlas-javscript-sdk.Feature<LineString>>

Линестрингс, который требуется добавить.

options
@azure-atlas-javscript-sdk.LinestringLayerOptions

Параметры слоев для добавления линестрингс к карте.

addPins

Добавьте коллекцию точек в карту в качестве ПИН-кодов. Если слой уже существует, все параметры, ранее заданные пользователем, будут по умолчанию иметь предыдущие значения; в противном случае они по умолчанию будут иметь значения по умолчанию [[Пинлайероптионс]].

function addPins(pins: Array<Feature<Point>>, options?: PinLayerOptions)

Параметры

pins
Array<@azure-atlas-javscript-sdk.Feature<@azure-atlas-javscript-sdk.Point>>

Добавляемые точки.

options
@azure-atlas-javscript-sdk.PinLayerOptions

Параметры слоев для добавления ПИН-кодов в карту.

addPolygons

Добавьте в карту коллекцию многоугольников. Если слой уже существует, все параметры, ранее заданные пользователем, будут по умолчанию иметь предыдущие значения; в противном случае они по умолчанию будут иметь значения по умолчанию [[Полигонлайероптионс]].

function addPolygons(polygons: Array<Feature<Polygon>>, options?: PolygonLayerOptions)

Параметры

polygons
Array<@azure-atlas-javscript-sdk.Feature<Polygon>>

Добавляемые многоугольники.

options
@azure-atlas-javscript-sdk.PolygonLayerOptions

Параметры слоев для добавления многоугольников в карту.

addRaster

Добавляет растровый слой в карту. Если слой уже существует, все параметры, ранее заданные пользователем, будут по умолчанию иметь предыдущие значения; в противном случае они по умолчанию будут иметь значения по умолчанию [[Растерлайероптионс]].

function addRaster(tileSources: string[], options?: RasterLayerOptions)

Параметры

tileSources
string[]

Список конечных точек, заданных в виде строк, из которых могут запрашиваться растровые изображения. Конечные точки могут быть параметризованы с помощью тегов ' {z} ', ' {x} ' и ' {y} ', чтобы указать масштаб, x – индекс и y – индекс необходимой плитки соответственно. Элемент управления Map будет запрашивать и размещать плитки, которые находятся в окне просмотра карты.

options
@azure-atlas-javscript-sdk.RasterLayerOptions

Параметры для определения растрового слоя, который требуется добавить.

getCamera

Возвращает текущие свойства камеры.

function getCamera()

getCanvas

Возвращает Хтмлканваселемент, на который рисуется карта.

function getCanvas()

Возвращаемое значение

HTMLCanvasElement

getCanvasContainer

Возвращает элемент HTMLElement, который содержит Хтмлканваселемент карты. События карты (например, панорамирование и масштабирование) присоединяются к этому элементу.

function getCanvasContainer()

Возвращаемое значение

HTMLElement

getLayers

Возвращает список слоев карты снизу вверх.

function getLayers()

getMapContainer

Возвращает элемент HTMLElement, содержащий карту.

function getMapContainer()

Возвращаемое значение

HTMLElement

getServiceOptions

Возвращает параметры службы, с помощью которой был инициализирован элемент управления картой.

function getServiceOptions()

Возвращаемое значение

@azure-atlas-javscript-sdk.ServiceOptions

getStyle

Возвращает параметры текущего стиля элемента управления карты.

function getStyle()

Возвращаемое значение

@azure-atlas-javscript-sdk.StyleOptions

getTraffic

Возврат параметров текущего трафика элемента управления Map.

function getTraffic()

Возвращаемое значение

@azure-atlas-javscript-sdk.TrafficOptions

getUserInteraction

Возвращает параметры обработчика взаимодействия текущего пользователя для элемента управления Map.

function getUserInteraction()

Возвращаемое значение

@azure-atlas-javscript-sdk.UserInteractionOptions

removeEventListener

Удаление прослушивателя событий из сопоставления для указанного типа и обратного вызова.

function removeEventListener(type: string, callback: any)

Параметры

type
string

Тип прослушивателя событий.

callback
any

Обратный вызов прослушивателя событий.

removeEventListener

Удаление прослушивателя событий из сопоставления для указанного типа и обратного вызова.

function removeEventListener(type: string, layer: string, callback: any)

Параметры

type
string
layer
string
callback
any

removeHtml

Удаляет настраиваемый элемент HTMLElement из карты.

function removeHtml(elementId: string)

Параметры

elementId
string

Идентификатор элемента, который требуется удалить.

removeLayers

Удаляет коллекцию слоев из карты.

function removeLayers(layerNames: string[])

Параметры

layerNames
string[]

Массив имен слоев, которые необходимо удалить из сопоставления.

setCamera

Настройте камеру элемента управления карты с помощью анимационного перехода. Все параметры, которые не указаны, будут по умолчанию использоваться в соответствии с текущими значениями.

function setCamera(options?: function)

Параметры

options
function

Параметры для настройки камеры карты и для анимации любого изменения представления.

setCameraBounds

Задайте границы камеры для элемента управления карты.

function setCameraBounds(options?: CameraBoundsOptions)

Параметры

options
@azure-atlas-javscript-sdk.CameraBoundsOptions

Параметры для настройки границ камеры карты.

setStyle

Задайте параметры стиля элемента управления карты. Все параметры, которые не указаны, будут по умолчанию использоваться в соответствии с текущими значениями.

function setStyle(options?: StyleOptions)

Параметры

options
@azure-atlas-javscript-sdk.StyleOptions

Параметры для настройки стиля элемента управления карты.

setTraffic

Задайте параметры трафика для карты. Все параметры, которые не указаны, будут по умолчанию использоваться в соответствии с текущими значениями.

function setTraffic(options?: TrafficOptions)

Параметры

options
@azure-atlas-javscript-sdk.TrafficOptions

Параметры для определения отображения трафика карты.

setUserInteraction

Настройка обработчиков взаимодействия пользователя для элемента управления карты. Все параметры, которые не указаны, будут по умолчанию использоваться в соответствии с текущими значениями.

function setUserInteraction(options?: UserInteractionOptions)

Параметры

options
@azure-atlas-javscript-sdk.UserInteractionOptions

Параметры для разрешения и отключения обработчиков взаимодействия с пользователем.