Class PrintComponent

Print panel component. Read print capabilities and generate options from it. Be able to print the content on the map, based on the layer tree and the OL map. Have actions on the print mask and on the map (rotation).

Hierarchy (View Summary)

GirafeHTMLElement
- PrintComponent

Index

Constructors

constructor

Accessors

state

Constructors

constructor

new PrintComponent(): PrintComponent
Returns PrintComponent
Overrides GirafeHTMLElement.constructor
- Defined in src/components/print/component.ts:76

Properties

activeTooltips

activeTooltips: any[] = []

attributeNames

attributeNames: string[] = []

callbacks

callbacks: Callback[] = []

componentManager

componentManager: ComponentManager

configManager

configManager: ConfigManager

`Optional`displayStyle

displayStyle?: string

dpis

dpis: number[] = []

layouts

layouts: MFPCapabilitiesLayout[] = []

name

name: string

printFormats

printFormats: string[] = []

rendered

rendered: boolean = false

scales

scales: number[] = []

`Optional`selectedLayout

selectedLayout?: MFPCapabilitiesLayout

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

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

attrNameForI18n

attrNameForI18n(attrName: string): string
Legacy fix for attrName i18n.
Parameters
- attrName: string
Returns string
- Defined in src/components/print/component.ts:210

connectedCallback

connectedCallback(): void
Returns void
- Defined in src/components/print/component.ts:82

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

getAttributeInputType

getAttributeInputType(
attributeName: string,
): "number" | "text" | "checkbox" | "textarea"
Used to know the matching HTML element.
Parameters
- attributeName: string
Returns "number" | "text" | "checkbox" | "textarea"
An arbitrary type based on the matching "capabilities" attribute.
- Defined in src/components/print/component.ts:198

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

getCapabilitiesAttribute

getCapabilitiesAttribute(
attributeName: string,
): undefined | MFPCapabilitiesLayoutAttribute
Parameters
- attributeName: string
Returns undefined | MFPCapabilitiesLayoutAttribute
The matching attribute in the selected "capabilities" layout.
- Defined in src/components/print/component.ts:189

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

getRenderState

getRenderState(): string
Returns string
The render state.
- 'error' if there was an error fetching the capabilities.
- 'setup' if the capabilities have been set up.
- 'loading' if the capabilities are being fetched.
- Defined in src/components/print/component.ts:101

getRotation

getRotation(): number
Returns number
The rotation angle in degrees, from the map.
- Defined in src/components/print/component.ts:174

getSelectedDpi

getSelectedDpi(): null | number
Returns null | number
Returns
the current print dpi value.
- Defined in src/components/print/component.ts:152

getSelectedFormat

getSelectedFormat(): null | string
Returns null | string
Returns
the current print format value.
- Defined in src/components/print/component.ts:145

getSelectedScale

getSelectedScale(): null | number
Returns null | number
Returns
the current print scale.
- Defined in src/components/print/component.ts:138

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

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

onCancelPrintElementClicked

onCancelPrintElementClicked(itemId: string): void
Removes the print element with the specified itemId from the printList array. Cancel the print if is it not finished.
Parameters
- itemId: string
Returns void
- Defined in src/components/print/component.ts:258

onDpiChanged

onDpiChanged(event: Event): void
Set selected dpi format.
Parameters
- event: Event
Returns void
- Defined in src/components/print/component.ts:166

onFormatChanged

onFormatChanged(event: Event): void
Set selected print format.
Parameters
- event: Event
Returns void
- Defined in src/components/print/component.ts:159

onInputRotationChanged

onInputRotationChanged(event: Event): void
Sync both rotation inputs and update the map rotation value.
Parameters
- event: Event
Returns void
- Defined in src/components/print/component.ts:181

onLayoutChanged

onLayoutChanged(event: Event): void
Update the values relative to the layout (attributes, scales, etc.) Set scale and print format in the state. Renders the panel with new info.
Parameters
- event: Event
Returns void
- Defined in src/components/print/component.ts:116

onPrintElementClicked

onPrintElementClicked(itemId: string): void
On print element clicked:
- Download it on success
- Do nothing otherwise element.
Parameters
- itemId: string
Returns void
- Defined in src/components/print/component.ts:246

onScaleChanged

onScaleChanged(event: Event): void
Set selected scale in the state and update the mask.
Parameters
- event: Event
Returns void
- Defined in src/components/print/component.ts:130

print

print(): void
Prints the current map state regarding every print options. Can add datasource (based on selection) and a legend. The status will be tracked until finished.

Returns void
- Defined in src/components/print/component.ts:220

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

render

render(): void
Render the component regarding its visibility. Fetch the print capabilities at first rendering, then render the print mask too and register to events.

Returns void
Overrides GirafeHTMLElement.render
- Defined in src/components/print/component.ts:91

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(): {}
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

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

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

`Static`filterValidLayouts

filterValidLayouts(
availableLayouts?: MFPCapabilitiesLayout[],
layouts?: string[],
): MFPCapabilitiesLayout[]
Whitelist the availableLayouts with the given layouts, or allows every of them.
Parameters
- OptionalavailableLayouts: MFPCapabilitiesLayout[]
- Optionallayouts: string[]
Returns MFPCapabilitiesLayout[]
Static
- Defined in src/components/print/component.ts:752

`Static`filterValidPrintFormats

filterValidPrintFormats(
configFormats: undefined | string[],
availableFormats: undefined | string[],
): string[]
Get the print formats based on the configuration. Removes formats not proposed in the available formats.
Parameters
- configFormats: undefined | string[]
- availableFormats: undefined | string[]
Returns string[]
Static
- Defined in src/components/print/component.ts:720

`Static`filterValidScales

filterValidScales(availableScales: number[], scales?: number[]): number[]
Whitelist the availableScales with the given scales, or allows every of them.
Parameters
- availableScales: number[]
- Optionalscales: number[]
Returns number[]
Static
- Defined in src/components/print/component.ts:770

`Static`getValidDefaultFormat

getValidDefaultFormat(
printFormats: string[],
defaultFormat?: string,
): undefined | string
Parameters
- printFormats: string[]
- OptionaldefaultFormat: string
Returns undefined | string
a valid default format from an array of print formats.

Static
- Defined in src/components/print/component.ts:738

Class PrintComponent

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns PrintComponent

Properties

activeTooltips

attributeNames

callbacks

componentManager

configManager

OptionaldisplayStyle

dpis

layouts

name

printFormats

rendered

scales

OptionalselectedLayout

shadow

stateManager

styleUrl

styleUrls

template

templateUrl

OptionaltimeoutId

Accessors

state

Returns State

Methods

activateTooltips

Parameters

Returns void

attrNameForI18n

Parameters

Returns string

connectedCallback

Returns void

deserialize

Parameters

Returns void

disconnectedCallback

Returns void

getAttributeInputType

Parameters

Returns "number" | "text" | "checkbox" | "textarea"

getById

Type Parameters

Parameters

Returns T

getCapabilitiesAttribute

Parameters

Returns undefined | MFPCapabilitiesLayoutAttribute

getParentOfType

Parameters

Returns null | Node

getRenderState

Returns string

getRotation

Returns number

getSelectedDpi

Returns null | number

Returns

getSelectedFormat

Returns null | string

Returns

getSelectedScale

Returns null | number

Returns

girafeTranslate

Returns void

hide

Returns void

htmlUnsafe

Parameters

`Optional`displayStyle

`Optional`selectedLayout

`Optional`timeoutId

`Static`filterValidLayouts

`Static`filterValidPrintFormats

`Static`filterValidScales

`Static`getValidDefaultFormat