Type class
Defines a DataItem
for ForceDirectedSeries
.
DataItem
@since 4.3.8
Sources
This information about ForceDirectedSeriesDataItem is provided for reference only and is not available through exported packages and thus should not be imported or used on its own.
Inheritance
ForceDirectedSeriesDataItem extends SeriesDataItem
.
ForceDirectedSeriesDataItem is not extended by any other symbol.
Properties
adapter # |
Type Inherited from Holds Adapter. |
---|---|
animations # |
Type Inherited from A list of |
bullets # |
Type Inherited from A dictionary of data items bullets, where key is uid of a bullet template. |
categories # |
Type Inherited from An object containing categories. |
childLinks # |
Type A list of This list does not include a link to node's parent, which is available through |
children # |
Type A list of item's sub-children. |
childrenInited # |
Type Default Have all children already been initialized? |
clonedFrom # |
Type Inherited from Reference to the original object this object was cloned from. We need to keep this so we can disassociate it from source object when this object is disposed. |
collapsed # |
Type Indicates whether node should start off as collapsed. This can be used to specify whether node should start off as collapsed via data. To toggle actual node, use its |
color # |
Type Item's color. If not set, will use parent's color, or, if that is not set either, automatically assigned color from chart's color set. ( |
component # |
Type A reference to a component of a data item. |
config # |
Type Inherited from Use this property to set JSON-based config. When set, triggers processing routine, which will go through all properties, and try to apply values, create instances, etc. Use this with caution, as it is a time-consuming process. It's used for initialchart setup only, not routine operations. |
dataContext # |
Type Inherited from Sets to a reference to an original object from Component's data. A reference to an original object in Component's data, that this Data Item is derived from. |
dates # |
Type Inherited from An object containing dates. |
depth # |
Type Inherited from Depth of the Data Item. In nested data structures, like TreeMap, this indicates the level this data point is at, in relation to the parent Data Item. |
events # |
Type Inherited from An |
fixed # |
Type Is this node fixed (immovable)? @since 4.6.2 |
hasProperties # |
Type Default Inherited from Indicates whether Data Item has any properties set. If it does not have any, the code can use this property to check whether they need to apply costly operation of re-applying properties, whenever Data Item-related element is redrawn, e.g. series. |
Type Inherited from Sets hidden flag for data item. Mostly used to initially hide data item. Returns |
|
Type Should dataItem (node) be hidden in legend? |
|
id # |
Type Inherited from Sets the user-defined id of the element. |
ignoreMinMax # |
Type Inherited from Sets whether this data point should not be included in the scale and minimum/maximum calculations. Exclude from min/max calculations? E.g. some we may want to exclude a particular data point from influencing |
index # |
Type Inherited from Data Item's position index in Component's data. |
isHiding # |
Type Default Inherited from Indicates whether Data Item is currently animiting from visible to hidden state. |
isTemplate # |
Type Default Inherited from Identifies if this object is a "template" and should not be treated as real object that is drawn or actually used in the chart. |
legendDataItem # |
Type A legend's data item, that corresponds to this data item. |
level # |
Type Depth level in the series hierarchy. The top-level item will have level set at 0. Its children will have level 1, and so on. @readonly |
linkWith # |
Type An array of id's of other nodes outside of the child/parent tree to link with. |
locations # |
Type Inherited from An object containing locations for the Data Item. A location is a position within date or category, or, in some other cases, where there is no single point but rather some period. Click here for info how data item locations work |
node # |
Type An element, related to this data item. (node) @readonly |
opacity # |
Type Inherited from Sets opacity for all Data Item's related elements (Sprites). |
parent # |
Type Inherited from When we are using a nested data structure, like for example in a TreeMap, this property points to a parent Data Item of this one. |
parentLink # |
Type A |
percent # |
Type Percent value of a node. @since 4.9.0 |
properties # |
Type Inherited from An object containing Data Item specific appearance properties in key-value pairs. Sometimes a single Data Item needs to apply different properties than the rest of the data That's where Data Item's Please note that you should set Data Item-specific properties using |
sprites # |
Type Default Inherited from A list of E.g. an Data Item keeps track of all of them, so it can toggle all related visual elements when it itself is toggled. |
uid # |
Type Inherited from Returns object's internal unique ID. |
value # |
Type Numeric value of the item. |
values # |
Type Inherited from An object containing calculated values. |
visible # |
Type Inherited from Sets visibility of the Data Item. Returns |
workingLocations # |
Type Inherited from Current working locations. |
There are 26 inherited items currently hidden from this list. |
Methods
animate( animationOptions: ) |
Returns Inherited from Creates and starts an |
---|---|
clone( cloneId?: ) |
Returns Inherited from Makes a copy of this object and returns the clone. Try to avoid cloning complex objects like chart, create new instances if you need them. |
constructor() |
Returns Constructor |
copyFrom( source: ) |
Returns Inherited from Copies all properties and related data from different data item. |
dispatch( eventType: ) |
Returns Inherited from Dispatches an event using own event dispatcher. Will automatically populate event data object with event type and target (this element). It also checks if there are any handlers registered for this sepecific event. |
dispatchImmediately( eventType: ) |
Returns Inherited from Works like |
dispose() |
Returns Inherited from Destroys this object and all related data. |
getCurrentThemes() |
Returns Inherited from Returns a list of themes that should be applied to this element. It could either be a list of themes set explicitly on this element, or system-wide. |
getDate( name: ) |
Returns Inherited from Returns a Date value of the data field. |
getDuration( duration?: ) |
Returns Inherited from Returns a duration (ms) the Data Item should take to animate from one value to another. If the duration is not specified via parameter, this method will try to request a default duration from the related |
getValue( name: ) |
Returns Inherited from Returns a numeric value for specific data field. If If |
getWorkingValue( name: ) |
Returns Inherited from Returns a current working value for a specific data field. The actual value may differ from the one returned by |
hide( duration?: ) |
Returns Hides the Data Item and related visual elements. |
isDisposed() |
Returns Inherited from Returns if this object has been already been disposed. |
setCalculatedValue( name: ) |
Returns Inherited from |
setCategory( name: ) |
Returns Inherited from Sets a related category for this Data Item. @todo Review description |
setDate( name: ) |
Returns Inherited from Sets Date value to a data field. |
setLocation( name: ) |
Returns Inherited from Sets a relative location for a data field. A location is always relative on a 0 to 1 scale, with 0 being beginning, 0.5 middle and 1 end. @todo Rewiew description |
setProperty( name: ) |
Returns Inherited from Sets a Data Item-specific visual properties to apply to related elements. |
setValue( name: ) |
Returns Inherited from Sets a numeric value for specific data field. |
setVisibility( value: ) |
Returns Inherited from Sets visibility of the Data Item. |
setWorkingLocation( name: ) |
Returns Inherited from Sets a current working location for a data field. @todo Rewiew description |
setWorkingValue( name: ) |
Returns Inherited from Set current working numeric value for a specific data field. |
show( duration?: ) |
Returns Shows the Data Item and related visual elements. |
There are 21 inherited items currently hidden from this list. |
Events
#calculatedvaluechanged |
Param { property: Inherited from Invoked when the calculated value has changed |
---|---|
#locationchanged |
Param { property: Inherited from Invoked when the location of Data Item changes |
#propertychanged |
Param { property: Inherited from Invoked when a property of the Data Item changes |
#valuechanged |
Param { property: Inherited from Invoked when the value is changed |
#visibilitychanged |
Param { visible: Inherited from Invoked when the visibility of the Data Item changes, i.e. Series is hidden |
#workinglocationchanged |
Param { property: Inherited from Invoked when working location of Data Item changes |
#workingvaluechanged |
Param { property: Inherited from Invoked when the internal/intermediate value has changed |
There are 7 inherited items currently hidden from this list. |
Adapters
#date |
Param { date: |
---|---|
#duration |
Param |
#value |
Param { field: |
#workingValue |
Param { field: |