AnyChart
API Reference
Still have questions?
Contact support
    Top
    You are looking at an outdated v7 version of this document. Switch to the v8 version to see the up to date information.

    class anychart.standalones.Title Improve this Doc

    Extends: anychart.core.ui.Title

    Methods Overview

    Specific settings
    text()Title text.
    Advanced Text Settings
    fontVariant()Font variant settings.
    letterSpacing()Text letter spacing settings.
    textDirection()Text direction settings.
    textIndent()Text indent settings.
    textOverflow()Text overflow settings.
    textWrap()Text wrap settings.
    useHtml()Text useHtml settings.
    Base Text Settings
    fontColor()Font color settings.
    fontDecoration()Font decoration settings.
    fontFamily()Font family settings.
    fontOpacity()Font opacity settings.
    fontSize()Font size settings.
    fontStyle()Font style settings.
    fontWeight()Font weight settings.
    hAlign()Text horizontal align settings.
    lineHeight()Text line height settings.
    vAlign()Text vertical align settings.
    Coloring
    background()Background settings.
    Events
    disablePointerEvents()Pointer events settings.
    listen()Adds an event listener.
    listenOnce()Adds a single time event listener.
    removeAllListeners()Removes all listeners.
    unlisten()Removes the listener.
    unlistenByKey()Removes the listener by the key.
    Export
    print()Prints all elements.
    Interactivity
    enabled()Element state (enabled or disabled).
    selectable()Text selectable option.
    Size and Position
    align()Align settings.
    getRemainingBounds()Returns the remaining (after title placement) part of the container.
    height()Height settings.
    margin()Margin settings.
    orientation()Orientation settings.
    padding()Padding settings.
    parentBounds()Parent bounds settings.
    rotation()Rotation settings.
    width()Width settings.
    zIndex()Z-index of the element.
    Text Settings
    textSettings()Text settings.
    Miscellaneous
    container()Getter for the title current container.
    draw()Draws title.

    Methods Description

    align

    align()

    Getter for the title align.

    Returns:

    anychart.enums.Align - The current title align.

    Try it:

    align(value)

    Setter for the title align.

    Params:

    NameTypeDefaultDescription
    valueanychart.enums.Align | string
    "center"
    		 Value to set.

    Returns:

    anychart.standalones.Title - Self instance for method chaining.

    Try it:

    background

    background()

    Getter for the current title background.

    Returns:

    anychart.core.ui.Background - Returns the current background.

    Try it:

    background(value)

    Setter for the title background.

    Params:

    NameTypeDefaultDescription
    valuestring | Object | null | boolean
    false
    		 Value to set.

    Returns:

    anychart.standalones.Title - Self instance for method chaining.

    Try it:

    container

    container()

    Getter for the title current container.

    Returns:

    string | Element - The current container.

    Try it:

    container(value)

    Setter for the title container.

    Params:

    NameTypeDescription
    valuestring | ElementThe value to set.

    Returns:

    anychart.standalones.Title - Self instance for method chaining.

    Try it:

    disablePointerEvents

    disablePointerEvents()

    Getter for the current pointer events.

    Returns:

    boolean - Flag of the current state.

    Try it:

    disablePointerEvents(value)

    Setter for the pointer events.

    Params:

    NameTypeDefaultDescription
    valueboolean
    false
    		 Value to set.

    Returns:

    anychart.standalones.Title - Self instance for method chaining.

    Try it:

    draw

    draw()

    Draws title.

    Returns:

    anychart.standalones.Title - Self instance for method chaining.

    Try it:

    enabled

    enabled()

    Getter for the current element state (enabled or disabled).

    Returns:

    boolean - The current element state.

    Try it:

    enabled(value)

    Setter for the element enabled state.

    Params:

    NameTypeDefaultDescription
    valueboolean
    true
    		 Value to set.

    Returns:

    anychart.standalones.Title - Self instance for method chaining.
    Example.
    if (!element.enabled())
   element.enabled(true);

    Try it:

    fontColor

    fontColor()

    Getter for the text font color.

    Returns:

    string - The current font color.

    Try it:

    fontColor(value)

    Setter for the text font color.
    https://www.w3schools.com/html/html_colors.asp

    Params:

    NameTypeDefaultDescription
    valuestring
    "#7c868e"
    		 Value to set.

    Returns:

    anychart.standalones.Title - Self instance for method chaining.

    Try it:

    fontDecoration

    fontDecoration()

    Getter for the text font decoration.

    Returns:

    anychart.graphics.vector.Text.Decoration | string - The current font decoration.

    Try it:

    fontDecoration(value)

    Setter for the text font decoration.

    Params:

    NameTypeDefaultDescription
    valueanychart.graphics.vector.Text.Decoration | string
    "none"
    		 Value to set.

    Returns:

    anychart.standalones.Title - Self instance for method chaining.

    Try it:

    fontFamily

    fontFamily()

    Getter for the current font family.

    Returns:

    string - The current font family.

    Try it:

    fontFamily(value)

    Setter for font family.

    Params:

    NameTypeDefaultDescription
    valuestring
    "Verdana", Helvetica, Arial, sans-serif
    		 Value to set.

    Returns:

    anychart.standalones.Title - Self instance for method chaining.

    Try it:

    fontOpacity

    fontOpacity()

    Getter for the text font opacity.

    Returns:

    number - The current font opacity.

    Try it:

    fontOpacity(value)

    Setter for the text font opacity. Double value from 0 to 1.

    Params:

    NameTypeDefaultDescription
    valuenumber
    1
    		 Value to set.

    Returns:

    anychart.standalones.Title - Self instance for method chaining.

    Try it:

    fontSize

    fontSize()

    Getter for the current text font size.

    Returns:

    string | number - Current font size.

    Try it:

    fontSize(value)

    Setter for text font size.

    Params:

    NameTypeDefaultDescription
    valuestring | number
    16
    		 Value to set.

    Returns:

    anychart.standalones.Title - Self instance for method chaining.

    Try it:

    fontStyle

    fontStyle()

    Getter for the text font style.

    Returns:

    anychart.graphics.vector.Text.FontStyle | string - The current font style.

    Try it:

    fontStyle(value)

    Setter for the text font style.

    Params:

    NameTypeDefaultDescription
    valueanychart.graphics.vector.Text.FontStyle | string
    "normal"
    		 Value to set.

    Returns:

    anychart.standalones.Title - Self instance for method chaining.

    Try it:

    fontVariant

    fontVariant()

    Getter for the text font variant.

    Returns:

    anychart.graphics.vector.Text.FontVariant | string - The current font variant.

    Try it:

    fontVariant(value)

    Setter for the text font variant.

    Params:

    NameTypeDefaultDescription
    valueanychart.graphics.vector.Text.FontVariant | string
    "normal"
    		 Value to set.

    Returns:

    anychart.standalones.Title - Self instance for method chaining.

    Try it:

    fontWeight

    fontWeight()

    Getter for the text font weight.

    Returns:

    string | number - The current font weight.

    Try it:

    fontWeight(value)

    Setter for the text font weight.
    https://www.w3schools.com/cssref/pr_font_weight.asp

    Params:

    NameTypeDefaultDescription
    valuestring | number
    "normal"
    		 Value to set.

    Returns:

    anychart.standalones.Title - Self instance for method chaining.

    Try it:

    getRemainingBounds

    getRemainingBounds()

    Returns the remaining (after title placement) part of the container.

    Returns:

    anychart.math.Rect - Parent bounds without the space used by the title.

    Try it:

    hAlign

    hAlign()

    Getter for the text horizontal align.

    Returns:

    anychart.graphics.vector.Text.HAlign | string - The current text horizontal align.

    Try it:

    hAlign(value)

    Setter for the text horizontal align.

    Params:

    NameTypeDefaultDescription
    valueanychart.graphics.vector.Text.HAlign | string
    "start"
    		 Value to set.

    Returns:

    anychart.standalones.Title - Self instance for method chaining.

    Try it:

    height

    height()

    Getter for the current title height.

    Returns:

    number | string | null - The current title width.

    Try it:

    height(value)

    Setter for the title height.

    Params:

    NameTypeDefaultDescription
    valuenumber | string | null
    null
    		 Value to set.

    Returns:

    anychart.standalones.Title - Self instance for method chaining.

    Try it:

    letterSpacing

    letterSpacing()

    Getter for the text letter spacing.

    Returns:

    string | number - The current letter spacing.

    Try it:

    letterSpacing(value)

    Setter for the text letter spacing.
    https://www.w3schools.com/cssref/pr_text_letter-spacing.asp

    Params:

    NameTypeDefaultDescription
    valuestring | number
    "normal"
    		 Value to set.

    Returns:

    anychart.standalones.Title - Self instance for method chaining.

    Try it:

    lineHeight

    lineHeight()

    Getter for the text line height.

    Returns:

    string | number - The current text line height.

    Try it:

    lineHeight(value)

    Setter for the text line height.
    https://www.w3schools.com/cssref/pr_dim_line-height.asp

    Params:

    NameTypeDefaultDescription
    valuestring | number
    "normal"
    		 Value to set.

    Returns:

    anychart.standalones.Title - Self instance for method chaining.

    Try it:

    listen

    listen(type, listener, useCapture, listenerScope)

    Adds an event listener to an implementing object.

    Params:

    NameTypeDefaultDescription
    typestring
    		The event type id.
    listenerfunction
    		Callback method. Function that looks like function(event){
   // event.actualTarget - actual event target
   // event.currentTarget - current event target
   // event.iterator - event iterator
   // event.originalEvent - original event
   // event.point - event point
   // event.pointIndex - event point index
}.
    useCaptureboolean
    false
    		 Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
    listenerScopeObject
    		Object in whose scope to call the listener.
    Returns:
    Object - Unique key for the listener.
    Try it:
    listenOnce
    listenOnce(type, listener, useCapture, listenerScope)
    Adds an event listener to an implementing object.
    Params:
    NameTypeDefaultDescription
    typestring
    		The event type id.
    listenerfunction
    		Callback method.
    useCaptureboolean
    false
    		 Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
    listenerScopeObject
    		Object in whose scope to call the listener.
    Returns:
    Object - Unique key for the listener.
    Try it:
    margin
    margin()
    Getter for the title margin.
