@types/vis
Advanced tools
Comparing version 4.18.8 to 4.18.9
@@ -298,4 +298,2 @@ // Type definitions for vis.js 4.18 | ||
* Options that can be passed to a DataSet. | ||
* | ||
* @interface DataSetOptions | ||
*/ | ||
@@ -308,5 +306,2 @@ export interface DataSetOptions extends DataSetQueueOptions { | ||
* For example CouchDB uses the field "_id" to identify documents. | ||
* | ||
* @type {string} | ||
* @memberOf DataSetOptions | ||
*/ | ||
@@ -322,5 +317,2 @@ fieldId?: string; | ||
* The available data types are listed in section Data Types. | ||
* | ||
* @type {*} | ||
* @memberOf DataSetOptions | ||
*/ | ||
@@ -341,5 +333,2 @@ type?: any; | ||
* Default value is Infinity. | ||
* | ||
* @type {(any | boolean)} | ||
* @memberOf DataSetOptions | ||
*/ | ||
@@ -353,5 +342,3 @@ queue?: any | boolean; | ||
* | ||
* @param {DataSetOptions} [options] DataSet options. | ||
* | ||
* @memberOf DataSet | ||
* @param [options] DataSet options. | ||
*/ | ||
@@ -363,6 +350,4 @@ constructor(options: DataSetOptions); | ||
* | ||
* @param {T[]} [data] An Array with items. | ||
* @param {DataSetOptions} [options] DataSet options. | ||
* | ||
* @memberOf DataSet | ||
* @param [data] An Array with items. | ||
* @param [options] DataSet options. | ||
*/ | ||
@@ -373,5 +358,2 @@ constructor(data?: T[], options?: DataSetOptions); | ||
* The number of items in the DataSet. | ||
* | ||
* @type {number} | ||
* @memberOf DataSet | ||
*/ | ||
@@ -384,7 +366,5 @@ length: number; | ||
* | ||
* @param {(T | T[])} data data can be a single item or an array with items. | ||
* @param {IdType} [senderId] Optional sender id. | ||
* @returns {IdType[]} The function returns an array with the ids of the added items. | ||
* | ||
* @memberOf DataSet | ||
* @param data data can be a single item or an array with items. | ||
* @param [senderId] Optional sender id. | ||
* @returns The function returns an array with the ids of the added items. | ||
*/ | ||
@@ -396,6 +376,4 @@ add(data: T | T[], senderId?: IdType): IdType[]; | ||
* | ||
* @param {IdType} [senderId] Optional sender id. | ||
* @returns {IdType[]} The function returns an array with the ids of the removed items. | ||
* | ||
* @memberOf DataSet | ||
* @param [senderId] Optional sender id. | ||
* @returns The function returns an array with the ids of the removed items. | ||
*/ | ||
@@ -408,6 +386,4 @@ clear(senderId?: IdType): IdType[]; | ||
* | ||
* @param {string} field The search term. | ||
* @returns {any[]} Returns an unordered array containing all distinct values. | ||
* | ||
* @memberOf DataSet | ||
* @param field The search term. | ||
* @returns Returns an unordered array containing all distinct values. | ||
*/ | ||
@@ -419,4 +395,2 @@ distinct(field: string): any[]; | ||
* Only available when the DataSet is configured with the option queue. | ||
* | ||
* @memberOf DataSet | ||
*/ | ||
@@ -428,6 +402,4 @@ flush(): void; | ||
* | ||
* @param {(item: T, id: IdType) => void} callback The item callback. | ||
* @param {DataSelectionOptions<T>} [options] Optional options | ||
* | ||
* @memberOf DataSet | ||
* @param callback The item callback. | ||
* @param [options] Optional options | ||
*/ | ||
@@ -439,7 +411,5 @@ forEach(callback: (item: T, id: IdType) => void, options?: DataSelectionOptions<T>): void; | ||
* | ||
* @param {DataSelectionOptions<T>} [options] Optional options. | ||
* @returns {T[]} When no item is found, null is returned when a single item was requested, | ||
* @param [options] Optional options. | ||
* @returns When no item is found, null is returned when a single item was requested, | ||
* and and empty Array is returned in case of multiple id's. | ||
* | ||
* @memberOf DataSet | ||
*/ | ||
@@ -451,8 +421,5 @@ get(options?: DataSelectionOptions<T>): T[]; | ||
* | ||
* @param {IdType} id The item id. | ||
* @param {DataSelectionOptions<T>} [options] | ||
* @returns {T} When no item is found, null is returned when a single item was requested, | ||
* @param id The item id. | ||
* @returns When no item is found, null is returned when a single item was requested, | ||
* and and empty Array is returned in case of multiple id's. | ||
* | ||
* @memberOf DataSet | ||
*/ | ||
@@ -464,8 +431,6 @@ get(id: IdType, options?: DataSelectionOptions<T>): T; | ||
* | ||
* @param {IdType[]} ids Array of item ids. | ||
* @param {DataSelectionOptions<T>} [options] Optional options. | ||
* @returns {T[]} When no item is found, null is returned when a single item was requested, | ||
* @param ids Array of item ids. | ||
* @param [options] Optional options. | ||
* @returns When no item is found, null is returned when a single item was requested, | ||
* and and empty Array is returned in case of multiple id's. | ||
* | ||
* @memberOf DataSet | ||
*/ | ||
@@ -479,5 +444,3 @@ get(ids: IdType[], options?: DataSelectionOptions<T>): T[]; | ||
* | ||
* @returns {DataSet<T>} The DataSet itself. | ||
* | ||
* @memberOf DataSet | ||
* @returns The DataSet itself. | ||
*/ | ||
@@ -489,6 +452,3 @@ getDataSet(): DataSet<T>; | ||
* | ||
* @param {DataSelectionOptions<T>} [options] | ||
* @returns {IdType[]} ids of all items or of a filtered set of items. | ||
* | ||
* @memberOf DataSet | ||
* @returns ids of all items or of a filtered set of items. | ||
*/ | ||
@@ -500,7 +460,5 @@ getIds(options?: DataSelectionOptions<T>): IdType[]; | ||
* | ||
* @param {(item: T, id: IdType) => T} callback The mapping callback. | ||
* @param {DataSelectionOptions<T>} [options] Optional options. | ||
* @returns {T[]} The mapped items. | ||
* | ||
* @memberOf DataSet | ||
* @param callback The mapping callback. | ||
* @param [options] Optional options. | ||
* @returns The mapped items. | ||
*/ | ||
@@ -512,6 +470,3 @@ map(callback: (item: T, id: IdType) => any, options?: DataSelectionOptions<T>): any[]; | ||
* | ||
* @param {string} field | ||
* @returns {T} Returns null if no item is found. | ||
* | ||
* @memberOf DataSet | ||
* @returns Returns null if no item is found. | ||
*/ | ||
@@ -523,6 +478,3 @@ max(field: string): T; | ||
* | ||
* @param {string} field | ||
* @returns {T} Returns null if no item is found. | ||
* | ||
* @memberOf DataSet | ||
* @returns Returns null if no item is found. | ||
*/ | ||
@@ -534,7 +486,5 @@ min(field: string): T; | ||
* | ||
* @param {string} event The event name. | ||
* @param {((event: string, properties: any, senderId: IdType) => void)} callback | ||
* @param event The event name. | ||
* @param callback | ||
* a callback function which will be called each time the event occurs. | ||
* | ||
* @memberOf DataSet | ||
*/ | ||
@@ -546,7 +496,5 @@ on(event: string, callback: (event: string, properties: any, senderId: IdType) => void): void; | ||
* | ||
* @param {string} event The event name. | ||
* @param {((event: string, properties: any, senderId: IdType) => void)} callback | ||
* @param event The event name. | ||
* @param callback | ||
* The exact same callback that was used when calling 'on'. | ||
* | ||
* @memberOf DataSet | ||
*/ | ||
@@ -558,7 +506,5 @@ off(event: string, callback: (event: string, properties: any, senderId: IdType) => void): void; | ||
* | ||
* @param {IdType} id The item id. | ||
* @param {IdType} [senderId] The sender id. | ||
* @returns {IdType[]} Returns an array with the ids of the removed items. | ||
* | ||
* @memberOf DataSet | ||
* @param id The item id. | ||
* @param [senderId] The sender id. | ||
* @returns Returns an array with the ids of the removed items. | ||
*/ | ||
@@ -569,6 +515,2 @@ remove(id: IdType | IdType[], senderId?: IdType): IdType[]; | ||
* Set options for the DataSet. | ||
* | ||
* @param {DataSetQueueOptions} [options] | ||
* | ||
* @memberOf DataSet | ||
*/ | ||
@@ -581,7 +523,4 @@ setOptions(options?: DataSetQueueOptions): void; | ||
* | ||
* @param {(T | T[])} data a single item or an array with items. | ||
* @param {IdType} [senderId] | ||
* @returns {IdType[]} Returns an array with the ids of the updated items. | ||
* | ||
* @memberOf DataSet | ||
* @param data a single item or an array with items. | ||
* @returns Returns an array with the ids of the updated items. | ||
*/ | ||
@@ -595,4 +534,2 @@ update(data: T | T[], senderId?: IdType): IdType[]; | ||
* These methods can have these options as a parameter. | ||
* | ||
* @interface DataSelectionOptions | ||
*/ | ||
@@ -606,5 +543,2 @@ export interface DataSelectionOptions<T> { | ||
* in fields will be included in the returned items. | ||
* | ||
* @type {(string[] | any)} | ||
* @memberOf DataSelectionOptions | ||
*/ | ||
@@ -619,5 +553,2 @@ fields?: string[] | any; | ||
* or convert strings to numbers or vice versa. The available data types are listed in section Data Types. | ||
* | ||
* @type {*} | ||
* @memberOf DataSelectionOptions | ||
*/ | ||
@@ -633,4 +564,2 @@ type?: any; | ||
* See section Data Filtering. | ||
* | ||
* @memberOf DataSelectionOptions | ||
*/ | ||
@@ -641,5 +570,2 @@ filter?(item: T): boolean; | ||
* Order the items by a field name or custom sort function. | ||
* | ||
* @type {(string | any)} | ||
* @memberOf DataSelectionOptions | ||
*/ | ||
@@ -653,5 +579,2 @@ order?: string | any; | ||
* The Object type will return a JSON object with the ID's as keys. | ||
* | ||
* @type {string} | ||
* @memberOf DataSelectionOptions | ||
*/ | ||
@@ -954,6 +877,2 @@ returnType?: string; | ||
* To handle a larger amount of nodes, Network has clustering support. Network uses HTML canvas for rendering. | ||
* | ||
* @export | ||
* @class Network | ||
* @implements {INetwork} | ||
*/ | ||
@@ -964,7 +883,5 @@ export class Network { | ||
* | ||
* @param {HTMLElement} container the HTML element representing the network container | ||
* @param {IData} data network data | ||
* @param {IOptions} [options] optional network options | ||
* | ||
* @memberOf Network | ||
* @param container the HTML element representing the network container | ||
* @param data network data | ||
* @param [options] optional network options | ||
*/ | ||
@@ -975,4 +892,2 @@ constructor(container: HTMLElement, data: Data, options?: Options); | ||
* Remove the network from the DOM and remove all Hammer bindings and references. | ||
* | ||
* @memberOf Network | ||
*/ | ||
@@ -987,5 +902,3 @@ destroy(): void; | ||
* | ||
* @param {IData} data network data | ||
* | ||
* @memberOf Network | ||
* @param data network data | ||
*/ | ||
@@ -999,5 +912,3 @@ setData(data: Data): void; | ||
* | ||
* @param {IOptions} options network options | ||
* | ||
* @memberOf Network | ||
* @param options network options | ||
*/ | ||
@@ -1010,6 +921,4 @@ setOptions(options: Options): void; | ||
* | ||
* @param {string} eventName the name of the event, f.e. 'click' | ||
* @param {(params?: any) => void} callback the callback function that will be raised | ||
* | ||
* @memberOf Network | ||
* @param eventName the name of the event, f.e. 'click' | ||
* @param callback the callback function that will be raised | ||
*/ | ||
@@ -1023,6 +932,4 @@ on(eventName: NetworkEvents, callback: (params?: any) => void): void; | ||
* | ||
* @param {string} eventName the name of the event, f.e. 'click' | ||
* @param {(params?: any) => void} [callback] the exact same callback function that was used when calling 'on' | ||
* | ||
* @memberOf Network | ||
* @param eventName the name of the event, f.e. 'click' | ||
* @param [callback] the exact same callback function that was used when calling 'on' | ||
*/ | ||
@@ -1036,6 +943,4 @@ off(eventName: NetworkEvents, callback?: (params?: any) => void): void; | ||
* | ||
* @param {string} eventName the name of the event, f.e. 'click' | ||
* @param {(params?: any) => void} callback the callback function that will be raised once | ||
* | ||
* @memberOf Network | ||
* @param eventName the name of the event, f.e. 'click' | ||
* @param callback the callback function that will be raised once | ||
*/ | ||
@@ -1049,6 +954,4 @@ once(eventName: NetworkEvents, callback: (params?: any) => void): void; | ||
* | ||
* @param {IPosition} position the canvas coordinates | ||
* @returns {IPosition} the DOM coordinates | ||
* | ||
* @memberOf Network | ||
* @param position the canvas coordinates | ||
* @returns the DOM coordinates | ||
*/ | ||
@@ -1062,6 +965,4 @@ canvasToDOM(position: Position): Position; | ||
* | ||
* @param {IPosition} position the DOM coordinates | ||
* @returns {IPosition} the canvas coordinates | ||
* | ||
* @memberOf Network | ||
* @param position the DOM coordinates | ||
* @returns the canvas coordinates | ||
*/ | ||
@@ -1072,4 +973,2 @@ DOMtoCanvas(position: Position): Position; | ||
* Redraw the network. | ||
* | ||
* @memberOf Network | ||
*/ | ||
@@ -1082,6 +981,4 @@ redraw(): void; | ||
* | ||
* @param {string} width width in a common format, f.e. '100px' | ||
* @param {string} height height in a common format, f.e. '100px' | ||
* | ||
* @memberOf Network | ||
* @param width width in a common format, f.e. '100px' | ||
* @param height height in a common format, f.e. '100px' | ||
*/ | ||
@@ -1092,6 +989,2 @@ setSize(width: string, height: string): void; | ||
* The joinCondition function is presented with all nodes. | ||
* | ||
* @param {IClusterOptions} [options] | ||
* | ||
* @memberOf Network | ||
*/ | ||
@@ -1106,6 +999,4 @@ cluster(options?: ClusterOptions): void; | ||
* | ||
* @param {string} nodeId the id of the node | ||
* @param {IClusterOptions} [options] the cluster options | ||
* | ||
* @memberOf Network | ||
* @param nodeId the id of the node | ||
* @param [options] the cluster options | ||
*/ | ||
@@ -1122,6 +1013,4 @@ clusterByConnection(nodeId: string, options?: ClusterOptions): void; | ||
* | ||
* @param {number} [hubsize] optional hubsize | ||
* @param {IClusterOptions} [options] optional cluster options | ||
* | ||
* @memberOf Network | ||
* @param [hubsize] optional hubsize | ||
* @param [options] optional cluster options | ||
*/ | ||
@@ -1133,5 +1022,3 @@ clusterByHubsize(hubsize?: number, options?: ClusterOptions): void; | ||
* | ||
* @param {IClusterOptions} [options] optional cluster options | ||
* | ||
* @memberOf Network | ||
* @param [options] optional cluster options | ||
*/ | ||
@@ -1151,6 +1038,4 @@ clusterOutliers(options?: ClusterOptions): void; | ||
* | ||
* @param {IdType} nodeId the node id. | ||
* @returns {IdType[]} an array of nodeIds showing where the node is | ||
* | ||
* @memberOf Network | ||
* @param nodeId the node id. | ||
* @returns an array of nodeIds showing where the node is | ||
*/ | ||
@@ -1163,4 +1048,4 @@ findNode(nodeId: IdType): IdType[]; | ||
* | ||
* @param {IdType} baseEdgeId the base edge id | ||
* @returns {IdType[]} an array of edgeIds | ||
* @param baseEdgeId the base edge id | ||
* @returns an array of edgeIds | ||
*/ | ||
@@ -1174,5 +1059,2 @@ getClusteredEdges(baseEdgeId: IdType): IdType[]; | ||
* This method can then be used to return the baseEdgeId. | ||
* | ||
* @param {IdType} clusteredEdgeId | ||
* @returns {IdType} | ||
*/ | ||
@@ -1187,5 +1069,2 @@ getBaseEdge(clusteredEdgeId: IdType): IdType; | ||
* and applys the options to it and any edges that were created from it while clustering. | ||
* | ||
* @param {IdType} startEdgeId | ||
* @param {IEdgeOptions} [options] | ||
*/ | ||
@@ -1203,6 +1082,3 @@ updateEdge(startEdgeId: IdType, options?: EdgeOptions): void; | ||
* | ||
* @param {IdType} nodeId the node id. | ||
* @returns {boolean} | ||
* | ||
* @memberOf Network | ||
* @param nodeId the node id. | ||
*/ | ||
@@ -1215,6 +1091,3 @@ isCluster(nodeId: IdType): boolean; | ||
* | ||
* @param {IdType} clusterNodeId the id of the cluster node | ||
* @returns {IdType[]} | ||
* | ||
* @memberOf Network | ||
* @param clusterNodeId the id of the cluster node | ||
*/ | ||
@@ -1230,6 +1103,4 @@ getNodesInCluster(clusterNodeId: IdType): IdType[]; | ||
* | ||
* @param {IdType} nodeId the node id | ||
* @param {IOpenClusterOptions} [options] optional open cluster options | ||
* | ||
* @memberOf Network | ||
* @param nodeId the node id | ||
* @param [options] optional open cluster options | ||
*/ | ||
@@ -1243,5 +1114,3 @@ openCluster(nodeId: IdType, options?: OpenClusterOptions): void; | ||
* | ||
* @returns {number} the current seed of the network. | ||
* | ||
* @memberOf Network | ||
* @returns the current seed of the network. | ||
*/ | ||
@@ -1253,4 +1122,2 @@ getSeed(): number; | ||
* Similar effect to pressing the edit button. | ||
* | ||
* @memberOf Network | ||
*/ | ||
@@ -1262,4 +1129,2 @@ enableEditMode(): void; | ||
* Similar effect to pressing the close icon (small cross in the corner of the toolbar). | ||
* | ||
* @memberOf Network | ||
*/ | ||
@@ -1273,4 +1138,2 @@ disableEditMode(): void; | ||
* To use these methods without having the manipulation GUI, make sure you set enabled to false. | ||
* | ||
* @memberOf Network | ||
*/ | ||
@@ -1282,4 +1145,2 @@ addNodeMode(): void; | ||
* The explaination from addNodeMode applies here as well. | ||
* | ||
* @memberOf Network | ||
*/ | ||
@@ -1291,4 +1152,2 @@ editNode(): void; | ||
* The explaination from addNodeMode applies here as well. | ||
* | ||
* @memberOf Network | ||
*/ | ||
@@ -1300,4 +1159,2 @@ addEdgeMode(): void; | ||
* The explaination from addNodeMode applies here as well. | ||
* | ||
* @memberOf Network | ||
*/ | ||
@@ -1309,4 +1166,2 @@ editEdgeMode(): void; | ||
* Having edit mode or manipulation enabled is not required. | ||
* | ||
* @memberOf Network | ||
*/ | ||
@@ -1321,7 +1176,2 @@ deleteSelected(): void; | ||
* When nothing is supplied, the positions of all nodes are returned. | ||
* | ||
* @param {string[]} nodeIds | ||
* @returns {{[nodeId: IdType]: IPosition}} | ||
* | ||
* @memberOf Network | ||
*/ | ||
@@ -1344,4 +1194,2 @@ getPositions(nodeIds?: IdType[]): { [nodeId: string]: Position }; | ||
* they cannot be correctly initialized from just the positions. | ||
* | ||
* @memberOf Network | ||
*/ | ||
@@ -1354,7 +1202,5 @@ storePositions(): void; | ||
* | ||
* @param {IdType} nodeId the node that will be moved | ||
* @param {number} x new canvas space x position | ||
* @param {number} y new canvas space y position | ||
* | ||
* @memberOf Network | ||
* @param nodeId the node that will be moved | ||
* @param x new canvas space x position | ||
* @param y new canvas space y position | ||
*/ | ||
@@ -1366,6 +1212,2 @@ moveNode(nodeId: IdType, x: number, y: number): void; | ||
* | ||
* @param {IdType} nodeId | ||
* @returns {IBoundingBox} | ||
* | ||
* @memberOf Network | ||
*/ | ||
@@ -1379,6 +1221,3 @@ getBoundingBox(nodeId: IdType): BoundingBox; | ||
* | ||
* @param {IdType} nodeOrEdgeId a node or edge id | ||
* @returns {(IdType[] | {fromId: IdType, toId: IdType}[])} | ||
* | ||
* @memberOf Network | ||
* @param nodeOrEdgeId a node or edge id | ||
*/ | ||
@@ -1390,6 +1229,3 @@ getConnectedNodes(nodeOrEdgeId: IdType): IdType[] | Array<{ fromId: IdType, toId: IdType }>; | ||
* | ||
* @param {IdType} nodeId the node id | ||
* @returns {IdType[]} | ||
* | ||
* @memberOf Network | ||
* @param nodeId the node id | ||
*/ | ||
@@ -1402,4 +1238,2 @@ getConnectedEdges(nodeId: IdType): IdType[]; | ||
* if you stop the simulation yourself and wish to continue it afterwards. | ||
* | ||
* @memberOf Network | ||
*/ | ||
@@ -1412,4 +1246,2 @@ startSimulation(): void; | ||
* altering the dataset or calling startSimulation(). | ||
* | ||
* @memberOf Network | ||
*/ | ||
@@ -1423,5 +1255,3 @@ stopSimulation(): void; | ||
* | ||
* @param {number} [iterations] the number of iterations it should do | ||
* | ||
* @memberOf Network | ||
* @param [iterations] the number of iterations it should do | ||
*/ | ||
@@ -1433,5 +1263,2 @@ stabilize(iterations?: number): void; | ||
* | ||
* @returns {{ nodes: IdType[], edges: IdType[] }} | ||
* | ||
* @memberOf Network | ||
*/ | ||
@@ -1444,5 +1271,2 @@ getSelection(): { nodes: IdType[], edges: IdType[] }; | ||
* | ||
* @returns {IdType[]} | ||
* | ||
* @memberOf Network | ||
*/ | ||
@@ -1455,5 +1279,2 @@ getSelectedNodes(): IdType[]; | ||
* | ||
* @returns {IdType[]} | ||
* | ||
* @memberOf Network | ||
*/ | ||
@@ -1466,6 +1287,2 @@ getSelectedEdges(): IdType[]; | ||
* | ||
* @param {IPosition} position | ||
* @returns {IdType} | ||
* | ||
* @memberOf Network | ||
*/ | ||
@@ -1478,6 +1295,2 @@ getNodeAt(position: Position): IdType; | ||
* | ||
* @param {IPosition} position | ||
* @returns {IdType} | ||
* | ||
* @memberOf Network | ||
*/ | ||
@@ -1491,6 +1304,2 @@ getEdgeAt(position: Position): IdType; | ||
* | ||
* @param {IdType[]} nodeIds | ||
* @param {boolean} [highlightEdges] | ||
* | ||
* @memberOf Network | ||
*/ | ||
@@ -1504,5 +1313,2 @@ selectNodes(nodeIds: IdType[], highlightEdges?: boolean): void; | ||
* | ||
* @param {IdType[]} edgeIds | ||
* | ||
* @memberOf Network | ||
*/ | ||
@@ -1515,6 +1321,2 @@ selectEdges(edgeIds: IdType[]): void; | ||
* | ||
* @param {{ nodes: IdType[], edges: IdType[] }} selection | ||
* @param {ISelectionOptions} [options] | ||
* | ||
* @memberOf Network | ||
*/ | ||
@@ -1526,4 +1328,2 @@ setSelection(selection: { nodes: IdType[], edges: IdType[] }, options?: SelectionOptions): void; | ||
* Does not fire events. | ||
* | ||
* @memberOf Network | ||
*/ | ||
@@ -1536,5 +1336,3 @@ unselectAll(): void; | ||
* | ||
* @returns {number} the current scale of the network | ||
* | ||
* @memberOf Network | ||
* @returns the current scale of the network | ||
*/ | ||
@@ -1546,5 +1344,3 @@ getScale(): number; | ||
* | ||
* @returns {IPosition} the view position; | ||
* | ||
* @memberOf Network | ||
* @returns the view position; | ||
*/ | ||
@@ -1556,5 +1352,3 @@ getViewPosition(): Position; | ||
* | ||
* @param {IFitOptions} [options] All options are optional for the fit method | ||
* | ||
* @memberOf Network | ||
* @param [options] All options are optional for the fit method | ||
*/ | ||
@@ -1568,6 +1362,2 @@ fit(options?: FitOptions): void; | ||
* | ||
* @param {IdType} nodeId | ||
* @param {IFocusOptions} [options] | ||
* | ||
* @memberOf Network | ||
*/ | ||
@@ -1579,5 +1369,2 @@ focus(nodeId: IdType, options?: FocusOptions): void; | ||
* | ||
* @param {IMoveToOptions} options | ||
* | ||
* @memberOf Network | ||
*/ | ||
@@ -1588,4 +1375,2 @@ moveTo(options: MoveToOptions): void; | ||
* Programatically release the focussed node. | ||
* | ||
* @memberOf Network | ||
*/ | ||
@@ -1598,5 +1383,2 @@ releaseNode(): void; | ||
* | ||
* @returns {*} | ||
* | ||
* @memberOf Network | ||
*/ | ||
@@ -1608,6 +1390,2 @@ getOptionsFromConfigurator(): any; | ||
* Options interface for focus function. | ||
* | ||
* @export | ||
* @interface IFocusOptions | ||
* @extends {IViewPortOptions} | ||
*/ | ||
@@ -1619,5 +1397,2 @@ export interface FocusOptions extends ViewPortOptions { | ||
* Default value is true. | ||
* | ||
* @type {boolean} | ||
* @memberOf IFocusOptions | ||
*/ | ||
@@ -1629,5 +1404,2 @@ locked?: boolean; | ||
* Base options interface for some viewport functions. | ||
* | ||
* @export | ||
* @interface IViewPortOptions | ||
*/ | ||
@@ -1638,5 +1410,2 @@ export interface ViewPortOptions { | ||
* Default value is 1.0. | ||
* | ||
* @type {number} the scale. | ||
* @memberOf IFocusOptions | ||
*/ | ||
@@ -1648,5 +1417,2 @@ scale?: number; | ||
* Default value is {x:0,y:0} | ||
* | ||
* @type {IPosition} | ||
* @memberOf IFocusOptions | ||
*/ | ||
@@ -1658,5 +1424,2 @@ offset?: Position; | ||
* disable it or you can define the duration (in milliseconds) and easing function manually. | ||
* | ||
* @type {(IAnimationOptions | boolean)} | ||
* @memberOf IFitOptions | ||
*/ | ||
@@ -1669,6 +1432,2 @@ animation?: AnimationOptions | boolean; | ||
* Otherwise, there is nothing to move to. | ||
* | ||
* @export | ||
* @interface IMoveToOptions | ||
* @extends {IViewPortOptions} | ||
*/ | ||
@@ -1678,5 +1437,2 @@ export interface MoveToOptions extends ViewPortOptions { | ||
* The position (in canvas units!) is the position of the central focus point of the camera. | ||
* | ||
* @type {IPosition} | ||
* @memberOf IMoveToOptions | ||
*/ | ||
@@ -1688,5 +1444,2 @@ position?: Position; | ||
* Animation options interface. | ||
* | ||
* @export | ||
* @interface IAnimationOptions | ||
*/ | ||
@@ -1696,5 +1449,2 @@ export interface AnimationOptions { | ||
* The duration (in milliseconds). | ||
* | ||
* @type {number} | ||
* @memberOf IAnimationOptions | ||
*/ | ||
@@ -1709,5 +1459,2 @@ duration: number; | ||
* easeInQuint, easeOutQuint, easeInOutQuint. | ||
* | ||
* @type {string} | ||
* @memberOf IAnimationOptions | ||
*/ | ||
@@ -1719,5 +1466,2 @@ easingFunction: string; | ||
* Optional options for the fit method. | ||
* | ||
* @export | ||
* @interface IFitOptions | ||
*/ | ||
@@ -1727,5 +1471,2 @@ export interface FitOptions { | ||
* The nodes can be used to zoom to fit only specific nodes in the view. | ||
* | ||
* @type {string[]} | ||
* @memberOf IFitOptions | ||
*/ | ||
@@ -1737,5 +1478,2 @@ nodes?: string[]; | ||
* disable it or you can define the duration (in milliseconds) and easing function manually. | ||
* | ||
* @type {(IAnimationOptions | boolean)} | ||
* @memberOf IFitOptions | ||
*/ | ||
@@ -1752,5 +1490,2 @@ animation: AnimationOptions | boolean; | ||
* These values are in canvas space. | ||
* | ||
* @export | ||
* @interface IBoundingBox | ||
*/ | ||
@@ -1766,5 +1501,2 @@ export interface BoundingBox { | ||
* Cluster methods options interface. | ||
* | ||
* @export | ||
* @interface IClusterOptions | ||
*/ | ||
@@ -1778,4 +1510,2 @@ export interface ClusterOptions { | ||
* as well as any custom fields you may have added to the node to determine whether or not to include it in the cluster. | ||
* | ||
* @memberOf IClusterOptions | ||
*/ | ||
@@ -1790,5 +1520,2 @@ joinCondition?(nodeOptions: any): boolean; | ||
* The function should return the properties to create the cluster node. | ||
* | ||
* @type {(clusterOptions: any, childNodesOptions: any[], childEdgesOptions: any[])} | ||
* @memberOf IClusterOptions | ||
*/ | ||
@@ -1804,5 +1531,2 @@ processProperties?(clusterOptions: any, childNodesOptions: any[], childEdgesOptions: any[]): any; | ||
* If undefined, default node options will be used. | ||
* | ||
* @type {INodeOptions} | ||
* @memberOf IClusterOptions | ||
*/ | ||
@@ -1818,5 +1542,2 @@ clusterNodeProperties?: NodeOptions; | ||
* If undefined, default edge options will be used. | ||
* | ||
* @type {IEdgeOptions} | ||
* @memberOf IClusterOptions | ||
*/ | ||
@@ -1828,5 +1549,2 @@ clusterEdgeProperties?: EdgeOptions; | ||
* Options for the openCluster function of Network. | ||
* | ||
* @export | ||
* @interface IOpenClusterOptions | ||
*/ | ||
@@ -1845,4 +1563,2 @@ export interface OpenClusterOptions { | ||
* This is also the default behaviour when no releaseFunction is defined. | ||
* | ||
* @memberOf IOpenClusterOptions | ||
*/ | ||
@@ -1849,0 +1565,0 @@ releaseFunction( |
{ | ||
"name": "@types/vis", | ||
"version": "4.18.8", | ||
"version": "4.18.9", | ||
"description": "TypeScript definitions for vis.js", | ||
@@ -52,4 +52,4 @@ "license": "MIT", | ||
}, | ||
"typesPublisherContentHash": "f9bef3da90ea3123ca729215579ab094bfdeb6086b266b3d77e23b5ee1f579ff", | ||
"typesPublisherContentHash": "44950282ddbf5f913edabc739c5a6e17ca05669b5a78112e49ace3f166f1dc06", | ||
"typeScriptVersion": "2.0" | ||
} |
@@ -11,3 +11,3 @@ # Installation | ||
Additional Details | ||
* Last updated: Wed, 25 Oct 2017 18:38:06 GMT | ||
* Last updated: Thu, 26 Oct 2017 15:07:04 GMT | ||
* Dependencies: moment | ||
@@ -14,0 +14,0 @@ * Global values: vis |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
56329
1522