arlas-web-contributors > "contributors/MapContributor" > MapContributor

Class: MapContributor

Hierarchy

Contributor

↳ MapContributor

Index

Constructors

Properties

Methods

Object literals


Constructors

constructor

new MapContributor(identifier: any, collaborativeSearcheService: CollaborativesearchService, configService: ConfigService, collection: string, colorGenerator?: ColorGeneratorLoader): MapContributor

Overrides Contributor.__constructor

Defined in contributors/MapContributor.ts:192

Parameters:

Name Type Description
identifier any Identifier of contributor.
collaborativeSearcheService CollaborativesearchService Instance of CollaborativesearchService from Arlas-web-core.
configService ConfigService Instance of ConfigService from Arlas-web-core.
collection string
Optional colorGenerator ColorGeneratorLoader

Returns: MapContributor


Properties

<Protected> additionalFilter

● additionalFilter: Filter

Defined in contributors/MapContributor.ts:153


<Protected> cacheDuration

● cacheDuration: number

Inherited from Contributor.cacheDuration

Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:17


center

● center: any

Defined in contributors/MapContributor.ts:159


collaborativeSearcheService

● collaborativeSearcheService: CollaborativesearchService

Overrides Contributor.collaborativeSearcheService

Defined in contributors/MapContributor.ts:199


collection

● collection: string

Overrides Contributor.collection

Defined in contributors/MapContributor.ts:200


collections

● collections: CollectionAggField[]

Inherited from Contributor.collections

Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:15


<Optional> colorGenerator

● colorGenerator: ColorGeneratorLoader

Defined in contributors/MapContributor.ts:201


configService

● configService: ConfigService

Overrides Contributor.configService

Defined in contributors/MapContributor.ts:199


countExtendBus

● countExtendBus: Subject<object> = new Subject<{ count: number, threshold: number }>()

Defined in contributors/MapContributor.ts:167


dataSources

● dataSources: Set<string> = new Set()

Defined in contributors/MapContributor.ts:192


drawPrecision

● drawPrecision: number

Defined in contributors/MapContributor.ts:81


drawingsUpdate

● drawingsUpdate: Subject<object> = new Subject()

Defined in contributors/MapContributor.ts:181


endCollaborationEvent

● endCollaborationEvent: Subject<unknown>

Inherited from Contributor.endCollaborationEvent

Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:16


expressionFilter

● expressionFilter: Expression

Defined in contributors/MapContributor.ts:174


geoPointFields

● geoPointFields: string[] = new Array()

Defined in contributors/MapContributor.ts:164


geoQueryField

● geoQueryField: string

Defined in contributors/MapContributor.ts:76


geoQueryOperation

● geoQueryOperation: OpEnum

Defined in contributors/MapContributor.ts:75


geoShapeFields

● geoShapeFields: string[] = new Array()

Defined in contributors/MapContributor.ts:165


identifier

● identifier: any

Overrides Contributor.identifier

Defined in contributors/MapContributor.ts:199


isDataUpdating

● isDataUpdating: boolean

Inherited from Contributor.isDataUpdating

Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:13


isFlat

● isFlat: boolean

Defined in contributors/MapContributor.ts:82


isSimpleModeAccumulative

● isSimpleModeAccumulative: boolean

Defined in contributors/MapContributor.ts:74


legendData

● legendData: Map<string, LegendData> = new Map()

Defined in contributors/MapContributor.ts:178


legendUpdater

● legendUpdater: Subject<Map<string, LegendData>> = new Subject()

Defined in contributors/MapContributor.ts:177


mapLoadExtent

● mapLoadExtent: number[] = [90, -180, -90, 180]

Defined in contributors/MapContributor.ts:160


mapTestExtent

● mapTestExtent: number[] = [90, -180, -90, 180]

Defined in contributors/MapContributor.ts:161


mapTestRawExtent

● mapTestRawExtent: number[] = [90, -180, -90, 180]