Learn more about margins at anychart.core.Chart#margin.
    Returns:
    anychart.core.utils.Margin - The title margin.
    Try it:
    margin(allValues)
    Setter for the title margin in pixels using one complex value.
    Params:
    NameTypeDefaultDescription
    allValuesstring | number | Array.<(number|string)> | Object
    {top: 0, right: 0, bottom: 2, left: 0}
    		 Value to set.
    Returns:
    anychart.standalones.Title - Self instance for method chaining.
    Try it:
    margin(value1, value2, value3, value4)
    Setter for the title margin in pixels using several numbers.
    Params:
    NameTypeDefaultDescription
    value1string | number
    0
    		 Top or top-bottom space.
    value2string | number
    0
    		 Right or right-left space.
    value3string | number
    0
    		 Bottom space.
    value4string | number
    0
    		 Left space.
    Returns:
    anychart.standalones.Title - Self instance for method chaining.
     Example.
    // 1) all 10px
title.margin(10);
// 2) top and bottom 10px, left and right 15px
title.margin(10, "15px");
// 3) top 10px, left and right 15px, bottom 5px
title.margin(10, "15px", 5);
// 4) top 10px, right 15px, bottom 5px, left 12px
title.margin(10, "15px", "5px", 12);
    Try it:
    orientation
    orientation()
    Getter for the current title orientation.
    Returns:
    anychart.enums.Orientation - The current orientation.
    Try it:
    orientation(value)
    Setter for the title orientation.
    Params:
    NameTypeDefaultDescription
    valueanychart.enums.Orientation | string
    "top"
    		 Value to set.
    Returns:
    anychart.standalones.Title - Self instance for method chaining.
    Try it:
    padding
    padding()
    Getter for the title padding.
    
