API / geotoolkit / report / dom / elements / Header / Header
Header is the document header element
↳
Header↳↳
Footer
Constructors
- [new Header(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.report.dom.elements.header.header.md#new header(options))
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
ContainerElement.attributes
• get childNodes(): NodeList<Node>
The element holding the item.
Name
module:geotoolkit/report/dom/Node~Node#childNodes
ContainerElement.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
ContainerElement.children
• get data(): string
Node data
Name
module:geotoolkit/report/dom/Node~Node#data
string
ContainerElement.data
• set data(data): void
Node data
Name
module:geotoolkit/report/dom/Node~Node#data
| Name | Type |
|---|---|
data | string |
void
ContainerElement.data
• get firstChild(): Node
First child node
Name
module:geotoolkit/report/dom/Node~Node#firstChild
ContainerElement.firstChild
• get lastChild(): Node
Last child node
Name
module:geotoolkit/report/dom/Node~Node#lastChild
ContainerElement.lastChild
• get localName(): string
Node local name
Name
module:geotoolkit/report/dom/Node~Node#localName
string
ContainerElement.localName
• get nextSibling(): Node
Next sibling node
Name
module:geotoolkit/report/dom/Node~Node#nextSibling
ContainerElement.nextSibling
• get nodeName(): string
Node name
Name
module:geotoolkit/report/dom/Node~Node#nodeName
string
ContainerElement.nodeName
• get nodeType(): NodeType
Node type
Name
module:geotoolkit/report/dom/Node~Node#nodeType
ContainerElement.nodeType
• get nodeValue(): string
Node value
Name
module:geotoolkit/report/dom/Node~Node#nodeValue
string
ContainerElement.nodeValue
• set nodeValue(value): void
Node value
Name
module:geotoolkit/report/dom/Node~Node#nodeValue
| Name | Type |
|---|---|
value | string |
void
ContainerElement.nodeValue
• get ownerDocument(): Document
Node owner document
Name
module:geotoolkit/report/dom/Node~Node#ownerDocument
ContainerElement.ownerDocument
• get parentNode(): Node
Parent node
Name
module:geotoolkit/report/dom/Node~Node#parentNode
ContainerElement.parentNode
• get previousSibling(): Node
Previous sibling node
Name
module:geotoolkit/report/dom/Node~Node#previousSibling
ContainerElement.previousSibling
• get rootNode(): Node
Return root node
Deprecated
since 2022 (3.4) use Node#getRootNode instead
Name
module:geotoolkit/report/dom/Node~Node#rootNode
ContainerElement.rootNode
• get tagName(): string
Node tag name
Name
module:geotoolkit/report/dom/Node~Node#tagName
string
ContainerElement.tagName
Methods
▸ appendChild(newChild): Header
Add child to the node
| Name | Type | Description |
|---|---|---|
newChild | Node | child to add |
▸ clearAttributes(): Header
Clear attributes
ContainerElement.clearAttributes
▸ clearNodes(): Header
Remove all child nodes from this node
this
▸ connectStyle(style, type, callback): Header
Connects style.<br> <br> This convenience method subscribes a listener to given style for the specified type.<br> 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): Header
Disconnect style <br> This convenience method un-subscribes a listener to given style for the specified type.<br>
| Name | Type | Description |
|---|---|---|
style | EventDispatcher | connect style |
type | string | type of event or property |
callback | AttributeCallback<EventDispatcher> | function to be called |
this
ContainerElement.disconnectStyle
▸ dispose(): void
Disposes this node, once disposes a node should not be used anymore.<br> Clear all listeners, and disconnect styles to avoid memory leaks.<br> 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
ContainerElement.enumerateNodes
▸ Protected flush(serializationContext?): Header
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
ContainerElement.getBackgroundStyle
▸ getBorderLineStyle(): LineStyle
Return border line style
ContainerElement.getBorderLineStyle
▸ 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)
ContainerElement.getContentTransform
▸ getCssClass(): string
Returns css class name to be used to apply CSS style
string
the css class name
▸ getElementRegistry(): IElementsRegistry
Returns elements Registry
ContainerElement.getElementRegistry
▸ getElementTransform(): { name: string ; parameters: string[] }[]
Return array of transformation instructions
{ name: string ; parameters: string[] }[]
array of transformations
ContainerElement.getElementTransform
▸ 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
ContainerElement.getInnerCssStyle
▸ getLayoutStyle(): LayoutStyle<string | number>
Return layout style
LayoutStyle<string | number>
layout style
ContainerElement.getLayoutStyle
▸ getMarginsStyle(): SpaceStyle<string | number>
Return margins style
SpaceStyle<string | number>
margins style
ContainerElement.getMarginsStyle
▸ getNodeIndex(): number
Return node index
number
▸ getNodeValue(): string
Returns node value
string
▸ getOrientation(): Orientation
Return element layout orientation
element layout orientation
ContainerElement.getOrientation
▸ getPaddingStyle(): SpaceStyle<string | number>
Return padding style
SpaceStyle<string | number>
padding style
ContainerElement.getPaddingStyle
▸ getPageBreak(): PageBreak
Returns element page break
page break
▸ getParent(): Node
Returns parent node
parent
▸ getProperties(): OptionsOut
Gets element properties
props
ContainerElement.getProperties
▸ 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
ContainerElement.getTransformOrigin
▸ 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
ContainerElement.hasChildNodes
▸ 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
ContainerElement.hasEventListener
▸ 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(): Header
this
▸ Protected invalidateDocument(eventArgs): Header
Invalidate root document
| Name | Type | Description |
|---|---|---|
eventArgs | NodeEventArgs | event args |
this
ContainerElement.invalidateDocument
▸ 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(): Header
Lock node
▸ normalize(): Header
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.<br>
this
▸ notify<E>(type, source, args?): Header
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?): Header
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: Header, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): Header
Attach listener on event that will be called whenever the specified event is delivered to the target <p> If the callback function is already in the list of event listeners for this target, the function is not added a second time. </p> <p> 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. </p>
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event or property |
callback | (eventType: E, sender: Header, args: EventMap[E]) => void | to be called |
this
▸ Protected onParentChanged(): Header
this
ContainerElement.onParentChanged
▸ Protected onResetCssProperties(silent): Header
Clean up cached properties
| Name | Type | Description |
|---|---|---|
silent | boolean | silent reset |
this
ContainerElement.onResetCssProperties
▸ removeAttribute(name): Header
Remove attribute
| Name | Type | Description |
|---|---|---|
name | string | attribute name |
ContainerElement.removeAttribute
▸ removeChild(child): Node
Remove child from node
| Name | Type | Description |
|---|---|---|
child | Node | to remove |
▸ replaceChild(newChild, oldChild): Header
Replace child
▸ Protected resetElementStyle(): Header
Reset own styles
ContainerElement.resetElementStyle
▸ 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): Header
Set attribute value
| Name | Type | Description |
|---|---|---|
name | string | attribute name |
value | string | attribute value |
▸ setAttributeNode(newAttr): Header
Adds a new Attribute node to the specified element.
| Name | Type | Description |
|---|---|---|
newAttr | Attribute | attribute |
this
ContainerElement.setAttributeNode
▸ setBackgroundStyle(backgroundStyle, merge?): Header
Set background style
| Name | Type | Description |
|---|---|---|
backgroundStyle | Type | background style |
Optional merge | boolean | merge flag |
this
ContainerElement.setBackgroundStyle
▸ setBorderLineStyle(borderStyle, merge?): Header
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
ContainerElement.setBorderLineStyle
▸ setContentTransform(angle): Header
Set content transformation angle
| Name | Type | Description |
|---|---|---|
angle | string | content transformation angle (90deg|180deg|270deg|-90deg) |
ContainerElement.setContentTransform
▸ setCssClass(cssClass): Header
Set css class
| Name | Type | Description |
|---|---|---|
cssClass | string | css class |
▸ Protected setElementRegistry(registry): Header
Set shadow element registry
| Name | Type | Description |
|---|---|---|
registry | IElementsRegistry | elements registry |
ContainerElement.setElementRegistry
▸ setElementTransform(transformOrigin, transformation?): void
Set element transform
| Name | Type | Description |
|---|---|---|
transformOrigin | string | transform origin |
Optional transformation | { name: string ; parameters: string[] }[] | transformations array |
void
ContainerElement.setElementTransform
▸ setFlip(flip): Header
Set element content flip orientation
| Name | Type | Description |
|---|---|---|
flip | boolean | element content flip |
▸ setGuid(guid): Header
Set node GUID
| Name | Type | Description |
|---|---|---|
guid | string | node GUID |
▸ setLayoutStyle(layoutStyle?, merge?, silent?): Header
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 |
ContainerElement.setLayoutStyle
▸ setMarginsStyle(margins?, merge?): Header
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 |
ContainerElement.setMarginsStyle
▸ setNodeValue(nodeValue): Header
Set node value
| Name | Type | Description |
|---|---|---|
nodeValue | string | node value |
▸ setOrientation(orientation): Header
Set element layout orientation
| Name | Type | Description |
|---|---|---|
orientation | Orientation | element layout orientation |
ContainerElement.setOrientation
▸ setPaddingStyle(padding?, merge?): Header
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 |
ContainerElement.setPaddingStyle
▸ setPageBreak(pageBreak): Header
Set element page break
| Name | Type | Description |
|---|---|---|
pageBreak | PageBreak | page break style |
this
▸ setProperties(props): Header
Sets the element properties
| Name | Type | Description |
|---|---|---|
props | Options | props |
this
ContainerElement.setProperties
▸ setSilent(bool): Header
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ setText(text): Header
Set text value
| Name | Type | Description |
|---|---|---|
text | string | text value |
this
▸ setTextStyle(textStyle, merge?): Header
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): Header
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
ContainerElement.setXmlContent
▸ unlock(): Header
Unlock node
▸ updateTimeStamp(): Header
Update time stamp to indicate that style has been changed.
this
ContainerElement.updateTimeStamp
▸ 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>
ContainerElement.findParentNode
▸ 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 |
ContainerElement.findParentNode
▸ Static getClassName(): string
string