SheetXL - v1.0.2
    Preparing search index...

    Interface IPoint

    One point of a series: what it states for itself, over the series (VBA's Point, Office Scripts' ChartPoint).

    interface IPoint {
        isIPoint: true;
        getChart(): IChart;
        getDataLabel(): IChart.IDataLabel;
        getElementType(): IChart.ElementType;
        getExplosion(): number;
        getHasDataLabel(): boolean;
        getIndex(): number;
        getInvertIfNegative(): boolean;
        getIsTotal(): boolean;
        getMarker(): IChart.IMarker;
        getParent(): IElement | null;
        getPath(): string;
        getStyle(): IShapeStyle;
        setExplosion(
            explosion: number,
            options?: ITransaction.OperationOptions,
        ): this;
        setHasDataLabel(
            has: boolean,
            options?: ITransaction.OperationOptions,
        ): this;
        setInvertIfNegative(
            invert: boolean,
            options?: ITransaction.OperationOptions,
        ): this;
        setIsTotal(total: boolean, options?: ITransaction.OperationOptions): this;
        update(
            update: IChart.IPoint.Update,
            options?: ITransaction.OperationOptions,
        ): this;
    }

    Hierarchy (View Summary)

    Index
    isIPoint
    getChart getDataLabel getElementType getExplosion getHasDataLabel getIndex getInvertIfNegative getIsTotal getMarker getParent getPath getStyle setExplosion setHasDataLabel setInvertIfNegative setIsTotal update
    isIPoint: true

    For runtime type checking.

    • Returns how far a slice is pulled out, as a percentage of the radius.

      Returns number

    • Returns whether the point's label is shown.

      Returns boolean

    • Returns the point's index in its series, from 0.

      Returns number

    • Returns whether a negative bar is drawn in the inverse of its fill, over the series.

      Returns boolean

    • Returns whether a waterfall's point is a total: its bar runs from zero to its value, which the points after it step from, rather than from the running total before it (VBA's IsTotal). false off a waterfall.

      Returns boolean

    • Returns the element this one is part of: a point's series, a gridline's axis, a legend entry's legend. The parts at the top (the title, the legend, the plot area, an axis, a series, a group) are the chart area's; the chart area has none.

      Returns IElement | null

    • Returns where the element is in its chart, as IChart.getElement takes it.

      Returns string

      A path is its parts' names joined by /, and does not change while the part is there:

      • chartArea, title, legend, legend/entries/<n>, plotArea, dataTable, and dataLabels (every series' at once);
      • axes/<primary|secondary>/<category|value|series>, and an axis's …/title, …/majorGridlines and …/minorGridlines;
      • series/<key>, and a series' …/marker, …/dataLabels, …/errorBars/<x|y>, …/trendlines/<n>, …/trendlines/<n>/label, …/points/<n>, …/points/<n>/marker and …/points/<n>/dataLabel;
      • groups/<n>, and a group's …/upDownBars, …/hiLoLines, …/dropLines and …/seriesLines.

      A series' key is its index in the file (c:idx), which an edit does not change; its place in the plot order can change. A point, a trendline, a legend entry and a group are named by their place, from 0: when one before it is removed, the path names the one that took its place.

    • Returns what the point is drawn with: a bar's or slice's fill and line; on a line series, its marker's fill and the line and outline at the point. Reads resolve to the series' own.

      Returns IShapeStyle

    • Sets whether this bar is drawn in the inverse of its fill when negative.

      Parameters

      Returns this

      ExpectedError off a bar.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods