Home Reference Source
import {SourceServerVector} from 'guide4you/src/sources/SourceServerVector.js'
public class | source

SourceServerVector

Extends:

ol/source/Vector~VectorSource → SourceServerVector

Direct Subclass:

QueryVectorSource

A custom Source class handling Vector Sources.

Let you set the loading loadingStrategy, if a proxy is used and you should specify in which format it comes in.

This class defines a custom loader function which makes it possible to use different loading strategies.

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public
public

format_: *

public
public
Protected Members
protected
Private Members
private

indicates if the source needs to be emptied

private
private
private
private
private

urlProjection_: module:ol/proj~ProjectionLike

Method Summary

Public Methods
public

addProxyToHrefTags(text: HTMLElement): HTMLElement

makes all urls in href-tags inside of a xmlDocument use the proxy address.

public
public

loader(extent: module:ol/extent~Extent, resolution: number, projection: module:ol/proj~Projection)

public

setRefresh(refresh: number)

This sets the refresh rate.

public

setUrlTemplate(urlTemplate: URL)

Public Constructors

public constructor(options: SourceServerVectorOptions) source

Params:

NameTypeAttributeDescription
options SourceServerVectorOptions
  • optional
  • default: {}

Public Members

public dataType_: string source

public format_: * source

public localised_: * source

public refreshTimeoutId_: * source

Protected Members

protected urlTemplate: URL source

Private Members

private doClear_: boolean source

indicates if the source needs to be emptied

private localiser_: L10N source

private refresh_: number source

private strategyType_: string source

private type_: string source

private urlProjection_: module:ol/proj~ProjectionLike source

Public Methods

public addProxyToHrefTags(text: HTMLElement): HTMLElement source

makes all urls in href-tags inside of a xmlDocument use the proxy address. this function needs to extended with all Tags which could contain urls

Params:

NameTypeAttributeDescription
text HTMLElement

an xml-Document

Return:

HTMLElement

the xmlDocument

public getUrlTemplate(): URL source

Return:

URL

public loader(extent: module:ol/extent~Extent, resolution: number, projection: module:ol/proj~Projection) source

Params:

NameTypeAttributeDescription
extent module:ol/extent~Extent
resolution number
projection module:ol/proj~Projection

public setRefresh(refresh: number) source

This sets the refresh rate. A value of 0 or smaller turns refresh off.

Params:

NameTypeAttributeDescription
refresh number

public setUrlTemplate(urlTemplate: URL) source

Params:

NameTypeAttributeDescription
urlTemplate URL