Defined in contributors/MapContributor.ts:162


redrawSource

● redrawSource: Subject<object> = new Subject()

Defined in contributors/MapContributor.ts:176


saturationWeight

● saturationWeight: number = 0.5

Defined in contributors/MapContributor.ts:168


searchSize

● searchSize: number

Defined in contributors/MapContributor.ts:78


searchSort

● searchSort: string

Defined in contributors/MapContributor.ts:80


updateData

● updateData: boolean

Inherited from Contributor.updateData

Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:46


visibilityStatus

● visibilityStatus: Map<string, boolean> = new Map()

Defined in contributors/MapContributor.ts:180


visibilityUpdater

● visibilityUpdater: Subject<Map<string, boolean>> = new Subject()

Defined in contributors/MapContributor.ts:179


visibleSources

● visibleSources: Set<string> = new Set()

Defined in contributors/MapContributor.ts:163


zoom

● zoom: any

Defined in contributors/MapContributor.ts:158


Methods

<Protected> addFilter

addFilter(filter: Filter, additionalFilter: Filter): void

Defined in contributors/MapContributor.ts:1942

Parameters:

Name Type Description
filter Filter filter to enrich
additionalFilter Filter filter to add to the first filter

Returns: void


changeVisualisation

changeVisualisation(visibleLayers: Set<string>): void

Defined in contributors/MapContributor.ts:350

Parameters:

Name Type
visibleLayers Set<string>

Returns: void


clearData

clearData(s: string): void

Defined in contributors/MapContributor.ts:1716

Parameters:

Name Type
s string

Returns: void


computeAggData

computeAggData(fc: FeatureCollection, aggSource: SourcesAgg, aggType: string): void

Defined in contributors/MapContributor.ts:1257

Parameters:

Name Type
fc FeatureCollection
aggSource SourcesAgg
aggType string

Returns: void


computeClusterData

computeClusterData(featureCollection: FeatureCollection, aggSource: SourcesAgg): void

Defined in contributors/MapContributor.ts:1329

Parameters:

Name Type
featureCollection FeatureCollection
aggSource SourcesAgg

Returns: void


computeData

computeData(data: any): void

Overrides Contributor.computeData

Defined in contributors/MapContributor.ts:373

Parameters:

Name Type
data any

Returns: void


computeFeatureData

computeFeatureData(featureCollection: FeatureCollection, sources: Array<string>): void

Defined in contributors/MapContributor.ts:1265

Parameters:

Name Type
featureCollection FeatureCollection
sources Array<string>

Returns: void


computeSimpleModeFeature

computeSimpleModeFeature(featureCollection: FeatureCollection, sources: Array<string>, renderStrategy: RenderStrategy, maxPages?: number, whichPage?: PageEnum): void

Defined in contributors/MapContributor.ts:1494

Parameters:

Name Type
featureCollection FeatureCollection
sources Array<string>
renderStrategy RenderStrategy
Optional maxPages number
Optional whichPage PageEnum

Returns: void


computeTopologyData

computeTopologyData(featureCollection: FeatureCollection, aggSource: SourcesAgg): void

Defined in contributors/MapContributor.ts:1307

Parameters:

Name Type
featureCollection FeatureCollection
aggSource SourcesAgg

Returns: void


drawGeoSearch

drawGeoSearch(fromParam?: number, appendId?: boolean): void

Defined in contributors/MapContributor.ts:1567

Parameters:

Name Type Description
Optional fromParam number Index of the search scrolling. Default to 0;
Optional appendId boolean Whether to append the id field name to the sort string. Default to 'false'

Returns: void


fetchAggSources

fetchAggSources(extent: Array<number>, zoom: number, aggs: Map<string, SourcesAgg>, aggType: string): void

Defined in contributors/MapContributor.ts:1207

Parameters:

Name Type
extent Array<number>
zoom number
aggs Map<string, SourcesAgg>
aggType string

