Skip to main content

IMapObjectState

geovisto-map • Readme | API


geovisto-map / IMapObjectState

Interface: IMapObjectState\<TProps, TDefaults, TConfig, TInitProps>

This interface declares the state of a map object. It wraps the state since the map object can work with state objects which needs to be explicitly serialized.

Author​

Jiri Hynek

Extended by​

Type parameters​

• TProps extends IMapObjectProps = IMapObjectProps

• TDefaults extends IMapObjectDefaults = IMapObjectDefaults

• TConfig extends IMapObjectConfig = IMapObjectConfig

• TInitProps extends IMapObjectInitProps\<TConfig> = IMapObjectInitProps\<TConfig>

Methods​

deserialize()​

deserialize(config): void

The metod takes config and deserializes the values.

Parameters​

• config: TConfig

Returns​

void

Source​

model/types/object/IMapObjectState.ts:32


getId()​

getId(): string

It returns the id property of the map object state.

Returns​

string

Source​

model/types/object/IMapObjectState.ts:49


getType()​

getType(): string

It returns the type property of the map object state.

Returns​

string

Source​

model/types/object/IMapObjectState.ts:44


initialize()​

initialize(defaults, props, initProps): void

It resets the state to the initial state.

Parameters​

• defaults: TDefaults

• props: TProps

• initProps: TInitProps

Returns​

void

Source​

model/types/object/IMapObjectState.ts:25


serialize()​

serialize(defaults): TConfig

The method serializes the map object state. Optionally, a serialized value can be let undefined if it equals the default value.

Parameters​

• defaults: undefined | TDefaults

Returns​

TConfig

Source​

model/types/object/IMapObjectState.ts:39


setId()​

setId(id): void

It sets the id property of the map object state. It can be set only once.

Parameters​

• id: string

Returns​

void

Source​

model/types/object/IMapObjectState.ts:57