Skip to content

Latest commit

 

History

History
448 lines (375 loc) · 12 KB

typedefFunctionList.adoc

File metadata and controls

448 lines (375 loc) · 12 KB

/** * Listener callback function. * @typedef {function} * @name ListenCallback * @param {Object} e Event object. */

/** * Listener callback function. * @typedef {function} * @name Callback * @param {Object} e Event object. * @return {boolean|undefined} */

/** * Fill function. * @typedef {function} * @name FillFunction * @return {anychart.graphics.vector.Fill} Fill settings. */

/** * Stroke function. * @typedef {function} * @name StrokeFunction * @return {(anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill)} Stroke settings. */

/** * Hatch fill function. * @typedef {function} * @name HatchFillFunction * @return {anychart.graphics.vector.HatchFill} hatchFill Hatch fill settings. */

/** * Dimmer function. * @typedef {function} * @name DimmerFunction * @param {anychart.graphics.vector.Fill} fill Fill. * @return {anychart.graphics.vector.Fill} Resulting dimmer fill. */

/** * Duration function. * @typedef {function} * @name DurationFunction * @return {number} The duration. */

/** * Inner radius function. * @typedef {function} * @name innerRadiusFunction * @param {number} outerRadius Outer radius. * @return {number} Inner radius. */

/** * Sort Sunburst function. * @typedef {function} * @name SortFunction * @param {anychart.data.Tree.DataItem|anychart.data.TreeView.DataItem} dataItem_1 The first data item. * @param {anychart.data.Tree.DataItem|anychart.data.TreeView.DataItem} dataItem_2 The second data item. * @return {number} Resulting sort value. */

/* * Sorting view function. * @typedef {function} * @name SortingFunction * @param {} value1 * @param {*} value2 * @return {number} Sorting value. */

/* * CSV settings function. * @typedef {function} * @name csvSettingsFunction * @param {} name Field name. * @param {*} value Value. */

/** * Content function. * @typedef {function} * @name ContentFunction * @param {anychart.graphics.vector.Path} path Buttons content */

/** * Ticks type function. * @typedef {function} * @name TicksTypeFunction * @param {anychart.graphics.vector.Path} path Path. * @param {number} x X-coordinate. * @param {number} y Y-coordinate. * @param {number} radius Radius. */

/** * Overrider function. * @typedef {function} * @name OverriderFunction * @param {anychart.core.ui.LabelsFactory.Label} label Label. * @param {anychart.data.Tree.DataItem} item Data item. */

/** * OnEdit function. * @typedef {function} * @name OnEditFunction * @return {Object|undefined} OnEdit function. */

/** * Format function. * @typedef {function} * @name FormatDataGridFunction * @param {anychart.data.Tree.DataItem} item Data item. */

/** * Items formatter function (Legend). * @typedef {function} * @name ItemsFormatterFunction * @param {Array.<anychart.core.ui.Legend.LegendItemProvider>} items Items array. * @return {Array.<anychart.core.ui.Legend.LegendItemProvider>} Formatted value. */

/** * Items formatter function (ContextMenu). * @typedef {function} * @name ItemsFormatterContextMenuFunction * @param {Object} item1 ContextMenu item. * @param {Object} item2 ContextMenu item. * @param {anychart.ui.ContextMenu.PrepareItemsContext} context Items context. * @return {Object} Formatted items. */

/** * Items text format function. * @typedef {function} * @name ItemsFormatFunction * @param {Object} value Options. * @return {string} Formatted value. */

/** * Function to format title text. * @typedef {function} * @name FormatTooltipFunction * @return {string} Formatted text. */

/* * Position formatter function. * @typedef {function} * @name PositionFormatterFunction * @param {} positionProvider * @param {number} index * @return {anychart.math.CoordinateObject} Coordinate object. */

/** * Function that is called when sharing is complete. * @typedef {function} * @name OnSuccess * @param {string} response Response to success. */

/** * Function that is called if sharing fails. * @typedef {function} * @name OnError * @param {string} response Response to error. */

/** * Success function (Json). * @typedef {function} * @name OnSuccessLoadJsonFile * @param {Array.<Object|string|number|boolean|null>} data Data array. */

/** * Error function. * @typedef {function} * @name OnErrorLoadJsonFile * @param {number} errorCode Error code. * @param {string} errorMessage Error message. */

/** * Success function (Xml). * @typedef {function} * @name OnSuccessLoadXmlFile * @param {Object} data Data object. */

/** * Success function (Csv). * @typedef {function} * @name OnSuccessLoadCsvFile * @param {Array<string>} data Data array. */

/** * Error function. * @typedef {function} * @name OnErrorExceptionMessage * @param {number} errorCode Error code. * @param {Object|string} exceptionOrMessage Exception object or error message */

/** * Success function. * @typedef {function} * @name OnSuccessLoadGoogleSpreadsheet * @param {anychart.data.DataSettings} data Data object. * @param {Object} settings */

/** * Handler function. * @typedef {function} * @name HandlerFunction * @return {boolean} hatchFill Handler function. */

/** * Start function. * @typedef {function} * @name StartFunction * @param {Object} context The context value from {@link anychart.data.TableComputer#setContext} method. */

/** * Calculation function. * @typedef {function} * @name CalculationFunction * @param {anychart.data.TableComputer.RowProxy} rowProxy * @param {Object} context */

/** * Condition function. * @typedef {function} * @name ConditionFunction * @param {anychart.data.Tree.DataItem|anychart.data.TreeView.DataItem} dataItem * @return {boolean} Boolean flag. */

/* * Comparison function. * @typedef {function} * @name ComparisonFunction * @param {} value1 Value to compare. * @param {*} value2 Value to compare. */

/* * Grouping function. * @typedef {function} * @name GroupingFunction * @param {} value Value to group. * @return {boolean} Filter result. */

/** * Filter tree function. * @typedef {function} * @name FilterTreeFunction * @param {(anychart.data.Tree.DataItem|anychart.data.TreeView.DataItem)} item Data item. */

/* * Filter view function. * @typedef {function} * @name FilterViewFunction * @param {} val */

/** * Callback function. * @typedef {function} * @name CallbackFunction * @param {anychart.graphics.vector.Element} element * @return {void} */

/** * Items provider function (ContextMenu). * @typedef {function} * @name ItemsProviderContextMenuFunction * @param {anychart.ui.ContextMenu.PrepareItemsContext} itemsContext1 ContextMenu item. * @param {anychart.ui.ContextMenu.PrepareItemsContext} itemsContext2 ContextMenu item. * @return {Object} Formatted context menu items. */

/** * Marker type function. * @typedef {function} * @name MarkerTypeFunction * @param {anychart.graphics.vector.Path} path Path * @param {number} x X-coordinate. * @param {number} y Y-coordinate. * @param {number} size Marker size * @return {anychart.graphics.vector.Path} Return path */

/** * Marker type function. * @typedef {function} * @name IconTypeFunction * @param {anychart.graphics.vector.Path} path Path * @param {number} size Icon size */