API / geotoolkit / report / dom / elements / Image / Image
Image element
↳
Image
Constructors
- [new Image(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.report.dom.elements.image.image.md#new image(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 |
Accessors
• get attributes(): NamedItemMap
Node attributes
Name
module:geotoolkit/report/dom/Node~Node#attributes
AbstractElement.attributes
• get childNodes(): NodeList<Node>
The element holding the item.
Name
module:geotoolkit/report/dom/Node~Node#childNodes
AbstractElement.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
AbstractElement.children
• get data(): string
Node data
Name
module:geotoolkit/report/dom/Node~Node#data
string
AbstractElement.data
• set data(data): void
Node data
Name
module:geotoolkit/report/dom/Node~Node#data
| Name | Type |
|---|---|
data | string |
void
AbstractElement.data
• get firstChild(): Node
First child node
Name
module:geotoolkit/report/dom/Node~Node#firstChild
AbstractElement.firstChild
• get lastChild(): Node
Last child node
Name
module:geotoolkit/report/dom/Node~Node#lastChild
AbstractElement.lastChild
• get localName(): string
Node local name
Name
module:geotoolkit/report/dom/Node~Node#localName
string
AbstractElement.localName
• get nextSibling(): Node
Next sibling node
Name
module:geotoolkit/report/dom/Node~Node#nextSibling
AbstractElement.nextSibling
• get nodeName(): string
Node name
Name
module:geotoolkit/report/dom/Node~Node#nodeName
string
AbstractElement.nodeName
• get nodeType(): NodeType
Node type
Name
module:geotoolkit/report/dom/Node~Node#nodeType
AbstractElement.nodeType
• get nodeValue(): string
Node value
Name
module:geotoolkit/report/dom/Node~Node#nodeValue
string
AbstractElement.nodeValue
• set nodeValue(value): void
Node value
Name
module:geotoolkit/report/dom/Node~Node#nodeValue
| Name | Type |
|---|---|
value | string |
void
AbstractElement.nodeValue
• get ownerDocument(): Document
Node owner document
Name
module:geotoolkit/report/dom/Node~Node#ownerDocument
AbstractElement.ownerDocument
• get parentNode(): Node
Parent node
Name
module:geotoolkit/report/dom/Node~Node#parentNode
AbstractElement.parentNode
• get previousSibling(): Node
Previous sibling node
Name
module:geotoolkit/report/dom/Node~Node#previousSibling
AbstractElement.previousSibling
• get rootNode(): Node
Return root node
Deprecated
since 2022 (3.4) use Node#getRootNode instead
Name
module:geotoolkit/report/dom/Node~Node#rootNode
AbstractElement.rootNode
• get tagName(): string
Node tag name
Name
module:geotoolkit/report/dom/Node~Node#tagName
string
AbstractElement.tagName
Methods
▸ appendChild(newChild): Image
Add child to the node
| Name | Type | Description |
|---|---|---|
newChild | Node | child to add |
▸ clearAttributes(): Image
Clear attributes
AbstractElement.clearAttributes
▸ clearNodes(): Image
Remove all child nodes from this node
this
▸ connectStyle(style, type, callback): Image
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): Image
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
AbstractElement.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
AbstractElement.enumerateNodes
▸ Protected flush(serializationContext?): Image
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
AbstractElement.getBackgroundStyle
▸ getBorderLineStyle(): LineStyle
Return border line style
AbstractElement.getBorderLineStyle
▸ getClassName(): string
string
▸ getCssClass(): string
Returns css class name to be used to apply CSS style
string
the css class name
▸ getElementRegistry(): IElementsRegistry
Returns elements Registry
AbstractElement.getElementRegistry
▸ getElementTransform(): { name: string ; parameters: string[] }[]
Return array of transformation instructions
{ name: string ; parameters: string[] }[]
array of transformations
AbstractElement.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
AbstractElement.getInnerCssStyle
▸ getLayoutStyle(): LayoutStyle<string | number>
Return layout style
LayoutStyle<string | number>
layout style
AbstractElement.getLayoutStyle
▸ getMarginsStyle(): SpaceStyle<string | number>
Return margins style
SpaceStyle<string | number>
margins style
AbstractElement.getMarginsStyle
▸ getNodeIndex(): number
Return node index
number
▸ getNodeValue(): string
Returns node value
string
▸ getOrientation(): Orientation
Return element layout orientation
element layout orientation
AbstractElement.getOrientation
▸ getPaddingStyle(): SpaceStyle<string | number>
Return padding style
SpaceStyle<string | number>
padding style
AbstractElement.getPaddingStyle
▸ getPageBreak(): PageBreak
Returns element page break
page break
▸ getParent(): Node
Returns parent node
parent
▸ getProperties(): Options
Gets the element properties
▸ getRootNode(): Node
Return root node
node
▸ getTagName(): string
Returns node tag name
string
▸ getTimeStamp(): number
Gets time stamp
number
timeStamp
▸ getTransformOrigin(): string
Return transform origin
string
AbstractElement.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
▸ 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
AbstractElement.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(): Image
this
▸ Protected invalidateDocument(eventArgs): Image
Invalidate root document
| Name | Type | Description |
|---|---|---|
eventArgs | NodeEventArgs | event args |
this
AbstractElement.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(): Image
Lock node
▸ normalize(): Image
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?): Image
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?): Image
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: Image, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): Image
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: Image, args: EventMap[E]) => void | to be called |
this
▸ Protected onParentChanged(): Image
this
AbstractElement.onParentChanged
▸ Protected onResetCssProperties(silent?): Image
Clean up cached properties
| Name | Type | Description |
|---|---|---|
Optional silent | boolean | silent reset |
this
AbstractElement.onResetCssProperties
▸ removeAttribute(name): Image
Remove attribute
| Name | Type | Description |
|---|---|---|
name | string | attribute name |
AbstractElement.removeAttribute
▸ removeChild(child): Node
Remove child from node
| Name | Type | Description |
|---|---|---|
child | Node | to remove |
▸ replaceChild(newChild, oldChild): Image
Replace child
▸ Protected resetElementStyle(): Image
Reset own styles
AbstractElement.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): Image
Set attribute value
| Name | Type | Description |
|---|---|---|
name | string | attribute name |
value | string | attribute value |
▸ setAttributeNode(newAttr): Image
Adds a new Attribute node to the specified element.
| Name | Type | Description |
|---|---|---|
newAttr | Attribute | attribute |
this
AbstractElement.setAttributeNode
▸ setBackgroundStyle(backgroundStyle, merge?): Image
Set background style
| Name | Type | Description |
|---|---|---|
backgroundStyle | Type | background style |
Optional merge | boolean | merge flag |
this
AbstractElement.setBackgroundStyle
▸ setBorderLineStyle(borderStyle, merge?): Image
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
AbstractElement.setBorderLineStyle
▸ setCssClass(cssClass): Image
Set css class
| Name | Type | Description |
|---|---|---|
cssClass | string | css class |
▸ Protected setElementRegistry(registry): Image
Set shadow element registry
| Name | Type | Description |
|---|---|---|
registry | IElementsRegistry | elements registry |
AbstractElement.setElementRegistry
▸ setElementTransform(transformOrigin, transformation?): void
Set element transform
| Name | Type | Description |
|---|---|---|
transformOrigin | string | transform origin |
Optional transformation | { name: string ; parameters: string[] }[] | transformations array |
void
AbstractElement.setElementTransform
▸ setFlip(flip): Image
Set element content flip orientation
| Name | Type | Description |
|---|---|---|
flip | boolean | element content flip |
▸ setGuid(guid): Image
Set node GUID
| Name | Type | Description |
|---|---|---|
guid | string | node GUID |
▸ setLayoutStyle(layout?, merge?, silent?): Image
Sets layout style
| Name | Type | Description |
|---|---|---|
Optional layout | LayoutStyle<string | number> | Options<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 |
AbstractElement.setLayoutStyle
▸ setMarginsStyle(margins?, merge?): Image
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 |
AbstractElement.setMarginsStyle
▸ setNodeValue(nodeValue): Image
Set node value
| Name | Type | Description |
|---|---|---|
nodeValue | string | node value |
▸ setOrientation(orientation): Image
Set element layout orientation
| Name | Type | Description |
|---|---|---|
orientation | Orientation | element layout orientation |
AbstractElement.setOrientation
▸ setPaddingStyle(padding?, merge?): Image
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 |
AbstractElement.setPaddingStyle
▸ setPageBreak(pageBreak): Image
Set element page break
| Name | Type | Description |
|---|---|---|
pageBreak | PageBreak | page break style |
this
▸ setProperties(props): Image
Sets the element properties
| Name | Type | Description |
|---|---|---|
props | Options | props |
this
▸ setSilent(bool): Image
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ setText(text): Image
Set text value
| Name | Type | Description |
|---|---|---|
text | string | text value |
this
▸ setVisible(visible): Image
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(): Image
Unlock node
▸ updateTimeStamp(): Image
Update time stamp to indicate that style has been changed.
this
AbstractElement.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>
AbstractElement.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 |
AbstractElement.findParentNode
▸ Static getClassName(): string
string