Class CopyrightElementHandler

constructor

• new CopyrightElementHandler(element, mapView?): CopyrightElementHandler

• Creates a new CopyrightElementHandler that updates the DOM element with the copyright info of the given mapView.

  Note: Generally, the static [[install]] method can be used to create and attach a new CopyrightElementHandler to a MapView

  Parameters

  • element: string | HTMLElement

    HTML DOM element or a HTML DOM element id

  • Optional mapView: MapView

    optional, [[attach]] to this MapView instance

  Returns CopyrightElementHandler

staticInfo

attach

• attach(mapView): CopyrightElementHandler

• Attaches this CopyrightInfo updates from MapView instance.

  Parameters

  • mapView: MapView

  Returns CopyrightElementHandler

destroy

• destroy(): void

• Destroys this object by removing all event listeners from the attached MapViews.

  Returns void

detach

• detach(mapView): CopyrightElementHandler

• Stop following CopyrightInfo updates from MapView instance.

  Parameters

  • mapView: MapView

  Returns CopyrightElementHandler

setDefaults

• setDefaults(defaults): CopyrightElementHandler

• Set CopyrightInfo defaults to be used in case DataSource does not provide deatailed copyright information.

  Parameters

  • defaults: undefined | CopyrightInfo[]

  Returns CopyrightElementHandler

  Remarks

  The defaults will applied to all undefined year, label and link values in the copyright information retrieved from MapView.

setStaticCopyightInfo

• setStaticCopyightInfo(staticInfo): CopyrightElementHandler

• Sets the [[staticInfo]] property.

  A CopyrightElementHandler always displays a deduplicated sum of static copyright info and copyright information obtained from attached MapViews.

  This information is used when DataSource instances of given MapView do not provide copyright information.

  Parameters

  • staticInfo: undefined | CopyrightInfo[]

  Returns CopyrightElementHandler

update

• update(): void

• Update copyright info text in controlled HTML element.

  Returns void

Static install

• install(element, mapView?): CopyrightElementHandler

• Install CopyrightElementHandler on DOM element and - optionally - attach to a MapView instance.

  Parameters

  • element: string | HTMLElement

    HTML DOM element or a HTML DOM element id

  • Optional mapView: MapView

    , optional, [[attach]] to this MapView

  Returns CopyrightElementHandler