Class TextElementGroupPriorityList

List of TextElement groups sorted by priority.

Hierarchy

GroupedPriorityList<TextElement>
- TextElementGroupPriorityList

Index

Properties

groups

Methods

Properties

Readonly groups

groups: PriorityListGroupMap<TextElement> = new Map()

Methods

add

add(element: TextElement): void

Inherited from GroupedPriorityList.add
- Defined in @here/harp-utils/lib/GroupedPriorityList.ts:67
Add an element to the GroupedPriorityList. Selects group based on the elements priority.

Parameters
- element: TextElement
  
  Element to be added.
Returns void

clear

clear(): void

Inherited from GroupedPriorityList.clear
- Defined in @here/harp-utils/lib/GroupedPriorityList.ts:95
Remove all internal PriorityListGroups.

Returns void

clone

clone(): GroupedPriorityList<TextElement>

Inherited from GroupedPriorityList.clone
- Defined in @here/harp-utils/lib/GroupedPriorityList.ts:116
Returns GroupedPriorityList<TextElement>

count

count(): number

Inherited from GroupedPriorityList.count
- Defined in @here/harp-utils/lib/GroupedPriorityList.ts:138
Count the number of elements in this GroupedPriorityList.

Returns number

forEach

forEach(fun: (element: TextElement) => void): void

Inherited from GroupedPriorityList.forEach
- Defined in @here/harp-utils/lib/GroupedPriorityList.ts:129
Apply function to all elements in this GroupedPriorityList.

Parameters
- fun: (element: TextElement) => void
  
  Function to apply.
  - - (element: TextElement): void
    - Parameters
      - element: TextElement
      Returns void
Returns void

merge

merge(other: GroupedPriorityList<TextElement>): GroupedPriorityList<TextElement>

Inherited from GroupedPriorityList.merge
- Defined in @here/harp-utils/lib/GroupedPriorityList.ts:104
Merge another GroupedPriorityList into this one.

Parameters
- other: GroupedPriorityList<TextElement>
  
  Other group to merge.
Returns GroupedPriorityList<TextElement>

remove

remove(element: TextElement): boolean

Inherited from GroupedPriorityList.remove
- Defined in @here/harp-utils/lib/GroupedPriorityList.ts:80
Remove an element from the GroupedPriorityList.

Note: It is required that the priority is the same as it was when the element has been added. Otherwise, the removal will fail.

Parameters
- element: TextElement
  
  Element to be removed.
Returns boolean

True if the element was removed, false otherwise.

Generated using TypeDoc