Class MassifLayer<C>

Click events need a listener on the NATIVE layer, installed on first subscription (chaining any existing one).

Type Parameters

C extends ClassName = any

Hierarchy (View Summary)

MassifObject<C>
- MassifLayer

Index

Constructors

constructor

new MassifLayer<C extends ClassName = any>(
 handle: Handle<C>,
 className: C,
 id?: string,
): MassifLayer<C>
Type Parameters
- C extends ClassName = any
Parameters
- handle: Handle<C>
- className: C
- Optionalid: string
 The registry id, when the object has one. A call result does not.
Returns MassifLayer<C>
Inherited from MassifObject.constructor
- Defined in packages/ui-massifmaps/api/index.common.d.ts:114

Properties

`Readonly`className

className: C

`Readonly`handle

handle: Handle<C>

`Optional` `Readonly`id

id?: string

The registry id, when the object has one. A call result does not.

`Optional`map

map?: MassifMap

Set when built or adopted through a map; needed to reorder or detach it.

Accessors

events

get events(): string[]
Returns string[]
Inherited from MassifObject.events
- Defined in packages/ui-massifmaps/api/index.common.d.ts:188

native

get native(): any
Returns any
- Defined in packages/ui-massifmaps/api/index.common.d.ts:213

valid

get valid(): boolean
False after destroy, and after the id was dropped.

Returns boolean
Inherited from MassifObject.valid
- Defined in packages/ui-massifmaps/api/index.common.d.ts:120

Methods

addEventListener

addEventListener(
    eventNames: string,
    callback: (data: EventData) => void,
    thisArg?: any,
    ...rest: any[],
): void
A facade event takes its native subscription here, on the first handler.
Parameters
- eventNames: string
- callback: (data: EventData) => void
- OptionalthisArg: any
- ...rest: any[]
Returns void
Inherited from MassifObject.addEventListener
- Defined in packages/ui-massifmaps/api/index.common.d.ts:201

apply

apply(values: Partial<{ [P in WritablePath<C>]: WriteAt<C, P> }>): this
Several properties in ONE JNI/JSI crossing via setAll. Object values (handles, inline specs) cannot be JSON and go one by one, as does everything on an SDK without setAll.
Parameters
- values: Partial<{ [P in WritablePath<C>]: WriteAt<C, P> }>
Returns this
Inherited from MassifObject.apply
- Defined in packages/ui-massifmaps/api/index.common.d.ts:142

`Protected`beforeSubscribe

beforeSubscribe(event: string): void
Hook for a subclass that has to install a native listener before the first subscription.
Parameters
- event: string
Returns void
Overrides MassifObject.beforeSubscribe
- Defined in packages/ui-massifmaps/api/index.common.d.ts:212

call

call<M extends string>(method: M, ...args: MethodArgs<C, M>): CallResult<C, M>
The path may traverse object properties (layer.call('tileDecoder.setStyleParameter', ...)). An object result is a MassifObject the CALLER OWNS - destroy() it, or it stays registered.
Type Parameters
- M extends string
Parameters
- method: M
- ...args: MethodArgs<C, M>
Returns CallResult<C, M>
Inherited from MassifObject.call
- Defined in packages/ui-massifmaps/api/index.common.d.ts:162

callAsync

callAsync<M extends string, R = CallResult<C, M>>(
 method: M,
 args: MethodArgs<C, M>,
 extract?: (result: MassifObject<ResultClass<C, M>>) => R,
): CancellablePromise<R>
call on a worker. extract runs INSIDE the delivery, the only time an object result is alive, e.g. (tile) => tile.getData('data'). Scalars and flat arrays need no extract.
Type Parameters
- M extends string
- R = CallResult<C, M>
Parameters
- method: M
- args: MethodArgs<C, M>
- Optionalextract: (result: MassifObject<ResultClass<C, M>>) => R
Returns CancellablePromise<R>
Inherited from MassifObject.callAsync
- Defined in packages/ui-massifmaps/api/index.common.d.ts:170

cancelCalls

cancelCalls(): number
Returns number
Inherited from MassifObject.cancelCalls
- Defined in packages/ui-massifmaps/api/index.common.d.ts:171

child

child(path: P): MassifObject<ClassAtPath<C, P>>
The object behind an object property, OWNED by the caller (destroy() it); null when empty. Unlike group it hands the object over, e.g. to share a source between layers.
Type Parameters
- P extends string
Parameters
- path: P
Returns MassifObject<ClassAtPath<C, P>>
Inherited from MassifObject.child
- Defined in packages/ui-massifmaps/api/index.common.d.ts:157