Returns: void


fetchData

fetchData(collaborationEvent?: CollaborationEvent): Observable<any>

Overrides Contributor.fetchData

Defined in contributors/MapContributor.ts:280

Parameters:

Name Type
Optional collaborationEvent CollaborationEvent

Returns: Observable<any>


fetchSearchSources

fetchSearchSources(filter: Filter, searches: Map<string, SourcesSearch>, renderStrategy: RenderStrategy, maxPages?: number, whichPage?: PageEnum): void

Defined in contributors/MapContributor.ts:1183

Parameters:

Name Type
filter Filter
searches Map<string, SourcesSearch>
renderStrategy RenderStrategy
Optional maxPages number
Optional whichPage PageEnum

Returns: void


fetchTiledSearchSources

fetchTiledSearchSources(extent: Array<number>, searches: Map<string, SourcesSearch>): void

Defined in contributors/MapContributor.ts:1140

Parameters:

Name Type
extent Array<number>
searches Map<string, SourcesSearch>

Returns: void


getAdditionalFilter

getAdditionalFilter(): Filter

Defined in contributors/MapContributor.ts:273

Returns: Filter


getBoundsToFit

getBoundsToFit(elementidentifier: ElementIdentifier, collection?: string): Observable<Array<Array<number>>>

Defined in contributors/MapContributor.ts:735

Parameters:

Name Type
elementidentifier ElementIdentifier
Optional collection string

Returns: Observable<Array<Array<number>>>


getConfigValue

getConfigValue(key: string): any

Inherited from Contributor.getConfigValue

Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:31

Parameters:

Name Type Description
key string a `key` defined in configuration.

Returns: any value of the key in configuration.


getFeatureToHightLight

getFeatureToHightLight(elementidentifier: ElementIdentifier): object

Defined in contributors/MapContributor.ts:743

Parameters:

Name Type
elementidentifier ElementIdentifier

Returns: object


getFilterDisplayName

getFilterDisplayName(): string

Overrides Contributor.getFilterDisplayName

Defined in contributors/MapContributor.ts:768

Returns: string Pretty name of contribution.


getFilterForCount

getFilterForCount(rawExtend: string, wrapExtend: string, countGeoField: string): Filter

Defined in contributors/MapContributor.ts:1607

Parameters:

Name Type
rawExtend string
wrapExtend string
countGeoField string

Returns: Filter


getName

getName(): string

Inherited from Contributor.getName

Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:35

Returns: string name of contributor set in configuration.


getPackageName

getPackageName(): string

Overrides Contributor.getPackageName

Defined in contributors/MapContributor.ts:762

Returns: string Package name for the configuration service.


getPage

getPage(reference: Map<string, string | number | Date>, sort: string, whichPage: PageEnum, maxPages: number): void

Defined in contributors/MapContributor.ts:1471

Parameters:

Name Type Description
reference Map<string, string number
sort string comma separated field names on which feature are sorted.
whichPage PageEnum Whether to fetch next or previous set.
maxPages number The maxumum number of set features.

Returns: void


getReturnedGeometries

getReturnedGeometries(returnedGeometries: string): Set<string>

Defined in contributors/MapContributor.ts:632

Parameters:

Name Type
returnedGeometries string

Returns: Set<string>


getWideModeData

getWideModeData(rawTestExtent: any, wrapTestExtent: any, mapLoadExtent: any, zoom: number, visibleSources: Set<string>): void

Defined in contributors/MapContributor.ts:475

Parameters:

Name Type
rawTestExtent any
wrapTestExtent any
mapLoadExtent any
zoom number
visibleSources Set<string>

Returns: void


getWindowModeData

getWindowModeData(wrapExtent: any, rawExtent: any, visibleSources: Set<string>, sort: string, keepOldData?: boolean, afterParam?: string, whichPage?: PageEnum, maxPages?: number, fromParam?: any): void

