API / geotoolkit / report / dom / elements / Footer / Footer
Footer is the document footer element
↳
Footer
Constructors
Accessors
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
backgroundstyle | string | Background style |
backgroundstyle | FillStyle | Background style |
backgroundstyle-color | string | Color in CSS form |
backgroundstyle-evenoddmode | boolean | Even-odd fill mode |
backgroundstyle-fillpattern | Pattern | Pattern |
backgroundstyle-fillpattern-containername | string | An optional container name, which creates an image pattern. This parameter is used for serialization if you want to save are reference to pattern instead of the pattern itself |
backgroundstyle-fillpattern-patternname | string | Name of this pattern for indexing |
backgroundstyle-fillpattern-scalable | boolean | Flag that sets scalability of the pattern coordinates, or relative to the shape it is filling (It is not supported) |
backgroundstyle-foreground | string | Foreground color |
backgroundstyle-pattern | Pattern | Pattern |
borderlinestyle | string | Border linestyle |
borderlinestyle | LineStyle | Border linestyle |
borderlinestyle-color | string | Color in CSS form |
borderlinestyle-fill | string | Optional fill style to be used to fill lines generated with this style |
borderlinestyle-fill | FillStyle | Optional fill style to be used to fill lines generated with this style |
borderlinestyle-linecap | CapStyle | The line cap style |
borderlinestyle-linedashoffset | number | Line dash offset of dashed line |
borderlinestyle-linejoin | JoinStyle | The line join style |
borderlinestyle-pixelsnapmode | boolean | Pixel Snap Mode, default( |
borderlinestyle-scalable | boolean | True if width should depend on transformation |
borderlinestyle-unit | string | Optional unit for the width |
borderlinestyle-width | number | string | The line thickness |
borders | string | Borders |
borders | LineStyle | Borders |
cssclass | string | Css class |
flip | boolean | Flip |
layoutstyle | LayoutStyle | Layout style |
layoutstyle-constraint | SizeConstraint | Layout constrains |
layoutstyle-flexgrow | number | Number specifying how much the item will grow relative to the rest of the items inside the same container |
layoutstyle-flexshrink | number | Number specifying how much the item will shrink relative to the rest of the items inside the same container |
layoutstyle-float | string | Float position |
layoutstyle-position | string | Layout position |
layoutstyle-size | number | string | Layout size |
marginstyle | number | string | Margin style |
orientation | Orientation | Orientation |
paddingstyle | number | string | Padding style |
pagebreak | PageBreak | Pagebreak |
textstyle | TextStyle | Text style |
textstyle-alignment | AlignmentStyle | Alignment |
textstyle-autosize | boolean | Auto font size on high definition display |
textstyle-background | string | Background style |
textstyle-background | FillStyle | Background style |
textstyle-baseline | BaseLineStyle | Base line |
textstyle-color | string | Color in CSS form |
textstyle-fill | FillStyle | Text fill style |
textstyle-font | string | Font see |
textstyle-fonturl | string | The place from which the font will be loaded, if null - uses system fonts. It can be base64 with url keyword |
textstyle-lineheight | string | number | Line height |
textstyle-multiline | boolean | Allow multi-line text |
textstyle-outline | string | Outline style |
textstyle-outline | LineStyle | Outline style |
textstyle-overflowwrap | OverflowWrapStyle | Overflow wrap |
textstyle-strikethrough | string | Strikethrough style |
textstyle-strikethrough | LineStyle | Strikethrough style |
textstyle-textoverflow | TextOverflowStyle | Text overflow |
textstyle-underline | string | Underline style |
textstyle-underline | LineStyle | Underline style |
textstyle-underlineoffset | string | number | Underline offset distance |
textstyle-whitespace | WhiteSpaceStyle | White space |
textstyle-wordbreak | WordBreakStyle | Word break |
Accessors
• get attributes(): NamedItemMap
Node attributes
Name
module:geotoolkit/report/dom/Node~Node#attributes
Header.attributes
• get childNodes(): NodeList<Node>
The element holding the item.
Name
module:geotoolkit/report/dom/Node~Node#childNodes
Header.childNodes
• get children(): NodeList<Element>
The children property returns a collection of an element's child elements, as an NodeList object.
Name
module:geotoolkit/report/dom/Element~Element#children
Header.children
• get data(): string
Node data
Name
module:geotoolkit/report/dom/Node~Node#data
string
Header.data
• set data(data): void
Node data
Name
module:geotoolkit/report/dom/Node~Node#data
| Name | Type |
|---|---|
data | string |
void
Header.data
• get firstChild(): Node
First child node
Name
module:geotoolkit/report/dom/Node~Node#firstChild
Header.firstChild
• get lastChild(): Node
Last child node
Name
module:geotoolkit/report/dom/Node~Node#lastChild
Header.lastChild
• get localName(): string
Node local name
Name
module:geotoolkit/report/dom/Node~Node#localName
string
Header.localName
• get nextSibling(): Node
Next sibling node
Name
module:geotoolkit/report/dom/Node~Node#nextSibling
Header.nextSibling
• get nodeName(): string
Node name
Name
module:geotoolkit/report/dom/Node~Node#nodeName
string
Header.nodeName
• get nodeType(): NodeType
Node type
Name
module:geotoolkit/report/dom/Node~Node#nodeType
Header.nodeType
• get nodeValue(): string
Node value
Name
module:geotoolkit/report/dom/Node~Node#nodeValue
string
Header.nodeValue
• set nodeValue(value): void
Node value
Name
module:geotoolkit/report/dom/Node~Node#nodeValue
| Name | Type |
|---|---|
value | string |
void
Header.nodeValue
• get ownerDocument(): Document
Node owner document
Name
module:geotoolkit/report/dom/Node~Node#ownerDocument
Header.ownerDocument
• get parentNode(): Node
Parent node
Name
module:geotoolkit/report/dom/Node~Node#parentNode
Header.parentNode
• get previousSibling(): Node
Previous sibling node
Name
module:geotoolkit/report/dom/Node~Node#previousSibling
Header.previousSibling
• get rootNode(): Node
Return root node
Deprecated
since 2022 (3.4) use Node#getRootNode instead
Name
module:geotoolkit/report/dom/Node~Node#rootNode
Header.rootNode
• get tagName(): string
Node tag name
Name
module:geotoolkit/report/dom/Node~Node#tagName
string
Header.tagName
Methods
▸ appendChild(newChild): Footer
Add child to the node
| Name | Type | Description |
|---|---|---|
newChild | Node | child to add |
▸ clearAttributes(): Footer
Clear attributes
▸ clearNodes(): Footer
Remove all child nodes from this node
this
▸ connectStyle(style, type, callback): Footer
Connects style.
This convenience method subscribes a listener to given style for the specified type.
And automatically un-subscribes listener if node is disposed to prevent memory leaks
| Name | Type | Description |
|---|---|---|
style | EventDispatcher | connect style |
type | string | type of event or property |
callback | AttributeCallback<EventDispatcher> | function to be called |
this
▸ disconnectStyle(style, type, callback): Footer
Disconnect style
This convenience method un-subscribes a listener to given style for the specified type.
| Name | Type | Description |
|---|---|---|
style | EventDispatcher | connect style |
type | string | type of event or property |
callback | AttributeCallback<EventDispatcher> | function to be called |
this
▸ dispose(): void
Disposes this node, once disposes a node should not be used anymore.
Clear all listeners, and disconnect styles to avoid memory leaks.
Also aggressively 'cleanup' this node by setting some of its members to null.
void
▸ enumerateNodes(callback, target?): void
Enumerate children nodes
| Name | Type | Description |
|---|---|---|
callback | Callback<Node> | callback |
Optional target | QueryBuilder<any> | target |
void
▸ Protected flush(serializationContext?): Footer
Flush all changes before saving
| Name | Type | Description |
|---|---|---|
Optional serializationContext | SerializationContext | serialization Context |
▸ getAttribute(name): string
Return attribute value
| Name | Type | Description |
|---|---|---|
name | string | attribute name |
string
▸ getBackgroundStyle(): FillStyle
Return background style
background current background style
▸ getBorderLineStyle(): LineStyle
Return border line style
▸ getClassName(): string
string
▸ getContentTransform(): string
Return content transformation angle or null if there is no content rotation specified
string
content transformation angle (90deg|180deg|270deg|-90deg)
▸ getCssClass(): string
Returns css class name to be used to apply CSS style
string
the css class name
▸ getElementRegistry(): IElementsRegistry
Returns elements Registry
▸ getElementTransform(): { name: string ; parameters: string[] }[]
Return array of transformation instructions
{ name: string ; parameters: string[] }[]
array of transformations
▸ getFlip(): boolean
Return element content flip flag
boolean
element layout orientation
▸ getGuid(): string
Returns element GUID
string
▸ getId(): string
Returns element id
string
▸ getInnerCssStyle(): string
Return collected inner css style
string
inner css style
▸ getLayoutStyle(): LayoutStyle<string | number>
Return layout style
LayoutStyle<string | number>
layout style
▸ getMarginsStyle(): SpaceStyle<string | number>
Return margins style
SpaceStyle<string | number>
margins style
▸ getNodeIndex(): number
Return node index
number
▸ getNodeValue(): string
Returns node value
string
▸ getOrientation(): Orientation
Return element layout orientation
element layout orientation
▸ getPaddingStyle(): SpaceStyle<string | number>
Return padding style
SpaceStyle<string | number>
padding style
▸ getPageBreak(): PageBreak
Returns element page break
page break
▸ getParent(): Node
Returns parent node
parent
▸ getProperties(): OptionsOut
Gets element properties
props
▸ getRootNode(): Node
Return root node
node
▸ getTagName(): string
Returns node tag name
string
▸ getTextStyle(): TextStyle
Return text style
text style
▸ getTimeStamp(): number
Gets time stamp
number
timeStamp
▸ getTransformOrigin(): string
Return transform origin
string
▸ getVisible(): boolean
Get element visible state
boolean
▸ hasAttribute(name): boolean
Check if attribute exists
| Name | Type | Description |
|---|---|---|
name | string | attribute name |
boolean
▸ hasChildNodes(): boolean
Return true if node has children
boolean
▸ hasEventListener(type, callback?): boolean
Check if a list of event listeners for this type contains this listener
| Name | Type | Description |
|---|---|---|
type | string | type of event or property |
Optional callback | Function | to be called, if null, check if any callback is registered |
boolean
▸ indexOfNode(node): number
Returns index of node.
| Name | Type | Description |
|---|---|---|
node | Node | item to get index of |
number
▸ insertAfter(newChild, refChild): Node
Insert child
▸ insertBefore(newChild, refChild): Node
Insert child
▸ Protected invalidate(): Footer
this
▸ Protected invalidateDocument(eventArgs): Footer
Invalidate root document
| Name | Type | Description |
|---|---|---|
eventArgs | NodeEventArgs | event args |
this
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ lock(): Footer
Lock node
▸ normalize(): Footer
Puts the specified node and all of its subtree into a "normalized" form. In a normalized sub-tree, no text nodes in the sub-tree are empty and there are no adjacent text nodes.
this
▸ notify<E>(type, source, args?): Footer
Notify listeners
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | event types |
source | Element | of the event |
Optional args | EventMap[E] | arguments of the event |
this
▸ off<E>(type?, callback?): Footer
Detach listener on event. Calling .off() with no arguments removes all attached listeners. Calling .off(type) with no callback removes all attached listeners for specific type.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
Optional type | E | type of the event |
Optional callback | (eventType: E, sender: Footer, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): Footer
Attach listener on event that will be called whenever the specified event is delivered to the target
If the callback function is already in the list of event listeners for this target, the function is not added a second time.
If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event or property |
callback | (eventType: E, sender: Footer, args: EventMap[E]) => void | to be called |
this
▸ Protected onParentChanged(): Footer
this
▸ Protected onResetCssProperties(silent): Footer
Clean up cached properties
| Name | Type | Description |
|---|---|---|
silent | boolean | silent reset |
this
▸ removeAttribute(name): Footer
Remove attribute
| Name | Type | Description |
|---|---|---|
name | string | attribute name |
▸ removeChild(child): Node
Remove child from node
| Name | Type | Description |
|---|---|---|
child | Node | to remove |
▸ replaceChild(newChild, oldChild): Footer
Replace child
▸ Protected resetElementStyle(): Footer
Reset own styles
▸ save(recursive?, serializationContext?): string
Serialize element to xml
| Name | Type | Description |
|---|---|---|
Optional recursive | boolean | save whole dom element structure |
Optional serializationContext | SerializationContext | serialization Context |
string
▸ setAttribute(name, value): Footer
Set attribute value
| Name | Type | Description |
|---|---|---|
name | string | attribute name |
value | string | attribute value |
▸ setAttributeNode(newAttr): Footer
Adds a new Attribute node to the specified element.
| Name | Type | Description |
|---|---|---|
newAttr | Attribute | attribute |
this
▸ setBackgroundStyle(backgroundStyle, merge?): Footer
Set background style
| Name | Type | Description |
|---|---|---|
backgroundStyle | Type | background style |
Optional merge | boolean | merge flag |
this
▸ setBorderLineStyle(borderStyle, merge?): Footer
Sets border line style Returns this
| Name | Type | Description |
|---|---|---|
borderStyle | Type | BorderStyle | line style or options |
Optional merge | boolean | true if you want to merge lineStyle with existing attribute, false by default |
this
▸ setContentTransform(angle): Footer
Set content transformation angle
| Name | Type | Description |
|---|---|---|
angle | string | content transformation angle (90deg|180deg|270deg|-90deg) |
▸ setCssClass(cssClass): Footer
Set css class
| Name | Type | Description |
|---|---|---|
cssClass | string | css class |
▸ Protected setElementRegistry(registry): Footer
Set shadow element registry
| Name | Type | Description |
|---|---|---|
registry | IElementsRegistry | elements registry |
▸ setElementTransform(transformOrigin, transformation?): void
Set element transform
| Name | Type | Description |
|---|---|---|
transformOrigin | string | transform origin |
Optional transformation | { name: string ; parameters: string[] }[] | transformations array |
void
▸ setFlip(flip): Footer
Set element content flip orientation
| Name | Type | Description |
|---|---|---|
flip | boolean | element content flip |
▸ setGuid(guid): Footer
Set node GUID
| Name | Type | Description |
|---|---|---|
guid | string | node GUID |
▸ setLayoutStyle(layoutStyle?, merge?, silent?): Footer
Sets layout style
| Name | Type | Description |
|---|---|---|
Optional layoutStyle | LayoutStyle<string | number> | Type<string | number> | layout style |
Optional merge | boolean | true if you want to merge layoutStyle with existing attribute, false by default |
Optional silent | boolean | silent setting |
▸ setMarginsStyle(margins?, merge?): Footer
Sets margins style
| Name | Type | Description |
|---|---|---|
Optional margins | Type<string | number> | margins style |
Optional merge | boolean | true if you want to merge marginsStyle with existing attribute, false by default |
▸ setNodeValue(nodeValue): Footer
Set node value
| Name | Type | Description |
|---|---|---|
nodeValue | string | node value |
▸ setOrientation(orientation): Footer
Set element layout orientation
| Name | Type | Description |
|---|---|---|
orientation | Orientation | element layout orientation |
▸ setPaddingStyle(padding?, merge?): Footer
Sets padding style
| Name | Type | Description |
|---|---|---|
Optional padding | Type<string | number> | padding style |
Optional merge | boolean | true if you want to merge paddingStyle with existing attribute, false by default |
▸ setPageBreak(pageBreak): Footer
Set element page break
| Name | Type | Description |
|---|---|---|
pageBreak | PageBreak | page break style |
this
▸ setProperties(props): Footer
Sets the element properties
| Name | Type | Description |
|---|---|---|
props | Options | props |
this
▸ setSilent(bool): Footer
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ setText(text): Footer
Set text value
| Name | Type | Description |
|---|---|---|
text | string | text value |
this
▸ setTextStyle(textStyle, merge?): Footer
Sets text style
| Name | Type | Description |
|---|---|---|
textStyle | Type | a new shape text style |
Optional merge | boolean | true if you want to merge textStyle with existing attribute, false by default |
▸ setVisible(visible): Footer
Set element visible state
| Name | Type | Description |
|---|---|---|
visible | boolean | element visibility flag |
▸ setXmlContent(xmlValue): Promise<NodeList<Node>>
Set XML content
| Name | Type | Description |
|---|---|---|
xmlValue | string | xml to parse |
promise
▸ unlock(): Footer
Unlock node
▸ updateTimeStamp(): Footer
Update time stamp to indicate that style has been changed.
this
▸ Static findParentNode<T>(node, classType): InstanceType<T>
Find root of the node with specified type
| Name | Type |
|---|---|
T | extends Constructable<any> |
| Name | Type | Description |
|---|---|---|
node | Node | node to start search |
classType | T | type of the class to search for or short interface name |
InstanceType<T>
▸ Static findParentNode(node, classType): Node
Find root of the node with specified type
| Name | Type | Description |
|---|---|---|
node | Node | node to start search |
classType | string | interface name to search for |
▸ Static getClassName(): string
string