SheetXL - v1.0.2
    Preparing search index...

    Interface ITitle

    A title: the chart's (IChart.getTitle), or an axis's (IChart.IAxisTitle).

    interface ITitle {
        isITitle: true;
        getChart(): IChart;
        getElementType(): IChart.ElementType;
        getOverlay(): boolean;
        getParent(): IElement | null;
        getPath(): string;
        getStyle(): ITextBoxStyle;
        getText(): string | null;
        getVisible(): boolean;
        setOverlay(overlay: boolean, options?: ITransaction.OperationOptions): this;
        setText(text: string | null, options?: ITransaction.OperationOptions): this;
        setVisible(visible: boolean, options?: ITransaction.OperationOptions): this;
        update(
            update: IChart.ITitle.Update,
            options?: ITransaction.OperationOptions,
        ): this;
    }

    Hierarchy (View Summary)

    Index
    isITitle
    getChart getElementType getOverlay getParent getPath getStyle getText getVisible setOverlay setText setVisible update
    isITitle: true

    For runtime type checking.

    • Returns whether the title is drawn over the plot area rather than taking room above it.

      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 the text the title shows, or null when it is not shown. A chart title that states no text of its own shows the name of a chart's only series, else Chart Title.

      Returns string | null

    • Returns whether the title is shown.

      Returns boolean

    • Sets the title's text and shows it. A formula (=Sheet1!$A$1) shows a cell's text. null hands a chart title back to the automatic text, and removes an axis title.

      Parameters

      Returns this

    Settings
    Member Visibility

    On This Page
    Properties
    Methods