Class UrlCopyrightProvider

Copyright provider which retrieves copyright coverage information from provided URL.

Hierarchy

CopyrightCoverageProvider
- UrlCopyrightProvider

Implements

CopyrightProvider

Index

Constructors

constructor

Properties

logger

Methods

Constructors

constructor

new UrlCopyrightProvider(m_fetchURL: string, m_baseScheme: string, m_requestHeaders?: RequestHeaders, m_transferManager?: ITransferManager): UrlCopyrightProvider

- Defined in @here/harp-mapview/lib/copyrights/UrlCopyrightProvider.ts:23
Default constructor.

Parameters
- m_fetchURL: string
  
  URL to fetch copyrights data from.
- m_baseScheme: string
  
  Scheme to get copyrights from.
- Optional m_requestHeaders: RequestHeaders
  
  Optional request headers for requests(e.g. Authorization)
- Default value m_transferManager: ITransferManager = TransferManager.instance()
Returns UrlCopyrightProvider

Properties

Protected Readonly logger

logger: ILogger = LoggerManager.instance.create("CopyrightCoverageProvider")

Logger instance.

Methods

getCopyrightCoverageData

getCopyrightCoverageData(abortSignal?: AbortSignal): Promise<AreaCopyrightInfo[]>

Overrides CopyrightCoverageProvider.getCopyrightCoverageData
- Defined in @here/harp-mapview/lib/copyrights/UrlCopyrightProvider.ts:53
inheritdoc

override

Parameters
- Optional abortSignal: AbortSignal
Returns Promise<AreaCopyrightInfo[]>

getCopyrights

getCopyrights(geoBox: GeoBox, level: number): Promise<CopyrightInfo[]>

Implementation of CopyrightProvider.getCopyrights

Inherited from CopyrightCoverageProvider.getCopyrights
- Defined in @here/harp-mapview/lib/copyrights/CopyrightCoverageProvider.ts:93
Retrieves copyrights.

Parameters
- geoBox: GeoBox
  
  Bounding geo box to get copyrights for.
- level: number
  
  Zoom level to get copyrights for.
Returns Promise<CopyrightInfo[]>

Promise with an array of copyrights for this geo box.

getTree

getTree(): Promise<any>

Inherited from CopyrightCoverageProvider.getTree
- Defined in @here/harp-mapview/lib/copyrights/CopyrightCoverageProvider.ts:77
inheritdoc

Returns Promise<any>

initRBush

initRBush(entries: AreaCopyrightInfo[]): any

Inherited from CopyrightCoverageProvider.initRBush
- Defined in @here/harp-mapview/lib/copyrights/CopyrightCoverageProvider.ts:125
Initializes RBush.

Parameters
- entries: AreaCopyrightInfo[]
  
  Entries for tree.
Returns any

RBush instance.

setRequestHeaders

setRequestHeaders(headers: RequestHeaders | undefined): void

- Defined in @here/harp-mapview/lib/copyrights/UrlCopyrightProvider.ts:45
Sets request headers.

Parameters
- headers: RequestHeaders | undefined
  
  -
Returns void

Generated using TypeDoc