YMapContext

The YMapContext class creates a context that components can provide or read.

The most common way to transfer information from a parent component to a child component is via props. However, if a tree has a complex structure of components or multiple components need the same information, transferring props can become cumbersome and inconvenient. Context enables a parent component to make some information available to any component in the tree below it without explicitly transferring it via props.

YMapContext doesn't contain any information. It determines which context is read or provided by other components. The context provider is the YMapContextProvider class.

YMapContextProviderYMapContextProvider

YMapContextProvider is a context provider for YMap, allowing the input of the context and its value.

Usage exampleUsage example

const mapContextProvider = new YMapContextProvider({context: SomeMapContext, value: {your: 'value'}});
map.addChild(mapContextProvider);

class SomeContextConsumer extends ymaps3.YMapEntity<{}> {
   constructor() {
       super({});
   }

   _onAttach() {
     const value = this._consumeContext(SomeMapContext);
     console.log(value); // {your: 'value'}
   }
}

mapContextProvider.addChild(new SomeContextConsumer());

<YMapContextProvider context={SomeMapContext} value={{your: 'value'}}>
    <YMapContainer>
        <YMapContainer>
            <SomeContextConsumer />
        <YMapContainer>
    </YMapContainer>
</YMapContextProvider>

ConstructorConstructor

new YMapContextProvider<T>(props, options?)

Constructor parametersConstructor parameters

Inherited from YMapGroupEntity.constructor.

new YMapContextProvider<T>(props, children?, options?)

Constructor parametersConstructor parameters

Inherited from YMapGroupEntity.constructor.

PropsProps

YMapContextProviderProps<T>: Object

ParametersParameters

MethodsMethods

addChildaddChild

addChild(child, index?): YMapContextProvider<T>

ParametersParameters

ReturnsReturns

YMapContextProvider<T>

Inherited fromInherited from

YMapGroupEntity.addChild

removeChildremoveChild

removeChild(child): YMapContextProvider<T>

ParametersParameters

ReturnsReturns

YMapContextProvider<T>

Inherited fromInherited from

YMapGroupEntity.removeChild

updateupdate

update(changedProps): void

Method for updating props of Entity.

ParametersParameters

ReturnsReturns

void

Inherited fromInherited from

YMapGroupEntity.update