clearTileCaches

clearTileCaches(all?: boolean): this
all includes the preloading caches, not just the visible set.
Parameters
- Optionalall: boolean
Returns this
- Defined in packages/ui-massifmaps/api/index.common.d.ts:228

collect

collect<R>(
 map: (
 element: MassifObject<
 ResultClass<C, keyof MethodTypes[C] & "getFeature">,
 >,
 index: number,
 ) => R,
): R[]
Defaults cover a search result; a route's instructions are collect(fn, { countPath: 'instructionCount', method: 'getInstruction' }).
Type Parameters
- R
Parameters
- map: (
 element: MassifObject<
 ResultClass<C, keyof MethodTypes[C] & "getFeature">,
 >,
 index: number,
 ) => R
Returns R[]
Inherited from MassifObject.collect
- Defined in packages/ui-massifmaps/api/index.common.d.ts:176
collect<M extends string, R>(
map: (element: MassifObject<ResultClass<C, M>>, index: number) => R,
options: { countPath: string; method: M },
): R[]
Defaults cover a search result; a route's instructions are collect(fn, { countPath: 'instructionCount', method: 'getInstruction' }).
Type Parameters
- M extends string
- R
Parameters
- map: (element: MassifObject<ResultClass<C, M>>, index: number) => R
- options: { countPath: string; method: M }
Returns R[]
Inherited from MassifObject.collect
- Defined in packages/ui-massifmaps/api/index.common.d.ts:177

destroy

destroy(): boolean
Subscriptions and pending async calls die with it, so no handler runs against a freed object.

Returns boolean
Inherited from MassifObject.destroy
- Defined in packages/ui-massifmaps/api/index.common.d.ts:204

detach

detach(): this
The object stays registered until it is destroyed.

Returns this
- Defined in packages/ui-massifmaps/api/index.common.d.ts:223

elevations

elevations(positions: AnyPosition[]): number[]
Only a hillshade layer answers; anything else gives an empty array.
Parameters
- positions: AnyPosition[]
Returns number[]
- Defined in packages/ui-massifmaps/api/index.common.d.ts:230

eventOptions

eventOptions(options: SubscribeOptions): this
Defaults for every later subscription on this object.
Parameters
- options: SubscribeOptions
Returns this
Inherited from MassifObject.eventOptions
- Defined in packages/ui-massifmaps/api/index.common.d.ts:187

get

get(path: P): ValueAt<C, P>
The path may walk objects (fogOptions.rangeStart), structs (clickInfo.clickType) and free-form data (properties.name). Enums come back as names, positions as [lon, lat], structs as JSON.
Type Parameters
- P extends string
Parameters
- path: P
Returns ValueAt<C, P>
Inherited from MassifObject.get
- Defined in packages/ui-massifmaps/api/index.common.d.ts:125

getData

getData(path?: string): ArrayBuffer
An empty path means the handle IS the blob.
Parameters
- Optionalpath: string
Returns ArrayBuffer
Inherited from MassifObject.getData
- Defined in packages/ui-massifmaps/api/index.common.d.ts:184

getDoubles

getDoubles(): number[]
Returns number[]
Inherited from MassifObject.getDoubles
- Defined in packages/ui-massifmaps/api/index.common.d.ts:185

getPos

getPos(path: P, projection?: ProjectionName): PositionAt<C, P>
WGS84 [lng, lat] unless a projection is named here or on the subscription. An object whose source projection is unknown is left unconverted: a wrong guess is worse than an unconverted number.
Type Parameters
- P extends string
Parameters
- path: P
- Optionalprojection: ProjectionName
Returns PositionAt<C, P>
Inherited from MassifObject.getPos
- Defined in packages/ui-massifmaps/api/index.common.d.ts:149
getPos(path: string & {}, projection?: ProjectionName): Position | Bounds
A path the tables do not carry - the concrete class is more derived than the declared one.
Parameters
- path: string & {}
- Optionalprojection: ProjectionName
Returns Position | Bounds
Inherited from MassifObject.getPos
- Defined in packages/ui-massifmaps/api/index.common.d.ts:151

group

group(path: P): PropertyGroup<ClassAtPath<C, P>>
Type Parameters
- P extends string
Parameters
- path: P
Returns PropertyGroup<ClassAtPath<C, P>>
Inherited from MassifObject.group
- Defined in packages/ui-massifmaps/api/index.common.d.ts:152

