CategoryAxisDataItem

Type class

Defines a DataItem for CategoryAxis.

@see DataItem

Sources

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

// CategoryAxisDataItem is available in all of the following modules.
// You only need to import one of them.

/**
 * --------------------------------------------------------
 * Import from: "charts.ts"
 * Use like: am4charts.CategoryAxisDataItem
 * --------------------------------------------------------
 */
import * as am4charts from "@amcharts/amcharts4/charts";

// CategoryAxisDataItem is available in all of the following modules.
// You only need to import one of them.

/**
 * --------------------------------------------------------
 * Include via: <script src="charts.js"></script>
 * Access items like: am4charts.CategoryAxisDataItem
 * --------------------------------------------------------
 */

Inheritance

CategoryAxisDataItem extends AxisDataItem.

CategoryAxisDataItem is not extended by any other symbol.

Properties

adapter
#

Type Adapter < CategoryAxisDataItem, ICategoryAxisDataItemAdapters >

Holds Adapter.

animations
#

Type Array < Animation >

Inherited from DataItem

A list of Animations objects currently mutating Data Item's values.

axisBreak
#

Type AxisBreak

Inherited from AxisDataItem

An AxisBreak this data item falls within.

axisFill
#

Type AxisFill

Inherited from AxisDataItem

An AxisFill associated element with this data item.

If there is no fill element associated with data item, a new one is created and returned.

bullet
#

Type Sprite

Inherited from AxisDataItem

Set it to an instance of any Sprite. It will be displayed as an axis bullet in the middle of the cell, or specific value.

If you need position bullet relatively to the cell, use AxisBullet instead. It has a location property which can be used to indicate precise relative location within cell/range.

Also, AxisBullet is a Container so you can push any other element into it.

NOTE: location is relative to the parent axis range's scope, i.e.

between its date and endDate for DateAxis, or value/endValue (ValueAxis), or category/endCategory (categoryAxis).

let range = dateAxis.axisRanges.create();
range.date = new Date(2018, 0, 5);

let flag = new am4plugins_bullets.FlagBullet();
flag.label.text = "Hello";

range.bullet = flag;
var range = dateAxis.axisRanges.create();
range.date = new Date(2018, 0, 5);

var flag = new am4plugins_bullets.FlagBullet();
flag.label.text = "Hello";

range.bullet = flag;
{
  // ...
  "xAxes": [{
    "type": "DateAxis",
    // ...
    "axisRanges": [{
      "date": new Date(2018, 0, 5),
      "bullet: {
        "type": "FlagBullet",
        "label": {
          "text": "Hello"
        }
      }
    }]
  }]
}

@since 4.5.9

categories
#

Type object

Inherited from DataItem

An object containing categories.

category
#

Type string

Category.

clonedFrom
#

Type $type.Optional < this >

Inherited from BaseObject

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.

config
#

Type object

Inherited from BaseObject

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.

contents
#

Type Container

Inherited from AxisDataItem

Returns a Container to place all visual elements, related to data item in.

If there is no Container, a new one is created.

dataContext
#

Type Object

Inherited from DataItem

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 object

Inherited from DataItem

An object containing dates.

depth
#

Type number

Inherited from DataItem

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.

endCategory
#

Type string

End category.

Used for items that span several categories, like CategoryAxisBreak.

events
#

Type EventDispatcher < AMEvent < this, IDataItemEvents > >

Inherited from BaseObjectEvents

An EventDispatcher instance

grid
#

Type Grid

Inherited from AxisDataItem

A Grid element associated with this data item.

If there is no grid element associated with data item, a new one is created and returned.

hasProperties
#

Type boolean

Default false

Inherited from DataItem

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.

hidden
#

Type boolean

Inherited from DataItem

Sets hidden flag for data item. Mostly used to initially hide data item.

Returns true if this Data Item is currently hidden.

id
#

Type $type.Optional < string >

Inherited from BaseObject

Sets the user-defined id of the element.

ignoreMinMax
#

Type boolean

Inherited from DataItem

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 ValueAxis scale.

index
#

Type number

Inherited from DataItem

Data Item's position index in Component's data.

isHiding
#

Type boolean

Default false

Inherited from DataItem

Indicates whether Data Item is currently animiting from visible to hidden state.

isTemplate
#

Type boolean

