Distribution module

Class: YMapOpenMapsButtonClass: YMapOpenMapsButton

Display button on a map.

Example

const controls = new YMapControls({position: 'bottom left'});
const {YMapOpenMapsButton} = await ymaps3.import('@yandex/ymaps3-controls-extra');
const openMapsButton = new YMapOpenMapsButton({});
controls.addChild(openMapsButton);
map.addChild(controls);

ConstructorsConstructors

constructorconstructor

new YMapOpenMapsButton(props)

ParametersParameters

Name	Type
props	YMapOpenMapsButtonProps

OverridesOverrides

YMapGroupEntity.constructor

PropertiesProperties

childrenchildren

readonly children: readonly YMapEntity<unknown, {}>[]

Inherited fromInherited from

YMapGroupEntity.children

---

[optionsKeyVuefy][optionsKeyVuefy]

static [optionsKeyVuefy]: CustomVuefyOptions<YMapOpenMapsButton>

---

defaultPropsdefaultProps

static defaultProps: Readonly<{
	title: string 
}>

AccessorsAccessors

parentparent

get parent(): YMapComplexEntity<unknown, {}>

Get parent entity.

ReturnsReturns

YMapComplexEntity<unknown, {}>

Inherited fromInherited from

YMapGroupEntity.parent

---

rootroot

get root(): YMap

Get root entity.

ReturnsReturns

YMap

Inherited fromInherited from

YMapGroupEntity.root

MethodsMethods

addChildaddChild

addChild(child, index?): YMapOpenMapsButton

ParametersParameters

Name	Type
child	YMapEntity<unknown, {}>
index?	number

ReturnsReturns

YMapOpenMapsButton

Inherited fromInherited from

YMapGroupEntity.addChild

---

removeChildremoveChild

removeChild(child): YMapOpenMapsButton

ParametersParameters

Name	Type
child	YMapEntity<unknown, {}>

ReturnsReturns

YMapOpenMapsButton

Inherited fromInherited from

YMapGroupEntity.removeChild

---

updateupdate

update(changedProps): void

Method for updating props of Entity.

ParametersParameters

Name	Type	Description
changedProps	Partial<YMapOpenMapsButtonProps>	New props values.

ReturnsReturns

void

Inherited fromInherited from

YMapGroupEntity.update

Class: ConfigClass: Config

Configuration object for whole API.
For example, it can be used to set experiments or apikeys.

ymaps3.getDefaultConfig().setApikeys({search: "YOUR_SEARCH_API_KEY"})`.

ConstructorsConstructors

constructorconstructor

new Config()

PropertiesProperties

descriptiondescription

readonly description: string

MethodsMethods

setApikeyssetApikeys

setApikeys(apikeys): void

Set apikeys for http-services.

ymaps3.getDefaultConfig().setApikeys({search: "YOUR_SEARCH_API_KEY"})`.

ParametersParameters

Name	Type
apikeys	Apikeys

ReturnsReturns

void

---

setExperimentssetExperiments

setExperiments(experiments): void

Set experiments for map.

ParametersParameters

Name	Type
experiments	Record<string, boolean>

ReturnsReturns

void

Class: Context<_TClass: Context<_T>

Type parametersType parameters

Name
_T

ConstructorsConstructors

constructorconstructor

new Context<_T>(name)

Type parametersType parameters

Name
_T

ParametersParameters

Name	Type
name	string

PropertiesProperties

namename

readonly name: string

Class: GenericComplexEntity<Props, DefaultProps, RootClass: GenericComplexEntity<Props, DefaultProps, Root>

Entity that aggregates multiple Entities but looks basic from the outside.

Example

type YMapSomeComplexEntityProps = {
 name?: string;
};
const defaultProps = {
 name: 'entity'
};
class YMapSomeComplexEntity extends GenericComplexEntity<YMapSomeComplexEntityProps, typeof defaultProps> {
 static defaultProps = defaultProps;
 private _someEntity?: YMapSomeEntity; // YMapSomeEntity extends GenericEntity
 protected _onAttach(): void {
     this._someEntity = new YMapSomeEntity();
     this.addChild(this._someEntity); // add someEntity as children
     // ...
 }
 // ...
}

Type parametersType parameters

Name	Type	Description
Props	Props	Type of input props of the Entity.
DefaultProps	extends Object = {}	Type of default input props of the Entity.
Root	extends GenericRootEntity<unknown> = GenericRootEntity<unknown>	Root Entity Class.

ConstructorsConstructors

constructorconstructor

new GenericComplexEntity<Props, DefaultProps, Root>(props, options?)

Type parametersType parameters

Name	Type
Props	Props
DefaultProps	extends Object = {}
Root	extends GenericRootEntity<unknown, {}, Root> = GenericRootEntity<unknown, {}>

ParametersParameters

Name	Type	Description
props	Props	The value of input props.
options?	ComplexOptions<Root>	Optional options object.

OverridesOverrides

GenericEntity.constructor

new GenericComplexEntity<Props, DefaultProps, Root>(props, children?, options?)

Type parametersType parameters

Name	Type
Props	Props
DefaultProps	extends Object = {}
Root	extends GenericRootEntity<unknown, {}, Root> = GenericRootEntity<unknown, {}>

ParametersParameters

Name	Type
props	Props
children?	GenericEntity<unknown, {}, Root>[]
options?	Omit<ComplexOptions<Root>, "children">

OverridesOverrides

GenericEntity<Props, DefaultProps, Root&gt;.constructor

AccessorsAccessors

parentparent

get parent(): GenericComplexEntity<unknown, {}, GenericRootEntity<unknown, {}>>

Get parent entity.

ReturnsReturns

GenericComplexEntity<unknown, {}, GenericRootEntity<unknown, {}>>

Inherited fromInherited from

GenericEntity.parent

---

rootroot

get root(): Root

Get root entity.

ReturnsReturns

Root

Inherited fromInherited from

GenericEntity.root

MethodsMethods

updateupdate

update(changedProps): void

Method for updating props of Entity.

ParametersParameters

