Class CrossSectionSettingsComponent

Hierarchy (View Summary)

GirafeHTMLElement
- CrossSectionSettingsComponent

Index

Constructors

Accessors

Methods

activateTooltips addInteractions connectedCallback deleteAllMarkers deleteAllMeasurements deleteMarker deleteProfile deserialize disconnectedCallback drawDomainLinestring drawLinestringBuffer drawMapMarkers drawPointer exportFeature getById getDistanceAtCoord getParentOfType girafeTranslate handleCursorDomainCoordinatesChange hide htmlUnsafe isNullOrUndefined isNullOrUndefinedOrBlank loadConfig pointStyleFunction printPlot refreshRender registerEvents registerVisibilityEvents removeInteractions render renderAnnotationsTable renderEmpty renderMeasurementsTable resetZoom serialize setAnnotationsFileFormat setBackgroundColor setColorPalette setColorVariable setLineDrawingMode setLineFileFormat setPointSize setPrintFileFormat setSectionWidth setUniformColor setVerticalExaggeration setViewSync shiftLinestring show simulateClick subscribe toggleLineDraw toggleMarkerDraw toggleMeasureDraw unregisterEvents unsubscribe updateLinestringCoordinates updateMarkers zoomToMarker

Constructors

constructor

new CrossSectionSettingsComponent(): CrossSectionSettingsComponent
Returns CrossSectionSettingsComponent
Overrides GirafeHTMLElement.constructor
- Defined in src/components/cross-section/cross-section-settings/component.ts:103

Properties

activeTooltips

activeTooltips: any[] = []

callbacks

callbacks: Callback[] = []

componentManager

componentManager: ComponentManager

configManager

configManager: ConfigManager

crossSectionState

crossSectionState: CrossSectionState

darkFrontendMode

darkFrontendMode: boolean = false

`Optional`displayStyle

displayStyle?: string

domainLinestring

domainLinestring: Feature<LineString>

domainLineStringLayer

domainLineStringLayer: VectorLayer<VectorSource<Feature<Geometry>>>

domainLinestringSource

domainLinestringSource: VectorSource<Feature<Geometry>>

drawInteraction

drawInteraction: Draw

i18nManager

i18nManager: I18nManager

iconStyle

iconStyle: Style = ...

linesLayer

linesLayer: VectorLayer<VectorSource<Feature<Geometry>>>

linestring

linestring: Feature<LineString>

linestringLength

linestringLength: number = 0.0

linestringSource

linestringSource: VectorSource<Feature<Geometry>>

markersTable

markersTable: null | HTMLTableElement = null

measurementsTable

measurementsTable: null | HTMLTableElement = null

modifyInteraction

modifyInteraction: Modify

name

name: string

parser

parser: any = ...

pointer

pointer: Feature<Point>

pointerLayer

pointerLayer: VectorLayer<VectorSource<Feature<Geometry>>>

pointerSource

pointerSource: VectorSource<Feature<Geometry>>

points

points: Feature<Point>[]

pointsLayer

pointsLayer: VectorLayer<VectorSource<Feature<Geometry>>>

pointsSource

pointsSource: VectorSource<Feature<Geometry>>

polygon

polygon: Feature<Polygon>

polygonLayer

polygonLayer: VectorLayer<VectorSource<Feature<Geometry>>>

polygonSource

polygonSource: VectorSource<Feature<Geometry>>

rendered

rendered: 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

visible

visible: boolean = false

Accessors

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

deleteMarker

deleteMarker(id: string): void
Parameters
- id: string
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:761

deleteProfile

deleteProfile(): void
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:757

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

drawDomainLinestring

drawDomainLinestring(): void
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:378

drawLinestringBuffer

drawLinestringBuffer(): void
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:334

drawMapMarkers

drawMapMarkers(): void
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:473

drawPointer

drawPointer(coords: [number, number]): void
Parameters
- coords: [number, number]
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:459

exportFeature

exportFeature(
    features: Feature<Geometry>[],
    filename: string,
    format: VectorFeatureFileFormat,
): void
Parameters
- features: Feature<Geometry>[]
- filename: string
- format: VectorFeatureFileFormat
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:604

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

getDistanceAtCoord

getDistanceAtCoord(lineStringGeom: LineString, coord: [number, number]): number
Parameters
- lineStringGeom: LineString
- coord: [number, number]
Returns number
- Defined in src/components/cross-section/cross-section-settings/component.ts:431

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

handleCursorDomainCoordinatesChange

