Fullscreen

Overview

The Fullscreen plugin allows users to expand the graph visualization content to the entire screen, providing a broader view and a better immersive experience.

Use Cases

The Fullscreen plugin is mainly suitable for the following scenarios:

• Provide a broader view for viewing complex graph data
• Enhance immersive experience, focusing on graph visualization content
• Display graph data in presentations or reports

Basic Usage

Below is a simple example of initializing the Fullscreen plugin:

const graph = new Graph({
  plugins: [
    {
      type: 'fullscreen',
      autoFit: true,
      trigger: {
        request: 'F', // Use shortcut key F to enter fullscreen
        exit: 'Esc', // Use shortcut key Esc to exit fullscreen
      },
      onEnter: () => {
        console.log('Entered fullscreen mode');
      },
      onExit: () => {
        console.log('Exited fullscreen mode');
      },
    },
  ],
});

Configuration Options

trigger

The trigger property is used to control the method of triggering fullscreen. It supports two configuration methods:

Shortcut Key Configuration

Use keyboard shortcuts to trigger fullscreen and exit fullscreen.

const graph = new Graph({
  plugins: [
    {
      type: 'fullscreen',
      trigger: {
        request: 'F', // Use shortcut key F to enter fullscreen
        exit: 'Esc', // Use shortcut key Esc to exit fullscreen
      },
    },
  ],
});

Custom Trigger

Control fullscreen by calling the request and exit methods.

const graph = new Graph({
  plugins: [
    {
      type: 'fullscreen',
      key: 'my-fullscreen',
    },
  ],
});

// Enter fullscreen
graph.getPluginInstance('my-fullscreen').request();

// Exit fullscreen
graph.getPluginInstance('my-fullscreen').exit();

autoFit

Whether to auto-fit the canvas size, the canvas size will automatically adapt to the screen size when fullscreen.

• When set to true, the canvas will automatically resize to fit the entire screen.
• When set to false, the canvas size remains unchanged.

const graph = new Graph({
  plugins: [
    {
      type: 'fullscreen',
      autoFit: true,
    },
  ],
});

API

Fullscreen.request()

This method is used to enter fullscreen mode programmatically. It can be called on the plugin instance to expand the graph visualization to the entire screen.

const graph = new Graph({
  plugins: [
    {
      type: 'fullscreen',
      key: 'my-fullscreen',
    },
  ],
});

// Enter fullscreen
graph.getPluginInstance('my-fullscreen').request();

Fullscreen.exit()

This method is used to exit fullscreen mode programmatically. It can be called on the plugin instance to revert the graph visualization back to its original size.

const graph = new Graph({
  plugins: [
    {
      type: 'fullscreen',
      key: 'my-fullscreen',
    },
  ],
});

// Exit fullscreen
graph.getPluginInstance('my-fullscreen').exit();

Practical Examples

import { Graph } from '@antv/g6';

const graph = new Graph({
  data: { nodes: Array.from({ length: 20 }).map((_, i) => ({ id: `node${i}` })) },
  autoFit: 'center',
  background: '#fff',
  plugins: [
    {
      type: 'fullscreen',
      key: 'fullscreen',
    },
    function () {
      const graph = this;
      return {
        type: 'toolbar',
        key: 'toolbar',
        position: 'top-left',
        onClick: (item) => {
          const fullscreenPlugin = graph.getPluginInstance('fullscreen');
          if (item === 'request-fullscreen') {
            fullscreenPlugin.request();
          }
          if (item === 'exit-fullscreen') {
            fullscreenPlugin.exit();
          }
        },
        getItems: () => {
          return [
            { id: 'request-fullscreen', value: 'request-fullscreen' },
            { id: 'exit-fullscreen', value: 'exit-fullscreen' },
          ];
        },
      };
    },
  ],
});

graph.render();

import { Graph } from '@antv/g6';
import GUI from 'lil-gui';

export function addPanel(renderPanel: (gui: GUI) => void) {
  const gui = new GUI({ container: document.body });
  gui.title('Control');
  Object.assign(gui.domElement.style, { position: 'absolute', top: '0', right: '0', zIndex: '10' });
  renderPanel(gui);
  addEventListener('pagehide', () => gui.destroy(), { once: true });
}

export async function createGraph(
  options: ConstructorParameters<typeof Graph>[0],
  size: { width?: number; height?: number } = {},
  renderPanel?: (gui: GUI, graph: Graph) => void,
) {
  const container = document.createElement('div');
  Object.assign(container.style, {
    width: '100%',
    maxWidth: `${size.width || 600}px`,
    height: `${size.height || 400}px`,
  });
  document.getElementById('container')!.append(container);
  const graph = new Graph({ ...size, ...options, width: container.clientWidth, container, autoResize: true });
  addEventListener('pagehide', () => graph.destroy(), { once: true });
  await graph.render();
  if (renderPanel) addPanel((gui) => renderPanel(gui, graph));
  return container;
}