Interface KeplerPeersExperimental

Kepler action creators the bridge can use when a host is attached. Every member is optional except addDataToMap; a missing creator downgrades the corresponding operation to "payload only" rather than throwing late.

interface KeplerPeers {
    addDataToMap: ((payload: unknown) => KeplerAction);
    removeDataset?: ((datasetId: string) => KeplerAction);
    replaceDataInMap?: ((payload: unknown) => KeplerAction);
    setFilter?: ((index: number, prop: string, value: unknown) => KeplerAction);
    updateMap?: ((mapState: unknown) => KeplerAction);
    version: string;
    wrapTo?: ((instanceId: string, action: KeplerAction) => KeplerAction);
}

Properties

addDataToMap removeDataset? replaceDataInMap? setFilter? updateMap? version wrapTo?

Properties

ReadonlyaddDataToMap

addDataToMap: ((payload: unknown) => KeplerAction)

Optional ReadonlyremoveDataset

removeDataset?: ((datasetId: string) => KeplerAction)

Optional ReadonlyreplaceDataInMap

replaceDataInMap?: ((payload: unknown) => KeplerAction)

Optional ReadonlysetFilter

setFilter?: ((index: number, prop: string, value: unknown) => KeplerAction)

Optional ReadonlyupdateMap

updateMap?: ((mapState: unknown) => KeplerAction)

Readonly Experimentalversion

version: string

Kepler.gl version the peers came from; validated against KEPLER_COMPATIBILITY_RANGE.

Optional ReadonlywrapTo

wrapTo?: ((instanceId: string, action: KeplerAction) => KeplerAction)

Settings

Member Visibility

On This Page

Properties