Class SelectionWindowComponent

Represents a draggable and resizable selection window component. Display itself when it should be visible and have selected features. To be visible, it has to be the defined selectionComponent.

Hierarchy (View Summary)

GirafeDraggableElement
- SelectionWindowComponent

Index

Constructors

constructor

Accessors

host state

Constructors

constructor

new SelectionWindowComponent(): SelectionWindowComponent
Returns SelectionWindowComponent
Overrides GirafeDraggableElement.constructor
- Defined in src/components/selectionwindow/component.ts:51

Properties

activeTooltips

activeTooltips: any[] = []

`Optional`button

button?: HTMLElement

callbacks

callbacks: Callback[] = []

`Optional`closeButton

closeButton?: HTMLElement

componentManager

componentManager: ComponentManager

configManager

configManager: ConfigManager

csvManager

csvManager: CsvManager = ...

displayedProperties

displayedProperties: [string, unknown][] = []

`Optional`displayStyle

displayStyle?: string

`Optional`div

div?: HTMLElement

focusedIndex

focusedIndex: number = 0

`Optional`header

header?: HTMLElement

iconCenter

iconCenter: string = IconCenter

maxIndex

maxIndex: number = 0

name

name: string

pos1

pos1: number = 0

pos2

pos2: number = 0

pos3

pos3: number = 0

pos4

pos4: number = 0

rendered

rendered: boolean = false

shadow

shadow: ShadowRoot

showDropdown

showDropdown: boolean = false

stateManager

stateManager: StateManager

styleUrl

styleUrl: null | string = null

styleUrls

styleUrls: string[] = ...

template

template: Hole | () => Hole

templateUrl

templateUrl: string = './template.html'

`Optional`timeoutId

timeoutId?: Timeout

visible

visible: boolean = false

Accessors

host

get host(): HTMLElement
Returns HTMLElement
Inherited from GirafeDraggableElement.host
- Defined in src/base/GirafeDraggableElement.ts:32

state

get state(): State
Returns State
Inherited from GirafeDraggableElement.state
- Defined in src/base/GirafeHTMLElement.ts:42

Methods

activateTooltips

activateTooltips(
    arrow: boolean,
    delay: [number, number],
    defaultPlacement: string,
): void
Parameters
- arrow: boolean
- delay: [number, number]
- defaultPlacement: string
Returns void
Inherited from GirafeDraggableElement.activateTooltips
- Defined in src/base/GirafeHTMLElement.ts:101

closeDragElement

closeDragElement(): void
Returns void
Inherited from GirafeDraggableElement.closeDragElement
- Defined in src/base/GirafeDraggableElement.ts:131

closeWindow

closeWindow(): void
Closes the window and deselect the selected features.

Returns void
Overrides GirafeDraggableElement.closeWindow
- Defined in src/components/selectionwindow/component.ts:151

connectedCallback

connectedCallback(): void
Returns void
- Defined in src/components/selectionwindow/component.ts:55

deserialize

deserialize(_serializedElement: unknown): void
Deserialize an element and set the current element state to the deserialized one
Parameters
- _serializedElement: unknown
  The element serialization as returned by the serialize method
Returns void
Inherited from GirafeDraggableElement.deserialize
- Defined in src/base/GirafeHTMLElement.ts:263

disconnectedCallback

disconnectedCallback(): void
When the component is disconnected from the DOM all the callbacks will be unregistered

Returns void
Inherited from GirafeDraggableElement.disconnectedCallback
- Defined in src/base/GirafeHTMLElement.ts:298

dragMouseDown

dragMouseDown(_this: GirafeDraggableElement, e: MouseEvent): void
Parameters
- _this: GirafeDraggableElement
- e: MouseEvent
Returns void
Inherited from GirafeDraggableElement.dragMouseDown
- Defined in src/base/GirafeDraggableElement.ts:67

elementDrag

elementDrag(_this: GirafeDraggableElement, e: MouseEvent): void
Parameters
- _this: GirafeDraggableElement
- e: MouseEvent
Returns void
Inherited from GirafeDraggableElement.elementDrag
- Defined in src/base/GirafeDraggableElement.ts:77

generateCSV