Default false

Inherited from DataItem

Identifies if this object is a "template" and should not be treated as real object that is drawn or actually used in the chart.

label
#

Type AxisLabel

Inherited from AxisDataItem

An AxisLabel element associated with this data item.

If there is no label element associated with data item, a new one is created and returned.

locations
#

Type object

Inherited from DataItem

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.

mask
#

Type AxisFill

Inherited from AxisDataItem

Data item's mask.

maxPosition
#

Type number

Inherited from AxisDataItem

Allows hiding axis item (tick, label, grid) if it is closer to axis end than this relative position (0-1).

For axis labels it overrides maxLabelPosition if set.

// Hide all ticks and labels closer than 20% to axis end.
axis.renderer.ticks.template.minPosition = 0.8;
axis.renderer.labels.template.minPosition = 0.8;
// Hide all ticks and labels closer than 20% to axis end.
axis.renderer.ticks.template.minPosition = 0.8;
axis.renderer.labels.template.minPosition = 0.8;
{
  // ...
  "xAxes": [{
    // ...
    // Hide all ticks and labels closer than 20% to axis end.
    "renderer": {
      "ticks": {
        "minPosition": 0.8
      },
      "labels": {
        "minPosition": 0.8
      }
    }
  }]
}

@since 4.5.11

minPosition
#

Type number

Inherited from AxisDataItem

Allows hiding axis item (tick, label, grid) if it is closer to axis beginning than this relative position (0-1).

For axis labels it overrides minLabelPosition if set.

// Hide all ticks and labels closer than 20% to axis beginning.
axis.renderer.ticks.template.minPosition = 0.2;
axis.renderer.labels.template.minPosition = 0.2;
// Hide all ticks and labels closer than 20% to axis beginning.
axis.renderer.ticks.template.minPosition = 0.2;
axis.renderer.labels.template.minPosition = 0.2;
{
  // ...
  "xAxes": [{
    // ...
    // Hide all ticks and labels closer than 20% to axis beginning.
    "renderer": {
      "ticks": {
        "minPosition": 0.2
      },
      "labels": {
        "minPosition": 0.2
      }
    }
  }]
}

@since 4.5.11

opacity
#

Type number

Inherited from DataItem

Sets opacity for all Data Item's related elements (Sprites).

parent
#

Type $type.Optional < this >

Inherited from DataItem

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.

point
#

Type IPoint

Inherited from AxisDataItem

Holds a physical position of the grid line associated with this data item, so that it can be used when measuring distance between points, and hiding some of them so they don't overlap.

position
#

Type number

Inherited from AxisDataItem

relative position of data item on axis

properties
#

Type object

Inherited from DataItem

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 Series it is part of. E.g. a single column, represented by a Data Item needs to be filled with a different color than the reset of the ColumnSeries it belongs to.

That's where Data Item's properties come into play.

Please note that you should set Data Item-specific properties using setProperty() method, rather than access properties object directly.

seriesDataItems
#

Type object

sprites
#

Type Sprite[]

Default []

Inherited from DataItem

A list of Sprite elements that are associated with this Data Item.

E.g. an Axis Data Item has several separate elements associated with it, like AxisTick, AxisLabel, and Grid.

Data Item keeps track of all of them, so it can toggle all related visual elements when it itself is toggled.

text
#

Type string

Inherited from AxisDataItem

Text to be used as data item's label.

tick
#

Type AxisTick

Inherited from AxisDataItem

An AxisTick element associated with this data item.

If there is no tick element associated with data item, a new one is created and returned.

uid
#

Type string

Inherited from BaseObject

Returns object's internal unique ID.

values
#

Type object

Inherited from DataItem

An object containing calculated values.

visible
#

Type boolean

Inherited from DataItem

Sets visibility of the Data Item.

Returns true if this Data Item is currently visible.

workingLocations
#

Type object

Inherited from DataItem

Current working locations.

There are 37 inherited items currently hidden from this list.

Methods

constructor()

#

Returns CategoryAxisDataItem

Constructor

animate(

animationOptions: IAnimationOptions[] | IAnimationOptions,
duration: number,
easing?: ( value: number) => number

)

#

Returns Animation

Inherited from DataItem

Creates and starts an Animation to interpolate (morph) Data Item's properties and/or values.

