Class DrawingComponent

Hierarchy (View Summary)

GirafeHTMLElement
- DrawingComponent

Index

Constructors

constructor

Accessors

selectedFeatures state

Constructors

constructor

new DrawingComponent(): DrawingComponent
Returns DrawingComponent
Overrides GirafeHTMLElement.constructor
- Defined in src/components/drawing/component.ts:65

Properties

activeTooltips

activeTooltips: any[] = []

batchCreateMode

batchCreateMode: boolean = false

buttons

buttons: { id: string; tool: null | DrawingShape }[] = ...

callbacks

callbacks: Callback[] = []

cesiumDrawing

cesiumDrawing: CesiumDrawing

checkedIcon

checkedIcon: string = checkedIcon

colorPickers

colorPickers: [GirafeColorPicker, () => string][] = []

componentManager

componentManager: ComponentManager

configManager

configManager: ConfigManager

`Optional`displayStyle

displayStyle?: string

drawingState

drawingState: DrawingState

fixedLengthEnabled

fixedLengthEnabled: boolean = false

locateIcon

locateIcon: string = locateIcon

mapContextMenu

mapContextMenu: undefined | ContextMenu = undefined

name

name: string

noCheckedIcon

noCheckedIcon: string = noCheckedIcon

notVisibleIcon

notVisibleIcon: string = notVisibleIcon

olDrawing

olDrawing: OlDrawing

rendered

rendered: boolean = false

renderedOnce

renderedOnce: boolean = false

shadow

shadow: ShadowRoot

stateManager

stateManager: StateManager

styleUrl

styleUrl: null | string = null

styleUrls

styleUrls: string[] = ...

template

template: Hole | () => Hole

templateUrl

templateUrl: string = './template.html'

`Optional`timeoutId

timeoutId?: Timeout

toolSelected

toolSelected: null | Element = null

trashIcon

trashIcon: string = trashIcon

visible

visible: boolean = false

visibleIcon

visibleIcon: string = visibleIcon

Accessors

selectedFeatures

get selectedFeatures(): DrawingFeature[]
Returns DrawingFeature[]
- Defined in src/components/drawing/component.ts:221

state

get state(): State
Returns State
Inherited from GirafeHTMLElement.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 GirafeHTMLElement.activateTooltips
- Defined in src/base/GirafeHTMLElement.ts:101

addColorPicker

addColorPicker(id: string, set: (c: Color) => unknown, get: () => string): void
Parameters
- id: string
- set: (c: Color) => unknown
- get: () => string
Returns void
- Defined in src/components/drawing/component.ts:155

connectedCallback

connectedCallback(): void
Returns void
- Defined in src/components/drawing/component.ts:197

createMapContextMenu

createMapContextMenu(): void
Returns void
- Defined in src/components/drawing/component.ts:350

deleteFeature

deleteFeature(feature: DrawingFeature): Promise<void>
Parameters
- feature: DrawingFeature
Returns Promise<void>
- Defined in src/components/drawing/component.ts:321

deselectAllFeatures

deselectAllFeatures(): void
Returns void
- Defined in src/components/drawing/component.ts:225

deserialize

deserialize(serializedFeatures: SerializedFeature[]): void
Deserialize an element and set the current element state to the deserialized one
Parameters
- serializedFeatures: SerializedFeature[]
Returns void
Overrides GirafeHTMLElement.deserialize
- Defined in src/components/drawing/component.ts:171

disconnectedCallback

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

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

exportSelectedFeatures

exportSelectedFeatures(format: "kml" | "geojson" | "gpx"): void
Parameters
- format: "kml" | "geojson" | "gpx"
Returns void
- Defined in src/components/drawing/component.ts:394

fixedLengthOptionAllowed

fixedLengthOptionAllowed(): boolean
Returns boolean
- Defined in src/components/drawing/component.ts:186

getById

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

getOptionsTitle

getOptionsTitle(): string
Returns string
- Defined in src/components/drawing/component.ts:301

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 GirafeHTMLElement.getParentOfType
- Defined in src/base/GirafeHTMLElement.ts:84

girafeTranslate

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

hide

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

Returns void
Inherited from GirafeHTMLElement.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 GirafeHTMLElement.htmlUnsafe
- Defined in src/base/GirafeHTMLElement.ts:185

isDisplayMeasureEnabled

