Class CopyrightCoverageProvider`Abstract`

Base class to provide copyrights based on copyright coverage information, defined by geographical bounding boxes and relevant zoom level ranges.

Hierarchy

CopyrightCoverageProvider
- UrlCopyrightProvider

Implements

CopyrightProvider

Index

Constructors

Properties

Methods

getCopyrightCoverageData getCopyrights getTree initRBush

Constructors

constructor

new CopyrightCoverageProvider(): CopyrightCoverageProvider
Returns CopyrightCoverageProvider

Properties

`Protected` `Readonly` logger

logger: ILogger = ...

Logger instance.

Methods

`Abstract` getCopyrightCoverageData

getCopyrightCoverageData(abortSignal?): Promise<AreaCopyrightInfo[]>
Asynchronously retrieves copyright coverage data.
Parameters
- Optional abortSignal: AbortSignal
  
  Optional AbortSignal to cancel the request.
Returns Promise<AreaCopyrightInfo[]>
- Defined in @xyzmaps/harp-mapview/lib/copyrights/CopyrightCoverageProvider.ts:75

getCopyrights

getCopyrights(geoBox, level): Promise<CopyrightInfo[]>
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.
Implementation of CopyrightProvider.getCopyrights
- Defined in @xyzmaps/harp-mapview/lib/copyrights/CopyrightCoverageProvider.ts:94

getTree

getTree(): Promise<any>
Returns Promise<any>

Inherit Doc
- Defined in @xyzmaps/harp-mapview/lib/copyrights/CopyrightCoverageProvider.ts:78

initRBush

initRBush(entries): any
Initializes RBush.
Parameters
- entries: AreaCopyrightInfo[]
  
  Entries for tree.
Returns any
RBush instance.
- Defined in @xyzmaps/harp-mapview/lib/copyrights/CopyrightCoverageProvider.ts:126

Generated using TypeDoc