`Protected`invoke

invoke(method: string, args: readonly unknown[]): unknown
Untyped call for the named wrappers: they know the declaring class, call's C does not.
Parameters
- method: string
- args: readonly unknown[]
Returns unknown
Inherited from MassifObject.invoke
- Defined in packages/ui-massifmaps/api/index.common.d.ts:164

is

is(className: ClassName): boolean
instanceof by class name, e.g. layer.is('massif::RasterTileLayer').
Parameters
- className: ClassName
Returns boolean
Inherited from MassifObject.is
- Defined in packages/ui-massifmaps/api/index.common.d.ts:118

json

json(path?: string): Json
Escape hatch for paths the tables cannot type: free-form feature properties, a more derived class.
Parameters
- Optionalpath: string
Returns Json
Inherited from MassifObject.json
- Defined in packages/ui-massifmaps/api/index.common.d.ts:182

moveTo

moveTo(index: number): this
0 is the bottom of the map's stack.
Parameters
- index: number
Returns this
- Defined in packages/ui-massifmaps/api/index.common.d.ts:221

off

off<E extends string>(event: E, callback?: any, thisArg?: any): void
Removes the listener(s) for the specified event name.
Type Parameters
- E extends string
Parameters
- event: E
- Optionalcallback: any
 An optional specific event listener to remove (if omitted, all event listeners by this name will be removed).
- OptionalthisArg: any
 An optional parameter which, when set, will be used to refine search of the correct event listener to be removed.
Returns void
Inherited from MassifObject.off
- Defined in packages/ui-massifmaps/api/index.common.d.ts:199

on

on<E extends string>(
 event: E,
 callback: (data: MassifEventData<C, E>) => void,
 thisArg?: any,
): void
Deliberately NOT widened to string so event-name typos fail; addEventListener takes any name.
Type Parameters
- E extends string
Parameters
- event: E
- callback: (data: MassifEventData<C, E>) => void
- OptionalthisArg: any
Returns void
Inherited from MassifObject.on
- Defined in packages/ui-massifmaps/api/index.common.d.ts:197

once

once<E extends string>(
 event: E,
 callback: (data: MassifEventData<C, E>) => void,
 thisArg?: any,
): void
Adds a listener for the specified event name, which, once fired, will remove itself.
Type Parameters
- E extends string
Parameters
- event: E
- callback: (data: MassifEventData<C, E>) => void
 The event listener to add. Will be called when an event of the given name is raised.
- OptionalthisArg: any
 An optional parameter which, when set, will be bound as the this context when the callback is called. Falsy values will be not be bound.
Returns void
Inherited from MassifObject.once
- Defined in packages/ui-massifmaps/api/index.common.d.ts:198

onCelestialClick

onCelestialClick(
 handler: (
 data: MassifEventData<"massif::CelestialLayer", "celestial.clicked">,
 ) => void,
 options?: SubscribeOptions,
): Subscription
Parameters
- handler: (data: MassifEventData<"massif::CelestialLayer", "celestial.clicked">) => void
- Optionaloptions: SubscribeOptions
Returns Subscription
- Defined in packages/ui-massifmaps/api/index.common.d.ts:233

onElementClick

onElementClick(
 handler: (
 data: MassifEventData<"massif::VectorLayer", "vectorelement.clicked">,
 ) => void,
 options?: SubscribeOptions,
): Subscription
Parameters
- handler: (data: MassifEventData<"massif::VectorLayer", "vectorelement.clicked">) => void
- Optionaloptions: SubscribeOptions
Returns Subscription
- Defined in packages/ui-massifmaps/api/index.common.d.ts:232

onFeatureClick

onFeatureClick(
 handler: (
 data: MassifEventData<"massif::VectorTileLayer", "vectortile.clicked">,
 ) => void,
 options?: SubscribeOptions,
): Subscription
Parameters
- handler: (data: MassifEventData<"massif::VectorTileLayer", "vectortile.clicked">) => void
- Optionaloptions: SubscribeOptions
Returns Subscription
- Defined in packages/ui-massifmaps/api/index.common.d.ts:231

onSkyClick

onSkyClick(
 handler: (
 data: MassifEventData<"massif::CelestialLayer", "sky.clicked">,
 ) => void,
 options?: SubscribeOptions,
): Subscription
Parameters
- handler: (data: MassifEventData<"massif::CelestialLayer", "sky.clicked">) => void
- Optionaloptions: SubscribeOptions
Returns Subscription
- Defined in packages/ui-massifmaps/api/index.common.d.ts:234