Name	Type	Description
changedProps	Partial<Props>	New props values.

ReturnsReturns

void

Inherited fromInherited from

GenericEntity.update

Class: GenericEntity<Props, DefaultProps, RootClass: GenericEntity<Props, DefaultProps, Root>

Entity Base Class. It has event handlers for attaching, detaching and updating props. Has a method for providing and using context.

Example

type YMapSomeEntityProps = {
 name?: string;
};
const defaultProps = {
 name: 'entity'
};
class YMapSomeEntity extends GenericEntity<YMapSomeEntityProps, typeof defaultProps> {
 static defaultProps = defaultProps;
 public isAttached: boolean;
 constructor(props: YMapSomeEntityProps) {
     super(props);
     this.isAttached = false
     // Additional actions can be taken in the constructor of a class.
 }
 protected _onAttach(): void {
     this.isAttached = true;
     // Additional actions can be taken when an Entity is attached.
 }
 // ...
}

Type parametersType parameters

Name	Type	Description
Props	Props	Type of input props of the Entity.
DefaultProps	extends Object = {}	Type of default input props of the Entity.
Root	extends GenericRootEntity<unknown> = GenericRootEntity<unknown>	Root Entity Class.

ConstructorsConstructors

constructorconstructor

new GenericEntity<Props, DefaultProps, Root>(props)

Type parametersType parameters

Name	Type
Props	Props
DefaultProps	extends Object = {}
Root	extends GenericRootEntity<unknown, {}, Root> = GenericRootEntity<unknown, {}>

ParametersParameters

Name	Type	Description
props	Props	The value of input props.

AccessorsAccessors

parentparent

get parent(): GenericComplexEntity<unknown, {}, GenericRootEntity<unknown, {}>>

Get parent entity.

ReturnsReturns

GenericComplexEntity<unknown, {}, GenericRootEntity<unknown, {}>>

---

rootroot

get root(): Root

Get root entity.

ReturnsReturns

Root

MethodsMethods

updateupdate

update(changedProps): void

Method for updating props of Entity.

ParametersParameters

Name	Type	Description
changedProps	Partial<Props>	New props values.

ReturnsReturns

void

Class: GenericGroupEntity<Props, DefaultProps, RootClass: GenericGroupEntity<Props, DefaultProps, Root>

Entity that aggregates multiple Entities, and allows you to publicly add and remove entities to a subtree.

Example

type YMapSomeGroupEntityProps = {
 name?: string;
};
const defaultProps = {
 name: 'entity'
};
class YMapSomeGroupEntity extends GenericGroupEntity<YMapSomeGroupEntityProps, typeof defaultProps> {
 static defaultProps = defaultProps;
 // ...
}
const groupEntity = new YMapSomeGroupEntity()
const someEntity = new YMapSomeEntity(); // YMapSomeEntity extends GenericEntity
groupEntity.addChild(someEntity); // add someEntity in YMapSomeGroupEntity object
groupEntity.removeChild(someEntity); // remove someEntity from YMapSomeGroupEntity object

Type parametersType parameters

Name	Type	Description
Props	Props	Type of input props of the Entity.
DefaultProps	extends Object = {}	Type of default input props of the Entity.
Root	extends GenericRootEntity<unknown> = GenericRootEntity<unknown>	Root Entity Class.

ConstructorsConstructors

constructorconstructor

new GenericGroupEntity<Props, DefaultProps, Root>(props, options?)

Type parametersType parameters

Name	Type
Props	Props
DefaultProps	extends Object = {}
Root	extends GenericRootEntity<unknown, {}, Root> = GenericRootEntity<unknown, {}>

ParametersParameters

Name	Type	Description
props	Props	The value of input props.
options?	ComplexOptions<Root>	Optional options object.

Inherited fromInherited from

GenericComplexEntity.constructor

new GenericGroupEntity<Props, DefaultProps, Root>(props, children?, options?)

Type parametersType parameters

Name	Type
Props	Props
DefaultProps	extends Object = {}
Root	extends GenericRootEntity<unknown, {}, Root> = GenericRootEntity<unknown, {}>

ParametersParameters

Name	Type
props	Props
children?	GenericEntity<unknown, {}, Root>[]
options?	Omit<ComplexOptions<Root>, "children">

Inherited fromInherited from

GenericComplexEntity.constructor

PropertiesProperties

childrenchildren

readonly children: readonly GenericEntity<unknown, {}, Root>[]

OverridesOverrides

GenericComplexEntity.children

AccessorsAccessors

parentparent

get parent(): GenericComplexEntity<unknown, {}, GenericRootEntity<unknown, {}>>

Get parent entity.

ReturnsReturns

GenericComplexEntity<unknown, {}, GenericRootEntity<unknown, {}>>

Inherited fromInherited from

GenericComplexEntity.parent

---

rootroot

get root(): Root

Get root entity.

ReturnsReturns

Root

Inherited fromInherited from

GenericComplexEntity.root

MethodsMethods

addChildaddChild

addChild(child, index?): GenericGroupEntity<Props, DefaultProps, Root>

ParametersParameters

Name	Type
child	GenericEntity<unknown, {}, Root>
index?	number

ReturnsReturns

GenericGroupEntity<Props, DefaultProps, Root>

OverridesOverrides

GenericComplexEntity.addChild

---

removeChildremoveChild

removeChild(child): GenericGroupEntity<Props, DefaultProps, Root>

ParametersParameters

Name	Type
child	GenericEntity<unknown, {}, Root>

ReturnsReturns

GenericGroupEntity<Props, DefaultProps, Root>

OverridesOverrides

GenericComplexEntity.removeChild

---

updateupdate

update(changedProps): void

Method for updating props of Entity.

ParametersParameters

Name	Type	Description
changedProps	Partial<Props>	New props values.

ReturnsReturns

void

Inherited fromInherited from

GenericComplexEntity.update

Class: GenericRootEntity<Props, DefaultPropsClass: GenericRootEntity<Props, DefaultProps>

Entity that is root and cannot be added anywhere