@see Animation

clone(

cloneId?: string

)

#

Returns this

Inherited from BaseObject

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.

copyFrom(

source: this

)

#

Returns void

Inherited from AxisDataItem

Copies all parameters from another AxisDataItem.

dispatch(

eventType: Key,
data?: any

)

#

Returns void

Inherited from BaseObjectEvents

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: Key,
data?: any

)

#

Returns void

Inherited from BaseObjectEvents

Works like dispatch, except event is triggered immediately, without waiting for the next frame cycle.

dispose()

#

Returns void

Inherited from DataItem

Destroys this object and all related data.

getCurrentThemes()

#

Returns ITheme[]

Inherited from BaseObject

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: string

)

#

Returns Date

Inherited from DataItem

Returns a Date value of the data field.

getDuration(

duration?: number

)

#

Returns $type.Optional < number >

Inherited from DataItem

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 Component.

getValue(

name: string,
calculated?: CalculatedValue

)

#

Returns $type.Optional < number >

Inherited from DataItem

Returns a numeric value for specific data field.

If calculated is not set, it will return a raw value, as it is in source data.

If calculated is set, it will return a pre-calculated specific value.

getWorkingValue(

name: string

)

#

Returns $type.Optional < number >

Inherited from DataItem

Returns a current working value for a specific data field.

The actual value may differ from the one returned by getValue(). The latter returns static values from the data source.

getWorkingValue() returns current value, which is usually different if Data Item is animating from one state to another.

hide(

duration?: number,
delay?: number,
toValue?: number,
fields?: string[]

)

#

Returns $type.Optional < Animation >

Inherited from DataItem

Hides the Data Item and related visual elements.

isDisposed()

#

Returns boolean

Inherited from BaseObject

Returns if this object has been already been disposed.

setCalculatedValue(

name: string,
value: number,
calculated: CalculatedValue

)

#

Returns void

Inherited from DataItem

setCategory(

name: string,
value: string

)

#

Returns void

Inherited from DataItem

Sets a related category for this Data Item.

@todo Review description

setDate(

name: string,
date: Date,
duration?: number

)

#

Returns void

Inherited from DataItem

Sets Date value to a data field.

setLocation(

name: string,
value: number,
duration?: number,
delay?: number

)

#

Returns void

Inherited from DataItem

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: string,
value: any

)

#

Returns void

Inherited from DataItem

Sets a Data Item-specific visual properties to apply to related elements.

setValue(

name: string,
value: number,
duration?: number,
delay?: number

)

#

Returns void

Inherited from DataItem

Sets a numeric value for specific data field.

setVisibility(

value: boolean,
noChangeValues?: boolean

)

#

Returns void

Inherited from AxisDataItem

Sets visibility of the Data Item.

setWorkingLocation(

name: string,
value: number,
duration?: number,
delay?: number

)

#

Returns $type.Optional < Animation >

Inherited from DataItem

Sets a current working location for a data field.

@todo Rewiew description

setWorkingValue(

name: string,
value: number,
duration?: number,
delay?: number

)

#

Returns $type.Optional < Animation >

Inherited from DataItem

Set current working numeric value for a specific data field.

show(

duration?: number,
delay?: number,
fields?: string[]

)

#

Returns $type.Optional < Animation >

Inherited from DataItem

Shows the Data Item and related visual elements.

There are 23 inherited items currently hidden from this list.

Events

#calculatedvaluechanged

Param { type: "calculatedvaluechanged",
  target: this }

Invoked when the calculated value has changed

#locationchanged

Param { type: "locationchanged",
  target: this }

Invoked when the location of Data Item changes

#propertychanged

Param { type: "propertychanged",
  target: this }

Invoked when a property of the Data Item changes

#valuechanged

Param { type: "valuechanged",
  target: this }

Invoked when the value is changed

#visibilitychanged

Param { type: "visibilitychanged",
  target: this }

Invoked when the visibility of the Data Item changes, i.e. Series is hidden

#workinglocationchanged

Param { type: "workinglocationchanged",
  target: this }

Invoked when working location of Data Item changes

#workingvaluechanged

Param { type: "workingvaluechanged",
  target: this }

Invoked when the internal/intermediate value has changed

Adapters

#date

Param object

#duration

Param number

#value

Param object

#workingValue

Param object