YMapDefaultSchemeLayer

The YMapDefaultSchemeLayer class is a visual component that loads map scheme data from some source and adds it to the map.

Depending on the layers parameter, a layer can display:

• ground: The whole raster map scheme and the vector ground layer.
• buildings: The building vector layer.
• icons: The icon vector layer.
• labels: The label vector layer.

Creating a layerCreating a layer

For example, this code will load the data and add a raster scheme layer to the map:

const schema = new YMapDefaultSchemeLayer({type: 'ground'});

map.addChild(schema);

const schema = new YMapDefaultSchemeLayer({theme: 'light'});

map.addChild(schema);

Creating a layer with selected schemesCreating a layer with selected schemes

The YMapDefaultSchemeLayer class can be used only as a data loader so that the loaded data can be displayed selectively using YMapLayer:

// Initialize invisible YMapDefaultSchemeLayer.
// It is hidden because it is only used to load data.
const schema = YMapDefaultSchemeLayer({theme: 'light', visible: false, source: 'scheme'});

// Add it to the map.
map.addChild(schema);

// Then add a couple YMapLayer's to the map, specifying for each of them
// which data from YMapDefaultSchemeLayer to display.
map.addChild(new YMapLayer({zIndex: 1, source: 'scheme', type: 'ground'}))
map.addChild(new YMapLayer({zIndex: 2, source: 'scheme', type: 'labels'}))
map.addChild(new YMapLayer({zIndex: 3, source: 'scheme', type: 'buildings'}))
map.addChild(new YMapLayer({zIndex: 4, source: 'scheme', type: 'icons'}))

ConstructorConstructor

new YMapDefaultSchemeLayer(props, options?)

Constructor parametersConstructor parameters

Inherited fromInherited from

YMapComplexEntity.constructor

new YMapDefaultSchemeLayer(props, children?, options?)

Constructor parametersConstructor parameters

Inherited fromInherited from

YMapComplexEntity.constructor

PropsProps

YMapDefaultSchemeLayerProps: Object

ParametersParameters

const defaultSchemeLayer = new YMapDefaultSchemeLayer({clampMapZoom: false}); map.addChild(defaultSchemeLayer);

true

MethodsMethods

updateupdate

update(changedProps): void

Method of updating object props.

ParametersParameters

ReturnsReturns

void

Inherited fromInherited from

YMapComplexEntity.update