KeplerOptions

KeplerOptions#

Configuration class for Kepler.gl visualization options.

class graphistry.kepler.KeplerOptions(raw_dict: Dict[str, Any])#
class graphistry.kepler.KeplerOptions(raw_dict: None = None, *, center_map: bool | None = None, read_only: bool | None = None)

Bases: object

Configure Kepler.gl visualization options.

Controls map behavior and interaction settings such as auto-centering and read-only mode.

Parameters:

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

  • center_map (Optional[bool]) – Auto-center map on data (default: True)

  • read_only (Optional[bool]) – Disable map interactions (default: False)

  • kwargs (Any)

Example: Structured parameters
from graphistry import KeplerOptions

# Auto-center with interactions enabled
opts = KeplerOptions(center_map=True, read_only=False)

# Read-only mode for presentations
opts = KeplerOptions(read_only=True)
Example: Using raw_dict
# Pass native format
opts = KeplerOptions({"centerMap": True, "readOnly": False})
to_dict()#

Serialize to dictionary format for Kepler.gl.

Return type:

Dict[str, Any]

See Also#