opacity

opacity(): number
Returns number
- Defined in packages/ui-massifmaps/api/index.common.d.ts:214
opacity(value: number): this
Parameters
- value: number
Returns this
- Defined in packages/ui-massifmaps/api/index.common.d.ts:215

refresh

refresh(): this
Returns this
- Defined in packages/ui-massifmaps/api/index.common.d.ts:224

removeEventListener

removeEventListener(eventNames: string, callback?: any, thisArg?: any): void
Removes listener(s) for the specified event name.
Parameters
- eventNames: string
- Optionalcallback: any
  An optional parameter pointing to a specific listener. If not defined, all listeners for the event names will be removed.
- OptionalthisArg: any
  An optional parameter which when set will be used to refine search of the correct callback which will be removed as event listener.
Returns void
Inherited from MassifObject.removeEventListener
- Defined in packages/ui-massifmaps/api/index.common.d.ts:202

set

set(path: P, value: WriteAt<C, P>): this
An enum takes its constant name, a position an array.
Type Parameters
- P extends string
Parameters
- path: P
- value: WriteAt<C, P>
Returns this
Inherited from MassifObject.set
- Defined in packages/ui-massifmaps/api/index.common.d.ts:128

source

source(): MassifSource<any>
OWNED by the caller. Typed as a source so .native is there, to hand the tiles to native code.

Returns MassifSource<any>
- Defined in packages/ui-massifmaps/api/index.common.d.ts:226

subscribe<E extends string>(
 event: E,
 handler: (data: MassifEventData<C, E>) => void,
 options?: SubscribeOptions,
): Subscription
For a handler needing its own projection or delivery; on covers most cases.
Type Parameters
- E extends string
Parameters
- event: E
- handler: (data: MassifEventData<C, E>) => void
- Optionaloptions: SubscribeOptions
Returns Subscription
Inherited from MassifObject.subscribe
- Defined in packages/ui-massifmaps/api/index.common.d.ts:190

toString

toString(): string
Returns a string representation of an object.

Returns string
Inherited from MassifObject.toString
- Defined in packages/ui-massifmaps/api/index.common.d.ts:205

trySet

trySet(path: P, value: WriteAt<C, P>): number
The same without throwing, for a path that may legitimately not be there.
Type Parameters
- P extends string
Parameters
- path: P
- value: WriteAt<C, P>
Returns number
Inherited from MassifObject.trySet
- Defined in packages/ui-massifmaps/api/index.common.d.ts:130

visible

visible(): boolean
Returns boolean
- Defined in packages/ui-massifmaps/api/index.common.d.ts:216
visible(value: boolean): this
Parameters
- value: boolean
Returns this
- Defined in packages/ui-massifmaps/api/index.common.d.ts:217

zoomRange

zoomRange(): [number, number]
Returns [number, number]
- Defined in packages/ui-massifmaps/api/index.common.d.ts:218
zoomRange(range: [number, number]): this
Parameters
- range: [number, number]
Returns this
- Defined in packages/ui-massifmaps/api/index.common.d.ts:219

Class MassifLayer<C>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns MassifLayer<C>

Properties

ReadonlyclassName

Readonlyhandle

Optional Readonlyid

Optionalmap

Accessors

events

Returns string[]

native

Returns any

valid

Returns boolean

Methods

addEventListener

Parameters

Returns void

apply

Parameters

Returns this

ProtectedbeforeSubscribe

Parameters

Returns void

call

Type Parameters

Parameters

Returns CallResult<C, M>

callAsync

Type Parameters

Parameters

Returns CancellablePromise<R>

cancelCalls

Returns number

child

Type Parameters

Parameters

Returns MassifObject<ClassAtPath<C, P>>

clearTileCaches

Parameters

Returns this

collect

Type Parameters

Parameters

Returns R[]

Type Parameters

Parameters

Returns R[]

destroy

Returns boolean

detach

Returns this

elevations

Parameters

Returns number[]

eventOptions

Parameters

Returns this

get

Type Parameters

Parameters

Returns ValueAt<C, P>

getData

Parameters

Returns ArrayBuffer

getDoubles

Returns number[]

getPos

Type Parameters

`Readonly`className

`Readonly`handle

`Optional` `Readonly`id

`Optional`map

`Protected`beforeSubscribe

`Protected`invoke