Skip to content

Latest commit

 

History

History
145 lines (120 loc) · 4.7 KB

SeriesPoint.adoc

File metadata and controls

145 lines (120 loc) · 4.7 KB

/** * Point representing all points that belongs to series-based chart. * @param {anychart.core.SeriesBase} series Series. * @param {number} index Point index in series. * @constructor * @extends {anychart.core.Point} */ anychart.core.SeriesPoint;

/** * Getter for series which current point belongs to. * @category Series * @example anychart.core.SeriesPoint.getSeries * @return {anychart.core.SeriesBase} Series. * @since 7.8.0 */ anychart.core.SeriesPoint.prototype.getSeries;

/** * Returns stack value of the point. * <b>Note</b>: Works only after chart.draw() is called. * @category Data * @example anychart.core.SeriesPoint.getStackValue * @return {number} Returns stack value of the point. * @since 7.8.0 */ anychart.core.SeriesPoint.prototype.getStackValue;

/** * Returns stack zero of the point.<br> * <b>Note</b>: Works only after chart.draw() is called. * @category Data * @example anychart.core.SeriesPoint.getStackZero * @return {number} Returns stack zero of the point * @since 7.8.0 */ anychart.core.SeriesPoint.prototype.getStackZero;

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

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

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

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

/** * Checks if the point with the given index exists in a dataset. * @detailed If you request an index that is bigger than array length you will get empty points. * If you set a value to this point, this value will not be added to array dataset. * @category Data * @example anychart.core.SeriesPoint.exists * @return {boolean} Whether point exists in dataset or not. * @since 7.8.0 */ anychart.core.SeriesPoint.prototype.exists;

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

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

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

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

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