Defined in contributors/MapContributor.ts:413

Parameters:

Name Type Default value Description
wrapExtent any -
rawExtent any -
visibleSources Set<string> -
sort string - comma separated field names on which feature are sorted.
Default value keepOldData boolean true
Optional afterParam string - comma seperated field values from which next/previous data is fetched
Optional whichPage PageEnum - Whether to fetch next or previous set.
Optional maxPages number -
Optional fromParam any - (page.from in arlas api) an offset from which fetching hits starts. It's ignored if `afterParam` is set.

Returns: void


onChangeAoi

onChangeAoi(fc: FeatureCollection): void

Defined in contributors/MapContributor.ts:784

Parameters:

Name Type Description
fc FeatureCollection FeatureCollection object

Returns: void


onChangeGeoQuery

onChangeGeoQuery(): void

Defined in contributors/MapContributor.ts:579

Returns: void


onMapMoved

onMapMoved(moveParams: OnMoveResult, recalculateWindow: boolean): void

Defined in contributors/MapContributor.ts:318

Parameters:

Name Type
moveParams OnMoveResult
recalculateWindow boolean

Returns: void


onMove

onMove(newMove: OnMoveResult, recalculateWindow: boolean): void

Defined in contributors/MapContributor.ts:852

Parameters:

Name Type
newMove OnMoveResult
recalculateWindow boolean

Returns: void


renderAggSources

renderAggSources(sources: Array<string>): void

Defined in contributors/MapContributor.ts:860

Parameters:

Name Type Description
sources Array<string> List of sources names (sources must be of the same type : cluster OR topology)

Returns: void


renderClusterSources

renderClusterSources(sources: Array<string>): void

Defined in contributors/MapContributor.ts:1026

Parameters:

Name Type Description
sources Array<string> List of sources names (sources must be of the same type : cluster)

Returns: void


renderSearchSources

renderSearchSources(sources: Array<string>): void

Defined in contributors/MapContributor.ts:908

Parameters:

Name Type Description
sources Array<string> List of sources names (sources must be of the same type : feature)

Returns: void


renderTopologySources

renderTopologySources(sources: Array<string>): void

Defined in contributors/MapContributor.ts:970

Parameters:

Name Type Description
sources Array<string> List of sources names (sources must be of the same type : topology)

Returns: void


resolveAggSources

resolveAggSources(visitedTiles: Set<string>, aggId: string, aggregation: Aggregation): Observable<FeatureCollection>

Defined in contributors/MapContributor.ts:1105

Parameters:

Name Type
visitedTiles Set<string>
aggId string
aggregation Aggregation

Returns: Observable<FeatureCollection>


resolveSearchSources

resolveSearchSources(filter: Filter, searchId: string, search: Search): Observable<FeatureCollection>

Defined in contributors/MapContributor.ts:1099

Parameters:

Name Type Description
filter Filter Filter object (from `arlas-api`) that requests the data to be resolved
searchId string identifier of search responsible of fetching this data
search Search Search object (from `arlas-api`) that indicates how data will be resolved

Returns: Observable<FeatureCollection>


resolveTiledSearchSources

resolveTiledSearchSources(tiles: Set<string>, searchId: string, search: Search): Observable<FeatureCollection>

Defined in contributors/MapContributor.ts:1066

Parameters:

Name Type Description
tiles Set<string> newly visited tiles on which data will be resolved
searchId string identifier of search responsible of fetching this data
search Search Search object (from `arlas-api`) that indicates how data will be resolved

Returns: Observable<FeatureCollection>


setAdditionalFilter

setAdditionalFilter(value: Filter): void

Defined in contributors/MapContributor.ts:276

Parameters:

Name Type
value Filter

Returns: void


setData

setData(data: any): void

Overrides Contributor.setData

Defined in contributors/MapContributor.ts:637

Parameters:

Name Type
data any

Returns: void


setDataCellGeoaggregate

