DataItem

Type class

One item of a Component's data, holding its values and settings.

Sources

DataItem can be used (imported) via one of the following packages.

TypeScript

// Import DataItem
import * as am5 from "@amcharts/amcharts5";

// Create DataItem
am5.DataItem.new(root, {
  // ... config if applicable
});

JavaScript

<!-- Load DataItem -->
<script src="index.js"></script>

<script>
// Create DataItem
am5.DataItem.new(root, {
  // ... config if applicable
});
</script>

Inheritance

DataItem extends Settings.

DataItem is not extended by any other symbol.

Settings

Set these settings on a DataItem object using its set() and setAll() methods. Read about settings concept.

DataItem does not have any settings.

Properties

#bullets

Type Array | undefined

Bullets shown for this data item.

#close

Type object | undefined

End of the base interval each date field's value falls in, by field.

Set by a DateAxis.

#component

Type Component

The Component the data item belongs to.

#dataContext

Type unknown

The object in the source data this data item was made from.

#open

Type object | undefined

Start of the base interval each date field's value falls in, by field.

Set by a DateAxis.

2 inherited items

#enableDispose

Type booleanDefault trueInherited from Settings

Set to false to make dispose() do nothing.

#uid

Type numberDefault ++counterInherited from Settings

A unique number, given to each object as it is created.

Methods

#constructor(component: Component,
dataContext: unknown,
settings: P)

Returns DataItem

#hide(duration?: undefined | number)

Returns void

Hides the data item.

#isHidden()

Returns boolean

Returns true if the data item is hidden.

#show(duration?: undefined | number)

Returns void

Shows the data item.

19 inherited items

#animate(options: AnimationOptions)

Returns AnimationInherited from Settings

Animates a setting from its current value (or from) to to. The setting jumps to from at once. With duration 0, or no value to start from, it is set to to at once and the returned animation is already stopped.

More info: Animations: animating settings

#dispose()

Returns voidInherited from Settings

Disposes the object, freeing everything it holds. A disposed object can't be used again.

#get(key: Key,
fallback: F)

Returns NonNullable | FInherited from Settings

Returns the value of setting key, or fallback if it is not set.

More info: Settings

#has(key: Key)

Returns booleanInherited from Settings

Returns true if setting key is set.

More info: Settings

#isDisposed()

Returns booleanInherited from Settings

Returns true if the object has been disposed.

#off(key: Key,
callback?: undefined | (value: [""], target: this, key: Key) => void)

Returns voidInherited from SettingsSince 5.9.2

Removes a callback added with on(). Without callback, removes all of them for key.

More info: Events: settings value change

#offDebounced(key: Key,
callback?: undefined | (value: [""], target: this, key: Key) => void)

Returns voidInherited from Settings

Removes a callback added with onDebounced(). Without callback, removes all of them for key.

More info: Events: settings value change

#offDebouncedPrivate(key: Key,
callback?: undefined | (value: [""], target: this, key: Key) => void)

Returns voidInherited from Settings

Removes a callback added with onPrivateDebounced(). Without callback, removes all of them for key.

More info: Events: settings value change

#offPrivate(key: Key,
callback?: undefined | (value: [""], target: this, key: Key) => void)

Returns voidInherited from SettingsSince 5.9.2

Removes a callback added with onPrivate(). Without callback, removes all of them for key.

More info: Events: settings value change

#on(key: Key,
callback: (value: [""], target: this, key: Key) => void)

Returns IDisposerInherited from Settings

Calls callback each time the value of setting key changes or is removed. Setting the same value again does not call it.

More info: Events: settings value change

#once(key: Key,
callback: (value: [""], target: this, key: Key) => void)

Returns IDisposerInherited from SettingsSince 5.20.4

Like on(), but the callback is removed after it is called once.

More info: Events: settings value change

#onceDebounced(key: Key,
callback: (value: [""], target: this, key: Key) => void,
debounceDelay: number)

Returns IDisposerInherited from SettingsSince 5.20.4

Like onDebounced(), but the callback is removed after it is called once.

More info: Events: settings value change

#onDebounced(key: Key,
callback: (value: [""], target: this, key: Key) => void,
debounceDelay: number)

Returns IDisposerInherited from Settings

Like on(), but waits until setting key has not changed for debounceDelay milliseconds, then calls callback once with the latest value.

More info: Events: settings value change

#onPrivate(key: Key,
callback: (value: [""], target: this, key: Key) => void)

Returns IDisposerInherited from Settings

Calls callback each time the value of private setting key changes.

More info: Events: settings value change

#onPrivateDebounced(key: Key,
callback: (value: [""], target: this, key: Key) => void,
debounceDelay: number)

Returns IDisposerInherited from Settings

Like onPrivate(), but waits until private setting key has not changed for debounceDelay milliseconds, then calls callback once with the latest value.

More info: Events: settings value change

#remove(key: Key)

Returns voidInherited from Settings

Removes the value of setting key.

More info: Settings

#removeAll()

Returns voidInherited from Settings

Removes all settings, as remove() does for each one.

More info: Settings

#set(key: Key,
value: Value)

Returns ValueInherited from Settings

Sets setting key to value and returns value. Stops any animation of that setting.

More info: Settings

#setAll(settings: Partial)

Returns voidInherited from Settings

Sets several settings at once, from an object of key-value pairs.

More info: Settings

Events

DataItem does not have any events.