Skip to content

InfiniteLine.adoc

Latest commit

 

History

History
263 lines (217 loc) · 8.95 KB

InfiniteLine.adoc

File metadata and controls

263 lines (217 loc) · 8.95 KB
Raw

/** * Infinite Line annotation. * @param {!anychart.core.annotations.ChartController} chartController * @constructor * @extends {anychart.core.annotations.Base} */ anychart.core.annotations.InfiniteLine;

/* * Getter for the X anchor. * @shortDescription X anchor settings * @category Size and Position * @listing See listing. * var controller = chart.annotations(); * var annotation = controller.infiniteLine(); * var xAnchor = annotation.xAnchor(); * @return {} The X anchor. * @since 7.11.0 */ anychart.core.annotations.InfiniteLine.prototype.xAnchor;

/* * Setter for the X anchor. * @example anychart.core.annotations.InfiniteLine.anchors * @param {} value X anchor to set. * @return {anychart.core.annotations.InfiniteLine} Self instance for method chaining. * @since 7.11.0 */ anychart.core.annotations.InfiniteLine.prototype.xAnchor;

/* * Getter for the value anchor. * @shortDescription Value anchor settings * @category Size and Position * @listing See listing. * var controller = chart.annotations(); * var annotation = controller.infiniteLine(); * var valueAnchor = annotation.valueAnchor(); * @return {} The value anchor. * @since 7.11.0 */ anychart.core.annotations.InfiniteLine.prototype.valueAnchor;

/* * Setter for the value anchor. * @example anychart.core.annotations.InfiniteLine.anchors * @param {} value Value anchor to set. * @return {anychart.core.annotations.InfiniteLine} Self instance for method chaining. * @since 7.11.0 */ anychart.core.annotations.InfiniteLine.prototype.valueAnchor;

/* * Getter for the second X anchor. * @shortDescription Second X anchor settings * @category Size and Position * @listing See listing. * var controller = chart.annotations(); * var annotation = controller.infiniteLine(); * var secondXAnchor = annotation.secondXAnchor(); * @return {} The second X anchor. * @since 7.11.0 */ anychart.core.annotations.InfiniteLine.prototype.secondXAnchor;

/* * Setter for the second X anchor. * @example anychart.core.annotations.InfiniteLine.anchors * @param {} value Second X anchor to set. * @return {anychart.core.annotations.InfiniteLine} Self instance for method chaining. * @since 7.11.0 */ anychart.core.annotations.InfiniteLine.prototype.secondXAnchor;

/* * Getter for the second value anchor. * @shortDescription Second value anchor settings * @category Size and Position * @listing See listing. * var controller = chart.annotations(); * var annotation = controller.infiniteLine(); * var secondValueAnchor = annotation.secondValueAnchor(); * @return {} The second value anchor. * @since 7.11.0 */ anychart.core.annotations.InfiniteLine.prototype.secondValueAnchor;

/* * Setter for the second value anchor. * @example anychart.core.annotations.InfiniteLine.anchors * @param {} value Second value anchor to set. * @return {anychart.core.annotations.InfiniteLine} Self instance for method chaining. * @since 7.11.0 */ anychart.core.annotations.InfiniteLine.prototype.secondValueAnchor;

/** * Getter for stroke settings. * @shortDescription Stroke settings. * @category Coloring * @detailed This method can be used as getter only if the value has been previously set. * @listing See listing. * var stroke = annotation.stroke(); * @return {!anychart.graphics.vector.Stroke} Stroke settings. * @since 7.11.0 */ anychart.core.annotations.InfiniteLine.prototype.stroke;

/** * Setter for annotations stroke by function. * @example anychart.core.annotations.InfiniteLine.stroke_set_asFunc * @param {StrokeFunction=} opt_strokeFunction [function() { * return anychart.color.darken(this.sourceColor); * }] Function that looks like: <pre>function(){ * // this.index - series index. * // this.sourceColor - color returned by fill() getter. * // this.iterator - series point iterator. * return strokeValue; // type anychart.graphics.vector.Stroke or anychart.graphics.vector.ColoredFill * }</pre> * @return {anychart.core.annotations.InfiniteLine} Self instance for method chaining. * @since 7.11.0 */ anychart.core.annotations.InfiniteLine.prototype.stroke;