isDisplayMeasureEnabled(): boolean
Returns boolean
- Defined in src/components/drawing/component.ts:313

isDisplayNameEnabled

isDisplayNameEnabled(): boolean
Returns boolean
- Defined in src/components/drawing/component.ts:309

isFillColorEnabled

isFillColorEnabled(): boolean
Returns boolean
- Defined in src/components/drawing/component.ts:317

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 GirafeHTMLElement.isNullOrUndefined
- Defined in src/base/GirafeHTMLElement.ts:76

isNullOrUndefinedOrBlank

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

loadConfig

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

onFeaturesChanged

onFeaturesChanged(
oldFeatures: DrawingFeature[],
newFeatures: DrawingFeature[],
): void
Parameters
- oldFeatures: DrawingFeature[]
- newFeatures: DrawingFeature[]
Returns void
- Defined in src/components/drawing/component.ts:230

onOptionsChange

onOptionsChange(): void
Returns void
- Defined in src/components/drawing/component.ts:329

onProjectionChanged

onProjectionChanged(oldProj: string, newProj: string): void
Parameters
- oldProj: string
- newProj: string
Returns void
- Defined in src/components/drawing/component.ts:261

onToggleBatchMode

onToggleBatchMode(): void
Returns void
- Defined in src/components/drawing/component.ts:278

onToggleFeatureSelection

onToggleFeatureSelection(feature: DrawingFeature): void
Parameters
- feature: DrawingFeature
Returns void
- Defined in src/components/drawing/component.ts:295

onToggleFixedLength

onToggleFixedLength(): void
Returns void
- Defined in src/components/drawing/component.ts:287

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
Overrides GirafeHTMLElement.refreshRender
- Defined in src/components/drawing/component.ts:145

render

render(): void
Render the component's template.

Returns void
Overrides GirafeHTMLElement.render
- Defined in src/components/drawing/component.ts:76

renderComponent

renderComponent(): void
Returns void
- Defined in src/components/drawing/component.ts:84

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 GirafeHTMLElement.renderEmpty
- Defined in src/base/GirafeHTMLElement.ts:173

serialize

serialize(): SerializedFeature[]
Returns the serialization of the current element. This method should be overwritten by child classes

Returns SerializedFeature[]
An object describing the current element serialized
Overrides GirafeHTMLElement.serialize
- Defined in src/components/drawing/component.ts:167

setTool

setTool(tool?: null | DrawingShape): void
Parameters
- tool: null | DrawingShape = null
Returns void
- Defined in src/components/drawing/component.ts:177

show

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

Returns void
Inherited from GirafeHTMLElement.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 GirafeHTMLElement.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 GirafeHTMLElement.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 GirafeHTMLElement.subscribe
- Defined in src/base/GirafeHTMLElement.ts:269

toggleMeasureVisibility

toggleMeasureVisibility(): void
Returns void
- Defined in src/components/drawing/component.ts:344

toggleNameVisibility

toggleNameVisibility(): void
Returns void
- Defined in src/components/drawing/component.ts:338

togglePanel

togglePanel(visible: boolean): void
Parameters
- visible: boolean
Returns void
- Defined in src/components/drawing/component.ts:205

unsubscribe

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

Class DrawingComponent

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns DrawingComponent

Properties

activeTooltips

batchCreateMode

buttons

callbacks

cesiumDrawing

checkedIcon

colorPickers

componentManager

configManager

OptionaldisplayStyle

drawingState

fixedLengthEnabled

locateIcon

mapContextMenu

name

noCheckedIcon

notVisibleIcon

olDrawing

rendered

renderedOnce

shadow

stateManager

styleUrl

styleUrls

template

templateUrl

OptionaltimeoutId

toolSelected

trashIcon

visible

visibleIcon

Accessors

selectedFeatures

Returns DrawingFeature[]

state

Returns State

Methods

activateTooltips

Parameters

Returns void

addColorPicker

Parameters

Returns void

connectedCallback

Returns void

createMapContextMenu

Returns void

deleteFeature

Parameters

Returns Promise<void>

deselectAllFeatures

Returns void

deserialize

Parameters

Returns void

disconnectedCallback

Returns void

exportSelectedFeatures

Parameters

Returns void

fixedLengthOptionAllowed

Returns boolean

getById

Type Parameters

Parameters

Returns T

getOptionsTitle

Returns string

getParentOfType

`Optional`displayStyle

`Optional`timeoutId