Class: DotDrawing

StockChartX. DotDrawing


new DotDrawing(config)

Represents dot drawing.
Parameters:
Name Type Argument Description
config object <optional>
The configuration object.
Properties
Name Type Argument Description
point StockChartX.Point | StockChartX.ChartPoint <optional>
The center point.
radius number <optional>
The radius of dot.
Example
// Create dot drawing at point (10, 20).
 var dot1 = new StockChartX.DotDrawing({
     point: {x: 10, y: 20}
 });

 // Create dot drawing at record 10 and value 20.0.
 var dot2 = new StockChartX.DotDrawing({
     point: {record: 10, value: 20.0}
 });

 // Create red dot drawing at point (10, 20).
 var dot3 = new StockChartX.DotDrawing({
     point: {x: 10, y: 20},
     theme: {
         fill: {
             fillColor: '#FF0000'
         }
     }
 });

Extends

Members


actualTheme :object

Returns actual theme.
Type:
  • object
Inherited From:

<readonly> canMove :boolean

Returns true if drawing can be moved, false otherwise.
Type:
  • boolean
Inherited From:

<readonly> canResize :boolean

Returns true if drawing can be resized, false otherwise.
Type:
  • boolean
Inherited From:

<readonly> canSelect :boolean

Returns true if drawing can be selected, false otherwise.
Type:
  • boolean
Inherited From:

chartPoints :Array.<StockChartX.ChartPoint>

Gets/Sets array of chart points.
Type:
Inherited From:

locked :boolean

Gets/Sets flag that indicates whether drawing is locked.
Type:
  • boolean
Inherited From:

<readonly> pointsNeeded :number

Returns number of required points for the drawing.
Type:
  • number
Inherited From:

radius :number

Gets/Sets dot radius.
Type:
  • number

resizable :boolean

Gets/Sets flag that indicates whether drawing is resizable.
Type:
  • boolean
Inherited From:

selectable :boolean

Gets/Sets flag that indicates whether drawing is selectable.
Type:
  • boolean
Inherited From:

selected :boolean

Gets/Sets flag that indicates whether drawing is selected.
Type:
  • boolean
Inherited From:

theme :object

Gets/Sets theme.
Type:
  • object
Inherited From:

Methods


appendChartPoint(point)

Appends new chart point.
Parameters:
Name Type Description
point StockChartX.Point | StockChartX.ChartPoint The point to append.
Inherited From:
Returns:
The array of drawing's points.
Type
Array.<StockChartX.ChartPoint>
Example
var drawing = new StockChartX.DotDrawing();
 drawing.appendChartPoint({record: 10, value: 20.0});

bounds()

Returns bounds rectangle.
Inherited From:
Returns:
Type
StockChartX.Rect

cartesianPoint(index)

Converts chart point to cartesian point.
Parameters:
Name Type Description
index number The index of point.
Inherited From:
Returns:
Type
StockChartX.Point
Example
var point = drawing.getCartesianPoint(0);
 var x = point.x;
 var y = point.y;

cartesianPoints()

Converts all chart points to cartesian points.
Inherited From:
Returns:
Type
Array.<StockChartX.Point>

select()

Makes drawing selected.
Inherited From:

translate(dx, dy)

Translates drawing onto a given distance.
Parameters:
Name Type Description
dx number The X offset.
dy number The Y offset.
Inherited From:
Example
drawing.translate(5, 5);