KeplerConfig

KeplerConfig#

Configuration class for Kepler.gl map and rendering settings.

class graphistry.kepler.KeplerConfig(raw_dict: Dict[str, Any])#
class graphistry.kepler.KeplerConfig(raw_dict: None = None, *, cull_unused_columns: bool | None = None, overlay_blending: Literal['normal', 'additive', 'subtractive'] | None = None, tile_style: Dict[str, Any] | None = None, auto_graph_renderer_switching: bool | None = None)

Bases: object

Configure Kepler.gl map and rendering settings.

Controls map appearance, data optimization, and layer blending behavior.

Parameters:

  • raw_dict (Optional[Dict[str, Any]]) – Native Kepler.gl config dictionary (if provided, kwargs ignored)

  • cull_unused_columns (Optional[bool]) – Remove unused columns from datasets (default: True)

  • overlay_blending (Optional[Literal['normal', 'additive', 'subtractive']]) – Blend mode - ‘normal’, ‘additive’, ‘subtractive’ (default: ‘normal’)

  • tile_style (Optional[Dict[str, Any]]) – Base map tile style configuration

  • auto_graph_renderer_switching (Optional[bool]) – Enable automatic graph renderer switching, which allows Graphistry to hide Kepler node and edge layers depending on the mode (default: True)

  • kwargs (Any)

Example: Structured parameters
from graphistry import KeplerConfig

# Optimize data transfer
cfg = KeplerConfig(cull_unused_columns=True)

# Additive blending for heatmaps
cfg = KeplerConfig(overlay_blending='additive')

# Custom dark base map
cfg = KeplerConfig(
    tile_style={
        "id": "dark",
        "label": "Dark Mode",
        "url": "mapbox://styles/mapbox/dark-v10"
    }
)
Example: Using raw_dict
# Pass native format
cfg = KeplerConfig({
    "cullUnusedColumns": True,
    "overlayBlending": "additive"
})
to_dict()#

Serialize to dictionary format for Kepler.gl.

Return type:

Dict[str, Any]

See Also#