ISidebarFragmentState
geovisto-map / ISidebarFragmentState
Interface: ISidebarFragmentState\<TProps, TDefaults, TConfig>
This interface declares the state of the sidebar fragment. It wraps the state since the sidebar fragment can work with state objects which needs to be explicitly serialized.
Author
Jiri Hynek
Extends
IMapObjectState
\<TProps
,TDefaults
,TConfig
>
Type parameters
• TProps extends ISidebarFragmentProps
= ISidebarFragmentProps
• TDefaults extends ISidebarFragmentDefaults
= ISidebarFragmentDefaults
• TConfig extends ISidebarFragmentConfig
= ISidebarFragmentConfig
Methods
deserialize()
deserialize(
config
):void
The metod takes config and deserializes the values.
Parameters
• config: TConfig
Returns
void
Inherited from
Source
model/types/object/IMapObjectState.ts:32
getContent()
getContent():
null
|HTMLElement
It returns the content property of the sidebar tab framgent state.
Returns
null
| HTMLElement
Source
tools/sidebar/model/types/fragment/ISidebarFragmentState.ts:56
getId()
getId():
string
It returns the id property of the map object state.
Returns
string
Inherited from
Source
model/types/object/IMapObjectState.ts:49
getSidebarTab()
getSidebarTab():
ISidebarTab
\<ISidebarTabProps
,ISidebarTabDefaults
,ISidebarTabState
\<ISidebarTabProps
,ISidebarTabDefaults
,ISidebarTabConfig
>,ISidebarTabConfig
,ISidebarTabInitProps
\<ISidebarTabConfig
>>
It returns the sidenar tab property of the sidebar fragment state.
Returns
ISidebarTab
\<ISidebarTabProps
, ISidebarTabDefaults
, ISidebarTabState
\<ISidebarTabProps
, ISidebarTabDefaults
, ISidebarTabConfig
>, ISidebarTabConfig
, ISidebarTabInitProps
\<ISidebarTabConfig
>>
Source
tools/sidebar/model/types/fragment/ISidebarFragmentState.ts:44
getTool()
getTool():
IMapTool
\<IMapToolProps
,IMapToolDefaults
,IMapToolState
\<IMapToolProps
,IMapToolDefaults
,IMapToolConfig
,IMapToolInitProps
\<IMapToolConfig
>>,IMapToolConfig
,IMapToolInitProps
\<IMapToolConfig
>,IMapToolAPI
>
It returns the tool property of the sidebar tab fragment state.
Returns
IMapTool
\<IMapToolProps
, IMapToolDefaults
, IMapToolState
\<IMapToolProps
, IMapToolDefaults
, IMapToolConfig
, IMapToolInitProps
\<IMapToolConfig
>>, IMapToolConfig
, IMapToolInitProps
\<IMapToolConfig
>, IMapToolAPI
>
Source
tools/sidebar/model/types/fragment/ISidebarFragmentState.ts:27
getType()
getType():
string
It returns the type property of the map object state.
Returns
string
Inherited from
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: IMapObjectInitProps
\<TConfig
>
Returns
void
Inherited from
Source
model/types/object/IMapObjectState.ts:25
isEnabled()
isEnabled():
boolean
It returns the enabled property of the sidebar tab fragment state.
Returns
boolean
Source
tools/sidebar/model/types/fragment/ISidebarFragmentState.ts:32
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
Inherited from
Source
model/types/object/IMapObjectState.ts:39
setContent()
setContent(
content
):void
It sets the content property of the sidebar fragmemt tab state.
Parameters
• content: HTMLElement
Returns
void
Source
tools/sidebar/model/types/fragment/ISidebarFragmentState.ts:63
setEnabled()
setEnabled(
enabled
):void
It sets the enabled property of the sidebar tab fragment state.
Parameters
• enabled: boolean
Returns
void
Source
tools/sidebar/model/types/fragment/ISidebarFragmentState.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
Inherited from
Source
model/types/object/IMapObjectState.ts:57
setSidebarTab()
setSidebarTab(
sidebarTab
):void
It sets the sidebar tab property of the sidebar tab contrfragmentol state.
Parameters
• sidebarTab: ISidebarTab
\<ISidebarTabProps
, ISidebarTabDefaults
, ISidebarTabState
\<ISidebarTabProps
, ISidebarTabDefaults
, ISidebarTabConfig
>, ISidebarTabConfig
, ISidebarTabInitProps
\<ISidebarTabConfig
>>
Returns
void
Source
tools/sidebar/model/types/fragment/ISidebarFragmentState.ts:51