@yandex/ymaps3-types
Version:
Types for ymaps3 maps library
43 lines (42 loc) • 1.24 kB
TypeScript
import { YMapComplexEntity } from "../YMapEnities";
/**
* YMapDefaultFeaturesLayer props
*/
type YMapDefaultFeaturesLayerProps = {
/** Should show layer. Default is true */
visible?: boolean;
/** Layer z-index */
zIndex?: number;
/** Name for source */
source?: string;
};
declare const defaultProps: Readonly<{
visible: true;
source: "ymaps3x0-default-feature";
}>;
type DefaultProps = typeof defaultProps;
/**
* Map defaults layer to show features on map.
*
* @example
* ```javascript
* const defaultFeaturesLayer = new YMapDefaultFeaturesLayer();
* // add to map
* map.addChild(defaultFeaturesLayer);
* // update
* defaultFeaturesLayer.update({zIndex: 1501});
* ```
*/
declare class YMapDefaultFeaturesLayer extends YMapComplexEntity<YMapDefaultFeaturesLayerProps, DefaultProps> {
static defaultProps: Readonly<{
visible: true;
source: "ymaps3x0-default-feature";
}>;
private _dataSource?;
private _featuresLayer?;
private _markerLayer?;
protected _onAttach(): void;
protected _onUpdate(propsDiff: Partial<YMapDefaultFeaturesLayerProps>): void;
protected _onDetach(): void;
}
export { YMapDefaultFeaturesLayer, YMapDefaultFeaturesLayerProps };