Example

type YMapProps = {
 name?: string;
};
class YMap extends GenericRootEntity<YMapProps, typeof defaultProps> {
 // ...
}
// Now we can specify their root element for the Entity
class YMapSomeEntity extends GenericEntity<YMapSomeEntityProps, typeof defaultProps, YMap> {
 static defaultProps = defaultProps;
 // ...
}

Type parametersType parameters

Name	Type	Description
Props	Props	Type of input props of the Entity.
DefaultProps	extends Object = {}	Type of default input props of the Entity.

ConstructorsConstructors

constructorconstructor

new GenericRootEntity<Props, DefaultProps>(props, options?)

Type parametersType parameters

Name	Type
Props	Props
DefaultProps	extends Object = {}

ParametersParameters

Name	Type	Description
props	Props	The value of input props.
options?	ComplexOptions<GenericRootEntity<unknown, {}>>	Optional options object.

Inherited fromInherited from

GenericGroupEntity.constructor

new GenericRootEntity<Props, DefaultProps>(props, children?, options?)

Type parametersType parameters

Name	Type
Props	Props
DefaultProps	extends Object = {}

ParametersParameters

Name	Type
props	Props
children?	GenericEntity<unknown, {}, GenericRootEntity<unknown, {}>>[]
options?	Omit<ComplexOptions<GenericRootEntity<unknown, {}>>, "children">

Inherited fromInherited from

GenericGroupEntity.constructor

PropertiesProperties

childrenchildren

readonly children: readonly GenericEntity<unknown, {}, GenericRootEntity<unknown, {}>>[]

Inherited fromInherited from

GenericGroupEntity.children

AccessorsAccessors

parentparent

get parent(): GenericComplexEntity<unknown, {}, GenericRootEntity<unknown, {}>>

Get parent entity.

ReturnsReturns

GenericComplexEntity<unknown, {}, GenericRootEntity<unknown, {}>>

Inherited fromInherited from

GenericGroupEntity.parent

---

rootroot

get root(): this

Get root entity.

ReturnsReturns

this

OverridesOverrides

GenericGroupEntity.root

MethodsMethods

addChildaddChild

addChild(child, index?): GenericRootEntity<Props, DefaultProps>

ParametersParameters

Name	Type
child	GenericEntity<unknown, {}, GenericRootEntity<unknown, {}>>
index?	number

ReturnsReturns

GenericRootEntity<Props, DefaultProps>

Inherited fromInherited from

GenericGroupEntity.addChild

---

destroydestroy

Abstract destroy(): void

Completely destroys the entity tree including the current entity

ReturnsReturns

void

---

removeChildremoveChild

removeChild(child): GenericRootEntity<Props, DefaultProps>

ParametersParameters

Name	Type
child	GenericEntity<unknown, {}, GenericRootEntity<unknown, {}>>

ReturnsReturns

GenericRootEntity<Props, DefaultProps>

Inherited fromInherited from

GenericGroupEntity.removeChild

---

updateupdate

update(changedProps): void

Method for updating props of Entity.

ParametersParameters

Name	Type	Description
changedProps	Partial<Props>	New props values.

ReturnsReturns

void

Inherited fromInherited from

GenericGroupEntity.update

Class: YMapClass: YMap

Main API class. Create a map container.

Example

const map = new YMap(
    document.getElementById('map-root'),
    {location: {center: [-0.118092, 51.509865], zoom: 10}}
);
// add default Yandex scheme layer
map.addChild(new YMapDefaultSchemeLayer());
// relocate map to another point with animation in 200 milliseconds
map.setLocation({center: [48.707067, 44.516975], duration: 200});
// change mode from default `auto` to `raster`
map.setMode('raster');
// get map zoom for some calculations
const zoom = map.zoom;

ConstructorsConstructors

constructorconstructor

new YMap(rootContainer, props, children?)

ParametersParameters

Name	Type
rootContainer	HTMLElement
props	YMapProps
children?	YMapEntity<unknown, {}>[]

OverridesOverrides

GenericRootEntity.constructor

PropertiesProperties

childrenchildren

readonly children: YMapEntity<unknown, {}>[]

OverridesOverrides

GenericRootEntity.children

---

[overrideKeyReactify][overrideKeyReactify]

static [overrideKeyReactify]: CustomReactify<YMap, ForwardRefExoticComponent<{
	behaviors?: BehaviorType[];
	camera?: YMapCameraRequest;
	children?: ReactNode;
	className?: string;
	config?: Config;
	copyrights?: boolean;
	copyrightsPosition?: YMapCopyrightsPosition;
	distribution?: boolean;
	distributionPosition?: "top left" | "top right" | "bottom left" | "bottom right" | "top" | "bottom" | "left" | "right" | "left top" | "left bottom" | "right top" | "right bottom";
	hotspotsStrategy?: "forViewport" | "forPointerPosition";
	key?: Key;
	location: YMapLocationRequest;
	margin?: Margin;
	mode?: MapMode;
	projection?: Projection;
	ref?: Ref<YMap>;
	restrictMapArea?: false | LngLatBounds;
	showScaleInCopyrights?: boolean;
	theme?: YMapTheme;
	tiltRange?: TiltRange;
	worldOptions?: WorldOptions;
	zoomRange?: ZoomRange;
	zoomRounding?: ZoomRounding;
	zoomStrategy?: ZoomStrategy 
}>>

---

defaultPropsdefaultProps

static defaultProps: Readonly<{
	behaviors: string[];
	camera: {
		azimuth: number;
		tilt: number 
	};
	className: "";
	config: Config;
	copyrights: true;
	copyrightsPosition: "bottom right";
	distributionPosition: "bottom left";
	hotspotsStrategy: "forViewport" | "forPointerPosition";
	margin: Margin;
	mode: "auto";
	projection: Projection;
	restrictMapArea: false;
	showScaleInCopyrights: false;
	theme: "light";
	worldOptions: {
		cycledX: boolean;
		cycledY: boolean 
	};
	zoomRange: ZoomRange;
	zoomRounding: "auto";
	zoomStrategy: "zoomToPointer" 
}>