/** * Setter for annotations stroke settings. * {docs:Graphics/Stroke_Settings}Learn more about stroke settings.{docs} * @example anychart.core.annotations.InfiniteLine.stroke_set * @param {(anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill|string|null)=} opt_color Stroke settings. * @param {number=} opt_thickness [1] Line thickness. * @param {string=} opt_dashpattern Controls the pattern of dashes and gaps used to stroke paths. * @param {(string|anychart.graphics.vector.StrokeLineJoin)=} opt_lineJoin Line join style. * @param {(string|anychart.graphics.vector.StrokeLineCap)=} opt_lineCap Line cap style. * @return {anychart.core.annotations.InfiniteLine} Self instance for method chaining. * @since 7.11.0 */ anychart.core.annotations.InfiniteLine.prototype.stroke;

/** * Setter for annotation stroke settings using an object. * @example anychart.core.annotations.InfiniteLine.stroke_set_asObj * @param {Object=} opt_settings Object with stroke settings from {@link anychart.graphics.vector.Stroke} * @return {anychart.core.annotations.InfiniteLine} Self instance for method chaining. * @since 7.11.0 */ anychart.core.annotations.InfiniteLine.prototype.stroke;

/** @inheritDoc */ anychart.core.annotations.InfiniteLine.prototype.normal;

/** @inheritDoc */ anychart.core.annotations.InfiniteLine.prototype.hovered;

/** @inheritDoc */ anychart.core.annotations.InfiniteLine.prototype.selected;

/** @inheritDoc */ anychart.core.annotations.InfiniteLine.prototype.getType;

/** @inheritDoc */ anychart.core.annotations.InfiniteLine.prototype.getChart;

/** @inheritDoc */ anychart.core.annotations.InfiniteLine.prototype.getPlot;

/** @inheritDoc */ anychart.core.annotations.InfiniteLine.prototype.yScale;

/** @inheritDoc */ anychart.core.annotations.InfiniteLine.prototype.yScale;

/** @inheritDoc */ anychart.core.annotations.InfiniteLine.prototype.xScale;

/** @inheritDoc */ anychart.core.annotations.InfiniteLine.prototype.xScale;

/** @inheritDoc */ anychart.core.annotations.InfiniteLine.prototype.select;

/** @inheritDoc */ anychart.core.annotations.InfiniteLine.prototype.markers;

/** @inheritDoc */ anychart.core.annotations.InfiniteLine.prototype.color;

/** @inheritDoc */ anychart.core.annotations.InfiniteLine.prototype.hoverGap;

/** @inheritDoc */ anychart.core.annotations.InfiniteLine.prototype.allowEdit;

/** @inheritDoc */ anychart.core.annotations.InfiniteLine.prototype.bottom;

/** @inheritDoc */ anychart.core.annotations.InfiniteLine.prototype.bounds;

/** @inheritDoc */ anychart.core.annotations.InfiniteLine.prototype.enabled;

/** @inheritDoc */ anychart.core.annotations.InfiniteLine.prototype.getPixelBounds;

/** @inheritDoc */ anychart.core.annotations.InfiniteLine.prototype.height;

/** @inheritDoc */ anychart.core.annotations.InfiniteLine.prototype.left;

/** @inheritDoc */ anychart.core.annotations.InfiniteLine.prototype.maxHeight;

/** @inheritDoc */ anychart.core.annotations.InfiniteLine.prototype.maxWidth;

/** @inheritDoc */ anychart.core.annotations.InfiniteLine.prototype.minHeight;

/** @inheritDoc */ anychart.core.annotations.InfiniteLine.prototype.minWidth;

/** @inheritDoc */ anychart.core.annotations.InfiniteLine.prototype.right;

/** @inheritDoc */ anychart.core.annotations.InfiniteLine.prototype.top;

/** @inheritDoc */ anychart.core.annotations.InfiniteLine.prototype.width;

/** @inheritDoc */ anychart.core.annotations.InfiniteLine.prototype.zIndex;