Skip to main content

IMapObject

geovisto-mapReadme | API


geovisto-map / IMapObject

Interface: IMapObject\<TProps, TDefaults, TState, TConfig, TInitProps>

This interface declares functions for using map object which can be identified by uniquie string.

Author

Jiri Hynek

Extended by

Type parameters

TProps extends IMapObjectProps = IMapObjectProps

TDefaults extends IMapObjectDefaults = IMapObjectDefaults

TState extends IMapObjectState = IMapObjectState

TConfig extends IMapObjectConfig = IMapObjectConfig

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

Methods

getDefaults()

getDefaults(): TDefaults

It returns default values of the state properties.

Returns

TDefaults

Source

model/types/object/IMapObject.ts:27


getId()

getId(): string

Help function which returns the id of the object.

Returns

string

Source

model/types/object/IMapObject.ts:42


getProps()

getProps(): TProps

It returns the props given by the programmer.

Returns

TProps

Source

model/types/object/IMapObject.ts:22


getState()

getState(): TState

It returns the map object state.

Returns

TState

Source

model/types/object/IMapObject.ts:32


getType()

getType(): string

Help function which returns the type of the object.

Returns

string

Source

model/types/object/IMapObject.ts:37


initialize()

initialize(initProps): this

It initializes the state of the object. It processes the serialized config and sets further objects.

This cannot be done in the object constructor since the object can be created before the Geovisto map is created.

Parameters

initProps: TInitProps

Returns

this

Source

model/types/object/IMapObject.ts:53