AccessorsAccessors

azimuthazimuth

get azimuth(): number

ReturnsReturns

number

---

behaviorsbehaviors

get behaviors(): readonly BehaviorType[]

getter for YMapProps.behaviors prop

ReturnsReturns

readonly BehaviorType[]

---

boundsbounds

get bounds(): LngLatBounds

getter for YMapProps.location.bounds prop

ReturnsReturns

LngLatBounds

---

centercenter

get center(): readonly [number, number, number]

getter for YMapProps.location.center prop

ReturnsReturns

readonly [number, number, number]

---

configconfig

get config(): Readonly<Config>

getter for YMapProps.config prop

ReturnsReturns

Readonly<Config>

---

containercontainer

get container(): HTMLElement

Main map container

ReturnsReturns

HTMLElement

---

parentparent

get parent(): GenericComplexEntity<unknown, {}, GenericRootEntity<unknown, {}>>

Get parent entity.

ReturnsReturns

GenericComplexEntity<unknown, {}, GenericRootEntity<unknown, {}>>

Inherited fromInherited from

GenericRootEntity.parent

---

projectionprojection

get projection(): Projection

getter for YMapProps.projection prop

ReturnsReturns

Projection

---

restrictMapArearestrictMapArea

get restrictMapArea(): Readonly<false | LngLatBounds>

getter for YMapProps.restrictMapArea prop

ReturnsReturns

Readonly<false | LngLatBounds>

---

rootroot

get root(): this

Get root entity.

ReturnsReturns

this

Inherited fromInherited from

GenericRootEntity.root

---

sizesize

get size(): PixelCoordinates

getter for map size

ReturnsReturns

PixelCoordinates

---

themetheme

get theme(): "light" | "dark"

getter for YMapProps.theme prop

ReturnsReturns

"light" | "dark"

---

tilttilt

get tilt(): number

ReturnsReturns

number

---

tiltRangetiltRange

get tiltRange(): Readonly<TiltRange>

ReturnsReturns

Readonly<TiltRange>

---

zoomzoom

get zoom(): number

getter for YMapProps.location.zoom prop

ReturnsReturns

number

---

zoomRangezoomRange

get zoomRange(): Readonly<ZoomRange>

getter for YMapProps.zoomRange prop

ReturnsReturns

Readonly<ZoomRange>

MethodsMethods

addChildaddChild

addChild(child, index?): YMap

ParametersParameters

Name	Type
child	YMapEntity<unknown, {}>
index?	number

ReturnsReturns

YMap

OverridesOverrides

GenericRootEntity.addChild

---

destroydestroy

destroy(): void

Destroy map and remove it from user DOM-element

ReturnsReturns

void

OverridesOverrides

GenericRootEntity.destroy

---

removeChildremoveChild

removeChild(child): YMap

ParametersParameters

Name	Type
child	YMapEntity<unknown, {}>

ReturnsReturns

YMap

OverridesOverrides

GenericRootEntity.removeChild

---

setBehaviorssetBehaviors

setBehaviors(behaviors): void

setter for YMapProps.behaviors prop

ParametersParameters

Name	Type
behaviors	BehaviorType[]

ReturnsReturns

void

---

setCamerasetCamera

setCamera(camera): void

setter for YMapProps.camera prop

ParametersParameters

Name	Type
camera	YMapCameraRequest

ReturnsReturns

void

---

setConfigsetConfig

setConfig(config): void

setter for YMapProps.config prop

ParametersParameters

Name	Type
config	Config

ReturnsReturns

void

---

setLocationsetLocation

setLocation(location): void

setter for YMapProps.location prop

ParametersParameters

Name	Type
location	YMapLocationRequest

ReturnsReturns

void

---

setMarginsetMargin

setMargin(margin): void

setter for YMapProps.margin prop

ParametersParameters

Name	Type
margin	Margin

ReturnsReturns

void

---

setModesetMode

setMode(mode): void

setter for YMapProps.mode prop

ParametersParameters

Name	Type
mode	MapMode

ReturnsReturns

void

---

setProjectionsetProjection

setProjection(projection): void

setter for YMapProps.projection prop

ParametersParameters

Name	Type
projection	Projection

ReturnsReturns

void

---

setRestrictMapAreasetRestrictMapArea

setRestrictMapArea(restrictMapArea): void

setter for YMapProps.config prop

ParametersParameters

Name	Type
restrictMapArea	LngLatBounds

ReturnsReturns

void

---

setZoomRangesetZoomRange

setZoomRange(zoomRange): void

setter for YMapProps.zoomRange prop

ParametersParameters

Name	Type
zoomRange	ZoomRange

ReturnsReturns

void

---

setZoomRoundingsetZoomRounding

setZoomRounding(zoomRounding): void

setter for YMapProps.zoomRounding prop

ParametersParameters

Name	Type
zoomRounding	ZoomRounding

ReturnsReturns

void

---

updateupdate

update(changedProps): void

Method for updating props of Entity.

ParametersParameters

Name	Type	Description
changedProps	Partial<YMapProps>	New props values.

ReturnsReturns

void

Inherited fromInherited from

GenericRootEntity.update

Class: YMapComplexEntity<Props, DefaultPropsClass: YMapComplexEntity<Props, DefaultProps>

Entity that aggregates multiple Entities but looks basic from the outside.

Type Param

Root Entity Class.

Example

type YMapSomeComplexEntityProps = {
 name?: string;
};
const defaultProps = {
 name: 'entity'
};
class YMapSomeComplexEntity extends YMapComplexEntity<YMapSomeComplexEntityProps, typeof defaultProps> {
 static defaultProps = defaultProps;
 private _someEntity?: YMapSomeEntity; // YMapSomeEntity extends GenericEntity
 protected _onAttach(): void {
     this._someEntity = new YMapSomeEntity();
     this.addChild(this._someEntity); // add someEntity as children
     // ...
 }
 // ...
}

Type parametersType parameters

