Skip to main content

ISidebarFragment

geovisto-map • Readme | API

geovisto-map / ISidebarFragment

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

This interface declares a sidebar fragment for a sidebar tab.

Author​

Jiri Hynek

Extends​

  • IMapObject\<TProps, TDefaults, TState, TConfig, TInitProps>

Type parameters​

• TProps extends ISidebarFragmentProps = ISidebarFragmentProps

• TDefaults extends ISidebarFragmentDefaults = ISidebarFragmentDefaults

• TState extends ISidebarFragmentState = ISidebarFragmentState

• TConfig extends ISidebarFragmentConfig = ISidebarFragmentConfig

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

Methods​

getContent()​

getContent(): HTMLDivElement

It returns the HTML content of the sidebar fragment.

Returns​

HTMLDivElement

Source​

tools/sidebar/model/types/fragment/ISidebarFragment.ts:27

getDefaults()​

getDefaults(): TDefaults

It returns default values of the state properties.

Returns​

TDefaults

Inherited from​

IMapObject.getDefaults

Source​

model/types/object/IMapObject.ts:27

getId()​

getId(): string

Help function which returns the id of the object.

Returns​

string

Inherited from​

IMapObject.getId

Source​

model/types/object/IMapObject.ts:42

getProps()​

getProps(): TProps

It returns the props given by the programmer.

Returns​

TProps

Inherited from​

IMapObject.getProps

Source​

model/types/object/IMapObject.ts:22

getState()​

getState(): TState

It returns the map object state.

Returns​

TState

Inherited from​

IMapObject.getState

Source​

model/types/object/IMapObject.ts:32

getType()​

getType(): string

Help function which returns the type of the object.

Returns​

string

Inherited from​

IMapObject.getType

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

Inherited from​

IMapObject.initialize

Source​

model/types/object/IMapObject.ts:53

postCreate()​

postCreate(): this

This function is called after the sidebar tab is rendered in sidebar.

Returns​

this

Source​

tools/sidebar/model/types/fragment/ISidebarFragment.ts:32

setFragmentContentChecked()​

setFragmentContentChecked(checked): void

Changes the state of the tool which is controled by this sidebar tab.

Parameters​

• checked: boolean

Returns​

void

Source​

tools/sidebar/model/types/fragment/ISidebarFragment.ts:39