g6R (version 0.1.0)

fullscreen: Configure Fullscreen Plugin

Description

Creates a configuration object for the fullscreen plugin in G6. This plugin enables fullscreen mode for the graph.

Usage

fullscreen(
  key = "fullscreen",
  autoFit = TRUE,
  trigger = NULL,
  onEnter = NULL,
  onExit = NULL,
  ...
)

Value

A list with the configuration settings for the fullscreen plugin.

Arguments

key

Unique identifier for the plugin (string, default: NULL).

autoFit

Whether to auto-fit the canvas size to the screen when in fullscreen mode (boolean, default: TRUE).

trigger

Methods to trigger fullscreen, e.g., list(request = "button", exit = "escape") (list, default: NULL).

onEnter

Callback function after entering fullscreen mode (JS function, default: NULL).

onExit

Callback function after exiting fullscreen mode (JS function, default: NULL).

...

Extra parameters. See https://g6.antv.antgroup.com/en/manual/plugin/fullscreen.

Examples

# Basic configuration
config <- fullscreen()

# Custom configuration
config <- fullscreen(
  key = "my-fullscreen",
  autoFit = TRUE,
  trigger = list(
    request = "F",
    exit = "Esc"
  ),
  onEnter = JS("() => {
    console.log('Entered fullscreen mode');
  }"),
  onExit = JS("() => {
    console.log('Exited fullscreen mode');
  }")
)