Name	Type	Description
Props	Props	Type of input props of the Entity.
DefaultProps	extends Object = {}	Type of default input props of the Entity.

ImplementsImplements

• YMapEntity<Props, DefaultProps>

Implemented byImplemented by

• YMapGroupEntity

ConstructorsConstructors

constructorconstructor

new YMapComplexEntity<Props, DefaultProps>(props, options?)

Type parametersType parameters

Name	Type
Props	Props
DefaultProps	extends Object = {}

ParametersParameters

Name	Type	Description
props	Props	The value of input props.
options?	ComplexOptions<YMap>	Optional options object.

Inherited fromInherited from

GenericComplexEntity.constructor

new YMapComplexEntity<Props, DefaultProps>(props, children?, options?)

Type parametersType parameters

Name	Type
Props	Props
DefaultProps	extends Object = {}

ParametersParameters

Name	Type
props	Props
children?	GenericEntity<unknown, {}, YMap>[]
options?	Omit<ComplexOptions<YMap>, "children">

Inherited fromInherited from

GenericComplexEntity.constructor

AccessorsAccessors

parentparent

get parent(): YMapComplexEntity<unknown, {}>

Get parent entity.

ReturnsReturns

YMapComplexEntity<unknown, {}>

Implementation ofImplementation of

YMapEntity.parent

OverridesOverrides

GenericComplexEntity.parent

---

rootroot

get root(): YMap

Get root entity.

ReturnsReturns

YMap

Implementation ofImplementation of

YMapEntity.root

OverridesOverrides

GenericComplexEntity.root

MethodsMethods

updateupdate

update(changedProps): void

Method for updating props of Entity.

ParametersParameters

Name	Type	Description
changedProps	Partial<Props>	New props values.

ReturnsReturns

void

Implementation ofImplementation of

YMapEntity.update

Inherited fromInherited from

GenericComplexEntity.update

Class: YMapEntity<Props, DefaultPropsClass: YMapEntity<Props, DefaultProps>

Entity Base Class. It has event handlers for attaching, detaching and updating props. Has a method for providing and using context.

Example

type YMapSomeEntityProps = {
 name?: string;
};
const defaultProps = {
 name: 'entity'
};
class YMapSomeEntity extends YMapEntity<YMapSomeEntityProps, typeof defaultProps> {
 static defaultProps = defaultProps;
 public isAttached: boolean;
 constructor(props: YMapSomeEntityProps) {
     super(props);
     this.isAttached = false
     // Additional actions can be taken in the constructor of a class.
 }
 protected _onAttach(): void {
     this.isAttached = true;
     // Additional actions can be taken when an Entity is attached.
 }
 // ...
}

Type parametersType parameters

Name	Type	Description
Props	Props	Type of input props of the Entity.
DefaultProps	extends Object = {}	Type of default input props of the Entity.

Implemented byImplemented by

• YMapComplexEntity

ConstructorsConstructors

constructorconstructor

new YMapEntity<Props, DefaultProps>(props)

Type parametersType parameters

Name	Type
Props	Props
DefaultProps	extends Object = {}

ParametersParameters

Name	Type	Description
props	Props	The value of input props.

Inherited fromInherited from

GenericEntity.constructor

AccessorsAccessors

parentparent

get parent(): YMapComplexEntity<unknown, {}>

Get parent entity.

ReturnsReturns

YMapComplexEntity<unknown, {}>

OverridesOverrides

GenericEntity.parent

---

rootroot

get root(): YMap

Get root entity.

ReturnsReturns

YMap

OverridesOverrides

GenericEntity.root

MethodsMethods

updateupdate

update(changedProps): void

Method for updating props of Entity.

ParametersParameters

Name	Type	Description
changedProps	Partial<Props>	New props values.

ReturnsReturns

void

Inherited fromInherited from

GenericEntity.update

Class: YMapGroupEntity<Props, DefaultPropsClass: YMapGroupEntity<Props, DefaultProps>

Entity that aggregates multiple Entities, and allows you to publicly add and remove entities to a subtree.

Type Param

Root Entity Class.

Example

type YMapSomeGroupEntityProps = {
 name?: string;
};
const defaultProps = {
 name: 'entity'
};
class YMapSomeGroupEntity extends YMapGroupEntity<YMapSomeGroupEntityProps, typeof defaultProps> {
 static defaultProps = defaultProps;
 // ...
}
const groupEntity = new YMapSomeGroupEntity()
const someEntity = new YMapSomeEntity(); // YMapSomeEntity extends GenericEntity
groupEntity.addChild(someEntity); // add someEntity in YMapSomeGroupEntity object
groupEntity.removeChild(someEntity); // remove someEntity from YMapSomeGroupEntity object

Type parametersType parameters

Name	Type	Description
Props	Props	Type of input props of the Entity.
DefaultProps	extends Object = {}	Type of default input props of the Entity.

ImplementsImplements

• YMapComplexEntity<Props, DefaultProps>

ConstructorsConstructors

constructorconstructor

new YMapGroupEntity<Props, DefaultProps>(props, options?)

Type parametersType parameters

Name	Type
Props	Props
DefaultProps	extends Object = {}

ParametersParameters

Name	Type	Description
props	Props	The value of input props.
options?	ComplexOptions<YMap>	Optional options object.

Inherited fromInherited from

GenericGroupEntity.constructor

new YMapGroupEntity<Props, DefaultProps>(props, children?, options?)

Type parametersType parameters

Name	Type
Props	Props
DefaultProps	extends Object = {}

ParametersParameters

Name	Type
props	Props
children?	GenericEntity<unknown, {}, YMap>[]
options?	Omit<ComplexOptions<YMap>, "children">

Inherited fromInherited from

GenericGroupEntity.constructor

PropertiesProperties

childrenchildren

readonly children: readonly YMapEntity<unknown, {}>[]

Implementation ofImplementation of

YMapComplexEntity.children

OverridesOverrides

GenericGroupEntity.children

AccessorsAccessors

parentparent

get parent(): YMapComplexEntity<unknown, {}>