setDataCellGeoaggregate(features: Array<any>): any

Defined in contributors/MapContributor.ts:1461

Parameters:

Name Type
features Array<any>

Returns: any


setDrawings

setDrawings(collaboration: Collaboration): void

Defined in contributors/MapContributor.ts:645

Parameters:

Name Type
collaboration Collaboration

Returns: void


setGeoQueryField

setGeoQueryField(geoQueryField: string): void

Defined in contributors/MapContributor.ts:401

Parameters:

Name Type Description
geoQueryField string

Returns: void


setGeoQueryOperation

setGeoQueryOperation(geoQueryOperation: string): void

Defined in contributors/MapContributor.ts:380

Parameters:

Name Type Description
geoQueryOperation string

Returns: void


setLegendSearchData

setLegendSearchData(s: any): void

Defined in contributors/MapContributor.ts:873

Parameters:

Name Type
s any

Returns: void


setName

setName(name: string): void

Inherited from Contributor.setName

Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:39

Parameters:

Name Type
name string

Returns: void set the name of the contributor


setSelection

setSelection(data: any, collaboration: Collaboration): any

Overrides Contributor.setSelection

Defined in contributors/MapContributor.ts:640

Parameters:

Name Type
data any
collaboration Collaboration

Returns: any


updateFromCollaboration

updateFromCollaboration(collaborationEvent: CollaborationEvent): void

Inherited from Contributor.updateFromCollaboration

Defined in /docs/node_modules/arlas-web-core/models/contributor.d.ts:55

Parameters:

Name Type
collaborationEvent CollaborationEvent

Returns: void


wrap

wrap(n: number, minimum: number, maximum: number): number

Defined in contributors/MapContributor.ts:772

Parameters:

Name Type
n number
minimum number
maximum number

Returns: number


<Static> getClusterAggregration

getClusterAggregration(source: LayerSourceConfig): Aggregation

Defined in contributors/MapContributor.ts:1811

Parameters:

Name Type
source LayerSourceConfig

Returns: Aggregation


<Static> getClusterSource

getClusterSource(ls: LayerSourceConfig): LayerClusterSource

Defined in contributors/MapContributor.ts:1741

Parameters:

Name Type
ls LayerSourceConfig

Returns: LayerClusterSource


<Static> getFeatureSearch

getFeatureSearch(source: LayerSourceConfig): Search

Defined in contributors/MapContributor.ts:1902

Parameters:

Name Type
source LayerSourceConfig

Returns: Search


<Static> getFeatureSource

getFeatureSource(ls: LayerSourceConfig): LayerFeatureSource

Defined in contributors/MapContributor.ts:1792

Parameters:

Name Type
ls LayerSourceConfig

Returns: LayerFeatureSource


<Static> getFilterFromExtent

getFilterFromExtent(rawExtend: string, wrapExtend: string, geoQueryField: string): Filter

Defined in contributors/MapContributor.ts:1586

Parameters:

Name Type
rawExtend string
wrapExtend string
geoQueryField string

Returns: Filter


<Static> getJsonSchema

getJsonSchema(): Object

Defined in contributors/MapContributor.ts:269

Returns: Object


<Static> getTopologyAggregration

getTopologyAggregration(source: LayerSourceConfig): Aggregation

Defined in contributors/MapContributor.ts:1841

Parameters:

Name Type
source LayerSourceConfig

Returns: Aggregation


<Static> getTopologySource

getTopologySource(ls: LayerSourceConfig): LayerTopologySource

Defined in contributors/MapContributor.ts:1764

Parameters:

Name Type
ls LayerSourceConfig

Returns: LayerTopologySource


Object literals

geojsondraw

geojsondraw: object

Defined in contributors/MapContributor.ts:147

features

● features: undefined[] = []

Defined in contributors/MapContributor.ts:149


type

● type: string = "FeatureCollection"

Defined in contributors/MapContributor.ts:148