SelectionTool
geovisto-map / SelectionTool
Class: SelectionTool
This class provides the selection tool.
Author
Jiri Hynek
Extends
Implements
Constructors
new SelectionTool()
new SelectionTool(
props
?):SelectionTool
It creates a new tool with respect to the props.
Parameters
• props?: ISelectionToolProps
Returns
Overrides
Paramps
Source
tools/selection/model/internal/tool/SelectionTool.ts:49
Properties
mapForm
private
mapForm:IMapForm
TODO: move to the tool state.
Source
tools/selection/model/internal/tool/SelectionTool.ts:42
api
static
private
api:ISelectionToolAPI
=SelectionToolAPI
tool api
Source
tools/selection/model/internal/tool/SelectionTool.ts:37
Methods
copy()
copy():
ISelectionTool
\<ISelectionToolProps
,ISelectionToolDefaults
,ISelectionToolState
\<ISelectionToolProps
,ISelectionToolDefaults
,ISelectionToolConfig
>,ISelectionToolConfig
,IMapToolInitProps
\<ISelectionToolConfig
>,ISelectionToolAPI
>
It creates a copy of the uninitialized tool.
Returns
ISelectionTool
\<ISelectionToolProps
, ISelectionToolDefaults
, ISelectionToolState
\<ISelectionToolProps
, ISelectionToolDefaults
, ISelectionToolConfig
>, ISelectionToolConfig
, IMapToolInitProps
\<ISelectionToolConfig
>, ISelectionToolAPI
>
Implementation of
Overrides
Source
tools/selection/model/internal/tool/SelectionTool.ts:56
create()
create():
this
It creates new filter tool.
Returns
this
Implementation of
Overrides
Source
tools/selection/model/internal/tool/SelectionTool.ts:127
createDefaults()
createDefaults():
ISelectionToolDefaults
It creates new defaults of the tool.
Returns
Overrides
Source
tools/selection/model/internal/tool/SelectionTool.ts:77
createMapForm()
protected
createMapForm():IMapForm
It creates new tab control.
Returns
Source
tools/selection/model/internal/tool/SelectionTool.ts:162
createState()
createState():
ISelectionToolState
\<ISelectionToolProps
,ISelectionToolDefaults
,ISelectionToolConfig
>
It creates the tool state.
Returns
ISelectionToolState
\<ISelectionToolProps
, ISelectionToolDefaults
, ISelectionToolConfig
>
Overrides
Source
tools/selection/model/internal/tool/SelectionTool.ts:91
getAPIGetter()
getAPIGetter():
undefined
|ISelectionToolAPIGetter
It returns the tool API
Returns
undefined
| ISelectionToolAPIGetter
Implementation of
Overrides
Source
tools/selection/model/internal/tool/SelectionTool.ts:98
getDefaults()
getDefaults():
ISelectionToolDefaults
It returns default values of the selection tool.
Returns
Implementation of
Overrides
Source
tools/selection/model/internal/tool/SelectionTool.ts:70
getId()
getId():
string
Help function which returns the id of the object.
Returns
string
Implementation of
Inherited from
Source
model/internal/object/MapObject.ts:93
getMap()
getMap():
undefined
|IMap
\<IMapProps
,IMapDefaults
,IMapState
\<IMapProps
,IMapDefaults
,IMapConfig
>,IMapConfig
,IMapInitProps
\<IMapConfig
>>
Help function returns map which uses this tool.
Do not override this function. Use the state class instead.
Returns
undefined
| IMap
\<IMapProps
, IMapDefaults
, IMapState
\<IMapProps
, IMapDefaults
, IMapConfig
>, IMapConfig
, IMapInitProps
\<IMapConfig
>>
Implementation of
Inherited from
Source
model/internal/tool/MapTool.ts:112
getMapForm()
getMapForm():
IMapForm
It returns a tab fragment.
Returns
Implementation of
Source
tools/selection/model/internal/tool/SelectionTool.ts:152
getProps()
getProps():
ISelectionToolProps
It returns the props given by the programmer.
Returns
Implementation of
Overrides
Source
tools/selection/model/internal/tool/SelectionTool.ts:63
getState()
getState():
ISelectionToolState
\<ISelectionToolProps
,ISelectionToolDefaults
,ISelectionToolConfig
>
It returns the selection tool state.
Returns
ISelectionToolState
\<ISelectionToolProps
, ISelectionToolDefaults
, ISelectionToolConfig
>
Implementation of
Overrides
Source
tools/selection/model/internal/tool/SelectionTool.ts:84
getType()
getType():
string
Help function which returns the type of the object.
Returns
string
Implementation of
Inherited from
Source
model/internal/object/MapObject.ts:86
handleEvent()
handleEvent(
event
):void
This function is called when a custom event is invoked.
Parameters
• event: IMapEvent
\<IMapObject
\<IMapObjectProps
, IMapObjectDefaults
\<IMapObjectProps
, IMapObjectConfig
>, IMapObjectState
\<IMapObjectProps
, IMapObjectDefaults
\<IMapObjectProps
, IMapObjectConfig
>, IMapObjectConfig
, IMapObjectInitProps
\<IMapObjectConfig
>>, IMapObjectConfig
, IMapObjectInitProps
\<IMapObjectConfig
>>>
Returns
void
Overrides
Source
tools/selection/model/internal/tool/SelectionTool.ts:171
initialize()
initialize(
initProps
):this
Overrides the super method.
Parameters
• initProps: IMapToolInitProps
\<ISelectionToolConfig
>
Returns
this
Implementation of
Overrides
Source
tools/selection/model/internal/tool/SelectionTool.ts:109
initializeAPI()
protected
initializeAPI():void
Help method which initializes the API.
Returns
void
Source
tools/selection/model/internal/tool/SelectionTool.ts:117
isEnabled()
isEnabled():
boolean
Help getter which returns enabled property of state.
Do not override this function. Use the state class instead.
Returns
boolean
Implementation of
Inherited from
Source
model/internal/tool/MapTool.ts:130
isSingleton()
isSingleton():
boolean
Help getter which returns a logtical value whether the tool type is singleton.
Returns
boolean
Implementation of
Inherited from
Source
model/internal/tool/MapTool.ts:81
setEnabled()
setEnabled(
enabled
):void
Some tools might be dynamicaly enabled/disabled. This function is called externally when the tool is enabled/disabled.
Override this function, if needed.
Parameters
• enabled: boolean
Returns
void
Implementation of
Inherited from
Source
model/internal/tool/MapTool.ts:142
setProps()
protected
setProps(props
):void
It updates the props.
Parameters
• props: IMapObjectProps
Returns
void
Inherited from
Source
model/internal/object/MapObject.ts:38
setSelection()
setSelection(
selection
):void
Parameters
• selection: null
| IMapSelection
Returns
void
Implementation of
Paramection
Source
tools/selection/model/internal/tool/SelectionTool.ts:138
switchEnabled()
switchEnabled():
void
Help function which switches enabled state (enabled/disabled).
Do not override this function. Use setEnabled instead.
Returns
void