Get parent entity.

ReturnsReturns

YMapComplexEntity<unknown, {}>

Implementation ofImplementation of

YMapComplexEntity.parent

OverridesOverrides

GenericGroupEntity.parent

---

rootroot

get root(): YMap

Get root entity.

ReturnsReturns

YMap

Implementation ofImplementation of

YMapComplexEntity.root

OverridesOverrides

GenericGroupEntity.root

MethodsMethods

addChildaddChild

addChild(child, index?): YMapGroupEntity<Props, DefaultProps>

ParametersParameters

Name	Type
child	YMapEntity<unknown, {}>
index?	number

ReturnsReturns

YMapGroupEntity<Props, DefaultProps>

Implementation ofImplementation of

YMapComplexEntity.addChild

OverridesOverrides

GenericGroupEntity.addChild

---

removeChildremoveChild

removeChild(child): YMapGroupEntity<Props, DefaultProps>

ParametersParameters

Name	Type
child	YMapEntity<unknown, {}>

ReturnsReturns

YMapGroupEntity<Props, DefaultProps>

Implementation ofImplementation of

YMapComplexEntity.removeChild

OverridesOverrides

GenericGroupEntity.removeChild

---

updateupdate

update(changedProps): void

Method for updating props of Entity.

ParametersParameters

Name	Type	Description
changedProps	Partial<Props>	New props values.

ReturnsReturns

void

Implementation ofImplementation of

YMapComplexEntity.update

Inherited fromInherited from

GenericGroupEntity.update

Interface: ApikeysInterface: Apikeys

All possible apikeys for http-services.

PropertiesProperties

routerrouter

optional router: string

---

searchsearch

optional search: string

---

suggestsuggest

optional suggest: string

Interface: ComplexOptions<RootInterface: ComplexOptions<Root>

Type parametersType parameters

Name	Type
Root	extends GenericRootEntity<unknown> = GenericRootEntity<unknown>

PropertiesProperties

childrenchildren

optional children: GenericEntity<unknown, {}, Root>[]

---

containercontainer

optional container: boolean

Interface: GenericProjection<TSourceInterface: GenericProjection<TSource>

Type parametersType parameters

Name
TSource

PropertiesProperties

typetype

optional readonly type: string

Projection identity type. It may be:

• EPSG-code (e.g. EPSG:3857)
• any other string to identify (e.g. 'cartesian')

MethodsMethods

fromWorldCoordinatesfromWorldCoordinates

fromWorldCoordinates(coordinates): TSource

ParametersParameters

Name	Type
coordinates	WorldCoordinates

ReturnsReturns

TSource

---

toWorldCoordinatestoWorldCoordinates

toWorldCoordinates(point): WorldCoordinates

ParametersParameters

Name	Type
point	TSource

ReturnsReturns

WorldCoordinates

Interface: PixelCoordinatesInterface: PixelCoordinates

Global pixel coordinates. World size depends on zoom.
Left top is (0; 0).
Right bottom is (2**(zoom + 8); 2**(zoom + 8)).

PropertiesProperties

typetype

optional readonly type: "pixel"

---

xx

x: number

Inherited fromInherited from

Vec2.x

---

yy

y: number

Inherited fromInherited from

Vec2.y

Interface: ReactParentInterface: ReactParent

PropertiesProperties

entityRefentityRef

entityRef: RefInstance<GenericEntity<unknown, {}, GenericRootEntity<unknown, {}>>>

MethodsMethods

positionChildpositionChild

positionChild(entity): number

ParametersParameters

Name	Type
entity	RefInstance<GenericEntity<unknown, {}, GenericRootEntity<unknown, {}>>>

ReturnsReturns

number

---

requestRepositionrequestReposition

requestReposition(): void

ReturnsReturns

void

Interface: TiltRangeInterface: TiltRange

PropertiesProperties

expansionexpansion

readonly expansion: number

Behavior tilt expansion in radians. E.g. you can tilt map with fingers a little bit more than max.

---

maxmax

readonly max: number

Maximum tilt in radians.

---

minmin

readonly min: number

Minimum tilt in radians.

Interface: Vec2Interface: Vec2

PropertiesProperties

xx

x: number

---

yy

y: number

Interface: WorldCoordinatesInterface: WorldCoordinates

Coordinates in [-1 ... +1].
Left bottom is (-1; -1).
Right top is (+1; +1).
Center is (0; 0).

PropertiesProperties

typetype

optional readonly type: "world"

---

xx

x: number

Inherited fromInherited from

Vec2.x

---

yy

y: number

Inherited fromInherited from

Vec2.y

---

zz

optional z: number

Interface: WorldOptionsInterface: WorldOptions

PropertiesProperties

cycledXcycledX

readonly cycledX: boolean

---

cycledYcycledY

readonly cycledY: boolean

Interface: ZoomRangeInterface: ZoomRange

PropertiesProperties

maxmax

max: number

---

minmin

min: number

Type AliasesType Aliases

YMapOpenMapsButtonPropsYMapOpenMapsButtonProps

YMapOpenMapsButtonProps: Object

YMapOpenMapsButton props

Type declarationType declaration

Name	Type	Description
title?	string	Button title

Module: <internalModule: <internal>

Type AliasesType Aliases

BehaviorTypeBehaviorType

BehaviorType: "drag" | "pinchZoom" | "scrollZoom" | "dblClick" | "magnifier" | "oneFingerZoom" | "mouseRotate" | "mouseTilt" | "pinchRotate" | "panTilt"

---

ContextWatcherFnContextWatcherFn

ContextWatcherFn: () => void

Type declarationType declaration

(): void

ReturnsReturns

void

---

CustomReactifyCustomReactify

CustomReactify<TEntity,
 TResult\>: (`ctor`: EntityConstructor<TEntity>, `params`: {
	React: typeof TReact;
	ReactDOM: typeof TReactDOM;
	ReactParent: typeof ReactParent;
	reactify: {
		context: <TContext>(`context?`: TContext) => TReact.Context<unknown>;
		module: ReactifyModule;
		entity: <T>(...`args`: [ctor: T, displayName?: string]) => T extends Overrided<T, TResult> ? TResult : ForwardRefExoticComponent<any> 
	} 
}) => TResult

