SymbolLayer class
Отображает данные на основе точек в виде символов на карте с помощью текста и (или) значков. Кроме того, можно создать символы для данных линий и многоугольников.
- Extends
Конструкторы
Symbol |
Создает новый объект SymbolLayer. |
Унаследованные свойства
metadata | Свойство для связывания пользовательских данных со слоем. |
Методы
get |
Возвращает параметры слоя символов. |
get |
Возвращает источник, указанный при создании слоя. |
set |
Задает параметры слоя символов. |
Наследуемые методы
get |
Возвращает идентификатор слоя. |
get |
Возвращает карту, к которому в данный момент добавляется слой, или значение NULL. |
on |
Метод инициализации для слоя, который вызывается при добавлении на карту. |
on |
Метод, вызываемый при удалении слоя из карты. Должен выполнять необходимую очистку слоя. |
Сведения о конструкторе
SymbolLayer(string | Source, string, SymbolLayerOptions)
Создает новый объект SymbolLayer.
new SymbolLayer(source: string | Source, id?: string, options?: SymbolLayerOptions)
Параметры
- source
-
string | Source
Идентификатор или экземпляр источника данных, который будет отображать слой.
- id
-
string
Идентификатор слоя. Если не указано, будет создан случайный.
- options
- SymbolLayerOptions
Параметры слоя многоугольников.
Сведения об унаследованном свойстве
metadata
Свойство для связывания пользовательских данных со слоем.
metadata?: any
Значение свойства
any
Наследуется отLayer.metadata
Сведения о методе
getOptions()
Возвращает параметры слоя символов.
function getOptions(): SymbolLayerOptions
Возвращаемое значение
getSource()
Возвращает источник, указанный при создании слоя.
function getSource(): string | Source
Возвращаемое значение
string | Source
setOptions(SymbolLayerOptions)
Задает параметры слоя символов.
function setOptions(options: SymbolLayerOptions)
Параметры
- options
- SymbolLayerOptions
Сведения о наследуемом методе
getId()
Возвращает идентификатор слоя.
function getId(): string
Возвращаемое значение
string
Наследуется отLayer.getId
getMap()
Возвращает карту, к которому в данный момент добавляется слой, или значение NULL.
function getMap(): Map
Возвращаемое значение
Наследуется отLayer.getMap
onAdd(Map)
Метод инициализации для слоя, который вызывается при добавлении на карту.
function onAdd(map: Map)
Параметры
- map
- Map
Карта, в который был добавлен слой.
Наследуется отLayer.onAdd
onRemove()
Метод, вызываемый при удалении слоя из карты. Должен выполнять необходимую очистку слоя.
function onRemove()
Наследуется отLayer.onRemove