generateCSV(layer: string): void
Generates a CSV file with the properties of the currently focused feature.
Parameters
- layer: string
  The layer to export.
Returns void
- Defined in src/components/selectionwindow/component.ts:114

getBodyHeight

getBodyHeight(): number
Returns number
Inherited from GirafeDraggableElement.getBodyHeight
- Defined in src/base/GirafeDraggableElement.ts:121

getBodyWidth

getBodyWidth(): number
Returns number
Inherited from GirafeDraggableElement.getBodyWidth
- Defined in src/base/GirafeDraggableElement.ts:111

getById

getById<T = HTMLElement>(id: string): T
Type Parameters
- T = HTMLElement
Parameters
- id: string
Returns T
Inherited from GirafeDraggableElement.getById
- Defined in src/base/GirafeHTMLElement.ts:46

getLayersList

getLayersList(): Layer[]
Gets the list of layers to export.

Returns Layer[]
The list of layers to export.
- Defined in src/components/selectionwindow/component.ts:99

getParentOfType

getParentOfType(
    parentNodeName: string,
    elem: null | Node,
    initialElem?: null | Node,
): null | Node
Parameters
- parentNodeName: string
- elem: null | Node
- initialElem: null | Node = elem
Returns null | Node
Inherited from GirafeDraggableElement.getParentOfType
- Defined in src/base/GirafeHTMLElement.ts:84

getWindowFeature

getWindowFeature(): WindowFeature
Returns WindowFeature
The WindowFeature at the currently focused index.
- Defined in src/components/selectionwindow/component.ts:70

girafeTranslate

girafeTranslate(): void
Returns void
Inherited from GirafeDraggableElement.girafeTranslate
- Defined in src/base/GirafeHTMLElement.ts:54

hide

hide(): void
Hide the component (display: none).

Returns void
Inherited from GirafeDraggableElement.hide
- Defined in src/base/GirafeHTMLElement.ts:237

htmlUnsafe