Type parametersType parameters

Name	Type
TEntity	extends GenericEntity<unknown>
TResult	TResult

Type declarationType declaration

(ctor, params): TResult

ParametersParameters

Name	Type
ctor	EntityConstructor<TEntity>
params	Object
params.React	typeof TReact
params.ReactDOM	typeof TReactDOM
params.ReactParent	typeof ReactParent
params.reactify	Object
params.reactify.context	<TContext>(context?: TContext) => TReact.Context<unknown>
params.reactify.module	ReactifyModule
params.reactify.entity	<T>(...args: [ctor: T, displayName?: string]) => T extends Overrided<T, TResult> ? TResult : ForwardRefExoticComponent<any>

ReturnsReturns

TResult

---

CustomVuefyOptionsCustomVuefyOptions

CustomVuefyOptions<TEntity,
 TExternalProps\>: Object

Type parametersType parameters

Name	Type
TEntity	extends DefaultEntity
TExternalProps	EntityProps<TEntity>

Type declarationType declaration

Name	Type
props	VuefyPropsObject<TExternalProps> | VuefyPropsArray<TExternalProps>

---

DefaultEntityDefaultEntity

DefaultEntity: GenericEntity<unknown>

---

DefaultPropsDefaultProps

DefaultProps: typeof defaultProps

---

EasingBezierPresetEasingBezierPreset

EasingBezierPreset: Object

Type declarationType declaration

Name	Type
p1	Vec2
p2	Vec2

---

EasingFunctionEasingFunction

EasingFunction: (`x`: number) => number

Type declarationType declaration

(x): number

ParametersParameters

Name	Type
x	number

ReturnsReturns

number

---

EasingFunctionDescriptionEasingFunctionDescription

EasingFunctionDescription: EasingPresetName | EasingBezierPreset | EasingFunction

---

EasingPresetNameEasingPresetName

EasingPresetName: "linear" | "ease" | "ease-in" | "ease-out" | "ease-in-out"

---

EntityConstructorEntityConstructor

EntityConstructor<TEntity\>: (...`args`: any[]) => TEntity

Type parametersType parameters

Name	Type
TEntity	extends GenericEntity<unknown>

Type declarationType declaration

(...args)

ParametersParameters

Name	Type
...args	any[]

---

EntityPropsEntityProps

EntityProps<T\>: T extends GenericEntity<infer P> ? P : never

Type parametersType parameters

Name	Type
T	extends GenericEntity<unknown>

---

GenericBoundsGenericBounds

GenericBounds<T\>: [T, T]

Generic for rectangle bounded by bottom-left and top-right coordinates

Type parametersType parameters

Name
T

---

LngLatLngLat

LngLat: [lon: number, lat: number, alt?: number]

Tuple with geodesic coordinates in longitude latitude order.
GeoJSON also uses this order https://tools.ietf.org/html/rfc7946#appendix-A.1

---

LngLatBoundsLngLatBounds

LngLatBounds: GenericBounds<LngLat>

Rectangle bounded by top-left and bottom-right coordinates

---

MapModeMapMode

MapMode: "raster" | "vector" | "auto"

---

MarginMargin

Margin: [number, number, number, number]

Map margins in pixels. Order is top, right, bottom, left.

---

OverridedOverrided

Overrided<TCtor,
 TReactResult\>: Object

Type parametersType parameters

Name	Type
TCtor	extends EntityConstructor<GenericEntity<unknown>>
TReactResult	TReactResult

Type declarationType declaration

Name	Type
[overrideKeyReactify]	CustomReactify<InstanceType<TCtor>, TReactResult>

---

ProjectionProjection

Projection: GenericProjection<LngLat>

---

RefInstanceRefInstance

RefInstance<TEntity\>: React.MutableRefObject<TEntity | undefined>

Type parametersType parameters

Name	Type
TEntity	extends GenericEntity<unknown>

---

VuefyPropsArrayVuefyPropsArray

VuefyPropsArray<RawProps\>: keyof RawProps[]

Type parametersType parameters

Name
RawProps

---

VuefyPropsObjectVuefyPropsObject

VuefyPropsObject<RawProps\>: { [K in keyof RawProps]-?: TVue.PropType<RawProps[K]\> \| TVue.Prop<RawProps[K]\> }

Type parametersType parameters

Name
RawProps

---

WithDefaultsWithDefaults

WithDefaults<Props,
 DefaultProps\>: Props & { [K in keyof DefaultProps]: K extends keyof Props ? NonNullable<Props[K]\> : never }

Type parametersType parameters

Name	Type
Props	Props
DefaultProps	extends Partial<Props>

---

YMapBoundsLocationYMapBoundsLocation

YMapBoundsLocation: Object

Calculate the center and zoom by specifying the coordinates of the top left and bottom right corners of the map.
In this case, the center of the map will be in the center of the rectangle described at the given coordinates.
If the map have an aspect ratio different from this rectangle, the rectangle will be inscribed in height and the map will be centered in width.

map.update({
    location: {bounds: [[-0.118092, 51.509865], [-0.118092, 51.509865]]}
});

Type declarationType declaration

Name	Type
bounds	LngLatBounds

---

YMapCameraYMapCamera

YMapCamera: Object

Observer camera position

Type declarationType declaration

Name	Type	Description
azimuth?	number	Map rotation in radians. Can take values from -Math.PI to Math.PI
tilt?	number	Map tilt in radians. Can take values from 0 to 50 degrees (degrees * (Math.PI / 180))

---

YMapCameraRequestYMapCameraRequest

YMapCameraRequest: YMapCamera & {
	duration?: number;
	easing?: EasingFunctionDescription 
}

Describes how to change current camera position. Change can be instantaneous or animated if duration property is set.

