@types/cytoscape-navigator
TypeScript icon, indicating that this package has built-in type declarations

2.0.3 • Public • Published

Installation

npm install --save @types/cytoscape-navigator

Summary

This package contains type definitions for cytoscape-navigator (https://github.com/cytoscape/cytoscape.js-navigator).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/cytoscape-navigator.

index.d.ts

import cytoscape = require("cytoscape");

declare const navigator: cytoscape.Ext;

export = navigator;
export as namespace navigator;

declare namespace navigator {
    interface Options {
        /**
         * Container element.
         * Supported strings: an element id selector (like "#someId"), or a className selector (like ".someClassName"). Otherwise an element will be created by the library.
         * Default: false
         */
        container?: string | boolean;
        /**
         * Frames per second.
         * Set false to update graph pan only on drag end.
         * Set to 0 to update graph instantly.
         * Set a number (e.g. 60) to update graph not more than N times per second.
         * Default: 0
         */
        viewLiveFramerate?: number | boolean;
        /**
         * Double click delay in milliseconds.
         * Default: 200
         */
        dblClickDelay?: number;
        /**
         * Flag to destroy the container on plugin destroy.
         * Default: true
         */
        removeCustomContainer?: boolean;
        /**
         * Rerender delay in milliseconds.
         * Default: 500
         */
        rerenderDelay?: number;
    }

    interface Nav {
        /**
         * Remove the navigator and clean up.
         */
        destroy: () => void;
    }
}

declare global {
    namespace cytoscape {
        interface Core {
            /*
             * Set up the navigator according to the given options.
             */
            navigator: (options?: navigator.Options) => navigator.Nav;
        }
    }
}

Additional Details

Credits

These definitions were written by Musa.

Readme

Keywords

none

Package Sidebar

Install

npm i @types/cytoscape-navigator

Weekly Downloads

223

Version

2.0.3

License

MIT

Unpacked Size

5.88 kB

Total Files

5

Last publish

Collaborators

  • types