handleCursorDomainCoordinatesChange(
cursorDomainCoordinates: [number, number],
): void
Parameters
- cursorDomainCoordinates: [number, number]
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:837

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

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

pointStyleFunction

pointStyleFunction(feature: Feature): Style
Parameters
- feature: Feature
Returns Style
- Defined in src/components/cross-section/cross-section-settings/component.ts:81

printPlot

printPlot(printFileFormat: PrintFileFormat): void
Parameters
- printFileFormat: PrintFileFormat
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:816

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

registerEvents

registerEvents(): void
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:902

registerVisibilityEvents

registerVisibilityEvents(): void
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:1111

removeInteractions

removeInteractions(): void
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:516

render

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

Returns void
Overrides GirafeHTMLElement.render
- Defined in src/components/cross-section/cross-section-settings/component.ts:873

renderAnnotationsTable

renderAnnotationsTable(table: HTMLTableElement, records: Marker[]): void
Parameters
- table: HTMLTableElement
- records: Marker[]
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:684

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

renderMeasurementsTable

renderMeasurementsTable(table: HTMLTableElement, records: Measurement[]): void
Parameters
- table: HTMLTableElement
- records: Measurement[]
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:632

resetZoom

resetZoom(): void
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:796

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

setAnnotationsFileFormat

setAnnotationsFileFormat(val: VectorFeatureFileFormat): void
Parameters
- val: VectorFeatureFileFormat
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:829

setBackgroundColor

setBackgroundColor(val: string): void
Parameters
- val: string
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:587

setColorPalette

setColorPalette(val: ColorPalette): void
Parameters
- val: ColorPalette
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:595

setColorVariable

setColorVariable(val: ColorVariable): void
Parameters
- val: ColorVariable
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:599

setLineDrawingMode

setLineDrawingMode(val: boolean): void
Parameters
- val: boolean
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:533

setLineFileFormat

setLineFileFormat(val: VectorFeatureFileFormat): void
Parameters
- val: VectorFeatureFileFormat
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:833

setPointSize

setPointSize(val: number): void
Parameters
- val: number
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:572

setPrintFileFormat

setPrintFileFormat(val: PrintFileFormat): void
Parameters
- val: PrintFileFormat
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:825

setSectionWidth

setSectionWidth(val: number): void
Parameters
- val: number
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:543

setUniformColor

setUniformColor(val: string): void
Parameters
- val: string
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:591

setVerticalExaggeration

setVerticalExaggeration(val: number): void
Parameters
- val: number
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:557

setViewSync

setViewSync(val: boolean): void
Parameters
- val: boolean
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:812

shiftLinestring

shiftLinestring(shift?: [number, number]): void
Parameters
- shift: [number, number] = ...
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:453

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

toggleLineDraw

toggleLineDraw(): void
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:529

toggleMarkerDraw

toggleMarkerDraw(): void
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:525

toggleMeasureDraw

toggleMeasureDraw(): void
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:521

unregisterEvents

unregisterEvents(): void
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:1100

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

updateLinestringCoordinates

updateLinestringCoordinates(): void
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:363

updateMarkers

updateMarkers(polygon: Feature<Polygon>): void
Parameters
- polygon: Feature<Polygon>
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:299

zoomToMarker

zoomToMarker(id: string): void
Parameters
- id: string
Returns void
- Defined in src/components/cross-section/cross-section-settings/component.ts:801

Class CrossSectionSettingsComponent

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns CrossSectionSettingsComponent

Properties

activeTooltips

callbacks

componentManager

configManager

crossSectionState

darkFrontendMode

OptionaldisplayStyle

domainLinestring

domainLineStringLayer

domainLinestringSource

drawInteraction

i18nManager

iconStyle

linesLayer

linestring

linestringLength

linestringSource

markersTable

measurementsTable

modifyInteraction

name

parser

pointer

pointerLayer

pointerSource

points

pointsLayer

pointsSource

polygon

polygonLayer

polygonSource

rendered

shadow

stateManager

styleUrl

styleUrls

template

templateUrl

OptionaltimeoutId

visible

Accessors

state

Returns State

Methods

activateTooltips

Parameters

Returns void

addInteractions

Returns void

connectedCallback

Returns void

deleteAllMarkers

Returns void

deleteAllMeasurements

Returns void

deleteMarker

Parameters

Returns void

deleteProfile

Returns void

deserialize

Parameters

Returns void

disconnectedCallback

Returns void

drawDomainLinestring

Returns void

drawLinestringBuffer

Returns void

`Optional`displayStyle

`Optional`timeoutId