Learn more about paddings at anychart.core.Chart#padding.
    Returns:
    anychart.core.utils.Padding - The title padding.
    Try it:
    padding(value)
    Setter for the title padding in pixels using single value.
    Params:
    NameTypeDefaultDescription
    valuestring | number | Array.<(number|string)> | Object
    {top: 0, right: 0, bottom: 2, left: 0}
    		 Value to set.
    Returns:
    anychart.standalones.Title - Self instance for method chaining.
    Try it:
    padding(value1, value2, value3, value4)
    Setter for the title padding in pixels using several numbers.
    Params:
    NameTypeDefaultDescription
    value1string | number
    0
    		 Top or top-bottom space.
    value2string | number
    0
    		 Right or right-left space.
    value3string | number
    0
    		 Bottom space.
    value4string | number
    0
    		 Left space.
    Returns:
    anychart.standalones.Title - Self instance for method chaining.
     Example.
    // 1) top and bottom 10px, left and right 15px
title.padding(10, "15px");
// 2) top 10px, left and right 15px, bottom 5px
title.padding(10, "15px", 5);
// 3) top 10px, right 15px, bottom 5px, left 12px
title.padding(10, "15px", "5px", 12);
    Try it:
    parentBounds
    parentBounds()
    Getter for bounds. As a getter falls back to stage bounds.
    Returns:
    anychart.math.Rect - Current bounds.
    Try it:
    parentBounds(value)
    Setter for bounds using single value.
    Params:
    NameTypeDescription
    valueanychart.math.Rect | Object | nullValue to set
    Returns:
    anychart.standalones.Title - Self instance for method chaining.
    Try it:
    parentBounds(left, top, width, height)
    Setter for bounds using several value.
    Params:
    NameTypeDescription
    leftnumberLeft space.
    topnumberTop space.
    widthnumberA width for a title.
    heightnumberA height for a title.
    Returns:
    anychart.standalones.Title - Self instance for method chaining.
    Try it:
    print
    print(paperSizeOrOptions, landscape)
    Prints all elements on related stage.
    Params:
    NameTypeDefaultDescription
    paperSizeOrOptionsanychart.graphics.vector.PaperSize | Object
    		Paper size or object with options.
    landscapeboolean
    false
    		 Flag of landscape.
    Try it:
    removeAllListeners
    removeAllListeners(type)
    Removes all listeners from an object. You can also optionally remove listeners of some particular type.
    Params:
    NameTypeDescription
    typestringType of event to remove, default is to remove all types.
    Returns:
    number - Number of listeners removed.
    Try it:
    rotation
    rotation()
    Getter for the current title rotation.
    Returns:
    number - The current rotation.
    Try it:
    rotation(value)
    Setter for the title rotation.
    Params:
    NameTypeDescription
    valuenumberValue to set.
    Returns:
    anychart.standalones.Title - Self instance for method chaining.
    Try it:
    rotation(value)
    Setter for the title rotation.
    Params:
    NameTypeDescription
    valuenumberValue to set.
    Returns:
    anychart.standalones.Title - Self instance for method chaining.
    Try it:
    selectable
    selectable()
    Getter for the text selectable option.
    Returns:
    boolean - The current text selectable option.
    Try it:
    selectable(value)
    Setter for the text selectable.
    Params:
    NameTypeDefaultDescription
    valueboolean
    false
    		 Value to set.
    Returns:
    anychart.standalones.Title - Self instance for method chaining.
    Try it:
    text
    text()
    Gets the text content for the current title.
    Returns:
    string - The current text content of the title.
    Try it:
    text(value)
    Sets the text content for the title.
    Params:
    NameTypeDefaultDescription
    valuestring
    "Title text"
    		 Value to set.
    Returns:
    anychart.standalones.Title - Self instance for method chaining.
    Try it:
    textDirection
    textDirection()
    Getter for the text direction.
    Returns:
    anychart.graphics.vector.Text.Direction | string - Current text direction.
    Try it:
    textDirection(value)
    Setter for the text direction.
    Params:
    NameTypeDefaultDescription
    valueanychart.graphics.vector.Text.Direction | string
    "ltr"
    		 Value to set.
    Returns:
    anychart.standalones.Title - Self instance for method chaining.
    Try it:
    textIndent
    textIndent()
    Getter for the text indent.
    Returns:
    number - The current text indent.
    Try it:
    textIndent(value)
    Setter for the text indent.
    Params:
    NameTypeDefaultDescription
    valuenumber
    0
    		 Value to set.
    Returns:
    anychart.standalones.Title - Self instance for method chaining.
    Try it:
    textOverflow
    textOverflow()
    Getter for the text overflow settings.
    Returns:
    anychart.graphics.vector.Text.TextOverflow | string - The current text overflow settings.
    Try it:
    textOverflow(value)
    Setter for the text overflow settings.
    Params:
    NameTypeDefaultDescription
    valueanychart.graphics.vector.Text.TextOverflow | string
    ""
    		 Value to set.
    Returns:
    anychart.standalones.Title - Self instance for method chaining.
    Try it:
    textSettings
    textSettings()
    Getter for the full text appearance settings.
    Returns:
    Object - A copy of settings object.
    Try it:
    textSettings(name)
    Getter for all text appearance settings.
    Params:
    NameTypeDescription
    namestringSetting name.
    Returns:
    string | number | boolean | undefined - Value of the setting.
    Try it:
    textSettings(objectWithSettings)
    Setter for text appearance settings.
    Params:
    NameTypeDescription
    objectWithSettingsObjectSettings object. Complete object looks like this:
   {
     "fontSize": smth,
     "fontFamily": smth,
     "fontColor": smth,
     "fontOpacity": smth,
     "fontDecoration": smth,
     "fontStyle": smth,
     "fontVariant": smth,
     "fontWeight": smth,
     "letterSpacing": smth,
     "textDirection": smth,
     "lineHeight": smth,
     "textIndent": smth,
     "vAlign": smth,
     "hAlign": smth,
     "textWrap": smth,
     "textOverflow": smth,
     "selectable": smth,
     "useHtml": smth
   }.
    Returns:
    anychart.standalones.Title - Self instance for method chaining.
    Try it:
    textSettings(name, value)
    Setter for the text appearance settings.
    Params:
    NameTypeDescription
    namestringSetting name.
    valuestring | number | boolean | functionSettings value.
    Returns:
    anychart.standalones.Title - Self instance for method chaining.
    Try it:
    textWrap
    textWrap()
    Getter for the text wrap settings.
    Returns:
    anychart.graphics.vector.Text.TextWrap | string - The current text wrap settings.
    Try it:
    textWrap(value)
    Setter for the text wrap settings.
    Params:
    NameTypeDefaultDescription
    valueanychart.graphics.vector.Text.TextWrap | string
    "byLetter"
    		 Value to set.
    Returns:
    anychart.standalones.Title - Self instance for method chaining.
    Try it:
    unlisten
    unlisten(type, listener, useCapture, listenerScope)
    Removes a listener added using listen() or listenOnce() methods.
    Params:
    NameTypeDefaultDescription
    typestring
    		The event type id.
    listenerfunction
    		Callback method.
    useCaptureboolean
    false
    		 Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
    listenerScopeObject
    		Object in whose scope to call the listener.
    Returns:
    boolean - Whether any listener was removed.
    Try it:
    unlistenByKey
    unlistenByKey(key)
    Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().
    Params:
    NameTypeDescription
    keyObjectThe key returned by listen() or listenOnce().
    Returns:
    boolean - Whether any listener was removed.
    Try it:
    useHtml
    useHtml()
    Getter for the useHTML flag.
    Returns:
    boolean - The current value of useHTML flag.
    Try it:
    useHtml(value)
    Setter for flag useHTML.
    Params:
    NameTypeDefaultDescription
    valueboolean
    false
    		 Value to set.
    Returns:
    anychart.standalones.Title - Self instance for method chaining.
    Try it:
    vAlign
    vAlign()
    Getter for the text vertical align.
    Returns:
    anychart.graphics.vector.Text.VAlign | string - The current text vertical align.
    Try it:
    vAlign(value)
    Setter for the text vertical align.
    Params:
    NameTypeDefaultDescription
    valueanychart.graphics.vector.Text.VAlign | string
    "top"
    		 Value to set.
    Returns:
    anychart.standalones.Title - Self instance for method chaining.
    Try it:
    width
    width()
    Getter for the title width.
    Returns:
    number | string | null - The current title width.
    Try it:
    width(value)
    Setter for the title width.
    Params:
    NameTypeDefaultDescription
    valuenumber | string | null
    null
    		 Value to set.
    Returns:
    anychart.standalones.Title - Self instance for method chaining.
    Try it:
    zIndex
    zIndex()
    Getter for the current Z-index of the element.
    Returns:
    number - The current zIndex.
    Try it:
    zIndex(value)
    Setter for the Z-index of the element.
    Params:
    NameTypeDefaultDescription
    valuenumber
    0
    		 Value to set.
    Returns:
    anychart.standalones.Title - Self instance for method chaining.
    Try it:
    AnyChart - JavaSript charts is a trusted solution for data visualization