Skip to content

Latest commit

 

History

History
218 lines (173 loc) · 6.37 KB

Point.adoc

File metadata and controls

218 lines (173 loc) · 6.37 KB

/** * Class that wraps point of series/chart. * @param {anychart.core.SeparateChart} chart Chart points belongs to. * @param {number} index Point index in chart. * @constructor */ anychart.core.Point;

/** * Getter for the point index in chart or series. * @category Specific settings * @example anychart.core.Point.getIndex * @return {number} Index of point. * @since 7.8.0 */ anychart.core.Point.prototype.getIndex;

/** * Getter for the chart which current point belongs to. * @category Charts * @example anychart.core.Point.getChart * @return {anychart.core.SeparateChart} The current chart. * @since 7.8.0 */ anychart.core.Point.prototype.getChart;

/* * Fetches a field value from point data row by its name. * @category Data * @example anychart.core.Point.get * @param {string} field Field in data row. * @return {} Field value. * @since 7.8.0 */ anychart.core.Point.prototype.get;

/* * Sets the field of the point data row to the specified value. * @category Data * @example anychart.core.Point.set * @param {string} field Field. * @param {} value Value to set. * @return {anychart.core.Point} Self instance for method chaining. * @since 7.8.0 */ anychart.core.Point.prototype.set;

/** * Getter for the hover point state. * @shortDescription Hover point state. * @category Point Elements * @example anychart.core.Point.hovered_get * @return {boolean} Returns the hover state. * @since 7.8.0 */ anychart.core.Point.prototype.hovered;

/** * Setter for hover point state. * @example anychart.core.Point.hovered_set * @param {boolean=} opt_enabled [false] Hover state to set. * @return {anychart.core.Point} Self instance for method chaining. * @since 7.8.0 */ anychart.core.Point.prototype.hovered;

/** * Getter for the select point state. * @shortDescription Select point state. * @category Point Elements * @listing See listing * var point = chart.getPoint(1); * var selected = point.selected(); * @return {boolean} Select point state. * @since 7.8.0 */ anychart.core.Point.prototype.selected;

/** * Setter for select point state. * @example anychart.core.Point.selected_set * @param {boolean=} opt_enabled [false] Select state to set. * @return {anychart.core.Point} Self instance for method chaining. * @since 7.8.0 */ anychart.core.Point.prototype.selected;

/** * Checks the existence of the current point (by index) in dataset. * @category Data * @detailed If you request an index that bigger than exist in an array, you will get empty points. * If you set a value for this point, then this value will be added to the end of array dataset. * @example anychart.core.Point.exists * @return {boolean} Whether point exists in dataset or not. * @since 7.8.0 */ anychart.core.Point.prototype.exists;

/* * Getter for the statistics value by key. * @category Data * @example anychart.core.Point.getStat * @param {(anychart.enums.Statistics|string)} key Key. * @return {} Statistics value. * @since 7.10.0 */ anychart.core.Point.prototype.getStat;

/** @inheritDoc */ anychart.core.PiePoint.prototype.getIndex;

/** @inheritDoc */ anychart.core.PiePoint.prototype.getChart;

/** @inheritDoc */ anychart.core.PiePoint.prototype.get;

/** @inheritDoc */ anychart.core.PiePoint.prototype.set;

/** @inheritDoc */ anychart.core.PiePoint.prototype.hovered;

/** @inheritDoc */ anychart.core.SeriesPoint.prototype.getIndex;

/** @inheritDoc */ anychart.core.SeriesPoint.prototype.getChart;

/** @inheritDoc */ anychart.core.SeriesPoint.prototype.get;

/** @inheritDoc */ anychart.core.SeriesPoint.prototype.set;

/** @inheritDoc */ anychart.core.BubblePoint.prototype.getSeries;

/** @inheritDoc */ anychart.core.BubblePoint.prototype.getStackValue;

/** @inheritDoc */ anychart.core.BubblePoint.prototype.getStackZero;

/** @inheritDoc */ anychart.core.BubblePoint.prototype.selected;

/** @inheritDoc */ anychart.core.BubblePoint.prototype.hovered;

/** @inheritDoc */ anychart.core.BubblePoint.prototype.getIndex;

/** @inheritDoc */ anychart.core.BubblePoint.prototype.getChart;

/** @inheritDoc */ anychart.core.BubblePoint.prototype.get;

/** @inheritDoc */ anychart.core.BubblePoint.prototype.set;