MAIDR JavaScript API
    Preparing search index...

    Minimal interface for an amCharts 5 series (ColumnSeries, LineSeries, PieSeries, etc.).

    The per-kind collections are optional because no series type has them all: columns belongs to a column series, bullets / strokes to a line one, and a pie series has neither — its wedges are reached through each data item's slice instead.

    interface AmXYSeries {
        get: (key: string) => unknown;
        className?: string;
        uid?: number;
        dataItems: AmDataItem[];
        columns?: AmListLike<AmSprite> & { template?: AmSprite };
        bullets?: AmListLike<AmBullet>;
        strokes?: AmListLike<AmSprite> & { template?: AmSprite };
        fills?: { template?: AmSprite };
        links?: AmListLike<AmSprite>;
        toGlobal?: (point: AmPoint) => AmPoint;
        width?: () => number;
        height?: () => number;
        globalBounds?: () => AmBounds;
    }

    Hierarchy (View Summary)

    Index

    Properties

    get: (key: string) => unknown
    className?: string
    uid?: number
    dataItems: AmDataItem[]
    columns?: AmListLike<AmSprite> & { template?: AmSprite }

    The per-kind graphics lists, each an am5 ListTemplate: the drawn sprites under values, and the template they were all made from under template.

    The template is where a chart's styling is declared, and styling is the only signal amCharts leaves for the marks it has no series class for — a hairline columns.template is a lollipop's stem, and a strokes.template at zero opacity is what makes a line series a dot plot.

    bullets?: AmListLike<AmBullet>
    strokes?: AmListLike<AmSprite> & { template?: AmSprite }
    fills?: { template?: AmSprite }

    The fill graphics of a line series, as an am5 ListTemplate.

    amCharts has no area series class — an area chart is a LineSeries whose fills have been made visible — so the template's settings are the only thing that tells an area from a line.

    The lines an am5hierarchy.ForceDirected draws between its nodes, as an am5 ListTemplate.

    A network is the one reading whose marks hang off neither a data item nor the series' own data: its links are derived from the tree and from the rows' linkWith columns, and amCharts keeps the drawn lines here. Each carries the two node data items it joins on source / target, which is how findNetworkLink tells them apart.

    toGlobal?: (point: AmPoint) => AmPoint

    Converts a series-local point to root-container coordinates.

    width?: () => number

    The series' own laid-out box, which every am5 series has because a series is a Container. Read only for a standalone series — an am5hierarchy layout pushed straight into the root container — where the series IS the panel and there is no plotContainer to measure instead.

    height?: () => number
    globalBounds?: () => AmBounds