Class Marker

Index

Constructors

Accessors

Methods

create on onEventListener remove setFilter setFilterByBuilding setFilterByVenue setIcon setIconAnchor setIconSize setOpacity setOpacityByBuilding setOpacityByVenue updateData

Constructors

constructor

new Marker(maplibreMap): Marker
Parameters
- maplibreMap: MaplibreMap
Returns Marker
- Defined in src/marker.ts:31

Accessors

layerId

get layerId(): string
Returns string
Description
Marker layer id getter.
- Defined in src/marker.ts:68

sourceId

get sourceId(): string
Returns string
Description
Marker source id getter.
- Defined in src/marker.ts:75

Methods

create

create(array): void
Parameters
- array: (IMarkerOptions | IMarkerOptionsWithFeatureId)[]
  {IMarkerOptions | IMarkerOptionsWithFeatureId[]} Coordinate and properties arrays of marker[s]. If you need to use updateData(), the parameter must be IMarkerOptionsWithFeatureId[].
Returns void
Description
Draw marker[s] on map.
- Defined in src/marker.ts:84

on

on(eventKey, callback): {
off: (() => MaplibreMap);
}
Parameters
- eventKey: keyof MapLayerEventType
- callback: ((marker) => void)
  - - (marker): void
    - Parameters
      marker: MapGeoJSONFeature
      Returns void
Returns {
off: (() => MaplibreMap);
}
- off: (() => MaplibreMap)
  - - (): MaplibreMap
    - Returns MaplibreMap
Description
Add marker event listener.
- Defined in src/marker.ts:195

onEventListener

onEventListener(eventKey, callback): {
offEventListener: VoidFunction;
}
Parameters
- eventKey: keyof MapLayerEventType
- callback: ((marker) => void)
  - - (marker): void
    - Parameters
      marker: MapGeoJSONFeature
      Returns void
Returns {
offEventListener: VoidFunction;
}
- offEventListener: VoidFunction
Description
Add marker event listener.

Deprecated
Use 'on' method instead.
- Defined in src/marker.ts:174

remove

remove(): void
Returns void
Description
Remove marker[s] layer and source.
- Defined in src/marker.ts:159

setFilter

setFilter(filterExpression): void
Parameters
- filterExpression: FilterSpecification
  A expression specifying conditions on source features. Only features that match the filter are displayed. Refer: https://maplibre.org/maplibre-style-spec/expressions/
Returns void
Description
Filter marker by custom properties.
- Defined in src/marker.ts:216

setFilterByBuilding

setFilterByBuilding(buildingId, ordinal): void
Parameters
- buildingId: string
  {string | null | undefined}
- ordinal: string
  {string | null | undefined}
Returns void
Description
Filter marker by buildingId and ordinal. Required 'buildingId' and 'ordinal' in properties. Markers not matched 'buildingId' and 'ordinal' would be hidden; Outdoor markers always are shown.
- Defined in src/marker.ts:259

setFilterByVenue

setFilterByVenue(venueId, ordinal): void
Parameters
- venueId: string
  {string | null | undefined}
- ordinal: string
  {string | null | undefined}
Returns void
Description
Filter marker by venueId and ordinal. Required 'venueId' and 'ordinal' in properties. Markers not matched 'venueId' and 'ordinal' would be hidden; Outdoor markers always are shown.
- Defined in src/marker.ts:230

setIcon

setIcon(icon): Promise<void>
Parameters
- icon: string
  Sprite name in map style or the URL of the image file. Image file must be in png, webp, or jpg format.
Returns Promise<void>
Description
Set custom marker image.
- Defined in src/marker.ts:44

setIconAnchor

setIconAnchor(anchor): void
Parameters
- anchor: TAnchorPosition
Returns void
Description
Set marker image anchor. Part of the icon placed closest to the anchor.
- Defined in src/marker.ts:61

setIconSize

setIconSize(imageScale): void
Parameters
- imageScale: number
  Default is 1.
Returns void
Description
Set marker image size.
- Defined in src/marker.ts:53

setOpacity

setOpacity(filterExpression): void
Parameters
- filterExpression: FilterSpecification
  A expression specifying conditions on source features. Only features that match the filter are displayed. Refer: https://maplibre.org/maplibre-style-spec/expressions/
Returns void
Description
Set marker's icon-opacity by custom properties.
- Defined in src/marker.ts:286

setOpacityByBuilding

setOpacityByBuilding(buildingId, ordinal): void
Parameters
- buildingId: string
  {string | null | undefined}
- ordinal: string
  {string | null | undefined}
Returns void
Description
Set marker's icon-opacity by buildingId and ordinal. Required 'buildingId' and 'ordinal' in properties. Opacities of markers matched 'buildingId' and 'ordinal' are 1, others are 0.5. Outdoor markers' opacity always are 1.
- Defined in src/marker.ts:341

setOpacityByVenue

setOpacityByVenue(venueId, ordinal): void
Parameters
- venueId: string
  {string | null | undefined}
- ordinal: string
  {string | null | undefined}
Returns void
Description
Set marker's icon-opacity by venueId and ordinal. Required 'venueId' and 'ordinal' in properties. Opacities of markers matched 'venueId' and 'ordinal' are 1, others are 0.5. Outdoor markers' opacity always are 1.
- Defined in src/marker.ts:304

updateData

updateData(diff): void
Parameters
- diff: {
      add?: IMarkerOptionsWithFeatureId[];
      remove?: number[];
      update?: IMarkerOptionsWithFeatureId[];
  }
  {remove: number[], add: IMarkerOptionsWithFeatureId[], update: IMarkerOptionsWithFeatureId[]} remove: Array of feature IDs to remove. add: Array of new features to add. update: Array of features to update, the new properties will replace the old ones.
  - Optional add?: IMarkerOptionsWithFeatureId[]
  - Optional remove?: number[]
  - Optional update?: IMarkerOptionsWithFeatureId[]
Returns void
Description
Add, delete or update features of this marker layer. This approach requires unique IDs for every feature in the source!!! Including create() parameters.
- Defined in src/marker.ts:102

Class Marker

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Marker

Accessors

layerId

Returns string

Description

sourceId

Returns string

Description

Methods

create

Parameters

Returns void

Description

on

Parameters

Parameters

Returns void

Returns { off: (() => MaplibreMap); }

off: (() => MaplibreMap)

Returns MaplibreMap

Description

onEventListener

Parameters

Parameters

Returns void

Returns { offEventListener: VoidFunction; }

offEventListener: VoidFunction

Description

Deprecated

remove

Returns void

Description

setFilter

Parameters

Returns void

Description

setFilterByBuilding

Parameters

Returns void

Description

setFilterByVenue

Parameters

Returns void

Description

setIcon

Parameters

Returns Promise<void>

Description

setIconAnchor

Parameters

Returns void

Description

setIconSize

Parameters

Returns void

Description

setOpacity

Parameters

Returns void

Description

setOpacityByBuilding

Parameters

Returns void

Description

setOpacityByVenue

Parameters

Returns void

Description

updateData

Parameters

Optional add?: IMarkerOptionsWithFeatureId[]

Optional remove?: number[]

Returns {
off: (() => MaplibreMap);
}

Returns {
offEventListener: VoidFunction;
}

`Optional` add?: IMarkerOptionsWithFeatureId[]

`Optional` remove?: number[]

`Optional` update?: IMarkerOptionsWithFeatureId[]