htmlUnsafe(str: string): Hole
Convert the string in parameter with uHtml and return it. This allows to convert a string with html in a right html object. For example, htmlUnsafe('
') will return an html div object.
Parameters
- str: string
Returns Hole
Inherited from GirafeDraggableElement.htmlUnsafe
- Defined in src/base/GirafeHTMLElement.ts:185

ignoreUndefinedValues

ignoreUndefinedValues(data: Record<string, unknown>): void
Ignores undefined values in the data.
Parameters
- data: Record<string, unknown>
Returns void
- Defined in src/components/selectionwindow/component.ts:140

isNullOrUndefined

isNullOrUndefined(val: unknown): boolean
NOTE REG: We cannot just use truthy here, because javascript comparaison table is really problematic. For example: 0 == false [] == false "" == false And there are cases where we want to check null or undefined, because 0 can be a right value. More here : https://dorey.github.io/JavaScript-Equality-Table/
Parameters
- val: unknown
Returns boolean
Inherited from GirafeDraggableElement.isNullOrUndefined
- Defined in src/base/GirafeHTMLElement.ts:76

isNullOrUndefinedOrBlank

isNullOrUndefinedOrBlank(val: unknown): boolean
Parameters
- val: unknown
Returns boolean
Inherited from GirafeDraggableElement.isNullOrUndefinedOrBlank
- Defined in src/base/GirafeHTMLElement.ts:80

loadConfig

loadConfig(): Promise<void>
Returns Promise<void>
Inherited from GirafeDraggableElement.loadConfig
- Defined in src/base/GirafeHTMLElement.ts:50

makeDraggable

makeDraggable(): void
Returns void
Inherited from GirafeDraggableElement.makeDraggable
- Defined in src/base/GirafeDraggableElement.ts:45

onFocusWindowFeature

onFocusWindowFeature(index: number): void
Sets the focus on a specific feature.
Parameters
- index: number
Returns void
- Defined in src/components/selectionwindow/component.ts:161

openDropdown

openDropdown(): void
Toggles the visibility of the layers dropdown.

Returns void
- Defined in src/components/selectionwindow/component.ts:90

recenter

recenter(): void
Recenter the map view based on the current feature.

Returns void
- Defined in src/components/selectionwindow/component.ts:77

refreshRender

refreshRender(): void
Re-Render the component. The method should be called when the component has already been rendered and needs to be updated.

Returns void
Inherited from GirafeDraggableElement.refreshRender
- Defined in src/base/GirafeHTMLElement.ts:152

render

render(): void
Render the component regarding its visibility.

Returns void
Overrides GirafeDraggableElement.render
- Defined in src/components/selectionwindow/component.ts:63

renderEmpty

renderEmpty(): void
Renders a hidden span with the name of the component. Useful to render a placeholder for not visible component.

Returns void
Inherited from GirafeDraggableElement.renderEmpty
- Defined in src/base/GirafeHTMLElement.ts:173

serialize

serialize(): {}
Returns the serialization of the current element. This method should be overwritten by child classes

Returns {}
An object describing the current element serialized
Inherited from GirafeDraggableElement.serialize
- Defined in src/base/GirafeHTMLElement.ts:255

show

show(): void
Show the component (display: block).

Returns void
Inherited from GirafeDraggableElement.show
- Defined in src/base/GirafeHTMLElement.ts:244

simulateClick

simulateClick(e: KeyboardEvent): void
In the templates, sometimes for accessibility reasons, we have to support the KeyDown Event In those case, we often juste want to do the same as the click event when Enter or Space is pressed Then this method can be used : it just calls the click event on the same element
Parameters
- e: KeyboardEvent
Returns void
Inherited from GirafeDraggableElement.simulateClick
- Defined in src/base/GirafeHTMLElement.ts:224

subscribe(path: string, callback: Callback): Callback
Subscribes with to the state changes made on
Parameters
- path: string
- callback: Callback
Returns Callback
Inherited from GirafeDraggableElement.subscribe
- Defined in src/base/GirafeHTMLElement.ts:268
subscribe(path: RegExp, callback: Callback): Callback
Subscribes with to the state changes made on
Parameters
- path: RegExp
- callback: Callback
Returns Callback
Inherited from GirafeDraggableElement.subscribe
- Defined in src/base/GirafeHTMLElement.ts:269

unsubscribe

unsubscribe(callback: Callback): void
Parameters
- callback: Callback
  Unsubscribe all callbacks
Returns void
Inherited from GirafeDraggableElement.unsubscribe
- Defined in src/base/GirafeHTMLElement.ts:282
unsubscribe(callbacks: Callback[]): void
Parameters
- callbacks: Callback[]
Returns void
Inherited from GirafeDraggableElement.unsubscribe
- Defined in src/base/GirafeHTMLElement.ts:283

`Static`createWindowFeatures

createWindowFeatures(gridDataById: GridDataById): WindowFeature[]
Creates an array of WindowFeature objects based on the provided GridDataById object. Using gridDataById orders by feature id the WindowFeatures.
Parameters
- gridDataById: GridDataById
Returns WindowFeature[]
An array of WindowFeature objects.

Static
- Defined in src/components/selectionwindow/component.ts:302

Class SelectionWindowComponent

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns SelectionWindowComponent

Properties

activeTooltips

Optionalbutton

callbacks

OptionalcloseButton

componentManager

configManager

csvManager

displayedProperties

OptionaldisplayStyle

Optionaldiv

focusedIndex

Optionalheader

iconCenter

maxIndex

name

pos1

pos2

pos3

pos4

rendered

shadow

showDropdown

stateManager

styleUrl

styleUrls

template

templateUrl

OptionaltimeoutId

visible

Accessors

host

Returns HTMLElement

state

Returns State

Methods

activateTooltips

Parameters

Returns void

closeDragElement

Returns void

closeWindow

Returns void

connectedCallback

Returns void

deserialize

Parameters

Returns void

disconnectedCallback

Returns void

dragMouseDown

Parameters

Returns void

elementDrag

Parameters

Returns void

generateCSV

Parameters

Returns void

getBodyHeight

Returns number

getBodyWidth

Returns number

getById

Type Parameters

Parameters

Returns T

getLayersList

Returns Layer[]

getParentOfType

`Optional`button

`Optional`closeButton

`Optional`displayStyle

`Optional`div

`Optional`header

`Optional`timeoutId

`Static`createWindowFeatures