class anychart.core.stock.series.DiscreteBase Improve this Doc
Extends: anychart.core.stock.series.Base
DiscreteBase series class.
Methods Overview
Specific settings | |
getIndex() | Returns series index. |
legendItem() | Legend item settings. |
pointWidth() | Point width settings. |
Data | |
data() | Data settings. |
name() | Series name settings. |
Events | |
listen() | Adds an event listener. |
listenOnce() | Adds a single time event listener. |
removeAllListeners() | Removes all listeners. |
unlisten() | Removes the listener. |
unlistenByKey() | Removes the listener by the key. |
Export | |
print() | Prints all elements. |
Interactivity | |
enabled() | Element state (enabled or disabled). |
Point Elements | |
tooltip() | Tooltip settings. |
Scales | |
yScale() | Y-scale settings. |
Size and Position | |
bottom() | Bottom bound setting. |
bounds() | Bounds settings. |
getPixelBounds() | Returns pixel bounds. |
height() | Height setting. |
left() | Left bound setting. |
maxHeight() | Maximum height. |
maxWidth() | Maximum width. |
minHeight() | Minimum height. |
minWidth() | Minimum width. |
right() | Right bound setting. |
top() | Top bound setting. |
width() | Width setting. |
zIndex() | Z-index of the element. |
Methods Description
bottom
Returns:
number | string | undefined - Current element's bottom bound setting.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Bottom bound setting for the element. |
Returns:
anychart.core.stock.series.DiscreteBase - Returns self for method chaining.Try it:
bounds
Returns:
anychart.core.utils.Bounds - Current bounds of the element.Params:
Name | Type | Description |
---|---|---|
value | anychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.Bounds | Bounds of element. |
Returns:
anychart.core.stock.series.DiscreteBase - Self instance for method chaining.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
x | number | string | null | X-coordinate. |
y | number | string | null | Y-coordinate. |
width | number | string | null | Width. |
height | number | string | null | Height. |
Returns:
anychart.core.stock.series.DiscreteBase - Self instance for method chaining.Try it:
data
Returns:
anychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | string - Returns current mapping.Params:
Name | Type | Description |
---|---|---|
value | anychart.data.TableMapping | anychart.data.Table | Array.<Array.<*>> | string | Data for the series. |
mappingSettings | Object.<string, ({column: number, type: anychart.enums.AggregationType, weights: number}|number)> | Mapping settings. An object where keys are field names and values are objects with fields: - 'column': number - Column index, that the field should get values from; - 'type': anychart.enums.AggregationType - How to group values for the field. Defaults to 'close'. - 'weights': number - Column to get weights from for 'weightedAverage' grouping type. Note: If type set to 'weightedAverage', but opt_weightsColumn is not passed - uses 'average' grouping instead. or numbers - just the column index to get values from. In this case the grouping type will be set to 'close'. |
csvSettings | Object | CSV parser settings if the string is passed. |
Returns:
anychart.core.stock.series.DiscreteBase - Self instance for method chaining.Try it:
enabled
Returns:
boolean - The current element state.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | boolean | true | Value to set. |
Returns:
anychart.core.stock.series.DiscreteBase - Self instance for method chaining.if (!element.enabled()) element.enabled(true);
Try it:
getIndex
getPixelBounds
Returns:
anychart.math.Rect - Pixel bounds of the element.height
Returns:
number | string | undefined - Current element's height setting.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Height setting for the element. |
Returns:
anychart.core.stock.series.DiscreteBase - Returns self for method chaining.Try it:
left
Returns:
number | string | undefined - Current element's left bound setting.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Left bound setting for the element. |
Returns:
anychart.core.stock.series.DiscreteBase - Returns self for method chaining.Try it:
legendItem
Returns:
anychart.core.utils.LegendItemSettings - Legend item settings.Try it:
Params:
Name | Type | Description |
---|---|---|
value | Object | Legend item settings object. |
Returns:
anychart.core.stock.series.DiscreteBase - Self instance for method chaining.Try it:
listen
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
Params:
Name | Type | Default | Description |
---|---|---|---|
type | string | The event type id. | |
listener | function | Callback method. Function that looks like function(event){
// event.actualTarget - actual event target
// event.currentTarget - current event target
// event.iterator - event iterator
// event.originalEvent - original event
// event.point - event point
// event.pointIndex - event point index
} . | |
useCapture | boolean | false | Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing |
listenerScope | Object | Object in whose scope to call the listener. |
Returns:
Object - Unique key for the listener.Try it:
listenOnce
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).
Params:
Name | Type | Default | Description |
---|---|---|---|
type | string | The event type id. | |
listener | function | Callback method. | |
useCapture | boolean | false | Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing |
listenerScope | Object | Object in whose scope to call the listener. |
Returns:
Object - Unique key for the listener.Try it:
maxHeight
Returns:
number | string | null - Current element's maximum height.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Value to set. |
Returns:
anychart.core.stock.series.DiscreteBase - Self instance for method chaining.Try it:
maxWidth
Returns:
number | string | null - Current element's maximum width.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Value to set. |
Returns:
anychart.core.stock.series.DiscreteBase - Self instance for method chaining.Try it:
minHeight
Returns:
number | string | null - Current element's minimum height.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Value to set. |
Returns:
anychart.core.stock.series.DiscreteBase - Self instance for method chaining.Try it:
minWidth
Returns:
number | string | null - Current element's minimum width.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Value to set. |
Returns:
anychart.core.stock.series.DiscreteBase - Self instance for method chaining.Try it:
name
Params:
Name | Type | Description |
---|---|---|
value | string |
Returns:
anychart.core.stock.series.DiscreteBase - Self instance for method chaining.Try it:
pointWidth
Returns:
string | number - Point width pixel value.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | "75%" | Point width pixel value. |
Returns:
anychart.core.stock.series.DiscreteBase - Self instance for method chaining.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
paperSizeOrOptions | anychart.graphics.vector.PaperSize | Object | Paper size or object with options. | |
landscape | boolean | false | Flag of landscape. |
Try it:
removeAllListeners
Params:
Name | Type | Description |
---|---|---|
type | string | Type of event to remove, default is to remove all types. |
Returns:
number - Number of listeners removed.Try it:
right
Returns:
number | string | undefined - Current element's right bound setting.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Right bound setting for the element. |
Returns:
anychart.core.stock.series.DiscreteBase - Returns self for method chaining.Try it:
tooltip
- null/boolean - disable or enable series tooltip.
- object - sets series tooltip settings.
Params:
Name | Type | Default | Description |
---|---|---|---|
value | Object | boolean | null | true | Tooltip settings. |
Returns:
anychart.core.stock.series.DiscreteBase - Self instance for method chaining.top
Returns:
number | string | undefined - Current element's top bound setting.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Top bound setting for the element. |
Returns:
anychart.core.stock.series.DiscreteBase - Returns self for method chaining.Try it:
unlisten
Params:
Name | Type | Default | Description |
---|---|---|---|
type | string | The event type id. | |
listener | function | Callback method. | |
useCapture | boolean | false | Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing |
listenerScope | Object | Object in whose scope to call the listener. |
Returns:
boolean - Whether any listener was removed.Try it:
unlistenByKey
Params:
Name | Type | Description |
---|---|---|
key | Object | The key returned by listen() or listenOnce(). |
Returns:
boolean - Whether any listener was removed.Try it:
width
Returns:
number | string | undefined - Current element's width setting.Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Width setting for the element. |
Returns:
anychart.core.stock.series.DiscreteBase - Returns self for method chaining.Try it:
yScale
Returns:
anychart.scales.ScatterBase - Series Y-scale.var myPlot = chart.plot(); var plotSeries = myPlot.line(data); plotSeries.yScale();
Params:
Name | Type | Description |
---|---|---|
value | anychart.scales.ScatterBase | Value to set. |
Returns:
anychart.core.stock.series.DiscreteBase - Self instance for method chaining.Try it:
zIndex
Returns:
number - The current zIndex.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | 0 | Value to set. |
Returns:
anychart.core.stock.series.DiscreteBase - Self instance for method chaining.Try it: