@amcharts/amcharts4
Version:
amCharts 4
123 lines (122 loc) • 3.72 kB
TypeScript
/**
* Contains code and logic for generating radial gradients.
*/
/**
* ============================================================================
* IMPORTS
* ============================================================================
* @hidden
*/
import { BaseObject } from "../../Base";
import { List } from "../../utils/List";
import { Group } from "../Group";
import { Paper } from "../Paper";
import { IGradientStop } from "./LinearGradient";
import { Color } from "../../utils/Color";
import * as $type from "../../utils/Type";
import { Percent } from "../../utils/Percent";
/**
* ============================================================================
* MAIN CLASS
* ============================================================================
* @hidden
*/
/**
* Radial gradient class.
*/
export declare class RadialGradient extends BaseObject {
/**
* List of colors switch definitions in a gradient.
*/
protected _stops: List<IGradientStop>;
/**
* An SVG `<group>` element used to draw gradient.
*
* @ignore Exclude from docs
*/
element: Group;
/**
* Reference to Paper to add element to.
*/
protected _paper: $type.Optional<Paper>;
/**
* A center x coordinate for the radial gradient, can be set in pixels or as Percent
*/
protected _cx: $type.Optional<number | Percent>;
/**
* A center y coordinate for the radial gradient, can be set in pixels or as Percent
*/
protected _cy: $type.Optional<number | Percent>;
/**
* A y coordinate of the focal point of a gradient, can be set in pixels or as Percent
*/
protected _fx: $type.Optional<number | Percent>;
/**
* A y coordinate of the focal point of a gradient, can be set in pixels or as Percent
*/
protected _fy: $type.Optional<number | Percent>;
/**
* Constructor
*/
constructor();
/**
* Draws gradient.
*/
protected draw(): void;
/**
* Adds a color step to the gradient.
*
* @param color Color (hex code or named color)
* @param opacity Opacity (value from 0 to 1; 0 completely transaprent, 1 fully opaque)
* @param offset Position of color in the gradient (value 0 to 1; 0 meaning start of the gradient and 1 end)
*/
addColor(color: Color, opacity?: number, offset?: number): void;
/**
* A [[Paper]] instace to use for the gradient.
*
* @ignore Exclude from docs
* @param paper Paper
*/
/**
* @ignore Exclude from docs
* @return Paper
*/
paper: Paper;
/**
* Center x coordinate of the gradient, can be set as number or Percent
*
* @param point Center point
*/
cx: $type.Optional<number | Percent>;
/**
* Center y coordinate of the gradient, can be set as number or Percent
*
* @param point Center point
*/
cy: $type.Optional<number | Percent>;
/**
* y coordinate of the focal point of a gradient, can be set in pixels or as Percent
*
* @param point Center point
*/
fx: $type.Optional<number | Percent>;
/**
* y coordinate of the focal point of a gradient, can be set in pixels or as Percent
*
* @param point Center point
*/
fy: $type.Optional<number | Percent>;
copyFrom(source: this): void;
/**
* A list of color stops in the gradient.
*
* @return Stops
*/
readonly stops: List<IGradientStop>;
/**
* Clears the gradient.
*
* @ignore Exclude from docs
*/
clear(): void;
}