Scenes and dynamic effects

Generated from the same registry as the Chinese reference. Contract version: 0.5-session. Edit the registry and reviewed English catalog, then rerun script_contract; do not edit this file. See the script guide.

Platform labels below are registry declarations, not device acceptance. Consult the platform coverage guide for actual host coverage and limits. These are the existing gis compatibility-module APIs; the shared sqsmap map facade is documented separately.

map.clusters

map.clusters.leaves

Page through cluster members; references expire when the hierarchy or source revision changes.

• Permission: project.read
• Declared platforms: desktop, mobile, web
• Signature: map.clusters.leaves(arg0: ClusterRef, arg1?: PageOptions): Operation<Page<FeatureSummary>>

map.clusters.expansionZoom

Return the first zoom level at which the cluster splits.

• Permission: project.read
• Declared platforms: desktop, mobile, web
• Signature: map.clusters.expansionZoom(arg0: ClusterRef): Operation<number | null>

map.clusters.expand

Animate the camera to expand the current cluster.

• Permission: map.write
• Declared platforms: desktop, mobile, web
• Signature: map.clusters.expand(arg0: ClusterRef, arg1?: {durationMs?:number}): Operation<void>

gis.live

gis.live.connect

Register a continuous collector controlled by its scene; replace snapshots atomically.

• Permission: scene.run
• Declared platforms: desktop, mobile, web
• Signature: live.connect(arg0: LiveConnectOptions, arg1: SceneOwnerOptions): Operation<LiveFeedRef>

gis.live.info

Read collection status, freshness, revision, and bounded-queue statistics.

• Permission: project.read
• Declared platforms: desktop, mobile, web
• Signature: live.info(arg0: LiveFeedRef): Operation<LiveFeedInfo>

gis.live.snapshot

Freeze the displayed source revision into immutable data for analysis and export.

• Permission: analysis.execute
• Declared platforms: desktop, mobile, web
• Signature: live.snapshot(arg0: SourceRef): Operation<DatasetRef>

map.images

map.images.pulse

Prepare a native pulse image driven by the host clock while its scene runs.

• Permission: map.write
• Declared platforms: desktop, mobile, web
• Signature: map.images.pulse(arg0: string, arg1: PulseImageOptions, arg2: SceneOwnerOptions): Operation<ImageRef>

map.images.sprite

Read a local static PNG/WebP sprite sheet in the background; playback changes only its frame index.

• Permission: map.write
• Declared platforms: desktop, mobile, web
• Signature: map.images.sprite(arg0: string, arg1: SpriteImageOptions, arg2: SceneOwnerOptions): Operation<ImageRef>

map.images.get

Acquire a registered image by its exact ID.

• Permission: project.read
• Declared platforms: desktop, mobile, web
• Signature: map.images.get(arg0: string): Operation<ImageRef | null>

map.images.info

Read image kind, logical dimensions, and frame count.

• Permission: project.read
• Declared platforms: desktop, mobile, web
• Signature: map.images.info(arg0: ImageRef): Operation<ImageInfo>

map.images.remove

Preview removal of an image that has no dependent symbols.

• Permission: map.write
• Declared platforms: desktop, mobile, web
• Signature: map.images.remove(arg0: ImageRef): ChangePlan<void>

map.animations

map.animations.route

Snapshot one route and animate its marker by distance or vertex timestamps; source changes stop playback.

• Permission: map.write
• Declared platforms: desktop, mobile, web
• Signature: map.animations.route(arg0: RoutePlaybackOptions, arg1: SceneOwnerOptions): Operation<PlaybackRef>

map.animations.line

Prepare composable flow trails, dashes, reveal, arrows, glow, and local patterns for a same-scene line layer; source changes stop playback.

• Permission: map.write
• Declared platforms: desktop, mobile, web
• Signature: map.animations.line(arg0: LinePlaybackOptions, arg1: SceneOwnerOptions): Operation<PlaybackRef>

map.playbacks

map.playbacks.play

Start or resume host playback.

• Permission: scene.run
• Declared platforms: desktop, mobile, web
• Signature: map.playbacks.play(arg0: PlaybackRef): Operation<void>

map.playbacks.pause

Pause host playback while preserving its position.

• Permission: map.write
• Declared platforms: desktop, mobile, web
• Signature: map.playbacks.pause(arg0: PlaybackRef): Operation<void>

map.playbacks.stop

Stop host playback and cancel completion waits.

• Permission: map.write
• Declared platforms: desktop, mobile, web
• Signature: map.playbacks.stop(arg0: PlaybackRef): Operation<void>

map.playbacks.seek

Move host playback to the specified time position.

• Permission: map.write
• Declared platforms: desktop, mobile, web
• Signature: map.playbacks.seek(arg0: PlaybackRef, arg1: number): Operation<void>

map.playbacks.info

Read host playback state and position.

• Permission: project.read
• Declared platforms: desktop, mobile, web
• Signature: map.playbacks.info(arg0: PlaybackRef): Operation<PlaybackInfo>

map.playbacks.finished

Wait for the current playback cycle; stopping or replacement cancels the wait.

• Permission: project.read
• Declared platforms: desktop, mobile, web
• Signature: map.playbacks.finished(arg0: PlaybackRef): Operation<void>

map.scenes

map.scenes.create

Prepare a host-managed scene; a draft neither displays resources nor starts playback.

• Permission: map.write
• Declared platforms: desktop, mobile, web
• Signature: map.scenes.create(arg0: {id:string;name:string}): Operation<SceneRef>

map.scenes.get

Acquire a scene reference by its exact ID.

• Permission: project.read
• Declared platforms: desktop, mobile, web
• Signature: map.scenes.get(arg0: string): Operation<SceneRef | null>

map.scenes.list

Page through host-managed scenes and their states.

• Permission: project.read
• Declared platforms: desktop, mobile, web
• Signature: map.scenes.list(arg0?: PageOptions): Operation<Page<SceneInfo>>

map.scenes.remove

Preview removal of a scene and its owned resources; external dependencies block removal and source files remain.

• Permission: map.write
• Declared platforms: desktop, mobile, web
• Signature: map.scenes.remove(arg0: SceneRef): ChangePlan<void>

map.scenes.start

Activate the scene atomically; the host owns it after the script exits.

• Permission: scene.run
• Declared platforms: desktop, mobile, web
• Signature: map.scenes.start(arg0: SceneRef): Operation<void>

map.scenes.pause

Freeze the scene clock while preserving its display.

• Permission: map.write
• Declared platforms: desktop, mobile, web
• Signature: map.scenes.pause(arg0: SceneRef): Operation<void>

map.scenes.resume

Resume the scene clock from its paused position.

• Permission: scene.run
• Declared platforms: desktop, mobile, web
• Signature: map.scenes.resume(arg0: SceneRef): Operation<void>

map.scenes.stop

Stop the scene and preserve its last display; a subsequent start resets its clock.

• Permission: map.write
• Declared platforms: desktop, mobile, web
• Signature: map.scenes.stop(arg0: SceneRef): Operation<void>

map.scenes.info

Read scene resource counts, state, and monotonic playback time.

• Permission: project.read
• Declared platforms: desktop, mobile, web
• Signature: map.scenes.info(arg0: SceneRef): Operation<SceneInfo>