map.update({camera: {
     tilt: 45 * (Math.PI / 180), // 45 degrees
     azimuth: 30 * (Math.PI / 180) // 30 degrees
     duration: 200, // Animation of moving camera will take 200 milliseconds
     easing: 'ease-in-out'
 }});

---

YMapCenterLocationYMapCenterLocation

YMapCenterLocation: Object

Sets map center. In this case, the zoom of the map remains unchanged.

map.update({
  location: {center: [-0.118092, 51.509865]}
});

Type declarationType declaration

Name	Type
center	LngLat

---

YMapCenterZoomLocationYMapCenterZoomLocation

YMapCenterZoomLocation: YMapCenterLocation & YMapZoomLocation

Sets map center and zoom. Combination of YMapCenterLocation and YMapZoomLocation

map.update({
 location: {center: [-0.118092, 51.509865], zoom: 10}
});

---

YMapCopyrightsPositionYMapCopyrightsPosition

YMapCopyrightsPosition: "top left" | "top right" | "bottom left" | "bottom right"

Copyrights position on the map container. By default, 'bottom right'.
For example, 'top left' or 'bottom right'

const map = new ymaps3.YMap(document.getElementById('map-root'), {
 copyrightsPosition: 'top left'
});

---

YMapLocationRequestYMapLocationRequest

YMapLocationRequest: YMapBoundsLocation | YMapCenterLocation | YMapZoomLocation | YMapCenterZoomLocation & {
	duration?: number;
	easing?: EasingFunctionDescription 
}

Describes how to change current map location. Change can be instantaneous or animated if duration property is set.

map.update({
 location: {
     center: [-0.118092, 51.509865], // Center of the map
     zoom: 10, // Zoom level
     duration: 200, // Animation of moving map will take 200 milliseconds
     easing: 'ease-in-out' // Animation easing function
 }
});

or just change center of the map

map.update({
 location: {
    center: [-0.118092, 51.509865], // Center of the map
    duration: 200, // Animation of moving map will take 200 milliseconds
    easing: 'linear' // Animation easing function
 }
})';

---

YMapPropsYMapProps

YMapProps: Object

Map settings. Allow to set map mode, behaviors, margin, zoom rounding, zoom range, restrict map area, theme and other settings.

const map = new YMap(document.getElementById('map-root'), {
   className: 'custom-map',
   location: {center: [-0.118092, 51.509865], zoom: 10},
   camera: {tilt: 45 * (Math.PI / 180), azimuth: 30 * (Math.PI / 180)}
   mode: 'raster',
   behaviors: ['drag', 'scrollZoom', 'dblClick', 'mouseRotate', 'mouseTilt'],
   margin: [0, 100, 0, 0],
   theme: 'light'
});

But required only location prop.

const map = new YMap(document.getElementById('map-root'), {
  location: {center: [-0.118092, 51.509865], zoom: 10}
});

Type declarationType declaration

Name	Type	Description
behaviors?	BehaviorType[]	Active behaviors
camera?	YMapCameraRequest	Initial camera or request to change camera with duration
className?	string	Map container css class name
config?	Config	Other configs
copyrightsPosition?	YMapCopyrightsPosition	Position of copyright on the page. Default is 'bottom right'
hotspotsStrategy?	"forViewport" | "forPointerPosition"	Strategy for fetching hotspots, for whole viewport or for tiles that pointer is hovering at
location	YMapLocationRequest	Initial location or request to change location with duration
margin?	Margin	Map margins
mode?	MapMode	Map mode, 'auto' (default. Show raster tiles while vector tiles are loading), 'raster' or 'vector' (without raster preloading).
projection?	Projection	Projection used in map
restrictMapArea?	LngLatBounds | false	Sets the map view area so that the user cannot move outside of this area.
showScaleInCopyrights?	boolean	Show the map scale next to copyright
theme?	YMapTheme	Theme applied to the scheme
worldOptions?	WorldOptions	Whether to repeat the world in X and Y
zoomRange?	ZoomRange	Restrict min and max map zoom
zoomRounding?	ZoomRounding	Set rounding for zoom. If auto is selected, zoom will be snap for raster and smooth for vector MapMode. Default is auto.
zoomStrategy?	ZoomStrategy	Zoom strategy describes if map center is bound to the zoom point or not

---

YMapThemeYMapTheme

YMapTheme: "light" | "dark"

Map theme. Affects the colors of the map controls and background.

const map = new ymaps3.YMap({
   location: {center: [55.751574, 37.573856], zoom: 9},
   theme: 'dark'
});

---

YMapZoomLocationYMapZoomLocation

YMapZoomLocation: Object

Sets map zoom. In this case, the center of the map remains unchanged.

map.update({
   location: {zoom: 10}
});

Type declarationType declaration

Name	Type
zoom	number

---

ZoomRoundingZoomRounding

ZoomRounding: "snap" | "smooth" | "auto"

Set rounding for zoom.
If auto is selected, zoom will be snap for raster and smooth for vector MapMode.
Default is auto.

---

ZoomStrategyZoomStrategy

ZoomStrategy: "zoomToCenter" | "zoomToPointer"

VariablesVariables

ReactParentReactParent

ReactParent: React.Context<[ReactParent] | undefined>

---

ReactParentReactParent

ReactParent: Context<[ReactParent]>

---

defaultPropsdefaultProps

const defaultProps: Readonly<{
	title: string 
}>

---

defaultPropsdefaultProps

const defaultProps: Readonly<{
	behaviors: string[];
	camera: {
		azimuth: number;
		tilt: number 
	};
	className: "";
	config: Config;
	copyrights: true;
	copyrightsPosition: "bottom right";
	distributionPosition: "bottom left";
	hotspotsStrategy: "forViewport" | "forPointerPosition";
	margin: Margin | undefined;
	mode: "auto";
	projection: Projection;
	restrictMapArea: false;
	showScaleInCopyrights: false;
	theme: "light";
	worldOptions: {
		cycledX: boolean;
		cycledY: boolean 
	};
	zoomRange: ZoomRange;
	zoomRounding: "auto";
	zoomStrategy: "zoomToPointer" 
}>