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.core.axes.CircularTicks Improve this Doc

    Extends: anychart.core.VisualBase

    Axis ticks class.

    Methods Overview

    Specific settings
    type()Ticks type.
    Coloring
    fill()Fill settings.
    hatchFill()Hatch fill settings.
    stroke()Stroke settings.
    Events
    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).
    Size and Position
    length()Ticks length.
    position()Ticks position.
    zIndex()Z-index of the element.

    Methods Description

    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.core.axes.CircularTicks - Self instance for method chaining.
    Example.
    if (!element.enabled())
   element.enabled(true);

    Try it:

    fill

    fill()

    Getter for ticks fill color.

    Returns:

    anychart.graphics.vector.Fill | function - Ticks fill color.

    Try it:

    fill(value)

    Setter for ticks fill settings using an array or a string. Learn more about coloring.

    Params:

    NameTypeDefaultDescription
    valueanychart.graphics.vector.Fill | string
    "#545f69"
    		 Color as an object or a string.

    Returns:

    anychart.core.axes.CircularTicks - Self instance for method chaining.

    Try it:

    fill(color, opacity)

    Ticks fill color with opacity. Fill as a string or an object.

    Params:

    NameTypeDescription
    colorstringColor as a string.
    opacitynumberColor opacity.

    Returns:

    anychart.core.axes.CircularTicks - Self instance for method chaining.

    Try it:

    fill(keys, angle, mode, opacity)

    Linear gradient fill. Learn more about coloring.

    Params:

    NameTypeDescription
    keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
    anglenumberGradient angle.
    modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
    opacitynumberGradient opacity.

    Returns:

    anychart.core.axes.CircularTicks - Self instance for method chaining.

    Try it:

    fill(keys, cx, cy, mode, opacity, fx, fy)

    Radial gradient fill. Learn more about coloring.

    Params:

    NameTypeDescription
    keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
    cxnumberX ratio of center radial gradient.
    cynumberY ratio of center radial gradient.
    modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
    opacitynumberOpacity of the gradient.
    fxnumberX ratio of focal point.
    fynumberY ratio of focal point.

    Returns:

    anychart.core.axes.CircularTicks - Self instance for method chaining.

    Try it:

    fill(imageSettings)

    Image fill. Learn more about coloring.

    Params:

    NameTypeDescription
    imageSettingsanychart.graphics.vector.FillObject with settings.

    Returns:

    anychart.core.axes.CircularTicks - Self instance for method chaining.

    Try it:

    hatchFill

    hatchFill()

    Getter for ticks hatch fill settings.

    Returns:

    anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | boolean - Ticks hatch fill.
    See listing
    var ticksSettings = axis.ticks();
var currentHatchFill = ticksSettings.hatchFill();

    hatchFill(patternFillOrType, color, thickness, size)

    Setter for ticks hatch fill settings. Learn more about hatch fill settings.

    Params:

    NameTypeDefaultDescription
    patternFillOrTypeanychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | anychart.graphics.vector.HatchFill.HatchFillType | string | boolean
    null
    		 PatternFill or HatchFill instance or type of hatch fill.
    colorstring
    		Color.
    thicknessnumber
    		Thickness.
    sizenumber
    		Pattern size.
    Returns:
    anychart.core.axes.CircularTicks - Self instance for method chaining.
    Try it:
    length
    length()
    Getter for ticks length.
    Returns:
    string - Ticks length.
    Try it:
    length(value)
    Setter for ticks length.
    Params:
    NameTypeDefaultDescription
    valuenull | number | string
    undefined
    		 Value to set.
    Returns:
    anychart.core.axes.CircularTicks - 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:
    position
    position()
    Getter for ticks position.
    Returns:
    anychart.enums.SidePosition | string - Ticks position.
    Try it:
    position(value)
    Setter for ticks position.
    Params:
    NameTypeDefaultDescription
    valueanychart.enums.SidePosition | string
    "center"
    		 Position to set.
    Returns:
    anychart.core.axes.CircularTicks - 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:
    stroke
    stroke()
    Getter for ticks stroke.
    Returns:
    anychart.graphics.vector.Stroke | function - Ticks stroke settings.
    Try it:
    stroke(strokeFunction)
    Setter for ticks stroke by function.
    Params:
    NameTypeDescription
    strokeFunctionfunctionFunction to set
    Returns:
    anychart.core.axes.CircularTicks - Self instance for method chaining.
    Try it:
    stroke(value, thickness, dashpattern, lineJoin, lineCap)
    Setter for ticks stroke settings.
Learn more about stroke settings.
    Params:
    NameTypeDefaultDescription
    valueanychart.graphics.vector.Stroke | string | null
    'none'
    		 Stroke settings.
    thicknessnumber
    1
    		 Line thickness.
    dashpatternstring
    		Controls the pattern of dashes and gaps used to stroke paths.
    lineJoinanychart.graphics.vector.StrokeLineJoin
    		Line join style.
    lineCapanychart.graphics.vector.StrokeLineCap
    		Line cap style.
    Returns:
    anychart.core.axes.CircularTicks - Self instance for method chaining.
    Try it:
    type
    type()
    Getter for ticks type.
    Returns:
    string | anychart.enums.MarkerType | function - Ticks type.
    Try it:
    type(value)
    Setter for ticks type.
    Params:
    NameTypeDefaultDescription
    valuestring | anychart.enums.MarkerType | function
    "line"
    		 Value to set.
    Returns:
    anychart.core.axes.CircularTicks - 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:
    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.core.axes.CircularTicks - Self instance for method chaining.
    Try it:
    AnyMap is a robust interactive Javascript/HTML5 maps library