Last updated

API / geotoolkit / report / parsers / widgets / TemplateNodeParser / TemplateNodeParser

Class: TemplateNodeParser

widgets.TemplateNodeParser.TemplateNodeParser

Hierarchy

Table of contents

Constructors
Methods

Contents

Constructors

new TemplateNodeParser(nodeName, nodeType)

new TemplateNodeParser(nodeName?, nodeType?)

Parameters

Name Type
Optional nodeNamestring
Optional nodeTypenumber

Overrides

NodeParser.constructor

Methods

addElements

addElements(childElements, context): ParserContext

add child elements

Parameters

Name Type
childElementsParserContext[]
contextParserContext

Returns

ParserContext

Inherited from

NodeParser.addElements


createElement

createElement(node, context): ParserContext

Create element associated with node

Parameters

Name Type Description
nodeElement | Node
contextParserContextThe parsing context to be used to parse the node

Returns

ParserContext

Overrides

NodeParser.createElement


getAttribute

getAttribute(node, attrName, defaultValue?): string

Extracts requested attribute from provided node

Parameters

Name Type Description
nodeElement | NodeXML node
attrNamestringThe name of attribute to obtain
Optional defaultValuestringdefault value

Returns

string

Value of the attribute

Inherited from

NodeParser.getAttribute


getClassName

getClassName(): string

Returns

string

Inherited from

NodeParser.getClassName


getName

getName(): string

Return parser name

Returns

string

Inherited from

NodeParser.getName


getType

getType(): number

Return node type

Returns

number

Inherited from

NodeParser.getType


parseAttributes

Protected parseAttributes(node, context): ParserContext

Parameters

Name Type Description
nodeElement | Nodenode to parse
contextParserContextparser context

Returns

ParserContext

Inherited from

NodeParser.parseAttributes


parseElement

parseElement(node, context): ParserContext

Parameters

Name Type Description
nodeElement | Nodenode
contextParserContextcontext

Returns

ParserContext

Inherited from

NodeParser.parseElement


tryParseArray

Protected tryParseArray(value): any

Parse string into array of objects, assuming that string value looks like "[value,value,value]" for example "[10,20,30,75.8999,36]" or "[x:10;y:20,x:15;y:45]"

Parameters

Name Type Description
valuestringvalue

Returns

any

Inherited from

NodeParser.tryParseArray


tryParseJSON

Protected tryParseJSON(value): object

Parse string in to object, assuming that string value looks like "name:value;name:value" for example or

Parameters

Name Type Description
valuestringvalue

Returns

object

Inherited from

NodeParser.tryParseJSON


tryParseValue

Protected tryParseValue(value): string | number | boolean

Try parse value to avoid converting it later in run-time

Parameters

Name Type Description
valuestringvalue

Returns

string | number | boolean

Inherited from

NodeParser.tryParseValue


getAttribute

Static getAttribute(node, attrName, defaultValue?): string

Extracts requested attribute from provided node

Parameters

Name Type Description
nodeElement | NodeXML node
attrNamestringThe name of attribute to obtain
Optional defaultValuestringdefault value

Returns

string

Value of the attribute

Inherited from

NodeParser.getAttribute


tryParseArray

Static tryParseArray(value): any

Parse string into array of objects, assuming that string value looks like "[value,value,value]" for example "[10,20,30,75.8999,36]" or "[x:10;y:20,x:15;y:45]"

Parameters

Name Type Description
valuestringvalue

Returns

any

Inherited from

NodeParser.tryParseArray


tryParseJSON

Static tryParseJSON(value): object

Parse string in to object, assuming that string value looks like "name:value;name:value" for example or

Parameters

Name Type Description
valuestringvalue

Returns

object

Inherited from

NodeParser.tryParseJSON


tryParseValue

Static tryParseValue(value): string | number | boolean

Try parse value to avoid converting it later in run-time

Parameters

Name Type Description
valuestringvalue

Returns

string | number | boolean

Inherited from

NodeParser.tryParseValue